@scriptc/compiler 0.4.1 → 0.4.3

package/dist/frontend/token-equivalence.test.js

@@ -0,0 +1,67 @@
+import { expect, test } from "vitest";
+import { tokenEquivalentSource } from "./token-equivalence.js";
+const equivalent = (previous, current, path = "/src/a.ts") => tokenEquivalentSource(path, previous, current);
+test("whitespace and plain comments are trivia", () => {
+    expect(equivalent("const a = 1;\n", "const a = 1; // one\n")).toBe(true);
+    expect(equivalent("f(a,b);\n", "f( a, /* first */ b );\n")).toBe(true);
+    expect(equivalent("const s = `x${a}y`;\n", "const s = `x${ a /* the value */ }y`;\n")).toBe(true);
+});
+test("tokens, literals and line breaks that change semicolon insertion are not", () => {
+    expect(equivalent("const a = 1;\n", "const a = 2;\n")).toBe(false);
+    expect(equivalent('const s = "a // b";\n', 'const s = "a // c";\n')).toBe(false);
+    expect(equivalent("const s = `a // ${b} /* c */`;\n", "const s = `a // ${b} /* d */`;\n")).toBe(false);
+    // `return` followed by a line break returns undefined.
+    expect(equivalent("return a;\n", "return\na;\n")).toBe(false);
+    expect(equivalent("return a;\n", "return /*\n*/ a;\n")).toBe(false);
+});
+test("comment-like text inside regular expressions is code", () => {
+    expect(equivalent("const r = /[//]/; x = 1;\n", "const r = /[//]/; x = 2;\n")).toBe(false);
+    expect(equivalent("if (a) /\\/*/.test(b); c = 1;\n", "if (a) /\\/*/.test(b); c = 2;\n")).toBe(false);
+    expect(equivalent("const q = a / b; // ratio\n", "const q = a / b; // the ratio\n")).toBe(true);
+    expect(equivalent("return /a/; // one\n", "return /a/; // two\n")).toBe(true);
+    // A `for await` header closes like a `for` header.
+    expect(equivalent("for await (const x of xs) /[//]/.test(x); c = 1;\n", "for await (const x of xs) /[//]/.test(x); c = 2;\n")).toBe(false);
+});
+test("a / after a line break is never equivalent", () => {
+    const loop = (body) => `a: for (;;) {\n${body}\n}\n`;
+    // Automatic semicolon insertion decides whether these start a regular
+    // expression.
+    expect(equivalent(loop("break\n/[//]/.test(x); c = 1;"), loop("break\n/[//]/.test(x); c = 2;"))).toBe(false);
+    expect(equivalent(loop("break a\n/[//]/.test(x); c = 1;"), loop("break a\n/[//]/.test(x); c = 2;"))).toBe(false);
+    expect(equivalent("type A = B\n/[//]/.test(x); c = 1;\n", "type A = B\n/[//]/.test(x); c = 2;\n")).toBe(false);
+    // A comment spanning lines separates them too; JavaScript keeps its comments as tokens.
+    expect(equivalent("x\n/* a\n */ /[//]/.test(y); c = 1;\n", "x\n/* a\n */ /[//]/.test(y); c = 2;\n", "/src/a.js")).toBe(false);
+    // A / on the line of the token before it still divides.
+    expect(equivalent(loop("continue\nx / 2; // one"), loop("continue\nx / 2; // two"))).toBe(true);
+});
+test("code units outside ASCII are equivalent only inside strings, templates and comments", () => {
+    expect(equivalent('const s = "é"; // one\n', 'const s = "é"; // two\n')).toBe(true);
+    expect(equivalent("const s = `é${a}`; // one\n", "const s = `é${a}`; // two\n")).toBe(true);
+    expect(equivalent("const a = 1; // é\n", "const a = 1; // è\n")).toBe(true);
+    expect(equivalent("const café = 1; // one\n", "const café = 1; // two\n")).toBe(false);
+    expect(equivalent("ä: for (;;) { break ä\n/[//]/.test(x); c = 1; }\n", "ä: for (;;) { break ä\n/[//]/.test(x); c = 2; }\n")).toBe(false);
+    expect(equivalent("const r = /é/; // one\n", "const r = /é/; // two\n")).toBe(false);
+});
+test("whitespace outside ASCII is never equivalent", () => {
+    expect(equivalent("return\u3000/[//]/.test(x); c = 1;\n", "return\u3000/[//]/.test(x); c = 2;\n")).toBe(false);
+    expect(equivalent("const a = 1;\u00a0// one\n", "const a = 1;\u00a0// two\n")).toBe(false);
+});
+test("U+2028 and U+2029 end a line comment, so their files are never equivalent", () => {
+    expect(equivalent("// a\u2028c = 1;\n", "// a\u2028c = 2;\n")).toBe(false);
+    expect(equivalent("/* a\u2029*/ c = 1;\n", "/* b\u2029*/ c = 1;\n")).toBe(false);
+});
+test("comments that can affect compilation are kept", () => {
+    expect(equivalent("/** @type {number} */ let a;\n", "/** @type {string} */ let a;\n")).toBe(false);
+    expect(equivalent("// @ts-ignore\nf();\n", "f();\n")).toBe(false);
+    expect(equivalent('/// <reference path="a.d.ts" />\n', "\n")).toBe(false);
+    // Every comment is kept in JavaScript, whose types come from JSDoc.
+    expect(equivalent("let a; // one\n", "let a; // two\n", "/src/a.js")).toBe(false);
+});
+test("text the scanner cannot classify is never equivalent", () => {
+    expect(equivalent("x = {} / 2; // a\n", "x = {} / 2; // b\n")).toBe(false);
+    expect(equivalent("++/a/.lastIndex; // a\n", "++/a/.lastIndex; // b\n")).toBe(false);
+    expect(equivalent("const \\u0061 = 1; // a\n", "const \\u0061 = 1; // b\n")).toBe(false);
+    expect(equivalent("const a = <b/>; // a\n", "const a = <b/>; // b\n", "/src/a.tsx")).toBe(false);
+    expect(equivalent('const s = "open\n', 'const s = "open // \n')).toBe(false);
+});
+//# sourceMappingURL=token-equivalence.test.js.map

