https://github.com/sagar-v4/nodejs-template
NodeJS starter template with Conventional commit & lint, branch name validation, ESLint, Prettier, Husky and Release with auto generation of Conventional CHANGELOG.md file with versioning
https://github.com/sagar-v4/nodejs-template
branch-name-validation changelog-generator commitizen conventional-changelog conventional-commits eslint husky nodejs prittier template versioning
Last synced: about 1 month ago
JSON representation
NodeJS starter template with Conventional commit & lint, branch name validation, ESLint, Prettier, Husky and Release with auto generation of Conventional CHANGELOG.md file with versioning
- Host: GitHub
- URL: https://github.com/sagar-v4/nodejs-template
- Owner: Sagar-v4
- Created: 2025-02-19T15:08:56.000Z (8 months ago)
- Default Branch: master
- Last Pushed: 2025-02-19T18:51:57.000Z (8 months ago)
- Last Synced: 2025-08-17T06:23:19.531Z (about 2 months ago)
- Topics: branch-name-validation, changelog-generator, commitizen, conventional-changelog, conventional-commits, eslint, husky, nodejs, prittier, template, versioning
- Language: JavaScript
- Homepage:
- Size: 3.91 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
_`NodeJs Starter Template`_
## Configurations:
1. ESLint plugin for TypeScript
2. Prettier plugin for TypeScript
3. Commitizen to enforce a consistent commit message format
4. Husky for git hooks
5. Realease for automated versioning and publishing with change logs
6. Staged linting with ESLint and Prettier
7. Branch name validation for feature branches
8. Some useful VSCode extensions
## Formating
Prittier is already integrated with ESLint. To format yourfiles, run:
```bash
npm run format
# or
yarn format
# or
pnpm format
```
## Linting
ESLint is already integrated with Prettier. To lint your files, run:
```bash
npm run lint
# or
yarn lint
# or
pnpm lint
```
## Commit
Conventional commit commands follow the [Conventional Commits specification](https://www.conventionalcommits.org/en/v1.0.0/).
```bash
cz
# or
git cz
```
Run this command to create a commit with the selected type, scope, and message.
## Release & CHANGELOG.md
Release-it will create a new tag, update the `CHANGELOG.md`, and push the changes to Github, run:
```bash
npm run release
# or
yarn release
# or
pnpm release
```