Merge pull request #21 from expressots/refactor/adjust-config-test-codecov

rsaz · web-flow · commit 89cea356762a · 2024-04-26T23:43:03.000-07:00
Refactor/adjust config test codecov
diff --git a/.eslintrc.cjs b/.eslintrc.cjs
@@ -1,28 +1,34 @@
 /* eslint-env node */
 module.exports = {
-	extends: [
-		"eslint:recommended",
-	 	"plugin:@typescript-eslint/recommended",
-		"eslint-config-prettier",
-		"prettier"
-	],
-	parser: "@typescript-eslint/parser",
-	parserOptions: {
-		project: ["./tsconfig.cjs.json"]
-	},
-	plugins: ["@typescript-eslint"],
-	root: true,
-	env: {
-		node: true,
-		jest: true,
-	},
-	ignorePatterns: ["dist", "node_modules", ".eslintrc.cjs"],
-	rules: {
-		"@typescript-eslint/adjacent-overload-signatures": "error",
-		"@typescript-eslint/array-type": ["error", { default: "generic" }],
-		"@typescript-eslint/await-thenable": "error",
-		"@typescript-eslint/ban-types": "error",
-		"@typescript-eslint/class-literal-property-style": "error",
-		"@typescript-eslint/explicit-function-return-type": "error",
-	},
-}
+  extends: [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/recommended",
+    "eslint-config-prettier",
+    "prettier",
+  ],
+  parser: "@typescript-eslint/parser",
+  parserOptions: {
+    project: ["./tsconfig.cjs.json", "./tsconfig.json"],
+  },
+  plugins: ["@typescript-eslint"],
+  root: true,
+  env: {
+    node: true,
+    jest: true,
+  },
+  ignorePatterns: [
+    "dist",
+    "node_modules",
+    ".eslintrc.cjs",
+    "**/__tests__/*.spec.ts",
+    "vitest.config.ts",
+  ],
+  rules: {
+    "@typescript-eslint/adjacent-overload-signatures": "error",
+    "@typescript-eslint/array-type": ["error", { default: "generic" }],
+    "@typescript-eslint/await-thenable": "error",
+    "@typescript-eslint/ban-types": "error",
+    "@typescript-eslint/class-literal-property-style": "error",
+    "@typescript-eslint/explicit-function-return-type": "error",
+  },
+};
diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml
@@ -1,11 +1,10 @@
-name: Build
+name: Build and Test
 
 on:
   push:
     branches:
       - main
   pull_request:
-    # The branches below must be a subset of the branches above
     branches: ["main"]
   pull_request_target:
     types: [opened, synchronize, reopened]
@@ -29,13 +28,24 @@ jobs:
       - name: Build
         run: npm run build
 
-      #- name: Unit Tests
-      #  working-directory: .
-      #  run: npm test
-      #  env:
-      #    CI: true
+      - name: Unit Tests
+        working-directory: ./src
+        run: npm run test
+        env:
+          CI: true
 
-      #- name: Set up .npmrc
-      #  run: echo "//npm.pkg.github.com/:_authToken=${{ secrets.GITHUB_TOKEN }}" >> .npmrc
-      #- name: Install dependencies
-      #  run: npm ci
+      - name: Run Code Coverage
+        working-directory: ./src
+        run: npm run coverage
+
+      - name: Upload coverage reports to Codecov
+        uses: codecov/codecov-action@v4.0.1
+        with:
+          working-directory: .
+          token: ${{ secrets.CODECOV_TOKEN }}
+
+      - name: Set up .npmrc
+        run: echo "//npm.pkg.github.com/:_authToken=${{ secrets.NPM_TOKEN }}" >> .npmrc
+
+      - name: Install dependencies
+        run: npm ci
diff --git a/.github/workflows/codesee-arch-diagram.yml b/.github/workflows/codesee-arch-diagram.yml
diff --git a/README.md b/README.md
@@ -2,6 +2,9 @@
 
 <!-- PROJECT SHIELDS -->
 
+[![Codecov][codecov-shield]][codecov-url]
+[![NPM][npm-shield]][npm-url]
+![Build][build-shield]
 [![Contributors][contributors-shield]][contributors-url]
 [![Forks][forks-shield]][forks-url]
 [![Stargazers][stars-shield]][stars-url]