package/dist/frontend/token-equivalence.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"token-equivalence.test.js","sourceRoot":"","sources":["../../src/frontend/token-equivalence.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AACtC,OAAO,EAAE,qBAAqB,EAAE,MAAM,wBAAwB,CAAC;AAE/D,MAAM,UAAU,GAAG,CAAC,QAAgB,EAAE,OAAe,EAAE,IAAI,GAAG,WAAW,EAAE,EAAE,CAC3E,qBAAqB,CAAC,IAAI,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;AAEjD,IAAI,CAAC,0CAA0C,EAAE,GAAG,EAAE;IACpD,MAAM,CAAC,UAAU,CAAC,gBAAgB,EAAE,uBAAuB,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACzE,MAAM,CAAC,UAAU,CAAC,WAAW,EAAE,0BAA0B,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACvE,MAAM,CAAC,UAAU,CAAC,uBAAuB,EAAE,yCAAyC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACpG,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,0EAA0E,EAAE,GAAG,EAAE;IACpF,MAAM,CAAC,UAAU,CAAC,gBAAgB,EAAE,gBAAgB,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACnE,MAAM,CAAC,UAAU,CAAC,uBAAuB,EAAE,uBAAuB,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACjF,MAAM,CAAC,UAAU,CAAC,kCAAkC,EAAE,kCAAkC,CAAC,CAAC,CAAC,IAAI,CAC7F,KAAK,CACN,CAAC;IACF,uDAAuD;IACvD,MAAM,CAAC,UAAU,CAAC,aAAa,EAAE,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC9D,MAAM,CAAC,UAAU,CAAC,aAAa,EAAE,oBAAoB,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;AACtE,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,sDAAsD,EAAE,GAAG,EAAE;IAChE,MAAM,CAAC,UAAU,CAAC,4BAA4B,EAAE,4BAA4B,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC3F,MAAM,CAAC,UAAU,CAAC,iCAAiC,EAAE,iCAAiC,CAAC,CAAC,CAAC,IAAI,CAC3F,KAAK,CACN,CAAC;IACF,MAAM,CAAC,UAAU,CAAC,6BAA6B,EAAE,iCAAiC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAChG,MAAM,CAAC,UAAU,CAAC,sBAAsB,EAAE,sBAAsB,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC9E,mDAAmD;IACnD,MAAM,CACJ,UAAU,CACR,oDAAoD,EACpD,oDAAoD,CACrD,CACF,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;AAChB,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,4CAA4C,EAAE,GAAG,EAAE;IACtD,MAAM,IAAI,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC,kBAAkB,IAAI,OAAO,CAAC;IAC7D,sEAAsE;IACtE,cAAc;IACd,MAAM,CACJ,UAAU,CAAC,IAAI,CAAC,+BAA+B,CAAC,EAAE,IAAI,CAAC,+BAA+B,CAAC,CAAC,CACzF,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACd,MAAM,CACJ,UAAU,CAAC,IAAI,CAAC,iCAAiC,CAAC,EAAE,IAAI,CAAC,iCAAiC,CAAC,CAAC,CAC7F,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACd,MAAM,CACJ,UAAU,CAAC,sCAAsC,EAAE,sCAAsC,CAAC,CAC3F,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACd,wFAAwF;IACxF,MAAM,CACJ,UAAU,CACR,uCAAuC,EACvC,uCAAuC,EACvC,WAAW,CACZ,CACF,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACd,wDAAwD;IACxD,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,yBAAyB,CAAC,EAAE,IAAI,CAAC,yBAAyB,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAClG,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,qFAAqF,EAAE,GAAG,EAAE;IAC/F,MAAM,CAAC,UAAU,CAAC,yBAAyB,EAAE,yBAAyB,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACpF,MAAM,CAAC,UAAU,CAAC,6BAA6B,EAAE,6BAA6B,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC5F,MAAM,CAAC,UAAU,CAAC,qBAAqB,EAAE,qBAAqB,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC5E,MAAM,CAAC,UAAU,CAAC,0BAA0B,EAAE,0BAA0B,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACvF,MAAM,CACJ,UAAU,CACR,mDAAmD,EACnD,mDAAmD,CACpD,CACF,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACd,MAAM,CAAC,UAAU,CAAC,yBAAyB,EAAE,yBAAyB,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;AACvF,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,8CAA8C,EAAE,GAAG,EAAE;IACxD,MAAM,CACJ,UAAU,CAAC,sCAAsC,EAAE,sCAAsC,CAAC,CAC3F,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACd,MAAM,CAAC,UAAU,CAAC,4BAA4B,EAAE,4BAA4B,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;AAC7F,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,2EAA2E,EAAE,GAAG,EAAE;IACrF,MAAM,CAAC,UAAU,CAAC,oBAAoB,EAAE,oBAAoB,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC3E,MAAM,CAAC,UAAU,CAAC,uBAAuB,EAAE,uBAAuB,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;AACnF,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,+CAA+C,EAAE,GAAG,EAAE;IACzD,MAAM,CAAC,UAAU,CAAC,gCAAgC,EAAE,gCAAgC,CAAC,CAAC,CAAC,IAAI,CACzF,KAAK,CACN,CAAC;IACF,MAAM,CAAC,UAAU,CAAC,uBAAuB,EAAE,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAClE,MAAM,CAAC,UAAU,CAAC,mCAAmC,EAAE,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC1E,oEAAoE;IACpE,MAAM,CAAC,UAAU,CAAC,iBAAiB,EAAE,iBAAiB,EAAE,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;AACpF,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,sDAAsD,EAAE,GAAG,EAAE;IAChE,MAAM,CAAC,UAAU,CAAC,oBAAoB,EAAE,oBAAoB,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC3E,MAAM,CAAC,UAAU,CAAC,yBAAyB,EAAE,yBAAyB,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACrF,MAAM,CAAC,UAAU,CAAC,2BAA2B,EAAE,2BAA2B,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACzF,MAAM,CAAC,UAAU,CAAC,wBAAwB,EAAE,wBAAwB,EAAE,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACjG,MAAM,CAAC,UAAU,CAAC,mBAAmB,EAAE,uBAAuB,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;AAC/E,CAAC,CAAC,CAAC"}

