Configured compodoc + swagger + i18n + etc

Author: c0dewriter

.env.example

@@ -0,0 +1 @@
+export NODE_ENV=development

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+  "cSpell.words": ["nestjs", "swcrc"]
+}

nest-cli.json

@@ -3,6 +3,25 @@
   "collection": "@nestjs/schematics",
   "sourceRoot": "src",
   "compilerOptions": {
-    "deleteOutDir": true
+    "deleteOutDir": true,
+    "typeCheck": true,
+    "webpack": false,
+    "assets": [{ "include": "i18n/**/*", "watchAssets": true }],
+    "builder": {
+      "type": "swc",
+      "options": {
+        "swcrcPath": "./.swcrc"
+      }
+    },
+    "plugins": [
+      {
+        "name": "@nestjs/swagger",
+        "options": {
+          "classValidatorShim": true,
+          "introspectComments": true,
+          "dtoFileNameSuffix": [".dto.ts", ".entity.ts", ".out.ts"]
+        }
+      }
+    ]
   }
 }

package.json

@@ -21,19 +21,30 @@
     "test:watch": "jest --watch",
     "test:cov": "jest --coverage",
     "test:debug": "node --inspect-brk -r tsconfig-paths/register -r ts-node/register node_modules/.bin/jest --runInBand",
-    "test:e2e": "jest --config ./test/jest-e2e.json"
+    "test:e2e": "jest --config ./test/jest-e2e.json",
+    "docs": "compodoc -p compodoc.tsconfig.json -d docs/internal --theme material",
+    "docs:serve": "compodoc -p compodoc.tsconfig.json -d docs/internal --theme material -s"
   },
   "dependencies": {
     "@nestjs/common": "^10.0.0",
     "@nestjs/core": "^10.0.0",
     "@nestjs/platform-express": "^10.0.0",
+    "@nestjs/swagger": "^7.3.1",
+    "@swc/cli": "^0.3.12",
+    "@swc/core": "^1.5.7",
+    "class-transformer": "^0.5.1",
+    "class-validator": "^0.14.1",
+    "helmet": "^7.1.0",
+    "nestjs-i18n": "^10.4.5",
     "reflect-metadata": "^0.2.0",
     "rxjs": "^7.8.1"
   },
   "devDependencies": {
+    "@compodoc/compodoc": "^1.1.24",
     "@nestjs/cli": "^10.0.0",
     "@nestjs/schematics": "^10.0.0",
     "@nestjs/testing": "^10.0.0",
+    "@swc/jest": "^0.2.36",
     "@types/express": "^4.17.17",
     "@types/jest": "^29.5.2",
     "@types/node": "^20.3.1",
@@ -43,7 +54,7 @@
     "eslint": "^8.42.0",
     "eslint-config-prettier": "^9.0.0",
     "eslint-plugin-prettier": "^5.0.0",
-    "jest": "^29.5.0",
+    "jest": "^29.7.0",
     "prettier": "^3.0.0",
     "source-map-support": "^0.5.21",
     "supertest": "^6.3.3",
@@ -54,16 +65,18 @@
     "typescript": "^5.1.3"
   },
   "jest": {
+    "transform": {
+      "^.+\\.(t|j)s?$": [
+        "@swc/jest"
+      ]
+    },
     "moduleFileExtensions": [
       "js",
       "json",
       "ts"
     ],
     "rootDir": "src",
     "testRegex": ".*\\.spec\\.ts$",
-    "transform": {
-      "^.+\\.(t|j)s$": "ts-jest"
-    },
     "collectCoverageFrom": [
       "**/*.(t|j)s"
     ],

src/app.controller.spec.ts

@@ -1,8 +1,8 @@
-import { Injectable } from '@nestjs/common';
+import { Injectable } from "@nestjs/common";
 
 @Injectable()
 export class AppService {
   getHello(): string {
-    return 'Hello World!';
+    return "Hello World!";
   }
 }

src/app.service.ts

@@ -1,8 +1,56 @@
-import { NestFactory } from '@nestjs/core';
-import { AppModule } from './app.module';
+import { VersioningType } from "@nestjs/common";
+import { NestFactory } from "@nestjs/core";
+import { DocumentBuilder, SwaggerModule } from "@nestjs/swagger";
+import helmet from "helmet";
+import { I18nValidationExceptionFilter, I18nValidationPipe } from "nestjs-i18n";
+
+import { AppModule } from "./app.module";
+import metadata from "./metadata";
 
 async function bootstrap() {
   const app = await NestFactory.create(AppModule);
+
+  app.useGlobalFilters(
+    new I18nValidationExceptionFilter({
+      detailedErrors: false,
+    }),
+  );
+
+  app.enableVersioning({
+    type: VersioningType.URI,
+    prefix: "v",
+  });
+
+  app.use(helmet());
+
+  app.useGlobalPipes(
+    new I18nValidationPipe({
+      transform: true,
+      forbidUnknownValues: true,
+      forbidNonWhitelisted: true,
+      stopAtFirstError: process.env.NODE_ENV !== "development",
+      disableErrorMessages: process.env.NODE_ENV !== "development",
+    }),
+  );
+
+  app.enableCors();
+
+  if (process.env.NODE_ENV === "development") {
+    const openAPIConfig = new DocumentBuilder()
+      .addBearerAuth()
+      .setTitle("Boilerplate")
+      .setDescription("Super Stable and Production-Ready 😬")
+      .setVersion("0.1")
+      .build();
+
+    await SwaggerModule.loadPluginMetadata(metadata);
+
+    const swaggerDocument = SwaggerModule.createDocument(app, openAPIConfig, {
+      ignoreGlobalPrefix: false,
+    });
+    SwaggerModule.setup("/docs/v1/swagger/", app, swaggerDocument);
+  }
+
   await app.listen(3000);
 }
 bootstrap();

src/main.ts

@@ -0,0 +1,5 @@
+/* eslint-disable */
+export default async () => {
+    const t = {};
+    return { "@nestjs/swagger": { "models": [], "controllers": [[import("./app.controller"), { "AppController": { "getHello": { type: String } } }]] } };
+};