feat: ✨ 添加后端文档生成

.commitlintrc.json

@@ -1,5 +1,6 @@
-{ "extends": ["@commitlint/config-conventional"],
-"rules": {
+{
+  "extends": ["@commitlint/config-conventional"],
+  "rules": {
     "type-enum": [
       2,
       "always",
@@ -97,4 +98,5 @@
         "name": "chore:    其他修改 | Other changes that do not modify src or test files"
       }
     ]
-  } }
+  }
+}

.gitignore

@@ -36,4 +36,4 @@ lerna-debug.log*
 !.vscode/launch.json
 !.vscode/extensions.json
 
-.turbo
+.turbo

apps/back/.gitignore

@@ -32,4 +32,6 @@ lerna-debug.log*
 !.vscode/settings.json
 !.vscode/tasks.json
 !.vscode/launch.json
-!.vscode/extensions.json
+!.vscode/extensions.json
+
+documentation/**

apps/back/package.json

@@ -17,6 +17,7 @@
     "start:debug": "nest start --debug --watch",
     "start:prod": "node dist/main",
     "lint": "tsc --noEmit && eslint \"src/**/*.ts\" --ignore-path .eslintignore",
+    "compodoc": "compodoc -p tsconfig.json -s -o",
     "test": "jest",
     "test:watch": "jest --watch",
     "test:cov": "jest --coverage",
@@ -40,6 +41,7 @@
     "winston-daily-rotate-file": "^5.0.0"
   },
   "devDependencies": {
+    "@compodoc/compodoc": "^1.1.23",
     "@nestjs/cli": "^10.3.2",
     "@nestjs/schematics": "^10.1.1",
     "@nestjs/testing": "^10.3.3",

apps/back/tsconfig.build.json

@@ -1,4 +1,4 @@
 {
   "extends": "./tsconfig.json",
-  "exclude": ["node_modules", "test", "dist", "**/*spec.ts","src/metadata.ts"]
+  "exclude": ["node_modules", "test", "dist", "**/*spec.ts", "src/metadata.ts"]
 }

apps/back/tsconfig.json

@@ -23,4 +23,4 @@
       "~/*": ["./src/*"]
     }
   }
-}
+}

apps/web/tsconfig.json

@@ -4,7 +4,7 @@
     "baseUrl": ".",
     "paths": {
       "@/*": ["./src/*"]
-    },
+    }
   },
   "include": [
     "src/**/*.ts",

package.json

@@ -11,7 +11,7 @@
     "lint": "turbo lint",
     "prepare": "husky install",
     "dev": "lerna run dev --scope=web",
-    "start": "lerna run start --scope=service"
+    "start": "lerna run start:dev --scope=service"
   },
   "config": {
     "commitizen": {

packages/typescript-config/nextjs.json

@@ -8,6 +8,6 @@
     "moduleResolution": "Bundler",
     "allowJs": true,
     "jsx": "preserve",
-    "noEmit": true,
+    "noEmit": true
   }
 }

packages/typescript-config/web.json

@@ -1,8 +1,7 @@
 {
-    "extends": "@vue/tsconfig/tsconfig.dom.json",
-    "compilerOptions": {
-      "noEmit": true,
-      "types": ["vitest", "vitest/globals"]
-    }
+  "extends": "@vue/tsconfig/tsconfig.dom.json",
+  "compilerOptions": {
+    "noEmit": true,
+    "types": ["vitest", "vitest/globals"]
   }
-  
+}