package/dist/frontend/ts7/ast-node.d.ts

@@ -1,6 +1,8 @@
 import { AstWireFile, type AstFileReference, type AstNodeHandle } from "./ast-wire.js";
 import type { SourceFile } from "./ast-types.js";
 import { SyntaxKind, NodeFlags } from "./enums.js";
+/** Installs the observer of raw source text reads (sourceTextObserver). */
+export declare function observeSourceText(observer: ((fileName: string) => void) | undefined): void;
 /** A list of child nodes with the list's own position, the shape of tsc-ts's
  * NodeList. The file keeps the nodes array, not this object: each read of a
  * list field returns a new AstNodeList over the same array, so `nodes` keeps
@@ -25,6 +27,17 @@ export declare class AstModifierList<T extends AstNode = AstNode> extends AstNod
  * list.
  * Parent access is lazy, so resolving a checker handle near the bottom
  * of a deep tree never recursively constructs its ancestors. */
+export interface AstFileOptions {
+    /** Answer the reference an assignment, a `++`/`--` update or a for-in/of
+     * head writes without the parentheses and non-null assertions around it.
+     * TypeScript accepts both around a target (`(x) = 1`, `a[i]! += 1`) and
+     * both are erased at run time. With this option the writer's `left`,
+     * `operand` or `initializer` is the reference itself and the reference's
+     * `parent` is the writer, so every reader of a write target sees one
+     * shape. Positions stay the source's: the reference keeps its own span.
+     * Files read for other purposes keep TypeScript's exact tree. */
+    writeTargets?: boolean;
+}
 export declare class AstFile {
     private readonly materialized?;
     readonly wire: AstWireFile;
@@ -36,7 +49,12 @@ export declare class AstFile {
     private readonly strings;
     private lines;
     private childIndices;
-    constructor(bytes: Uint8Array, materialized?: (() => void) | undefined);
+    /** The root source file's name (AstNode.fileName). */
+    private rootFileName;
+    /** Whether nodes answer write targets without their wrappers (see
+     * AstFileOptions.writeTargets). */
+    readonly writeTargets: boolean;
+    constructor(bytes: Uint8Array, materialized?: (() => void) | undefined, options?: AstFileOptions);
     /** Checker factories also return AST fragments. Only source-file
      * consumers require this kind check; a type or signature root is valid
      * for typeToTypeNode/signatureToSignatureDeclaration. */
@@ -46,16 +64,21 @@ export declare class AstFile {
     modifierList(index: number): AstModifierList;
     private listNodes;
     namedChild(node: AstNode, name: string): number;
+    /** The child in wire slot `order` (astChildOrder), or 0 when the slot is
+     * negative or empty. */
+    namedChildAt(node: AstNode, order: number): number;
     resolve(handle: string): AstNode;
     resolveHandle(parsed: AstNodeHandle): AstNode;
     fileReferences(offset: number): AstFileReference[];
     nodeReferences(offset: number): AstNode[];
     stringReferences(offset: number): string[];
+    /** Reports a read of this file's raw text or line positions. */
+    noteSourceText(): void;
+    /** The file name of the source file node at `index`; the root's is
+     * read once. */
+    sourceFileName(index: number): string;
     lineStarts(): number[];
 }
-/** Concrete native layout shared by every syntax kind. Kind-specific
- * properties are views over the wire; they never copy identity-bearing
- * nodes into structural records. */
 export declare class AstNode {
     readonly file: AstFile;
     readonly index: number;
@@ -72,6 +95,10 @@ export declare class AstNode {
     get text(): string | undefined;
     get rawText(): string | undefined;
     childNode(name: string): AstNode | undefined;
+    /** childNode by wire slot, as the generated getters select it. */
+    childNodeAt(order: number): AstNode | undefined;
+    childListAt(order: number): AstNodeList | undefined;
+    childAt(order: number): AstNode | AstNodeList | undefined;
     childList(name: string): AstNodeList | undefined;
     child(name: string): AstNode | AstNodeList | undefined;
     /** Append semantic child handles without giving a traversal worklist an
@@ -79,6 +106,9 @@ export declare class AstNode {
      * checked, identity-preserving cache used by forEachChild. */
     appendChildIndices(indices: number[]): void;
     forEachChild<T>(visitNode: (node: AstNode) => T, visitList?: (nodes: AstNodeList) => T): T | undefined;
+    /** forEachChild through the sibling and parent links. */
+    private forEachLinkedChild;
+    private visitChildList;
     get jsDoc(): AstNode[] | undefined;
     getSourceFile(): SourceFile;
     getStart(sourceFile?: AstNode, includeJsDocComment?: boolean): number;
@@ -108,6 +138,9 @@ export declare class AstNode {
     get modifiers(): AstModifierList | undefined;
     get body(): AstNode | undefined;
     get questionToken(): AstNode | undefined;
+    get initializer(): AstNode | undefined;
+    get left(): AstNode | undefined;
+    get operand(): AstNode | undefined;
     get argument(): AstNode | undefined;
     get argumentExpression(): AstNode | undefined;
     get arguments(): AstNodeList | undefined;
@@ -150,10 +183,8 @@ export declare class AstNode {
     get importClause(): AstNode | undefined;
     get incrementor(): AstNode | undefined;
     get indexType(): AstNode | undefined;
-    get initializer(): AstNode | undefined;
     get jsdocPropertyTags(): AstNode | undefined;
     get label(): AstNode | undefined;
-    get left(): AstNode | undefined;
     get literal(): AstNode | undefined;
     get members(): AstNodeList | undefined;
     get moduleReference(): AstNode | undefined;
@@ -167,7 +198,6 @@ export declare class AstNode {
     get objectType(): AstNode | undefined;
     get openingElement(): AstNode | undefined;
     get openingFragment(): AstNode | undefined;
-    get operand(): AstNode | undefined;
     get operatorToken(): AstNode | undefined;
     get parameterName(): AstNode | undefined;
     get parameters(): AstNodeList | undefined;
@@ -201,6 +231,12 @@ export declare class AstNode {
     get variableDeclaration(): AstNode | undefined;
     get whenFalse(): AstNode | undefined;
     get whenTrue(): AstNode | undefined;
+    private bodySlot;
+    private initializerSlot;
+    private leftSlot;
+    private modifiersSlot;
+    private operandSlot;
+    private questionTokenSlot;
     get fileName(): string;
     get path(): string;
     get languageVariant(): number;