@tslite/checker 1.1.0 → 1.2.0

package/dist/index.d.cts

@@ -1,6 +1,6 @@
 import { Schema, Schemes, TypeScheme, ObjectSchema, Completion } from './types/index.cjs';
 export { AnySchema, ApplySchema, ArraySchema, Bindings, DEFAULT_TYPE_LIMITS, Discovery, ElementFlag, FnSchema, GuardSig, INSTANTIATION_COUNT_LIMIT, INSTANTIATION_DEPTH_LIMIT, Incompatibility, IncompatibilityKind, IndexSchema, Instantiation, InstantiationLimitError, KeyofSchema, LiteralSchema, MappedSchema, OverloadSchema, Param, Prop, ScalarSchema, TYPE_EVAL_DEPTH_LIMIT, TupleSchema, TypeEvalLimitError, TypeEvalLimits, TypeForm, TypePosition, UnionSchema, UnionTooComplexError, UnknownSchema, VarCandidates, VarSchema, apparentType, asLiteralOrigin, baseLiteralType, bindTypeParams, comparable, configureTypeLimits, contravariantInference, covariantInference, discover, equals, erasedSignature, expand1, flagAt, format, formatTypeArgs, formatTypeDiff, freeVars, groundVars, inferFromCandidates, inferredTypes, instantiate, instantiateInContextOf, instantiateLoose, isMissingType, isNumericLiteralName, isObjectOrArrayLiteral, isScheme, isSerializable, isVariadicTuple, join, joinAll, missingType, normalizeUnion, ownProp, renameTypeParams, resetInstantiationCount, resetTypeLimits, resolveConditional, resolveOp, resolveTypeOp, restIndex, s, sampleValue, silentNever, substitute, subtype, typeAtPosition, typeDiff, typeFeatures, typeLimits, typeNeedsParens, typeParamArity, unify, widen, widenInferred, widenLiteral, widenOrigin, widenType, withoutUndefined } from './types/index.cjs';
-import { Scope as Scope$1, BaseNode, Node, types, Expression, SourceLocation } from '@tslite/ast';
+import { Scope as Scope$1, BaseNode, Node, types, SourceLocation, Expression } from '@tslite/ast';
 import { CapabilityProfile, CompiledProfile } from '@tslite/capability';
 import { Span } from '@tslite/language-service';
 
@@ -600,6 +600,67 @@ type BindingMap = WeakMap<BaseNode, BaseNode>;
  */
 declare function collectBindings(root: BaseNode): BindingMap;
 
