@groma/scanner-javascript 0.2.0 → 0.2.2

package/README.md

@@ -13,7 +13,7 @@ bun plugins/scanners/javascript/build.ts
 From the project being scanned:
 
 ```sh
-groma scanner add /absolute/path/to/groma/plugins/scanners/javascript/dist/package
+groma plugin add /absolute/path/to/groma/plugins/scanners/javascript/dist/package
 groma scan
 ```
 
@@ -42,10 +42,10 @@ output, such as `jquery-ui.min.js`, and `node_modules`, `dist`, `build` and
 lists select.
 
 A bundle under an ordinary name, such as `vendor.js`, is read like any other
-source; a project that keeps it out adds a pattern to `scanners.json`.
+source; a project that keeps it out adds a pattern to `config.json`.
 
 Test sources are treated like any other JavaScript source: the defaults name
-none, so a project that keeps them out adds a pattern to `scanners.json`.
+none, so a project that keeps them out adds a pattern to `config.json`.
 
 TypeScript sources belong to the [TypeScript scanner](../typescript/index.md)
 and single-file components to the [Vue scanner](../vue/index.md). This scanner
@@ -78,7 +78,8 @@ assignments or `cross-env` may come before the runtime, and runtime options and
 a `run` or `watch` subcommand before the script; the first remaining word must
 name the script, so a preloaded module or `bun build` supplies none. An HTML
 page's script supplies one too, named after the page, or after its folder for
-an `index.html`.
+an `index.html`. A `package.json`, `angular.json` or `project.json` that is not
+valid JSON supplies none: the scan continues and reports a warning for that file.
 
 ## Source outline
 

package/dist/index.js

