template-typescript-cli

A barebones file structure for creating a cli package (on npm) in TypeScript.

Other Templates

• TypeScript Barebones Project
• TypeScript NPM Package
• TypeScript Mono Repo

Includes

• eslint
• jest for testing
• A GitHub workflow file for continuous testing and npm publishing
• semantic-release for a fully automated release (using semantic versioning)
• prettier, husky, lint-staged for automatic formatting and linting

Scripts

• npm start for starting src/index.ts (might want to remove this and ts-node depending on package)
• npm run test for jest testing
• npm run test:watch for watching files using jest
• npm run build for building TypeScripts to lib folder
• npm run lint runs eslint
• npm run format runs prettier

Resources

• Kent C. Dodds article on general tips and unit testing.

License

This project is licensed with the MIT license.