+/** O que um nome denota. */
+type ReferenceSymbol = {
+    readonly kind: "local";
+    /** O `Identifier` que declara — a identidade, por referência. */
+    readonly declaration: BaseNode;
+} | {
+    readonly kind: "environment";
+    /** O caminho a partir da raiz da DI: `["params"]`, `["params", "id"]`. */
+    readonly path: readonly string[];
+};
+/**
+ * Onde o nome aparece como SHORTHAND, e portanto nomeia duas coisas ao mesmo tempo
+ * — o `prefixText`/`suffixText` do `findRenameLocations` do TypeScript:
+ *
+ * - `"property"`: o nome é o valor e também a PROPRIEDADE (`{ x }`, ou `const { x
+ *   } = o` renomeando o `x` local). A propriedade continua com o nome antigo:
+ *   `{ x: x2 }`;
+ * - `"binding"`: o nome é a propriedade e também um BINDING (`const { id } =
+ *   params`, renomeando o `params.id`). O binding continua com o nome antigo:
+ *   `{ id2: id }`;
+ * - `"import"`: o nome importado é também o local (`import { a } from "m"`,
+ *   renomeando o local): `import { a as a2 }`.
+ */
+type Shorthand = "property" | "binding" | "import";
+/** Uma referência a tipo nomeado escrita numa anotação (a `typeRefs` do parser). */
+interface TypeRefSite {
+    readonly name: string;
+    readonly loc: SourceLocation;
+}
+/** Um lugar onde o nome aparece. */
+type Occurrence = {
+    /** O nó cujo texto É o nome: `Identifier`, `JSXIdentifier` ou a chave literal. */
+    readonly site: "node";
+    readonly node: BaseNode;
+    readonly symbol: ReferenceSymbol;
+    /** A declaração do símbolo, e não um uso. */
+    readonly isDeclaration?: true;
+    readonly shorthand?: Shorthand;
+} | {
+    /** Um segmento do `typeof a.b` numa anotação: o nó não tem posição por segmento. */
+    readonly site: "typeQuery";
+    readonly node: BaseNode;
+    readonly segment: number;
+    readonly symbol: ReferenceSymbol;
+} | {
+    /** Um nome de tipo numa anotação, que não é nó (E6 do editor). */
+    readonly site: "typeRef";
+    readonly ref: TypeRefSite;
+    readonly symbol: ReferenceSymbol;
+};
+/** Os dois símbolos são o mesmo? */
+declare function sameSymbol(a: ReferenceSymbol, b: ReferenceSymbol): boolean;
+/**
+ * Todas as ocorrências de nome do programa, cada uma com o símbolo que denota.
+ *
+ * Quem renomeia escolhe o símbolo sob o cursor (`occurrenceAt` do editor) e pega as
+ * ocorrências com `sameSymbol`; quem renomeia um caminho do ambiente sem cursor (o
+ * host que renomeou a declaração no `Env`) filtra pelo caminho direto.
+ */
+declare function collectReferences(root: BaseNode): readonly Occurrence[];
+
 /** Anota uma ligação/parâmetro: `x` → `x: T`. */
 declare const annotate: <N extends BaseNode>(node: N, type: Schema) => N & {
     typeAnnotation: Schema;
@@ -722,4 +783,4 @@ declare function anchorDiagnostics<A>(root: object, diagnostics: readonly Diagno
  */
 declare function spanOf(text: string, loc: SourceLocation | null | undefined): Span | undefined;
 
-export { type AnchorDiagnosticsOptions, type AnchoredDiagnostic, type Anchors, BINARY_OP, BINARY_OPS, type BinaryOpCategory, type BinaryOpSpec, type BindingMap, type CheckOptions, type CheckResult, type CheckerErrorCode, Completion, type Diagnostic, type DiagnosticCode, type DiagnosticData, type DiagnosticKind, type DiagnosticSink, type Env, type EnvOptions, FUNCTION_KINDS, type Guard, type GuardContext, LOGICAL_OPS, type LogicalOpSpec, type LowerValueOptions, type MissingProperty, ObjectSchema, type OpResult, type Profile, Schema, Schemes, type Scope, type Severity, type TypeOverlay, TypeScheme, UNARY_OPS, type UnaryOpSpec, type UnusedOptions, anchorDiagnostics, annotate, annotateReturn, asExpression, binaryOpsProducing, calleeAllowlist, capabilityNodes, check, childScope, collectBindings, collectMutations, collectUnused, componentProps, componentPropsOf, contextualTypeAt, createAnchors, createEnv, createSink, diag, diagnosticsAt, extractModuleType, fromCapability, guard, guardsFromCompiled, lookup, lowerValue, makeDiagnostic, maxArgs, maxCallNesting, maxDepth, maxFunctionNesting, maxNestingOf, maxNodes, memberCompletions, memberDepth, opResultSchema, resolveNamed, resolveScheme, resultType, rootScope, scopeAt, scopeCompletions, spanOf, typeAt, unaryOpsProducing, visibleNames };
+export { type AnchorDiagnosticsOptions, type AnchoredDiagnostic, type Anchors, BINARY_OP, BINARY_OPS, type BinaryOpCategory, type BinaryOpSpec, type BindingMap, type CheckOptions, type CheckResult, type CheckerErrorCode, Completion, type Diagnostic, type DiagnosticCode, type DiagnosticData, type DiagnosticKind, type DiagnosticSink, type Env, type EnvOptions, FUNCTION_KINDS, type Guard, type GuardContext, LOGICAL_OPS, type LogicalOpSpec, type LowerValueOptions, type MissingProperty, ObjectSchema, type Occurrence, type OpResult, type Profile, type ReferenceSymbol, Schema, Schemes, type Scope, type Severity, type Shorthand, type TypeOverlay, type TypeRefSite, TypeScheme, UNARY_OPS, type UnaryOpSpec, type UnusedOptions, anchorDiagnostics, annotate, annotateReturn, asExpression, binaryOpsProducing, calleeAllowlist, capabilityNodes, check, childScope, collectBindings, collectMutations, collectReferences, collectUnused, componentProps, componentPropsOf, contextualTypeAt, createAnchors, createEnv, createSink, diag, diagnosticsAt, extractModuleType, fromCapability, guard, guardsFromCompiled, lookup, lowerValue, makeDiagnostic, maxArgs, maxCallNesting, maxDepth, maxFunctionNesting, maxNestingOf, maxNodes, memberCompletions, memberDepth, opResultSchema, resolveNamed, resolveScheme, resultType, rootScope, sameSymbol, scopeAt, scopeCompletions, spanOf, typeAt, unaryOpsProducing, visibleNames };

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import { Schema, Schemes, TypeScheme, ObjectSchema, Completion } from './types/index.js';
 export { AnySchema, ApplySchema, ArraySchema, Bindings, DEFAULT_TYPE_LIMITS, Discovery, ElementFlag, FnSchema, GuardSig, INSTANTIATION_COUNT_LIMIT, INSTANTIATION_DEPTH_LIMIT, Incompatibility, IncompatibilityKind, IndexSchema, Instantiation, InstantiationLimitError, KeyofSchema, LiteralSchema, MappedSchema, OverloadSchema, Param, Prop, ScalarSchema, TYPE_EVAL_DEPTH_LIMIT, TupleSchema, TypeEvalLimitError, TypeEvalLimits, TypeForm, TypePosition, UnionSchema, UnionTooComplexError, UnknownSchema, VarCandidates, VarSchema, apparentType, asLiteralOrigin, baseLiteralType, bindTypeParams, comparable, configureTypeLimits, contravariantInference, covariantInference, discover, equals, erasedSignature, expand1, flagAt, format, formatTypeArgs, formatTypeDiff, freeVars, groundVars, inferFromCandidates, inferredTypes, instantiate, instantiateInContextOf, instantiateLoose, isMissingType, isNumericLiteralName, isObjectOrArrayLiteral, isScheme, isSerializable, isVariadicTuple, join, joinAll, missingType, normalizeUnion, ownProp, renameTypeParams, resetInstantiationCount, resetTypeLimits, resolveConditional, resolveOp, resolveTypeOp, restIndex, s, sampleValue, silentNever, substitute, subtype, typeAtPosition, typeDiff, typeFeatures, typeLimits, typeNeedsParens, typeParamArity, unify, widen, widenInferred, widenLiteral, widenOrigin, widenType, withoutUndefined } from './types/index.js';
-import { Scope as Scope$1, BaseNode, Node, types, Expression, SourceLocation } from '@tslite/ast';
+import { Scope as Scope$1, BaseNode, Node, types, SourceLocation, Expression } from '@tslite/ast';
 import { CapabilityProfile, CompiledProfile } from '@tslite/capability';
 import { Span } from '@tslite/language-service';
 
@@ -600,6 +600,67 @@ type BindingMap = WeakMap<BaseNode, BaseNode>;
  */
 declare function collectBindings(root: BaseNode): BindingMap;
 
+/** O que um nome denota. */
+type ReferenceSymbol = {
+    readonly kind: "local";
+    /** O `Identifier` que declara — a identidade, por referência. */
+    readonly declaration: BaseNode;
+} | {
+    readonly kind: "environment";
+    /** O caminho a partir da raiz da DI: `["params"]`, `["params", "id"]`. */
+    readonly path: readonly string[];
+};
+/**
+ * Onde o nome aparece como SHORTHAND, e portanto nomeia duas coisas ao mesmo tempo
+ * — o `prefixText`/`suffixText` do `findRenameLocations` do TypeScript:
+ *
+ * - `"property"`: o nome é o valor e também a PROPRIEDADE (`{ x }`, ou `const { x
+ *   } = o` renomeando o `x` local). A propriedade continua com o nome antigo:
+ *   `{ x: x2 }`;
+ * - `"binding"`: o nome é a propriedade e também um BINDING (`const { id } =
+ *   params`, renomeando o `params.id`). O binding continua com o nome antigo:
+ *   `{ id2: id }`;
+ * - `"import"`: o nome importado é também o local (`import { a } from "m"`,
+ *   renomeando o local): `import { a as a2 }`.
+ */
+type Shorthand = "property" | "binding" | "import";
+/** Uma referência a tipo nomeado escrita numa anotação (a `typeRefs` do parser). */
+interface TypeRefSite {
+    readonly name: string;
+    readonly loc: SourceLocation;
+}
+/** Um lugar onde o nome aparece. */
+type Occurrence = {
+    /** O nó cujo texto É o nome: `Identifier`, `JSXIdentifier` ou a chave literal. */
+    readonly site: "node";
+    readonly node: BaseNode;
+    readonly symbol: ReferenceSymbol;
+    /** A declaração do símbolo, e não um uso. */
+    readonly isDeclaration?: true;
+    readonly shorthand?: Shorthand;
+} | {
+    /** Um segmento do `typeof a.b` numa anotação: o nó não tem posição por segmento. */
+    readonly site: "typeQuery";
+    readonly node: BaseNode;
+    readonly segment: number;
+    readonly symbol: ReferenceSymbol;
+} | {
+    /** Um nome de tipo numa anotação, que não é nó (E6 do editor). */
+    readonly site: "typeRef";
+    readonly ref: TypeRefSite;
+    readonly symbol: ReferenceSymbol;
+};
+/** Os dois símbolos são o mesmo? */
+declare function sameSymbol(a: ReferenceSymbol, b: ReferenceSymbol): boolean;
+/**
+ * Todas as ocorrências de nome do programa, cada uma com o símbolo que denota.
+ *
+ * Quem renomeia escolhe o símbolo sob o cursor (`occurrenceAt` do editor) e pega as
+ * ocorrências com `sameSymbol`; quem renomeia um caminho do ambiente sem cursor (o
+ * host que renomeou a declaração no `Env`) filtra pelo caminho direto.
+ */
+declare function collectReferences(root: BaseNode): readonly Occurrence[];
+
 /** Anota uma ligação/parâmetro: `x` → `x: T`. */
 declare const annotate: <N extends BaseNode>(node: N, type: Schema) => N & {
     typeAnnotation: Schema;
@@ -722,4 +783,4 @@ declare function anchorDiagnostics<A>(root: object, diagnostics: readonly Diagno
  */
 declare function spanOf(text: string, loc: SourceLocation | null | undefined): Span | undefined;
 
-export { type AnchorDiagnosticsOptions, type AnchoredDiagnostic, type Anchors, BINARY_OP, BINARY_OPS, type BinaryOpCategory, type BinaryOpSpec, type BindingMap, type CheckOptions, type CheckResult, type CheckerErrorCode, Completion, type Diagnostic, type DiagnosticCode, type DiagnosticData, type DiagnosticKind, type DiagnosticSink, type Env, type EnvOptions, FUNCTION_KINDS, type Guard, type GuardContext, LOGICAL_OPS, type LogicalOpSpec, type LowerValueOptions, type MissingProperty, ObjectSchema, type OpResult, type Profile, Schema, Schemes, type Scope, type Severity, type TypeOverlay, TypeScheme, UNARY_OPS, type UnaryOpSpec, type UnusedOptions, anchorDiagnostics, annotate, annotateReturn, asExpression, binaryOpsProducing, calleeAllowlist, capabilityNodes, check, childScope, collectBindings, collectMutations, collectUnused, componentProps, componentPropsOf, contextualTypeAt, createAnchors, createEnv, createSink, diag, diagnosticsAt, extractModuleType, fromCapability, guard, guardsFromCompiled, lookup, lowerValue, makeDiagnostic, maxArgs, maxCallNesting, maxDepth, maxFunctionNesting, maxNestingOf, maxNodes, memberCompletions, memberDepth, opResultSchema, resolveNamed, resolveScheme, resultType, rootScope, scopeAt, scopeCompletions, spanOf, typeAt, unaryOpsProducing, visibleNames };
+export { type AnchorDiagnosticsOptions, type AnchoredDiagnostic, type Anchors, BINARY_OP, BINARY_OPS, type BinaryOpCategory, type BinaryOpSpec, type BindingMap, type CheckOptions, type CheckResult, type CheckerErrorCode, Completion, type Diagnostic, type DiagnosticCode, type DiagnosticData, type DiagnosticKind, type DiagnosticSink, type Env, type EnvOptions, FUNCTION_KINDS, type Guard, type GuardContext, LOGICAL_OPS, type LogicalOpSpec, type LowerValueOptions, type MissingProperty, ObjectSchema, type Occurrence, type OpResult, type Profile, type ReferenceSymbol, Schema, Schemes, type Scope, type Severity, type Shorthand, type TypeOverlay, type TypeRefSite, TypeScheme, UNARY_OPS, type UnaryOpSpec, type UnusedOptions, anchorDiagnostics, annotate, annotateReturn, asExpression, binaryOpsProducing, calleeAllowlist, capabilityNodes, check, childScope, collectBindings, collectMutations, collectReferences, collectUnused, componentProps, componentPropsOf, contextualTypeAt, createAnchors, createEnv, createSink, diag, diagnosticsAt, extractModuleType, fromCapability, guard, guardsFromCompiled, lookup, lowerValue, makeDiagnostic, maxArgs, maxCallNesting, maxDepth, maxFunctionNesting, maxNestingOf, maxNodes, memberCompletions, memberDepth, opResultSchema, resolveNamed, resolveScheme, resultType, rootScope, sameSymbol, scopeAt, scopeCompletions, spanOf, typeAt, unaryOpsProducing, visibleNames };