0.0.3 ā€¢ Published 3 years ago

@kks-web/module-template v0.0.3

Weekly downloads
-
License
MIT
Repository
github
Last release
3 years ago

Module Template

npm version npm downloads npm downloads npm bundle size PRs welcome

šŸš€ Your module start template that powered by TSDX.

Directory Structure

Here is the structure of the starter.

.
ā”œā”€ā”€ src                # Write your code here
ā”œā”€ā”€ example            # Try your code here (refer to ./example for more info)
ā”œā”€ā”€ test               # Test your code here
ā”œā”€ā”€ jest.config.ts     # Jest configuration
ā””ā”€ā”€ tsconfig.json      # TypeScript configuration

Script Commands

Some useful commands you might need.

yarn <script>Description
startBundles the module with watch mode.
buildBundles the module to the dist folder (format: CommonJS and ES Module).
testRuns your tests using Jest.
test:covRuns your tests with coverage report.
lintRuns Eslint with Prettier on .ts and .tsx files.
sizeCreates bundle size snapshots with size-limit.
size:analyzeCreates bundle size snapshots with visualized analysis.
cleanRemoves both dist and testing coverage folder.
clean:buildRemoves dist folder.
clean:covRemoves testing coverage folder.

Need More Information?

For more information or configuration, please refer to TSDX document.