auto-generate list of Units and AreaUnits and link all modules with units param

package.json

@@ -33,6 +33,7 @@
     "@monorepolint/config": "0.5.0-alpha.132",
     "@monorepolint/core": "0.5.0-alpha.132",
     "@monorepolint/rules": "0.5.0-alpha.132",
+    "@phenomnomnominal/tsquery": "6.1.3",
     "@types/node": "18.11.9",
     "@typescript-eslint/eslint-plugin": "^6.10.0",
     "@typescript-eslint/parser": "^6.10.0",

scripts/generate-readmes.ts

@@ -5,6 +5,7 @@ const { glob } = require("glob");
 const path = require("path");
 const { loadJsonFileSync } = require("load-json-file");
 const yaml = require("yamljs");
+const { ast, query } = require("@phenomnomnominal/tsquery");
 
 (async () => {
   // documentation v14 has moved to ESM so need to import as if async, and wrap
@@ -59,6 +60,72 @@ const yaml = require("yamljs");
               /{module}/,
               name
             )}`;
+
+            if (packagePath.includes("turf-helpers")) {
+              const helpersTs = fs.readFileSync(indexPath, "utf8").toString();
+              const theAst = ast(helpersTs);
+
+              // To learn how to write tsquery selectors, see: https://tsquery-playground.firebaseapp.com/ and paste the code from turf-helpers/index.ts
+
+              // query Units string literal names
+              // ToDo: malformed selector.  In addition to Units, it includes StringLiterals from AreaUnits as well (hectares, acres, degrees, radians)
+              const unitLiterals = query(
+                theAst,
+                'TypeAliasDeclaration:has(Identifier[name="Units"]) UnionType LiteralType StringLiteral'
+              );
+              const unitArray = unitLiterals.map((sLiteral) =>
+                sLiteral.getText().replaceAll('"', "")
+              );
+              const unitNames =
+                unitLiterals.length > 0 ? "Units: " + unitArray.join(", ") : "";
+              console.log(unitNames);
+
+              // query all AreaUnits string literals (including exclusions)
+              const areaUnitAllLiterals = query(
+                theAst,
+                'TypeAliasDeclaration:has(Identifier[name="AreaUnits"]) UnionType > LiteralType StringLiteral'
+              );
+              const areaUnitAllArray = areaUnitAllLiterals.map((sLiteral) =>
+                sLiteral.getText().replaceAll('"', "")
+              );
+              console.log("areaUnitAllArray", areaUnitAllArray);
+
+              // query AreaUnits string literals to Exclude
+              const areaUnitExcludeLiterals = query(
+                theAst,
+                'TypeAliasDeclaration:has(Identifier[name="AreaUnits"]) UnionType TypeReference LiteralType StringLiteral'
+              );
+              const areaUnitExcludeArray = areaUnitExcludeLiterals.map(
+                (sLiteral) => sLiteral.getText().replaceAll('"', "")
+              );
+              console.log("areaUnitExcludeArray", areaUnitExcludeArray);
+
+              // AreaUnits to add = all AreaUnits - Exclude AreaUnits
+              const newAreaUnitArray = areaUnitAllArray.filter(
+                (name) => !areaUnitExcludeArray.includes(name)
+              );
+              // console.log("newAreaUnitArray", newAreaUnitArray)
+
+              // Subtract Exclude AreaUnits from all AreaUnits and add new ones
+              const areaUnitArray = unitArray
+                .filter((name) => !areaUnitExcludeArray.includes(name))
+                .concat(newAreaUnitArray);
+              // console.log("areaUnitArray", areaUnitArray)
+              const areaUnitNames =
+                areaUnitArray.length > 0
+                  ? "Area Units: " + areaUnitArray.join(", ")
+                  : "";
+              console.log("areaUnitNames", areaUnitNames);
+
+              // extract area unit names.  unit names - exclusions + inclusions
+
+              const insertText = "## helpers\n";
+              markdown = markdown.replace(
+                insertText,
+                `${insertText}\n### units\n\n${unitNames}\n`
+              );
+            }
+
             if (diagrams.length)
               markdown += "\n\n### Diagrams\n\n" + diagramToMarkdown(diagrams);
             fs.writeFileSync(path.join(directory, "README.md"), markdown);