@kks-web/module-template

Module Template

🚀 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
start	Bundles the module with watch mode.
build	Bundles the module to the dist folder (format: CommonJS and ES Module).
test	Runs your tests using Jest.
test:cov	Runs your tests with coverage report.
lint	Runs Eslint with Prettier on .ts and .tsx files.
size	Creates bundle size snapshots with size-limit.
size:analyze	Creates bundle size snapshots with visualized analysis.
clean	Removes both dist and testing coverage folder.
clean:build	Removes dist folder.
clean:cov	Removes testing coverage folder.

Need More Information?

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