fix(deps): update replace-in-file and use vitest (#832)

goatwu1993 · npalm · web-flow · commit dbd51c21179d · 2025-06-11T22:41:45.000+02:00
* test: migrate from jest to vitest for esm support

* fix(deps): update replace-in-file to ^8.3.0

* chore: fix some cspell issues

* chore: fix editor config checker

* chore: megalinter

* disable json checks for megalinter

* disable json checks for megalinter

---------

Co-authored-by: Niek Palm &lt;niek.palm@philips.com&gt;
diff --git a/.cspell.json b/.cspell.json
@@ -6,6 +6,9 @@
     "**/.pnpm-lock.json",
     ".vscode",
     "megalinter",
+    "megalinter-reports/**",
+    "coverage/**",
+    "coverage_nyc/**",
     "package-lock.json",
     "report",
     ".*"
@@ -15,7 +18,8 @@
     "npalm",
     "nvmrc",
     "markdownlintignore",
-    "devcontainer"
+    "devcontainer",
+    "vitest"
   ],
   "language": "en",
   "noConfigSearch": true,
diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json
@@ -15,11 +15,11 @@
         "esbenp.prettier-vscode",
         "github.vscode-pull-request-github",
         "orta.vscode-jest",
-        "yzhang.markdown-all-in-one"    
+        "yzhang.markdown-all-in-one"
       ]
     }
   },
   "postCreateCommand": "yarn install",
   "waitFor": "postCreateCommand",
-  "onCreateCommand": "sudo cp .devcontainer/welcome.txt /usr/local/etc/vscode-dev-containers/first-run-notice.txt",
+  "onCreateCommand": "sudo cp .devcontainer/welcome.txt /usr/local/etc/vscode-dev-containers/first-run-notice.txt"
 }
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -1,5 +1,5 @@
 {
-  "plugins": ["import", "jest", "@typescript-eslint"],
+  "plugins": ["import", "@typescript-eslint"],
   "extends": ["plugin:github/recommended"],
   "parser": "@typescript-eslint/parser",
   "parserOptions": {
@@ -56,12 +56,11 @@
     "@typescript-eslint/restrict-plus-operands": "error",
     "@typescript-eslint/type-annotation-spacing": "error",
     "@typescript-eslint/unbound-method": "error",
-      "no-shadow": "off",
-      "@typescript-eslint/no-shadow": "error"
+    "no-shadow": "off",
+    "@typescript-eslint/no-shadow": "error"
   },
   "env": {
     "node": true,
-    "es6": true,
-    "jest/globals": true
+    "es6": true
   }
 }
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -18,9 +18,9 @@ updates:
       eslint:
         patterns:
           - "eslint*"
-      jest:
+      vitest:
         patterns:
-          - "*jest*"
+          - "*vitest*"
       figlet:
         patterns:
           - "*figlet*"
diff --git a/.mega-linter.yml b/.mega-linter.yml
@@ -32,7 +32,7 @@ DISABLE_LINTERS:
   - COPYPASTE_JSCPD
   - JAVASCRIPT_ES
 
-JSON_JSONLINT_FILTER_REGEX_EXCLUDE: (tsconfig.json)
+JSON_JSONLINT_FILTER_REGEX_EXCLUDE: (tsconfig\\.json|\\.vscode/extensions\\.json)
 
 SPELL_LYCHEE_FILTER_REGEX_EXCLUDE: (CHANGELOG.md)
 
diff --git a/.vscode/extensions.json b/.vscode/extensions.json
@@ -10,4 +10,4 @@
     "orta.vscode-jest",
     "yzhang.markdown-all-in-one"
   ]
