feat: set excluded functions from env variable

surrealdb · Sep 16, 2024 · 1e78232 · 1e78232
1 parent 41c293c
commit 1e78232
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 2 deletions.
diff --git a/.github/workflows/validate.yaml b/.github/workflows/validate.yaml
@@ -17,3 +17,13 @@ jobs:
         working-directory: ./scripts
       - run: bun run index.ts
         working-directory: ./scripts
+        env:
+          EXCLUDED_FUNCS: |
+            .chain
+          NOT_IMPLEMENTED_FUNCS: |
+            string::distance::hamming
+            string::distance::levenshtein
+            string::similarity::jaro
+            vector::distance::mahalanobis
+            vector::similarity::spearman
+
diff --git a/scripts/index.ts b/scripts/index.ts
@@ -5,7 +5,12 @@ const repositoryName = "surrealdb/surrealdb";
 const branch = "main";
 const fncSourceCodeFilePath = "core/src/fnc/mod.rs";
 
-const fncExclusions = [".chain"];
+const fncExclusions = Bun.env.EXCLUDED_FUNCS
+  ? Bun.env.EXCLUDED_FUNCS.split("\n")
+  : [];
+const fncNotImplemented = Bun.env.NOT_IMPLEMENTED_FUNCS
+  ? Bun.env.NOT_IMPLEMENTED_FUNCS.split("\n")
+  : [];
 
 const detectMissingFunctions = async () => {
   console.log("Detecting missing functions...");
@@ -85,7 +90,8 @@ const detectMissingFunctions = async () => {
           .replace(/\u200B/g, "")
       )
       .get()
-      .filter((functionName) => !fncExclusions.includes(functionName));
+      .filter((functionName) => !fncExclusions.includes(functionName))
+      .filter((functionName) => !fncNotImplemented.includes(functionName));
 
     allDocumentedFunctions.push(...functionNames);
   }