README.md

better-nodejs-project

Ways for a better Node.js backend project

ECMAScript Modules (ESM)

For modern, future-proof Node.js development, using ESM instead of CommonJS can provide benefits such as Top-level await, clearer handling of Circular dependency, and more

• Node.js Docs: ECMAScript modules
• MDN Docs: JavaScript modules

TypeScript

For preventing errors in your code with static analysis

• TypeScript from scratch
• TypeScript Handbook

NestJS Framework

For extensible architectural structures and production-ready functionality

• https://docs.nestjs.com/#introduction
• https://discord.gg/nestjs

TypeScript ESLint

For correcting bad code and writing consistent code

• https://typescript-eslint.io

It is recommended to apply the known extended presets in addition to the basic rules
The following rules are available in flat config in eslint v9

• neostandard
• eslint-plugin-sonarjs
• eslint-plugin-unicorn
• eslint-plugin-github
• eslint-config-love

Conventional Commits

For consistent commit message

• https://www.conventionalcommits.org
• https://commitlint.js.org

Semantic Versioning

For automatic versioning and changelog based on consistent commit messages

• Automatically Version with Conventional Commits
  • nx release version
  • nx release changelog
  • If you publish the project as a package, use nx release publish.
• Manage Releases
  • Release TypeScript/JavaScript Packages to NPM

Husky - Git hooks

For consistent work to avoid mistakes before committing

• https://typicode.github.io/husky
• commitlint, lint-staged, check-dependencies, etc.

Example

See the source code of this repository

Links

Other helpful links

• Awesome Node.js
• Node.js Best Practices
• JavaScript Clean Code
  • Goodbye, Clean Code
• JavaScript Questions
• Modern JavaScript Tutorial