-}
+}
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -26,7 +26,7 @@
 ### Bug Fixes
 
 * **deps:** bump yaml from 2.5.0 to 2.5.1 ([#692](https://github.com/npalm/action-docs/issues/692)) ([92755ae](https://github.com/npalm/action-docs/commit/92755aeeec47a015b2dcbdfba12155b65985cfb6))
-* upgrade replace-in-file and figlet depenencies ([e585c0f](https://github.com/npalm/action-docs/commit/e585c0fd9a1409e417c6bee2f62ff6d869ffa388))
+* upgrade replace-in-file and figlet dependencies ([e585c0f](https://github.com/npalm/action-docs/commit/e585c0fd9a1409e417c6bee2f62ff6d869ffa388))
 
 ## [2.4.3](https://github.com/npalm/action-docs/compare/v2.4.2...v2.4.3) (2024-09-03)
 
@@ -69,7 +69,7 @@
 
 ### Bug Fixes
 
-* -a option was ingored ([#561](https://github.com/npalm/action-docs/issues/561)) ([8dbd40e](https://github.com/npalm/action-docs/commit/8dbd40eb476605d90f9a0d94848015097c02198f))
+* -a option was ignored ([#561](https://github.com/npalm/action-docs/issues/561)) ([8dbd40e](https://github.com/npalm/action-docs/commit/8dbd40eb476605d90f9a0d94848015097c02198f))
 * **deps:** bump yaml from 2.4.0 to 2.4.1 ([#557](https://github.com/npalm/action-docs/issues/557)) ([8c2dc15](https://github.com/npalm/action-docs/commit/8c2dc15d9f90772c93c66133ef5d4948705b3e56))
 
 ## [2.2.0](https://github.com/npalm/action-docs/compare/v2.1.0...v2.2.0) (2024-03-06)
diff --git a/__tests__/fixtures/action/action.yml b/__tests__/fixtures/action/action.yml
@@ -26,4 +26,3 @@ outputs:
 runs:
   using: "node12"
   main: "dist/index.js"
-  
diff --git a/__tests__/fixtures/action/all_fields_action.yml b/__tests__/fixtures/action/all_fields_action.yml
@@ -30,4 +30,3 @@ outputs:
 runs:
   using: "node12"
   main: "dist/index.js"
-  
diff --git a/__tests__/fixtures/action/all_fields_action.yml.crlf b/__tests__/fixtures/action/all_fields_action.yml.crlf
@@ -1,32 +1,33 @@
-name: 'An Action'
-description: 'Default test'
-author: 'Niek Palm'
-inputs:
-  inputA:
-    description: 'A description A'
-    required: false
-  inputB:     
-    description: 'A description B'
-    required: true
-  inputC:
-    description: 'A description C'
-    required: true
-    default: C
-  inputD:
-    description: 'A description D'
-    required: false
-    default: D
-  inputE:
-    description: 'A description E'
-    required: false
-    default: false
-
-outputs:
-  outputA:
-    description: 'A description A'
-  outputB:
-    description: 'A description B'
-
-runs:
-  using: 'node12'
-  main: 'dist/index.js'
+name: 'An Action'
+description: 'Default test'
+author: 'Niek Palm'
+inputs:
+  inputA:
+    description: 'A description A'
+    required: false
+  inputB:
+    description: 'A description B'
+    required: true
+  inputC:
+    description: 'A description C'
+    required: true
+    default: C
+  inputD:
+    description: 'A description D'
+    required: false
+    default: D
+  inputE:
+    description: 'A description E'
+    required: false
+    default: false
+
+outputs:
+  outputA:
+    description: 'A description A'
+  outputB:
+    description: 'A description B'
+
+runs:
+  using: 'node12'
+  main: 'dist/index.js'
+
diff --git a/__tests__/fixtures/action/deprecated_input_action.yml b/__tests__/fixtures/action/deprecated_input_action.yml
@@ -9,9 +9,8 @@ inputs:
   inputB:
     required: false
     description: This is an input
-    deprecationMessage: ''
+    deprecationMessage: ""
 
 runs:
   using: "node12"
   main: "dist/index.js"
-  
diff --git a/__tests__/fixtures/workflow/all_fields_workflow.yml.crlf b/__tests__/fixtures/workflow/all_fields_workflow.yml.crlf
@@ -1,32 +1,32 @@
-name: 'An Action'
-description: 'Default test'
-author: 'Niek Palm'
-inputs:
-  inputA:
-    description: 'A description A'
-    required: false
-  inputB:     
-    description: 'A description B'
-    required: true
-  inputC:
-    description: 'A description C'
-    required: true
-    default: C
-  inputD:
-    description: 'A description D'
-    required: false
-    default: D
-  inputE:
-    description: 'A description E'
-    required: false
-    default: false
-
-outputs:
-  outputA:
-    description: 'A description A'
-  outputB:
-    description: 'A description B'
-
-runs:
-  using: 'node12'
-  main: 'dist/index.js'
+name: 'An Action'
+description: 'Default test'
+author: 'Niek Palm'
+inputs:
+  inputA:
+    description: 'A description A'
+    required: false
+  inputB:
+    description: 'A description B'
+    required: true
+  inputC:
+    description: 'A description C'
+    required: true
+    default: C
+  inputD:
+    description: 'A description D'
+    required: false
+    default: D
+  inputE:
+    description: 'A description E'
+    required: false
+    default: false
+
+outputs:
+  outputA:
+    description: 'A description A'
+  outputB:
+    description: 'A description B'
+
+runs:
+  using: 'node12'
+  main: 'dist/index.js'
diff --git a/jest.config.js b/jest.config.js
diff --git a/package.json b/package.json
@@ -14,11 +14,11 @@
     "format": "prettier --write **/*.ts",
     "format-check": "prettier --check **/*.ts",
     "lint": "eslint src/**/*.ts",
-    "test": "jest --runInBand --testTimeout=10000 --collect-coverage --coverage",
-    "test-default": "jest --testTimeout=10000 --testPathIgnorePatterns=__tests__/cli.test.ts --collect-coverage --coverage",
-    "test-cli": "nyc jest --testTimeout=10000 --silent --testMatch=**/cli*test.ts && nyc report --reporter=lcov --reporter=html --report-dir=./coverage_nyc",
-    "test-action": "nyc jest --testTimeout=10000 --silent --testMatch=**/action-docs-action.test.ts --coverage=false",
-    "test-workflow": "nyc jest --testTimeout=10000 --silent --testMatch=**/action-docs-workflow.test.ts --coverage=false",
+    "test": "vitest --fileParallelism false --testTimeout=10000 --coverage",
+    "test-default": "vitest run --testTimeout=10000 --exclude=__tests__/cli.test.ts --coverage",
+    "test-cli": "vitest run --silent --testTimeout=10000 **/cli*test.ts --coverage.enabled=true --coverage.reporter=lcov --coverage.reporter=html --coverage.reportsDirectory=coverage_nyc",
+    "test-action": "vitest run --testTimeout=10000 --silent **/action-docs-action.test.ts --coverage=false",
+    "test-workflow": "vitest run --testTimeout=10000 --silent **/action-docs-workflow.test.ts --coverage=false",
     "dev-action": "yarn run build && node lib/cli.js -s __tests__/fixtures/action/action.yml",
     "dev-workflow": "yarn run build && node lib/cli.js -s __tests__/fixtures/workflow/workflow.yml",
     "help": "yarn run build && node lib/cli.js --help",
@@ -38,9 +38,10 @@
   "author": "Niek Palm",
   "license": "MIT",
   "dependencies": {
+    "@types/node": "^22.15.21",
     "chalk": "^5.3.0",
     "figlet": "^1.7.0",
-    "replace-in-file": "^7.1.0",
+    "replace-in-file": "^8.3.0",
     "showdown": "^2.1.0",
     "yaml": "^2.3.4",
     "yargs": "^17.7.2"
@@ -53,19 +54,18 @@
   ],
   "devDependencies": {
     "@types/figlet": "^1.5.0",
-    "@types/jest": "^29.5.12",
     "@types/showdown": "^2.0.6",
+    "@types/yargs": "^17.0.33",
     "@typescript-eslint/parser": "^8.8.1",
+    "@vitest/coverage-v8": "3.1.4",
     "eslint": "^8.56.0",
     "eslint-import-resolver-typescript": "^3.6.1",
     "eslint-plugin-github": "^4.10.0",
-    "eslint-plugin-jest": "^27.6.0",
     "eslint-plugin-prettier": "^5.1.0",
-    "jest": "^29.7.0",
     "nyc": "^17.0.0",
     "prettier": "^3.2.5",
-    "ts-jest": "^29.1.0",
     "typescript": "^5.3.0",
+    "vitest": "^3.1.4",
     "yaml-types": "^0.4.0",
     "yarn": "^1.22.0"
   },
diff --git a/src/action-docs.ts b/src/action-docs.ts
@@ -1,7 +1,7 @@
 import { LineBreakType, getLineBreak } from "./linebreak.js";
 import { parse } from "yaml";
 import { readFileSync } from "fs";
-import replaceInFile from "replace-in-file";
+import { replaceInFile } from "replace-in-file";
 import pkg from "showdown";
 const { Converter } = pkg;
 const converter = new Converter();
@@ -370,7 +370,7 @@ async function updateReadme(
         matchProjectVersion ? matchProjectVersion[2] : "",
       );
 
-    await replaceInFile.replaceInFile({
+    await replaceInFile({
       files: options.readmeFile,
       from: regexp,
       to:
diff --git a/tsconfig.json b/tsconfig.json
@@ -10,5 +10,5 @@
     "esModuleInterop": true /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */,
     "declaration": true
   },
-  "exclude": ["node_modules", "**/*.test.ts", "lib"]
+  "exclude": ["node_modules", "**/*.test.ts", "lib", "vitest.config.ts"]
 }
diff --git a/vitest.config.ts b/vitest.config.ts
@@ -0,0 +1,26 @@
+/// <reference types="vitest" />
+import { defineConfig } from 'vitest/config';
+
+export default defineConfig({
+  test: {
+    environment: 'node',
+    coverage: {
+      reporter: ['lcov', 'text', 'html'],
+      reportsDirectory: './coverage',
+      include: ['src/**/*.{ts,js,jsx}'],
+      exclude: ['**/*cli*.ts'],
+      thresholds: {
+        lines: 100,
+        statements: 100,
+        functions: 96.66,
+        branches: 98.14
+      }
+    },
+    clearMocks: true,
+    include: ['**/*.{test,spec}.{ts,js}'],
+    watch: false,
+    testTimeout: 10000,
+    globals: true,
+  },
+});
+
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -15,11 +15,11 @@`
`15`	`15`	`"esbenp.prettier-vscode",`
`16`	`16`	`"github.vscode-pull-request-github",`
`17`	`17`	`"orta.vscode-jest",`
`18`		`- "yzhang.markdown-all-in-one"`
	`18`	`+ "yzhang.markdown-all-in-one"`
`19`	`19`	`]`
`20`	`20`	`}`
`21`	`21`	`},`
`22`	`22`	`"postCreateCommand": "yarn install",`
`23`	`23`	`"waitFor": "postCreateCommand",`
`24`		`- "onCreateCommand": "sudo cp .devcontainer/welcome.txt /usr/local/etc/vscode-dev-containers/first-run-notice.txt",`
	`24`	`+ "onCreateCommand": "sudo cp .devcontainer/welcome.txt /usr/local/etc/vscode-dev-containers/first-run-notice.txt"`
`25`	`25`	`}`
Original file line number	Diff line number	Diff line change
`@@ -10,4 +10,4 @@`
`10`	`10`	`"orta.vscode-jest",`
`11`	`11`	`"yzhang.markdown-all-in-one"`
`12`	`12`	`]`
`13`		`-}`
	`13`	`+}`