@openrewrite/rewrite 8.92.16 → 8.92.18

package/dist/javascript/scope.d.ts

@@ -1,7 +1,14 @@
-import { Cursor } from "../tree";
+import { Cursor, Tree } from "../tree";
 import { J } from "../java";
 import { JS } from "./tree";
 import type { JavaScriptVisitor } from "./visitor";
+/**
+ * What a name means where it is bound, a value, a type or a namespace, which is what TypeScript
+ * resolves a name against. A `const` binds a value, an interface a type, a class both, and the
+ * qualifier before a dot in a type reads a namespace, which an interface does not declare. A read
+ * with one meaning is hidden only by a binding with that meaning.
+ */
+export type Meaning = 'value' | 'type' | 'namespace';
 /** One scope: the names it binds itself, the scopes around it, and what they answer together. */
 export interface Scope {
     /** The names this scope binds itself, which is not what it reaches: for that, ask `declares`. */
@@ -12,15 +19,16 @@ export interface Scope {
      * name already in hand.
      */
     walk(visit: (scope: Scope) => boolean): void;
-    /** Whether this scope or one enclosing it binds `name`. */
-    declares(name: string): boolean;
     /**
-     * The node owning the innermost scope that binds `name` — the compilation unit for a
-     * module-scope binding, otherwise the function, block or loop holding it — or undefined where
-     * nothing in scope does. A caller holding a declaration asks whether this is the node it came
-     * from: anything nearer shadows it.
+     * Whether this scope or one enclosing it binds `name`. Any meaning counts unless one is asked
+     * for, since a new binding collides with a type of its name as much as with a value.
+     */
+    declares(name: string, meaning?: Meaning): boolean;
+    /**
+     * The node owning the innermost scope that binds `name`, or undefined. A caller holding a
+     * declaration compares this to the node it came from, since anything nearer shadows it.
      */
-    declaringScope(name: string): J | undefined;
+    declaringScope(name: string, meaning?: Meaning): J | undefined;
 }
 /**
  * The innermost scope holding `cursor`, which a visitor's own cursor rarely is: it stands on
@@ -46,7 +54,8 @@ export declare function namesDeclaredWithin(node: unknown, cacheKey?: object): R
 /**
  * The names `node` reads and nothing within it binds, so each one reaches a binding further out.
  * A name its parent introduces rather than reads is not one, nor is a name an inner scope rebinds:
- * that reference reads the rebinding.
+ * that reference reads the rebinding. A value position is hidden only by a value binding, a type
+ * position only by a type.
  */
 export declare function namesReferencedWithin(node: unknown, cacheKey?: object): ReadonlySet<string>;
 /**
@@ -64,7 +73,7 @@ export declare function bindingNames(pattern: J | undefined): {
  * into, which a `JavaType` is not, so the walk stays in the tree the source spells rather than
  * entering the type graph — cyclic and shared, where it would not terminate.
  */
-export declare function walk(node: unknown, visit: (node: any) => boolean): void;
+export declare function walk(node: unknown, visit: (node: Tree) => boolean): void;
 /** `cursor` is protected on `TreeVisitor` and these APIs are free functions, so reaching it takes a cast. */
 export declare function cursorOf(visitor: JavaScriptVisitor<any>): Cursor | undefined;
 /** The compilation unit a cursor sits in, or the one a visitor is currently positioned in. */
@@ -78,11 +87,46 @@ export declare function deconflict(preferred: string, isTaken: (name: string) =>
  */
 export declare function declarationsOf(statement: J | undefined): J.VariableDeclarations[];
 /**
- * Whether the identifier references a binding rather than naming one, which is what tells a rename
- * which occurrences to follow. A name its parent introduces does not — a property, a method, a
- * variable, a type parameter — nor one drawn from a namespace of its own: a statement label,
- * declaring (`x:`) or referencing (`break x`), and a JSX attribute's prop. Position is all this
- * reads: an import specifier's own name answers true, and a type position reads alike to a value.
+ * Whether the identifier may be renamed in place, which is so where its slot reads rather than
+ * names. A shorthand property `{x}` answers false though it reads `x`, since a rename has to
+ * expand it to `{x: y}`. Position is all this reads, so a type position reads alike to a value,
+ * and what `x` reads is {@link resolve}'s question.
+ */
+export declare function isReference(cursor: Cursor, identifier: J.Identifier): boolean;
+/**
+ * @deprecated Use {@link isReference}. Unlike this function once did, it answers false for an
+ * import's own name, an alias and a re-export's specifier, which name rather than read.
+ */
+export declare const isValueReference: typeof isReference;
+/**
+ * The node owning the scope that binds what `identifier` reads, or undefined where it reads a
+ * global or reads nothing. Position is what resolves it, so the cursor stands on the identifier
+ * or on the node holding it, and a node the cursor does not hold is refused.
+ */
+export declare function resolve(cursor: Cursor, identifier: J.Identifier): J | undefined;
+/**
+ * Whether the identifier is assigned to where it stands. An assignment's target, plain or compound,
+ * is, and so are the operand of `++` or `--`, the head of a for-in or for-of declaring nothing, and
+ * a name in such a target's destructuring pattern. A write resolves as a value read, since
+ * `x = 2` assigns to the `x` it reads. The cursor is as {@link resolve} takes it.
+ */
+export declare function isWrite(cursor: Cursor, identifier: J.Identifier): boolean;
+/** One identifier referring to a binding, from {@link referencesOf}. */
+export interface Reference {
+    /** The identifier's position, holding the tree nodes above it with no padding between them. */
+    cursor: Cursor;
+    identifier: J.Identifier;
+    /** Whether the identifier is one declaring the binding. */
+    declares: boolean;
+    /** Whether the identifier is assigned to, as {@link isWrite} answers. */
+    writes: boolean;
+}
+/**
+ * Every identifier referring to the binding `name` has at `cursor`, the ones declaring it and the
+ * ones resolving to it, in the order the tree holds them, which a type annotation can depart from.
+ * The binding is the innermost one of the name with `meaning`, or with any meaning where none is
+ * asked for. A read with any meaning, as an export clause reads, refers to every meaning it finds.
+ * A name bound nowhere has no references. Each reference's cursor continues the caller's chain.
  */
-export declare function isValueReference(cursor: Cursor, identifier: J.Identifier): boolean;
+export declare function referencesOf(cursor: Cursor, name: string, meaning?: Meaning): Reference[];
 //# sourceMappingURL=scope.d.ts.map

package/dist/javascript/scope.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"scope.d.ts","sourceRoot":"","sources":["../../src/javascript/scope.ts"],"names":[],"mappings":"AAeA,OAAO,EAAC,MAAM,EAAS,MAAM,SAAS,CAAC;AACvC,OAAO,EAAC,CAAC,EAAC,MAAM,SAAS,CAAC;AAC1B,OAAO,EAAC,EAAE,EAAC,MAAM,QAAQ,CAAC;AAE1B,OAAO,KAAK,EAAC,iBAAiB,EAAC,MAAM,WAAW,CAAC;AAIjD,iGAAiG;AACjG,MAAM,WAAW,KAAK;IAClB,iGAAiG;IACjG,KAAK,IAAI,WAAW,CAAC,MAAM,CAAC,CAAC;IAE7B;;;;OAIG;IACH,IAAI,CAAC,KAAK,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,OAAO,GAAG,IAAI,CAAC;IAE7C,2DAA2D;IAC3D,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC;IAEhC;;;;;OAKG;IACH,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,CAAC,GAAG,SAAS,CAAC;CAC/C;AAED;;;;GAIG;AACH,wBAAgB,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,KAAK,CAE7C;AAgCD;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,EAAE,EAAE,EAAE,CAAC,eAAe,GAAG,WAAW,CAAC,MAAM,CAAC,CAE3E;AAED;;;GAGG;AACH,wBAAgB,WAAW,CAAC,EAAE,EAAE,EAAE,CAAC,eAAe,GAAG,WAAW,CAAC,MAAM,CAAC,CAEvE;AAED,sGAAsG;AACtG,wBAAgB,eAAe,CAAC,IAAI,EAAE,OAAO,EAAE,QAAQ,GAAE,MAAuB,GAAG,WAAW,CAAC,MAAM,CAAC,CAiBrG;AAED,0GAA0G;AAC1G,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,OAAO,EAAE,QAAQ,GAAE,MAAuB,GAAG,WAAW,CAAC,MAAM,CAAC,CA4BzG;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,OAAO,EAAE,QAAQ,GAAE,MAAuB,GAAG,WAAW,CAAC,MAAM,CAAC,CAY3G;AA8CD;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,OAAO,EAAE,CAAC,GAAG,SAAS,GAAG;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE,EAAE,CA6BxF;AA4OD;;;;;GAKG;AACH,wBAAgB,IAAI,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,IAAI,EAAE,GAAG,KAAK,OAAO,GAAG,IAAI,CAcvE;AAOD,6GAA6G;AAC7G,wBAAgB,QAAQ,CAAC,OAAO,EAAE,iBAAiB,CAAC,GAAG,CAAC,GAAG,MAAM,GAAG,SAAS,CAE5E;AAED,8FAA8F;AAC9F,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG,iBAAiB,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,eAAe,GAAG,SAAS,CAGvG;AAED,gHAAgH;AAChH,wBAAgB,UAAU,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,GAAG,MAAM,CAUxF;AAED;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,SAAS,EAAE,CAAC,GAAG,SAAS,GAAG,CAAC,CAAC,oBAAoB,EAAE,CAUjF;AAED;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC,CAAC,UAAU,GAAG,OAAO,CAMlF"}
+{"version":3,"file":"scope.d.ts","sourceRoot":"","sources":["../../src/javascript/scope.ts"],"names":[],"mappings":"AAeA,OAAO,EAAC,MAAM,EAAU,IAAI,EAAC,MAAM,SAAS,CAAC;AAC7C,OAAO,EAAC,CAAC,EAAC,MAAM,SAAS,CAAC;AAE1B,OAAO,EAAC,EAAE,EAAC,MAAM,QAAQ,CAAC;AAE1B,OAAO,KAAK,EAAC,iBAAiB,EAAC,MAAM,WAAW,CAAC;AAIjD;;;;;GAKG;AACH,MAAM,MAAM,OAAO,GAAG,OAAO,GAAG,MAAM,GAAG,WAAW,CAAC;AA0CrD,iGAAiG;AACjG,MAAM,WAAW,KAAK;IAClB,iGAAiG;IACjG,KAAK,IAAI,WAAW,CAAC,MAAM,CAAC,CAAC;IAE7B;;;;OAIG;IACH,IAAI,CAAC,KAAK,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,OAAO,GAAG,IAAI,CAAC;IAE7C;;;OAGG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC;IAEnD;;;OAGG;IACH,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,CAAC,GAAG,SAAS,CAAC;CAClE;AAED;;;;GAIG;AACH,wBAAgB,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,KAAK,CAE7C;AAkCD;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,EAAE,EAAE,EAAE,CAAC,eAAe,GAAG,WAAW,CAAC,MAAM,CAAC,CAE3E;AAED;;;GAGG;AACH,wBAAgB,WAAW,CAAC,EAAE,EAAE,EAAE,CAAC,eAAe,GAAG,WAAW,CAAC,MAAM,CAAC,CAEvE;AAED,sGAAsG;AACtG,wBAAgB,eAAe,CAAC,IAAI,EAAE,OAAO,EAAE,QAAQ,GAAE,MAAuB,GAAG,WAAW,CAAC,MAAM,CAAC,CAiBrG;AAED,0GAA0G;AAC1G,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,OAAO,EAAE,QAAQ,GAAE,MAAuB,GAAG,WAAW,CAAC,MAAM,CAAC,CAiCzG;AAED;;;;;GAKG;AACH,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,OAAO,EAAE,QAAQ,GAAE,MAAuB,GAAG,WAAW,CAAC,MAAM,CAAC,CAgB3G;AAsOD;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,OAAO,EAAE,CAAC,GAAG,SAAS,GAAG;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE,EAAE,CAGxF;AAoaD;;;;;GAKG;AACH,wBAAgB,IAAI,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,IAAI,EAAE,IAAI,KAAK,OAAO,GAAG,IAAI,CAcxE;AAWD,6GAA6G;AAC7G,wBAAgB,QAAQ,CAAC,OAAO,EAAE,iBAAiB,CAAC,GAAG,CAAC,GAAG,MAAM,GAAG,SAAS,CAE5E;AAED,8FAA8F;AAC9F,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG,iBAAiB,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,eAAe,GAAG,SAAS,CAGvG;AAED,gHAAgH;AAChH,wBAAgB,UAAU,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,GAAG,MAAM,CAUxF;AAED;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,SAAS,EAAE,CAAC,GAAG,SAAS,GAAG,CAAC,CAAC,oBAAoB,EAAE,CAUjF;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC,CAAC,UAAU,GAAG,OAAO,CAG7E;AAyFD;;;GAGG;AACH,eAAO,MAAM,gBAAgB,oBAAc,CAAC;AAE5C;;;;GAIG;AACH,wBAAgB,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC,CAAC,UAAU,GAAG,CAAC,GAAG,SAAS,CAG/E;AAED;;;;;GAKG;AACH,wBAAgB,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC,CAAC,UAAU,GAAG,OAAO,CAEzE;AAED,wEAAwE;AACxE,MAAM,WAAW,SAAS;IACtB,+FAA+F;IAC/F,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,CAAC,CAAC,UAAU,CAAC;IACzB,2DAA2D;IAC3D,QAAQ,EAAE,OAAO,CAAC;IAClB,yEAAyE;IACzE,MAAM,EAAE,OAAO,CAAC;CACnB;AAED;;;;;;GAMG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,SAAS,EAAE,CA2CzF"}