NestJS boilerplate 🎉
Home
  • English
  • Tiếng Việt
GitHub
Home
  • English
  • Tiếng Việt
GitHub
  • Setup & Development
  • Technologies
  • Architecture
  • API
  • Database
  • Security
  • Testing
  • Benchmarking
  • Deployment
  • Troubleshooting
  • FAQ
  • Convention

    • Naming cheatsheet
    • TypeScript Style Guide and Coding Conventions
    • Clean code Typescript
    • Branch conventions
    • Commit conventions
    • Linting & Formatting

Linting & Formatting

This project uses Typescript Eslint, and Prettier to catch errors and avoid bike-shedding by enforcing a common code style.


  • Languages
  • Scripts
    • Terminal
    • Pre-commit
    • Editor
  • Configuration

Languages

  • Typescript is linted by Typescript Eslint and formatted by Prettier
  • JSON is formatted by Prettier

Scripts

There are a few different contexts in which the linters run.

Terminal

# Lint all files, fixing many violations automatically
pnpm lint

See package.json to update.

Pre-commit

Staged files are automatically linted and tested before each commit. See lint-staged.config.mjs to update.

Editor

In supported editors, all files will be linted and show under the linter errors section.

Configuration

  • ESLint

    • eslint.config.mjs
  • Prettier

    • .prettierrc
Edit this page
Last Updated:
Contributors: Lâm Ngọc Khương
Prev
Commit conventions