Merge pull request #108 from vndevteam/develop

feat: merge develop into main

Author: lamngockhuong

.husky/pre-commit

@@ -1,5 +1,3 @@
-#!/usr/bin/env sh
-
 BRANCH=$(git rev-parse --abbrev-ref HEAD)
 REGEX="^(feature|bugfix|hotfix|release|merge)\.([a-zA-Z0-9-]+(\.[a-zA-Z0-9-]+)*)$"
 

.husky/pre-push

@@ -1,4 +1,3 @@
-#!/usr/bin/env sh
 GREEN='\033[0;32m'
 BLUE='\033[0;34m'
 NC='\033[0m'

.vscode/launch.json

@@ -0,0 +1,15 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "Nest Debug",
+      "request": "launch",
+      "runtimeArgs": ["start:debug"],
+      "autoAttachChildProcesses": true,
+      "console": "integratedTerminal",
+      "runtimeExecutable": "pnpm",
+      "skipFiles": ["<node_internals>/**"],
+      "type": "node"
+    }
+  ]
+}

README.md

@@ -72,6 +72,11 @@ $ pnpm run start:prod
 - [x] Docker.
 - [x] CI (Github Actions).
 
+## References
+
+- [Awesome Nest Boilerplate](https://github.com/NarHakobyan/awesome-nest-boilerplate)
+- [Brocoders NestJS Boilerplate](https://github.com/brocoders/nestjs-boilerplate)
+
 ## Support
 
 [Discuss on Github](https://github.com/vndevteam/nestjs-boilerplate/discussions)

docs/README.md

@@ -1 +1,17 @@
-# NestJS Boilerplate
+# NestJS Boilerplate Documentation
+
+- [Setup & Development](development.md)
+- [Architecture](architecture.md)
+- [Database](database.md)
+- [Security](security.md)
+- [Testing](testing.md)
+- [Deployment](deployment.md)
+- [Techniques](techniques.md)
+- [Troubleshooting](troubleshooting.md)
+- Convention
+  - [Naming cheatsheet](conventions/naming-cheatsheet.md)
+  - [TypeScript Style Guide and Coding Conventions](conventions/styleguide.md)
+  - [Clean code Typescript](conventions/clean-code-typescript.md)
+  - [Branch conventions](conventions/branch-conventions.md)
+  - [Commit conventions](conventions/commit-conventions.md)
+  - [Linting & formatting](conventions/linting.md)

docs/conventions/linting.md

@@ -1,19 +1,37 @@
 # Linting & formatting
 
-We use `prettier` to format the code
+This project uses [Typescript Eslint](https://typescript-eslint.io/), and [Prettier](https://prettier.io/) to catch errors and avoid bike-shedding by enforcing a common code style.
 
-## Prettier
+## Languages
 
-<!-- prettier-ignore-start -->
+- **Typescript** is linted by Typescript Eslint and formatted by Prettier
+- **JSON** is formatted by Prettier
 
-- Semicolons
+## Scripts
 
-```ts
-// bad ❌
-const foo = 1
+There are a few different contexts in which the linters run.
 
-// good ✅
-const foo = 1;
+### Terminal
+
+```bash
+# Lint all files, fixing many violations automatically
+pnpm lint
 ```
 
-<!-- prettier-ignore-end -->
+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](https://eslint.org/docs/latest/use/configure/)
+  - `eslint.config.mjs`
+
+- [Prettier](https://prettier.io/docs/en/configuration.html)
+  - `.prettierrc`

docs/testing.md

@@ -1 +1,55 @@
 # Testing
+
+We use **Jest** for comprehensive unit testing in our NestJS project. Below are the various commands and methods you can use to run tests effectively.
+
+## Running All Tests
+
+Execute all test cases across the project using:
+
+```bash
+pnpm test
+```
+
+## Running a Specific Test File
+
+To run tests in a specific file, use the following command:
+
+```bash
+pnpm test path/to/file
+
+# example: pnpm test src/api/auth/auth.controller.spec.ts
+```
+
+## Running End-to-End (e2e) Tests
+
+End-to-end tests can be executed using:
+
+```bash
+pnpm test:e2e
+```
+
+## Running Tests in Watch Mode
+
+For continuous testing, enabling watch mode allows you to re-run tests automatically upon file changes:
+
+```bash
+pnpm test:watch
+```
+
+## Running Tests with Coverage
+
+To generate a code coverage report, use the command:
+
+```bash
+pnpm test:cov
+```
+
+## Running Tests in IDE
+
+### Visual Studio Code
+
+For a seamless testing experience within Visual Studio Code, install the [Jest Runner](https://marketplace.visualstudio.com/items?itemName=firsttris.vscode-jest-runner) extension. This extension allows you to run tests directly from the test file, streamlining the development process.
+
+![Jest Runner](https://github.com/firsttris/vscode-jest/raw/master/public/vscode-jest.gif)
+
+By following this guide, you can ensure a robust testing workflow, leading to more reliable and maintainable code.

package.json

@@ -66,7 +66,7 @@
     "@nestjs/schematics": "10.1.2",
     "@nestjs/testing": "10.3.10",
     "@swc/cli": "0.4.0",
-    "@swc/core": "1.6.13",
+    "@swc/core": "1.7.0",
     "@types/compression": "1.7.5",
     "@types/eslint__js": "8.42.3",
     "@types/express": "4.17.21",
@@ -83,7 +83,7 @@
     "eslint": "9.7.0",
     "eslint-config-prettier": "9.1.0",
     "eslint-plugin-prettier": "5.2.1",
-    "husky": "9.1.0",
+    "husky": "9.1.1",
     "jest": "29.7.0",
     "lint-staged": "15.2.7",
     "prettier": "3.3.3",