refactor:更改目录结构 #2

Refactor/dirctory structure

Author: CodeGetters

.commitlintrc.json

@@ -0,0 +1,100 @@
+{ "extends": ["@commitlint/config-conventional"],
+"rules": {
+    "type-enum": [
+      2,
+      "always",
+      [
+        "feat",
+        "fix",
+        "docs",
+        "style",
+        "refactor",
+        "test",
+        "build",
+        "chore",
+        "perf",
+        "ci",
+        "revert"
+      ]
+    ],
+    "type-case": [2, "always", "lower-case"],
+    "type-empty": [2, "never"],
+    "subject-full-stop": [2, "never", "."],
+    "header-max-length": [2, "always", 100],
+    "subject-case": [
+      2,
+      "never",
+      ["sentence-case", "start-case", "pascal-case", "upper-case"]
+    ]
+  },
+  "prompt": {
+    "useEmoji": true,
+    "allowCustomIssuePrefix": true,
+    "allowEmptyIssuePrefix": true,
+    "confirmColorize": true,
+    "messages": {
+      "type": "选择你要提交的类型 :",
+      "scope": "选择一个提交范围（可选）:",
+      "customScope": "请输入自定义的提交范围 :",
+      "subject": "填写简短精炼的变更描述 :\n",
+      "body": "填写更加详细的变更描述（可选）。使用 '|' 换行 :\n",
+      "breaking": "列举非兼容性重大的变更（可选）。使用 '|' 换行 :\n",
+      "footerPrefixesSelect": "选择关联issue前缀（可选）:",
+      "customFooterPrefix": "输入自定义issue前缀 :",
+      "footer": "列举关联issue (可选) 例如: #31, #I3244 :\n",
+      "confirmCommit": "是否提交或修改commit ?"
+    },
+    "types": [
+      {
+        "value": "feat",
+        "emoji": "✨",
+        "name": "feat:     新增功能 | A new feature"
+      },
+      { "value": "fix", "name": "fix:      修复缺陷 | A bug fix" },
+      {
+        "value": "docs",
+        "emoji": "📚",
+        "name": "docs:     文档更新 | Documentation only changes"
+      },
+      {
+        "value": "style",
+        "emoji": "💎",
+        "name": "style:    代码格式 | Changes that do not affect the meaning of the code"
+      },
+      {
+        "value": "refactor",
+        "emoji": "📦",
+        "name": "refactor: 代码重构 | A code change that neither fixes a bug nor adds a feature"
+      },
+      {
+        "value": "perf",
+        "emoji": "🚀",
+        "name": "perf:     性能提升 | A code change that improves performance"
+      },
+      {
+        "value": "test",
+        "emoji": "🚨",
+        "name": "test:     测试相关 | Adding missing tests or correcting existing tests"
+      },
+      {
+        "value": "build",
+        "emoji": "🛠",
+        "name": "build:    构建相关 | Changes that affect the build system or external dependencies"
+      },
+      {
+        "value": "ci",
+        "emoji": "⚙️",
+        "name": "ci:       持续集成 | Changes to our CI configuration files and scripts"
+      },
+      {
+        "value": "revert",
+        "emoji": "🗑",
+        "name": "revert:   回退代码 | Revert to a commit"
+      },
+      {
+        "value": "chore",
+        "emoji": "♻️",
+        "name": "chore:    其他修改 | Other changes that do not modify src or test files"
+      }
+    ]
+  } }

.eslintignore

@@ -1,4 +1,10 @@
 dist
 .eslintrc.cjs
+.eslintrc.js
 shims-vue.d.ts
 webpack-hmr.config.js
+commitlint.config.js
+packages/**
+api-generate.js
+components.d.ts
+coverage/**

.eslintrc.js

@@ -0,0 +1,10 @@
+// This configuration only applies to the package manager root.
+/** @type {import("eslint").Linter.Config} */
+module.exports = {
+  ignorePatterns: ["packages/**"],
+  extends: ["@vtiuse/eslint-config/library.js"],
+  parser: "@typescript-eslint/parser",
+  parserOptions: {
+    project: true,
+  },
+};

.gitignore

@@ -35,3 +35,5 @@ lerna-debug.log*
 !.vscode/tasks.json
 !.vscode/launch.json
 !.vscode/extensions.json
+
+.turbo

.nvmrc

@@ -0,0 +1 @@
+20

packages/back/.env renamed to apps/back/.env

@@ -0,0 +1 @@
+dist

apps/back/.eslintignore

@@ -0,0 +1,9 @@
+/** @type {import("eslint").Linter.Config} */
+module.exports = {
+  root: true,
+  parser: "@typescript-eslint/parser",
+  extends: ["@vtiuse/eslint-config/nest.js"],
+  parserOptions: {
+    project: true,
+  },
+};

apps/back/.eslintrc.js

