The best starting point for your new Node project
This is a GitHub template repository Read more
It provides basic foundations for package authors, but it can be used as a good starting point for your Node.js application
Before using, download and install Node.js. Node.js 10.16.3 or higher is recommended.
- TypeScript
- Testing with Jest and Tap reporter
- TypeScript linting using eslint
- TypeScript watch mode using ts-node-dev
- Formatting using Prettier
- Pre-commit hook using Husky (will run linter, formatting and unit tests before each commit)
- Format on save / type enabled by default using Prettier
- Prettier extension configuration, Read more
- Source folder: src
- Output directory: dist
- Sourcemaps enabled by default
- Jest current file: Unit test debugging command for VSCode
- Debug: Node debugging command for VSCode
- All the eslint plugins are using the recommended defaults
$ npm run dev
$ npm run build
$ npm run build:watch
$ npm test
$ npm run lint
$ npm run lint:fix
$ npm run coverage
The following extensions works great alongside with this setup:
The recommended approach is to create a scoped public package (if you are not using private packages) Read more about scoped packages here
If you're using the package.json from the template you may want to change the name and references to pgk-template and change it to your library.