@suss/contract-wrangler 0.34.0 → 0.35.0

package/README.md

@@ -55,7 +55,7 @@ Wrangler replaces a whole block instead of merging it, so an environment that de
 
 ## Code scope
 
-The Worker's code is the directory the document is in, and `main` gives the entry file. `main` often points at a bundle that a build step writes, outside the source. If the entry matches no file, the directory alone decides the code scope, so the code is placed correctly either way.
+The Worker's code is the directory the document is in, and `main` gives the entry file. `main` often points at a bundle that a build step writes, outside the source. If the entry matches no file, the directory alone decides the code scope, so the code is placed correctly either way. The bundle can also contain code from outside the source, such as a framework adapter that reads its own variables, so the checker does not call a variable unused for a Worker whose entry it never read. It lists those variables in one info finding instead.
 
 ## Out of scope for now
 

package/dist/index.cjs

@@ -41,6 +41,8 @@ __export(index_exports, {
 });
 module.exports = __toCommonJS(index_exports);
 var import_node_path2 = __toESM(require("path"), 1);
+var import_behavioral_ir3 = require("@suss/behavioral-ir");
+var import_files = require("@suss/behavioral-ir/files");
 var import_ir_core2 = require("@suss/ir-core");
 
 // src/bindings.ts
@@ -388,17 +390,14 @@ function wranglerFileToSummaries(target, options = {}) {
     throw new Error(`Wrangler configuration not found: ${target}`);
   }
   const document = loadConfigurationDocument(located.file);
-  return wranglerToSummaries(document, {
-    source: options.source ?? `${RECOGNITION}:${relativeToRun(located.file)}`,
-    codeScope: options.codeScope ?? (0, import_ir_core2.codeScopePath)(import_node_path2.default.dirname(relativeToRun(located.file)))
+  const root = options.projectRoot ?? (0, import_files.defaultProjectRoot)(located.file);
+  const summaries = wranglerToSummaries(document, {
+    source: options.source ?? (0, import_files.documentSourceLabel)(RECOGNITION, located.file, root),
+    codeScope: options.codeScope ?? (0, import_ir_core2.codeScopePath)(import_node_path2.default.posix.dirname((0, import_files.pathInProject)(located.file, root)))
   });
-}
-function relativeToRun(file) {
-  const relative = import_node_path2.default.relative(process.cwd(), import_node_path2.default.resolve(file));
-  if (relative === "" || relative.startsWith("..")) {
-    return import_node_path2.default.resolve(file).split(import_node_path2.default.sep).join("/");
-  }
-  return relative.split(import_node_path2.default.sep).join("/");
+  return options.codeScope === void 0 ? summaries.map(
+    (summary) => (0, import_behavioral_ir3.withCodeScopeWorkspace)(summary, (0, import_files.projectNameOf)(root))
+  ) : summaries;
 }
 function codeScopeFor(document, scope) {
   const main = typeof document.main === "string" ? document.main : null;

package/dist/index.d.cts

@@ -116,9 +116,11 @@ interface WranglerToSummariesOptions {
     /**
      * The directory the Worker's code is in, relative to wherever the
      * extraction run was pointed. Defaults to where the document is,
-     * relative to the working directory.
+     * relative to the project root.
      */
     codeScope?: string;
+    /** Absolute. The directory the document's paths are measured from. */
+    projectRoot?: string;
 }
 declare function wranglerToSummaries(document: WranglerDocument, options: {
     source: string;

package/dist/index.d.ts

@@ -116,9 +116,11 @@ interface WranglerToSummariesOptions {
     /**
      * The directory the Worker's code is in, relative to wherever the
      * extraction run was pointed. Defaults to where the document is,
-     * relative to the working directory.
+     * relative to the project root.
      */
     codeScope?: string;
+    /** Absolute. The directory the document's paths are measured from. */
+    projectRoot?: string;
 }
 declare function wranglerToSummaries(document: WranglerDocument, options: {
     source: string;

package/dist/index.js

@@ -1,5 +1,12 @@
 // src/index.ts
 import path2 from "path";
+import { withCodeScopeWorkspace } from "@suss/behavioral-ir";
+import {
+  defaultProjectRoot,
+  documentSourceLabel,
+  pathInProject,
+  projectNameOf
+} from "@suss/behavioral-ir/files";
 import { codeScopePath } from "@suss/ir-core";
 
 // src/bindings.ts
@@ -347,17 +354,14 @@ function wranglerFileToSummaries(target, options = {}) {
     throw new Error(`Wrangler configuration not found: ${target}`);
   }
   const document = loadConfigurationDocument(located.file);
-  return wranglerToSummaries(document, {
-    source: options.source ?? `${RECOGNITION}:${relativeToRun(located.file)}`,
-    codeScope: options.codeScope ?? codeScopePath(path2.dirname(relativeToRun(located.file)))
+  const root = options.projectRoot ?? defaultProjectRoot(located.file);
+  const summaries = wranglerToSummaries(document, {
+    source: options.source ?? documentSourceLabel(RECOGNITION, located.file, root),
+    codeScope: options.codeScope ?? codeScopePath(path2.posix.dirname(pathInProject(located.file, root)))
   });
-}
-function relativeToRun(file) {
-  const relative = path2.relative(process.cwd(), path2.resolve(file));
-  if (relative === "" || relative.startsWith("..")) {
-    return path2.resolve(file).split(path2.sep).join("/");
-  }
-  return relative.split(path2.sep).join("/");
+  return options.codeScope === void 0 ? summaries.map(
+    (summary) => withCodeScopeWorkspace(summary, projectNameOf(root))
+  ) : summaries;
 }
 function codeScopeFor(document, scope) {
   const main = typeof document.main === "string" ? document.main : null;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@suss/contract-wrangler",
-  "version": "0.34.0",
+  "version": "0.35.0",
   "type": "module",
   "description": "Read a Cloudflare wrangler.toml or wrangler.jsonc and check the bindings it declares against the Worker code that uses them.",
   "keywords": [
@@ -47,8 +47,8 @@
     "typecheck": "tsc --noEmit"
   },
   "dependencies": {
-    "@suss/behavioral-ir": "0.34.0",
-    "@suss/ir-core": "0.34.0",
+    "@suss/behavioral-ir": "0.35.0",
+    "@suss/ir-core": "0.35.0",
     "jsonc-parser": "^3.3.1",
     "smol-toml": "^1.4.2"
   },