@@ -1,5 +1,5 @@
 {
-  "name": "@vtiuse-full/back",
+  "name": "service",
   "version": "0.0.1",
   "description": "",
   "author": "CodeGetters",
@@ -16,49 +16,48 @@
     "start:dev": "nest build --webpack --webpackPath webpack-hmr.config.js --watch",
     "start:debug": "nest start --debug --watch",
     "start:prod": "node dist/main",
-    "lint": "eslint \"{src,apps,libs,test}/**/*.ts\" --fix",
+    "lint": "tsc --noEmit && eslint \"src/**/*.ts\" --ignore-path .eslintignore",
     "test": "jest",
     "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",
-    "preinstall": "npx only-allow pnpm"
+    "test:e2e": "jest --config ./test/jest-e2e.json"
   },
   "dependencies": {
-    "@nestjs/common": "^10.3.0",
-    "@nestjs/config": "^3.1.1",
-    "@nestjs/core": "^10.3.0",
-    "@nestjs/platform-express": "^10.3.0",
-    "@nestjs/swagger": "^7.2.0",
+    "@nestjs/common": "^10.3.3",
+    "@nestjs/config": "^3.2.0",
+    "@nestjs/core": "^10.3.3",
+    "@nestjs/platform-express": "^10.3.3",
+    "@nestjs/swagger": "^7.3.0",
     "class-transformer": "^0.5.1",
     "class-validator": "^0.14.1",
     "dayjs": "^1.11.10",
     "nest-winston": "^1.9.4",
-    "nestjs-i18n": "^10.4.0",
+    "nestjs-i18n": "^10.4.5",
     "reflect-metadata": "^0.2.1",
     "rxjs": "^7.8.1",
-    "winston": "^3.11.0",
-    "winston-daily-rotate-file": "^4.7.1"
+    "winston": "^3.12.0",
+    "winston-daily-rotate-file": "^5.0.0"
   },
   "devDependencies": {
-    "@nestjs/cli": "^10.3.0",
-    "@nestjs/schematics": "^10.1.0",
-    "@nestjs/testing": "^10.3.0",
+    "@nestjs/cli": "^10.3.2",
+    "@nestjs/schematics": "^10.1.1",
+    "@nestjs/testing": "^10.3.3",
     "@types/express": "^4.17.21",
-    "@types/jest": "^29.5.11",
-    "@types/node": "^20.11.5",
+    "@types/jest": "^29.5.12",
+    "@types/node": "^20.11.28",
     "@types/supertest": "^6.0.2",
     "jest": "^29.7.0",
     "kolorist": "^1.8.0",
     "module-alias": "^2.2.3",
     "run-script-webpack-plugin": "^0.2.0",
     "source-map-support": "^0.5.21",
     "supertest": "^6.3.4",
-    "ts-jest": "^29.1.1",
+    "ts-jest": "^29.1.2",
     "ts-loader": "^9.5.1",
     "ts-node": "^10.9.2",
     "tsconfig-paths": "^4.2.0",
-    "webpack": "^5.89.0",
+    "webpack": "^5.90.3",
     "webpack-cli": "^5.1.4",
     "webpack-node-externals": "^3.0.0"
   },
@@ -78,5 +77,13 @@
     ],
     "coverageDirectory": "../coverage",
     "testEnvironment": "node"
+  },
+  "homepage": "https://github.com/CodeGetters/vtiuse-full#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/CodeGetters/vtiuse-full.git"
+  },
+  "bugs": {
+    "url": "https://github.com/CodeGetters/vtiuse-full/issues"
   }
 }

packages/back/.gitignore renamed to apps/back/.gitignore

