test: compile checker every time

meilisearch · Aug 14, 2023 · a639601 · a639601
1 parent b3582bf
commit a639601
Show file tree

Hide file tree

Showing 5 changed files with 22 additions and 19 deletions.
diff --git a/.github/actions/validate-docs-links/lib/index.js b/.github/actions/validate-docs-links/lib/index.js
diff --git a/.github/actions/validate-docs-links/package.json b/.github/actions/validate-docs-links/package.json
@@ -4,9 +4,12 @@
   "files": [
     "src"
   ],
+  "type": "module",
   "scripts": {
-    "test": "ts-node --files src/checker.ts",
-    "build": "yarn run types && ncc -m -o ./lib build src/index.ts --target es --license licenses.txt",
+    "local:build": "yarn run types && ncc -m -o ./dist build src/checker.ts && yarn local:check",
+    "local:check": "node lib/checker --run-local-checker",
+    "action:build": "yarn run types && ncc -m -o ./lib build src/index.ts --license licenses.txt",
+    "build": "yarn action:build",
     "types": "tsc"
   },
   "devDependencies": {

diff --git a/.github/actions/validate-docs-links/src/checker.ts b/.github/actions/validate-docs-links/src/checker.ts
@@ -66,7 +66,7 @@ type FailureFunction =  (message: string) => void
 const RELATIVE_PATH = '/'
 const EXCLUDED_HASHES = ['top']
 
-const slugger = (require.main === module) ? {
+const slugger = (process.argv[2] === '--run-local-checker') ? {
   slug: (str: string) => str.replace(/\s+/g, '-').toLowerCase(),
   reset: () => null
 } : new GithubSlugger()
@@ -240,7 +240,7 @@ const formatTableRow = (
   docPath: string,
   sha?: string
 ) => {
-  if (require.main === module) return `| ${link} | ${errorType} | /${docPath} | \n`
+  if (process.argv[2] === '--run-local-checker') return `| ${link} | ${errorType} | /${docPath} | \n`
   return `| ${link} | ${errorType} | [/${docPath}](https://github.com/meilisearch/documentation/blob/${sha}/${docPath}) | \n`
 }
 
@@ -322,6 +322,6 @@ export async function validateAllInternalLinks(basePath: string, setFailed: Fail
   }
 }
 
-if (require.main === module) {
+if (process.argv[2] === '--run-local-checker') {
   validateAllInternalLinks('../../../', (message) => {throw new Error(message)})
 }
diff --git a/.github/actions/validate-docs-links/tsconfig.json b/.github/actions/validate-docs-links/tsconfig.json
@@ -8,11 +8,4 @@
     "noImplicitAny": true,
     "allowSyntheticDefaultImports": true,
   },
-  "ts-node": {
-    // "esModuleInterop": true,
-    // "esm": true,
-    // "compilerOptions": {
-    //   "module": "CommonJS",
-    // }
-  }
 }
diff --git a/.gitignore b/.gitignore
@@ -120,4 +120,7 @@ yarn-error.log
 
 .vuepress/code-samples/generated-samples.json
 
+### Links checker
+.github/actions/validate-docs-links/dist
+
 # End of https://www.gitignore.io/api/vue,node,vuejs