@@ -95,6 +98,11 @@ Distributed under the MIT License. See [`LICENSE.txt`](https://github.com/expres
 <!-- MARKDOWN LINKS & IMAGES -->
 <!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
 
+[codecov-url]: https://codecov.io/gh/expressots/adapter-express
+[codecov-shield]: https://img.shields.io/codecov/c/gh/expressots/adapter-express/main?style=for-the-badge&logo=codecov&labelColor=FB9AD1
+[npm-url]: https://www.npmjs.com/package/@expressots/adapter-express
+[npm-shield]: https://img.shields.io/npm/v/@expressots/adapter-express?style=for-the-badge&logo=npm&color=9B3922
+[build-shield]: https://img.shields.io/github/actions/workflow/status/expressots/adapter-express/build.yml?branch=main&style=for-the-badge&logo=github
 [contributors-shield]: https://img.shields.io/github/contributors/expressots/adapter-express?style=for-the-badge
 [contributors-url]: https://github.com/expressots/adapter-express/graphs/contributors
 [forks-shield]: https://img.shields.io/github/forks/expressots/adapter-express?style=for-the-badge
diff --git a/jest.config.ts b/jest.config.ts
diff --git a/package.json b/package.json
@@ -57,7 +57,10 @@
     "build:cjs": "tsc -p tsconfig.cjs.json",
     "release": "release-it",
     "prepublish": "npm run build && npm pack",
-    "test": "jest",
+    "publish": "npm publish --tag latest",
+    "test": "vitest run --reporter default",
+    "test:watch": "vitest run --watch",
+    "coverage": "vitest run --coverage",
     "format": "prettier --write \"src/**/*.ts\" --cache",
     "lint": "eslint \"src/**/*.ts\"",
     "lint:fix": "eslint \"src/**/*.ts\" --fix"
@@ -66,26 +69,29 @@
     "dotenv": "16.4.5",
     "inversify": "6.0.2",
     "inversify-binding-decorators": "4.0.0",
-    "jest": "29.5.0",
     "reflect-metadata": "0.2.2"
   },
   "devDependencies": {
-    "@commitlint/cli": "^18.0.0",
+    "@codecov/vite-plugin": "^0.0.1-beta.6",
+    "@commitlint/cli": "18.0.0",
     "@commitlint/config-conventional": "17.7.0",
     "@expressots/core": "latest",
     "@release-it/conventional-changelog": "7.0.1",
     "@types/express": "4.17.21",
-    "@types/jest": "29.5.0",
     "@types/node": "20.4.9",
     "@typescript-eslint/eslint-plugin": "6.6.0",
     "@typescript-eslint/parser": "6.6.0",
+    "@vitest/coverage-v8": "^1.4.0",
     "eslint": "8.48.0",
     "eslint-config-prettier": "9.0.0",
     "husky": "8.0.3",
     "prettier": "3.0.3",
     "release-it": "16.1.5",
     "ts-jest": "29.0.5",
-    "typescript": "5.2.2"
+    "typescript": "5.2.2",
+    "vite": "^5.2.8",
+    "vite-tsconfig-paths": "^4.3.2",
+    "vitest": "^1.4.0"
   },
   "release-it": {
     "git": {
diff --git a/src/adapter-express/__tests__/application-express.spec.ts b/src/adapter-express/__tests__/application-express.spec.ts
@@ -0,0 +1,7 @@
+import { describe, expect, it } from "vitest";
+
+describe("application-express", () => {
+  it("should have tests", () => {
+    expect(true).toBe(true);
+  });
+});
diff --git a/tsconfig.cjs.json b/tsconfig.cjs.json
@@ -1,5 +1,5 @@
 {
-  "extends": "./tsconfig.base.json",
+  "extends": "./tsconfig.json",
   "compilerOptions": {
     "module": "commonjs",
     "target": "ES2021",
diff --git a/tsconfig.json b/tsconfig.json
@@ -12,8 +12,8 @@
     "allowSyntheticDefaultImports": true,
     "experimentalDecorators": true,
     "emitDecoratorMetadata": true,
-    "types": ["node", "reflect-metadata", "jest"]
+    "types": ["node", "reflect-metadata", "vitest/globals"]
   },
   "include": ["./src/**/*.ts"],
-  "exclude": ["node_modules"]
+  "exclude": ["node_modules", "**/__tests__/*.spec.ts", "scripts/**/*"]
 }
diff --git a/vitest.config.ts b/vitest.config.ts
@@ -0,0 +1,41 @@
+import { defineConfig } from "vitest/config";
+import { codecovVitePlugin } from "@codecov/vite-plugin";
+import tsconfigPaths from "vite-tsconfig-paths";
+
+/**
+ * @see {@link https://vitejs.dev/config/}
+ * @see {@link https://vitest.dev/config/}
+ */
+export default defineConfig({
+  plugins: [
+    tsconfigPaths(),
+    codecovVitePlugin({
+      enableBundleAnalysis: process.env.CODECOV_TOKEN !== undefined,
+      bundleName: "expresso-ts-adapter-express-coverage",
+      uploadToken: process.env.CODECOV_TOKEN,
+    }),
+  ],
+  test: {
+    globals: true,
+    environment: "node",
+    setupFiles: ["reflect-metadata"],
+    exclude: ["**/node_modules/**", "**/test/**", "**/lib/**"],
+    coverage: {
+      all: true,
+      include: ["**/src/**"],
+      exclude: ["**/node_modules/**", "**/lib/**", "**/test/**", "**/index.ts/**"],
+      thresholds: {
+        global: {
+          statements: 85,
+          branches: 85,
+          functions: 85,
+          lines: 85,
+        },
+      },
+      reporter: ["text", "html", "json"],
+      provider: "v8",
+    },
+    // ref: https://vitest.dev/config/#testtimeout
+    testTimeout: 10000,
+  },
+});

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`{`
`2`		`- "extends": "./tsconfig.base.json",`
	`2`	`+ "extends": "./tsconfig.json",`
`3`	`3`	`"compilerOptions": {`
`4`	`4`	`"module": "commonjs",`
`5`	`5`	`"target": "ES2021",`