@@ -25,6 +25,7 @@ interface IResponse {
 @Catch(HttpException)
 export default class HttpExceptionFilter implements ExceptionFilter {
   constructor(
+    // eslint-disable-next-line no-unused-vars
     @Inject(WINSTON_MODULE_PROVIDER) private readonly logger: Logger,
   ) {}
 
@@ -48,8 +49,7 @@ export default class HttpExceptionFilter implements ExceptionFilter {
     ) {
       msg = response.message;
     }
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    const { query, headers, url, method, body } = req;
+    // const { query, headers, url, method, body } = req;
 
     this.logger.error(msg, {
       status,

packages/back/README.md renamed to apps/back/README.md

@@ -1,3 +1,4 @@
+// eslint-disable-next-line import/order
 import {
   CallHandler,
   ExecutionContext,
@@ -21,13 +22,14 @@ import { getReqMainInfo } from "~/common/utils/logger";
 @Injectable()
 export default class ResponseInterceptor implements NestInterceptor {
   constructor(
+    // eslint-disable-next-line no-unused-vars
     @Inject(WINSTON_MODULE_PROVIDER) private readonly logger: Logger,
   ) {}
 
   intercept(
     context: ExecutionContext,
-    next: CallHandler<any>,
-  ): Observable<any> | Promise<Observable<any>> {
+    next: CallHandler<unknown>,
+  ): Observable<unknown> | Promise<Observable<unknown>> {
     const ctx = context.switchToHttp();
     const req = ctx.getRequest<Request>();
 

packages/back/nest-cli.json renamed to apps/back/nest-cli.json

@@ -1,4 +1,4 @@
-/* eslint-disable @typescript-eslint/no-unused-vars */
+/* eslint-disable no-console */
 import { Logger } from "winston";
 import { bgGreen, green, cyan } from "kolorist";
 import { WINSTON_MODULE_PROVIDER } from "nest-winston";
@@ -14,11 +14,9 @@ export default class LoggerMiddleware implements NestMiddleware {
 
   use(req: Request, res: Response, next: NextFunction) {
     const {
-      query,
       headers: { host },
       url,
       method,
-      body,
       baseUrl,
     } = req;
 

packages/back/package.json renamed to apps/back/package.json

@@ -4,8 +4,9 @@ import { Request } from "express";
  * 获取请求头信息
  * @param req
  */
+// eslint-disable-next-line no-unused-vars
 export const getReqMainInfo: (req: Request) => {
-  [prop: string]: any;
+  [prop: string]: unknown;
 } = (req) => {
   const { query, headers, url, method, body, connection, baseUrl } = req;
 

packages/back/src/common/dto/user.dto.ts renamed to apps/back/src/common/dto/user.dto.ts

@@ -1,3 +1,4 @@
 export default {
+  // eslint-disable-next-line turbo/no-undeclared-env-vars
   port: parseInt(process.env.NEST_PORT, 10) || 3000,
 };

packages/back/src/common/filters/http-exception.filter.ts renamed to apps/back/src/common/filters/http-exception.filter.ts

@@ -11,6 +11,7 @@ import ResponseInterceptor from "~/common/interceptor/response.interceptor";
 @Controller("example")
 @UseInterceptors(ResponseInterceptor)
 export class AppController {
+  // eslint-disable-next-line no-unused-vars
   constructor(private readonly appService: AppService) {}
 
   @Get()

packages/back/src/common/guards/user.guard.ts renamed to apps/back/src/common/guards/user.guard.ts

@@ -1,3 +1,6 @@
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-nocheck
+
 import "module-alias";
 import { blue } from "kolorist";
 import overallConfig from "./config";
@@ -6,7 +9,7 @@ import { AppModule } from "~/modules/app.module";
 import { ValidationPipe } from "@nestjs/common";
 import type { OpenAPIObject } from "@nestjs/swagger";
 import { SwaggerModule, DocumentBuilder } from "@nestjs/swagger";
-declare const module: any;
+declare const module: unknown;
 
 /**
  *
@@ -38,7 +41,9 @@ async function bootstrap() {
   }
 
   await app.listen(overallConfig.port);
+  // eslint-disable-next-line no-console
   console.log(blue(`[API Docs]${await app.getUrl()}/docs`));
+  // eslint-disable-next-line no-console
   console.log(blue(`[Test API]${await app.getUrl()}/back/example`));
 }
 bootstrap();

packages/back/src/common/interceptor/response.interceptor.ts renamed to apps/back/src/common/interceptor/response.interceptor.ts

@@ -1,9 +1,11 @@
+/* eslint-disable no-console */
 import { blue } from "kolorist";
 import { Injectable } from "@nestjs/common";
 import { I18nLang, I18nService } from "nestjs-i18n";
 
 @Injectable()
 export class AppService {
+  // eslint-disable-next-line no-unused-vars
   constructor(private readonly i18n: I18nService) {}
 
   getHello(@I18nLang() lang: string) {

packages/back/src/common/middleware/logger.middler.ts renamed to apps/back/src/common/middleware/logger.middler.ts

@@ -1 +1,2 @@
+// eslint-disable-next-line no-undef
 describe("AppController", () => {});

packages/back/src/common/utils/formatTime.ts renamed to apps/back/src/common/utils/formatTime.ts

@@ -1,3 +1,4 @@
+/* eslint-disable no-undef */
 import { Test, TestingModule } from "@nestjs/testing";
 import { INestApplication } from "@nestjs/common";
 import * as request from "supertest";

packages/back/src/common/utils/logger.ts renamed to apps/back/src/common/utils/logger.ts

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

packages/back/src/config.ts renamed to apps/back/src/config.ts

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

packages/back/src/controllers/app.controller.ts renamed to apps/back/src/controllers/app.controller.ts

@@ -0,0 +1,10 @@
+/** @type {import("eslint").Linter.Config} */
+module.exports = {
+  root: true,
+  extends: ["@vtiuse/eslint-config/web.js"],
+  parser: "@typescript-eslint/parser",
+  extends: [".eslintrc-auto-import.json"],
+  parserOptions: {
+    project: true,
+  },
+};