@groma/scanner-react 0.2.0 → 0.2.2

package/README.md

@@ -15,7 +15,7 @@ bun plugins/scanners/react/build.ts
 From the project being scanned:
 
 ```sh
-groma scanner add /absolute/path/to/groma/plugins/scanners/react/dist/package
+groma plugin add /absolute/path/to/groma/plugins/scanners/react/dist/package
 groma scanner check
 groma scan
 ```

package/dist/index.js

@@ -252,13 +252,13 @@ function compare(...values) {
 }
 function uniqueBy(values, key, label) {
   const seen = new Set;
-  for (const value of values) {
-    const id = key(value);
+  const keyed = values.map((value) => ({ id: key(value), value }));
+  for (const { id } of keyed) {
     if (seen.has(id))
       throw new Error(`duplicate ${label}: ${id}`);
     seen.add(id);
   }
-  return [...values].sort((left, right) => key(left).localeCompare(key(right)));
+  return keyed.sort((left, right) => left.id.localeCompare(right.id)).map((entry) => entry.value);
 }
 function createScanObservation(input) {
   const roots = validateRoots(input.roots);
@@ -269,9 +269,7 @@ function createScanObservation(input) {
     symbols: [...new Map(file.symbols.map((symbol) => [
       compare(symbol.id, symbol.kind),
       symbol
-    ])).values()].sort((left, right) => {
-      return compare(left.id, left.kind).localeCompare(compare(right.id, right.kind));
-    })
+    ]))].sort(([left], [right]) => left.localeCompare(right)).map(([, symbol]) => symbol)
   })), (file) => file.file, "file path");
   const filePaths = new Set(files.map((file) => file.file));
   for (const file of files) {
@@ -282,8 +280,6 @@ function createScanObservation(input) {
         throw new Error(`file references unknown root: ${root}`);
     }
   }
-  for (const diagnostic of input.diagnostics)
-    diagnosticLocation(diagnostic);
   return {
     schemaVersion: 1,
     scanner: input.scanner,
@@ -293,14 +289,14 @@ function createScanObservation(input) {
     ...entryPoints(input.entryPoints, filePaths),
     ...operationEvidence(input, filePaths),
     ...httpEvidence(input.httpEndpoints, input.httpRequests, input.operations && new Set(input.operations.map((operation) => operation.id))),
-    diagnostics: [...new Map(input.diagnostics.map((diagnostic) => [
-      diagnosticKey(diagnostic),
-      diagnostic
-    ])).values()].sort((left, right) => {
-      return diagnosticKey(left).localeCompare(diagnosticKey(right));
-    })
+    diagnostics: normalizeScanDiagnostics(input.diagnostics)
   };
 }
+function normalizeScanDiagnostics(diagnostics) {
+  for (const diagnostic of diagnostics)
+    diagnosticLocation(diagnostic);
+  return [...new Map(diagnostics.map((diagnostic) => [diagnosticKey(diagnostic), diagnostic]))].sort(([left], [right]) => left.localeCompare(right)).map(([, diagnostic]) => diagnostic);
+}
 function entryPoints(input, paths) {
   if (input === undefined)
     return {};
@@ -409,10 +405,14 @@ function operationTokens(operation) {
   const endLine = Number(operation.endLine);
   if (endLine < startLine)
     throw new Error("operation.endLine must be at or after startLine");
+  const tokens = array(operation.tokens, "operation.tokens");
+  tokens.forEach((token) => {
+    string(token, "operation.token");
+  });
   return {
     startLine,
     endLine,
-    tokens: array(operation.tokens, "operation.tokens").map((token) => string(token, "operation.token"))
+    tokens
   };
 }
 function validateOperationTokens(operation) {
@@ -603,20 +603,32 @@ function reachedFiles(entry, compiled, imports, packages, units) {
 }
 async function declaredEntries(root, declarations, packages, workspaces) {
   const entries = [];
+  const diagnostics = [];
   for (const file of declarations) {
     const text = await readFile3(path4.join(root, file), "utf8");
     const name = path4.posix.basename(file);
-    if (name === "package.json") {
-      const manifest = JSON.parse(text);
-      entries.push(...declaredBins(file, manifest), ...declaredScripts(file, manifest.scripts));
-    } else if (name === "angular.json")
-      entries.push(...angularEntries(file, text));
-    else if (name === "project.json")
-      entries.push(...nxEntries(file, text, workspaces));
-    else if (file.endsWith(".html"))
-      entries.push(...browserEntries(file, text, packages));
+    try {
+      if (name === "package.json") {
+        const manifest = JSON.parse(text);
+        entries.push(...declaredBins(file, manifest), ...declaredScripts(file, manifest.scripts));
+      } else if (name === "angular.json")
+        entries.push(...angularEntries(file, text));
+      else if (name === "project.json")
+        entries.push(...nxEntries(file, text, workspaces));
+      else if (file.endsWith(".html"))
+        entries.push(...browserEntries(file, text, packages));
+    } catch (error) {
+      if (!(error instanceof SyntaxError))
+        throw error;
+      diagnostics.push({
+        severity: "warning",
+        code: "JAVASCRIPT_MANIFEST_INVALID",
+        file,
+        message: `The file is not valid JSON; the entry points it declares are not read. ${error.message}`
+      });
+    }
   }
-  return entries;
+  return { entries, diagnostics };
 }
 function sourced(entry, files, outputs = []) {
   const file = sourceOf(entry.file, outputs, files);
@@ -630,7 +642,8 @@ async function withJavaScriptEntries(root, observation, inputs, files) {
   const packages = new Set(inventory.filter((file) => path4.posix.basename(file) === "package.json").map((file) => path4.posix.dirname(file)));
   const active = new Set(observation.files.map((file) => packageFor(file.file, packages)));
   const declarations = inventory.filter((file) => path4.posix.basename(file) !== "nx.json" && active.has(packageFor(file, packages)));
-  const entries = [...inputs.entries, ...await declaredEntries(root, declarations, packages, workspaces)];
+  const declared = await declaredEntries(root, declarations, packages, workspaces);
+  const entries = [...inputs.entries, ...declared.entries];
   const inventoryFiles = [...observation.files];
   const visible = new Set(inventoryFiles.map((file) => file.file));
   const readable = new Set(files);
@@ -647,7 +660,12 @@ async function withJavaScriptEntries(root, observation, inputs, files) {
     }
     return [{ ...entry, files: [...new Set([entry.file, ...members.map((file) => file.file)])] }];
   });
-  return createScanObservation({ ...observation, files: inventoryFiles, entryPoints });
+  return createScanObservation({
+    ...observation,
+    files: inventoryFiles,
+    entryPoints,
+    diagnostics: [...observation.diagnostics, ...declared.diagnostics]
+  });
 }
 
 // plugins/scanners/entry-points/source.ts

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@groma/scanner-react",
-  "version": "0.2.0",
+  "version": "0.2.2",
   "description": "Complementary React framework evidence; a dependency declaration does not verify runtime use.",
   "private": false,
   "type": "module",
@@ -52,7 +52,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/MrLesk/Groma.md.git"
+    "url": "https://github.com/MrLesk/groma.md.git"
   },
   "publishConfig": {
     "access": "public"