@@ -118,13 +118,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);
@@ -135,9 +135,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) {
@@ -148,8 +146,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,
@@ -159,14 +155,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 {};
@@ -275,10 +271,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) {
@@ -308,7 +308,7 @@ function sourcePosition(position) {
 }
 
 // plugins/scanners/javascript/src/index.ts
-import ts7 from "./typescript.cjs";
+import ts8 from "./typescript.cjs";
 
 // plugins/scanners/javascript/src/evidence.ts
 import ts2 from "./typescript.cjs";
@@ -643,15 +643,15 @@ function topLevelDeclarations(source) {
 
 // plugins/scanners/javascript/src/evidence.ts
 var { executable, operationFields } = typeScriptOperations(ts2);
-function javaScriptEvidence(file, source) {
+function javaScriptEvidence(file, syntax) {
   const operations = [];
   const invocations = [];
   const calls = [];
   const owners = new Map;
-  const lineOf = (position) => source.getLineAndCharacterOfPosition(position).line + 1;
+  const lineOf = (position) => syntax.getLineAndCharacterOfPosition(position).line + 1;
   let moduleCode;
   function operation(node) {
-    const position = node.getStart(source);
+    const position = node.getStart(syntax);
     const recorded = { id: `${file}#${position}`, file, position, ...operationFields(node) };
     operations.push(recorded);
     owners.set(node, recorded.id);
@@ -659,13 +659,13 @@ function javaScriptEvidence(file, source) {
   }
   function moduleOperation() {
     if (moduleCode === undefined) {
-      moduleCode = { id: `${file}#module`, file, name: "(anonymous)", position: source.getStart(source) };
+      moduleCode = { id: `${file}#module`, file, name: "(anonymous)", position: syntax.getStart(syntax) };
       operations.push(moduleCode);
     }
     return moduleCode;
   }
   function invocation(node, owner) {
-    const position = node.getStart(source);
+    const position = node.getStart(syntax);
     invocations.push({
       source: owner.id,
       targets: [],
@@ -691,8 +691,8 @@ function javaScriptEvidence(file, source) {
     }
     return moduleOperation().id;
   }
-  source.forEachChild((child) => visit(child, undefined));
-  const symbols = new Map(topLevelDeclarations(source).map((declaration) => [`${file}#${declaration.name}`, { id: `${file}#${declaration.name}`, ...declaration }]));
+  syntax.forEachChild((child) => visit(child, undefined));
+  const symbols = new Map(topLevelDeclarations(syntax).map((declaration) => [`${file}#${declaration.name}`, { id: `${file}#${declaration.name}`, ...declaration }]));
   return { symbols: [...symbols.values()], operations, invocations, calls, operationAt };
 }
 
@@ -2288,10 +2288,10 @@ async function httpRequest(context, call) {
 }
 
 // plugins/scanners/javascript/src/http.ts
-function fileChecker(source) {
+function fileChecker(syntax) {
   const options = { allowJs: true, noLib: true, noResolve: true, types: [], noEmit: true };
   const host = {
-    getSourceFile: (name) => name === source.fileName ? source : undefined,
+    getSourceFile: (name) => name === syntax.fileName ? syntax : undefined,
     getDefaultLibFileName: () => "lib.d.ts",
     writeFile: () => {
       return;
@@ -2301,18 +2301,18 @@ function fileChecker(source) {
     useCaseSensitiveFileNames: () => true,
     getNewLine: () => `
 `,
-    fileExists: (name) => name === source.fileName,
+    fileExists: (name) => name === syntax.fileName,
     readFile: () => {
       return;
     }
   };
-  return ts4.createProgram([source.fileName], options, host).getTypeChecker();
+  return ts4.createProgram([syntax.fileName], options, host).getTypeChecker();
 }
 function classic(node) {
   return node;
 }
-function fileContext(source, evidence) {
-  const context = urlContext(ts4, classicChecker(ts4, fileChecker(source)), [source], true);
+function fileContext({ file, syntax }, evidence) {
+  const context = urlContext(ts4, classicChecker(ts4, fileChecker(syntax)), [syntax], true);
   const operationAt = (node) => evidence.operationAt(classic(node));
   return {
     ...context,
@@ -2323,7 +2323,7 @@ function fileContext(source, evidence) {
       return typeof held === "object" && ts4.isFunctionLike(classic(held.node)) ? operationAt(held.node) : operationAt(registration);
     },
     callerOperation: operationAt,
-    file: (node) => node.getSourceFile().fileName
+    file: () => file
   };
 }
 async function javaScriptHttpFacts(source, evidence) {
@@ -2334,7 +2334,7 @@ async function javaScriptHttpFacts(source, evidence) {
     if (request !== undefined)
       httpRequests.push({ operation: evidence.operationAt(call), ...request });
   }
-  const placed = await routerEndpoints(context, [source], evidence.calls);
+  const placed = await routerEndpoints(context, [source.syntax], evidence.calls);
   return { httpEndpoints: [...withOrder(placed), ...await serveEndpoints(context, evidence.calls)], httpRequests };
 }
 
@@ -2527,14 +2527,17 @@ async function readJavaScriptOutline(repositoryRoot, references) {
 // plugins/scanners/javascript/src/sources.ts
 import { readFile as readFile2 } from "fs/promises";
 import path2 from "path";
+import ts6 from "./typescript.cjs";
 var SOURCE = /\.(?:js|mjs|cjs|jsx)$/;
 function javaScriptFiles(files) {
   return files.filter((file) => SOURCE.test(file));
 }
 async function javaScriptSources(root, files) {
   const sources = [];
-  for (const file of javaScriptFiles(files))
-    sources.push({ file, text: await readFile2(path2.join(root, file), "utf8") });
+  for (const file of javaScriptFiles(files)) {
+    const text = await readFile2(path2.join(root, file), "utf8");
+    sources.push({ file, syntax: ts6.createSourceFile(file, text, ts6.ScriptTarget.Latest, true) });
+  }
   return sources;
 }
 
@@ -2656,20 +2659,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);
@@ -2683,7 +2698,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);
@@ -2700,12 +2716,17 @@ 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/javascript/src/entries.ts
 import path6 from "path";
-import ts6 from "./typescript.cjs";
+import ts7 from "./typescript.cjs";
 
 // plugins/scanners/entry-points/source.ts
 import path5 from "path";
@@ -2770,37 +2791,34 @@ async function sourceBuildEntries(root, ts, checker, sources) {
 
 // plugins/scanners/javascript/src/entries.ts
 async function javaScriptEntries(root, sources) {
-  const files = new Set(sources.map((source) => source.fileName));
-  const imports = new Map(sources.map((source) => {
-    const targets = ts6.preProcessFile(source.text, true, true).importedFiles.flatMap((imported) => {
+  const files = new Set(sources.map((source) => source.file));
+  const imports = new Map(sources.map(({ file, syntax }) => {
+    const targets = ts7.preProcessFile(syntax.text, true, true).importedFiles.flatMap((imported) => {
       if (!imported.fileName.startsWith("."))
         return [];
-      const base = path6.posix.normalize(path6.posix.join(path6.posix.dirname(source.fileName), imported.fileName));
+      const base = path6.posix.normalize(path6.posix.join(path6.posix.dirname(file), imported.fileName));
       const candidates = [base, ...[".js", ".mjs", ".cjs", ".jsx"].flatMap((extension) => [base + extension, `${base}/index${extension}`])];
-      return candidates.find((file) => files.has(file)) ?? [];
+      return candidates.find((candidate) => files.has(candidate)) ?? [];
     });
-    return [source.fileName, targets];
+    return [file, targets];
   }));
-  const entries = (await Promise.all(sources.map((source) => sourceBuildEntries(root, ts6, classicChecker(ts6, fileChecker(source)), [source])))).flat();
+  const entries = (await Promise.all(sources.map(async ({ file, syntax }) => (await sourceBuildEntries(root, ts7, classicChecker(ts7, fileChecker(syntax)), [syntax])).map((entry) => ({ ...entry, declaration: file }))))).flat();
   return { imports, entries };
 }
 
 // plugins/scanners/javascript/src/index.ts
-function parse(source) {
-  return ts7.createSourceFile(source.file, source.text, ts7.ScriptTarget.Latest, true);
-}
 var SLOPPY_MODE_ONLY = new Set([1121, 1487, 1488, 1489]);
-function parseWarning(source) {
-  const { parseDiagnostics } = source;
+function parseWarning({ file, syntax }) {
+  const { parseDiagnostics } = syntax;
   const first = parseDiagnostics.find((diagnostic) => !SLOPPY_MODE_ONLY.has(diagnostic.code));
   if (first === undefined)
     return;
   return {
     severity: "warning",
     code: "JAVASCRIPT_SOURCE_INVALID",
-    file: source.fileName,
-    line: source.getLineAndCharacterOfPosition(first.start).line + 1,
-    message: `The file does not parse, so it contributes no evidence: ${ts7.flattenDiagnosticMessageText(first.messageText, " ")}`
+    file,
+    line: syntax.getLineAndCharacterOfPosition(first.start).line + 1,
+    message: `The file does not parse, so it contributes no evidence: ${ts8.flattenDiagnosticMessageText(first.messageText, " ")}`
   };
 }
 var src_default = {
@@ -2815,18 +2833,17 @@ var src_default = {
     const sources = await javaScriptSources(root, files);
     if (!sources.length)
       return;
-    const parsed = sources.map(parse);
-    const warnings = parsed.map(parseWarning);
-    const readable = parsed.filter((_, index) => warnings[index] === undefined);
+    const warnings = sources.map(parseWarning);
+    const readable = sources.filter((_, index) => warnings[index] === undefined);
     const scanned = await Promise.all(readable.map(async (source) => {
-      const evidence = javaScriptEvidence(source.fileName, source);
-      return { file: source.fileName, evidence, facts: await javaScriptHttpFacts(source, evidence) };
+      const evidence = javaScriptEvidence(source.file, source.syntax);
+      return { file: source.file, evidence, facts: await javaScriptHttpFacts(source, evidence) };
     }));
     const symbols = new Map(scanned.map(({ file, evidence }) => [file, evidence.symbols]));
     return withJavaScriptEntries(root, createScanObservation({
-      scanner: { id: "javascript", technology: "javascript", engine: "typescript-sdk", engineVersion: ts7.version },
+      scanner: { id: "javascript", technology: "javascript", engine: "typescript-sdk", engineVersion: ts8.version },
       roots: [{ id: "javascript-source", kind: "source-group", name: path7.basename(root) }],
-      files: parsed.map(({ fileName: file }) => ({ file, symbols: symbols.get(file) ?? [], roots: ["javascript-source"] })),
+      files: sources.map(({ file }) => ({ file, symbols: symbols.get(file) ?? [], roots: ["javascript-source"] })),
       operations: scanned.flatMap(({ evidence }) => evidence.operations),
       invocations: scanned.flatMap(({ evidence }) => evidence.invocations),
       httpEndpoints: scanned.flatMap(({ facts }) => facts.httpEndpoints),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@groma/scanner-javascript",
-  "version": "0.2.0",
+  "version": "0.2.2",
   "description": "JavaScript source declarations, outlines and operation bodies without project dependencies.",
   "private": false,
   "type": "module",
@@ -55,7 +55,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/MrLesk/Groma.md.git"
+    "url": "https://github.com/MrLesk/groma.md.git"
   },
   "publishConfig": {
     "access": "public"