@flint.fyi/ts 0.15.0 → 0.18.0

package/lib/collectReferencedFilePaths.js

@@ -1,22 +0,0 @@
-import * as path from "node:path";
-import * as ts from "typescript";
-export function collectReferencedFilePaths(program, sourceFile) {
-    // TODO: Also handle inline import()s
-    // https://github.com/flint-fyi/flint/issues/115
-    return sourceFile.statements
-        .filter(isImportDeclarationWithStringLiteral)
-        .map((statement) => {
-        const resolved = ts.resolveModuleName(statement.moduleSpecifier.text, sourceFile.fileName, program.getCompilerOptions(), 
-        // TODO: Eventually, the file system should be abstracted
-        // https://github.com/flint-fyi/flint/issues/73
-        ts.sys);
-        return (resolved.resolvedModule?.isExternalLibraryImport === false &&
-            path.relative(process.cwd(), resolved.resolvedModule.resolvedFileName));
-    })
-        .filter((resolvedFileName) => resolvedFileName !== false);
-}
-function isImportDeclarationWithStringLiteral(statement) {
-    return (ts.isImportDeclaration(statement) &&
-        ts.isStringLiteral(statement.moduleSpecifier));
-}
-//# sourceMappingURL=collectReferencedFilePaths.js.map

package/lib/convertTypeScriptDiagnosticToLanguageFileDiagnostic.d.ts

@@ -1,14 +0,0 @@
-import { LanguageFileDiagnostic, SourceFileWithLineMapAndFileName } from "@flint.fyi/core";
-import ts from "typescript";
-export interface TSBasedDiagnostic extends TSBasedDiagnosticRelatedInformation {
-    relatedInformation?: TSBasedDiagnosticRelatedInformation[];
-}
-export interface TSBasedDiagnosticRelatedInformation {
-    code: number;
-    file: SourceFileWithLineMapAndFileName | undefined;
-    length: number | undefined;
-    messageText: string | ts.DiagnosticMessageChain;
-    start: number | undefined;
-}
-export declare function convertTypeScriptDiagnosticToLanguageFileDiagnostic(diagnostic: TSBasedDiagnostic): LanguageFileDiagnostic;
-//# sourceMappingURL=convertTypeScriptDiagnosticToLanguageFileDiagnostic.d.ts.map

package/lib/convertTypeScriptDiagnosticToLanguageFileDiagnostic.js

@@ -1,129 +0,0 @@
-// Adapted from: https://github.com/ArnaudBarre/tsl/blob/742a6f1a956705239f2149f856b1f572ade79919/src/formatDiagnostic.ts
-// ...which notes:
-// Adapted from: https://github.com/microsoft/TypeScript/blob/78c16795cdee70b9d9f0f248b6dbb6ba50994a59/src/compiler/program.ts#L680-L811
-// eslint-disable-next-line @eslint-community/eslint-comments/disable-enable-pair
-/* eslint-disable @typescript-eslint/no-non-null-assertion */
-import { getColumnAndLineOfPosition, getPositionOfColumnAndLine, } from "@flint.fyi/core";
-import ts, { flattenDiagnosticMessageText } from "typescript";
-export function convertTypeScriptDiagnosticToLanguageFileDiagnostic(diagnostic) {
-    return {
-        code: `TS${diagnostic.code}`,
-        text: formatDiagnostic(diagnostic),
-    };
-}
-function color(text, formatStyle) {
-    return formatStyle + text + resetEscapeSequence;
-}
-function formatDiagnostic(diagnostic) {
-    let output = "";
-    if (diagnostic.file !== undefined) {
-        output += formatLocation(diagnostic.file, diagnostic.start);
-        output += " - ";
-    }
-    output += color(`TS${diagnostic.code}`, COLOR.Grey);
-    output += ": ";
-    output += ts.flattenDiagnosticMessageText(diagnostic.messageText, "\n");
-    if (diagnostic.file !== undefined) {
-        output += "\n";
-        output += formatCodeSpan(diagnostic.file, diagnostic.start, diagnostic.length, "", COLOR.Red);
-    }
-    if (diagnostic.relatedInformation) {
-        output += "\n";
-        for (const { file, length, messageText, start, } of diagnostic.relatedInformation) {
-            const indent = "  ";
-            if (file) {
-                output += "\n";
-                output += " " + formatLocation(file, start);
-                output += formatCodeSpan(file, start, length, indent, COLOR.Cyan);
-            }
-            output += "\n";
-            output += indent + flattenDiagnosticMessageText(messageText, "\n");
-        }
-    }
-    return output;
-}
-const gutterStyleSequence = "\u001b[7m";
-const ellipsis = "...";
-const gutterSeparator = " ";
-const resetEscapeSequence = "\u001b[0m";
-const COLOR = {
-    Blue: "\u001b[94m",
-    Cyan: "\u001b[96m",
-    Grey: "\u001b[90m",
-    Red: "\u001b[91m",
-    Yellow: "\u001b[93m",
-};
-function displayFilename(name) {
-    if (name.startsWith("./")) {
-        return name.slice(2);
-    }
-    return name.slice(process.cwd().length + 1);
-}
-function formatCodeSpan(file, start, length, indent, squiggleColor) {
-    const { column: firstLineChar, line: firstLine } = getColumnAndLineOfPosition(file, start);
-    const { column: lastLineChar, line: lastLine } = getColumnAndLineOfPosition(file, start + length);
-    const lastLineInFile = getColumnAndLineOfPosition(file, file.text.length).line;
-    const hasMoreThanFiveLines = lastLine - firstLine >= 4;
-    // eslint-disable-next-line @typescript-eslint/restrict-plus-operands
-    let gutterWidth = (lastLine + 1 + "").length;
-    if (hasMoreThanFiveLines) {
-        gutterWidth = Math.max(ellipsis.length, gutterWidth);
-    }
-    let context = "";
-    for (let i = firstLine; i <= lastLine; i++) {
-        context += "\n";
-        if (hasMoreThanFiveLines && firstLine + 1 < i && i < lastLine - 1) {
-            context +=
-                indent +
-                    color(ellipsis.padStart(gutterWidth), gutterStyleSequence) +
-                    gutterSeparator +
-                    "\n";
-            i = lastLine - 1;
-        }
-        const lineStart = getPositionOfColumnAndLine(file, { column: 0, line: i });
-        const lineEnd = i < lastLineInFile
-            ? getPositionOfColumnAndLine(file, { column: 0, line: i + 1 })
-            : file.text.length;
-        let lineContent = file.text.slice(lineStart, lineEnd);
-        lineContent = lineContent.trimEnd();
-        lineContent = lineContent.replace(/\t/g, " ");
-        context +=
-            indent +
-                // eslint-disable-next-line @typescript-eslint/restrict-plus-operands
-                color((i + 1 + "").padStart(gutterWidth), gutterStyleSequence) +
-                gutterSeparator;
-        context += lineContent + "\n";
-        context +=
-            indent +
-                color("".padStart(gutterWidth), gutterStyleSequence) +
-                gutterSeparator;
-        context += squiggleColor;
-        if (i === firstLine) {
-            const lastCharForLine = i === lastLine ? lastLineChar : undefined;
-            context += lineContent.slice(0, firstLineChar).replace(/\S/g, " ");
-            context += lineContent
-                .slice(firstLineChar, lastCharForLine)
-                .replace(/./g, "~");
-        }
-        else if (i === lastLine) {
-            context += lineContent.slice(0, lastLineChar).replace(/./g, "~");
-        }
-        else {
-            context += lineContent.replace(/./g, "~");
-        }
-        context += resetEscapeSequence;
-    }
-    return context;
-}
-function formatLocation(file, start) {
-    const { column, line } = getColumnAndLineOfPosition(file, start);
-    const relativeFileName = displayFilename(file.fileName);
-    let output = "";
-    output += color(relativeFileName, COLOR.Cyan);
-    output += ":";
-    output += color(`${line + 1}`, COLOR.Yellow);
-    output += ":";
-    output += color(`${column + 1}`, COLOR.Yellow);
-    return output;
-}
-//# sourceMappingURL=convertTypeScriptDiagnosticToLanguageFileDiagnostic.js.map

package/lib/createTypeScriptFileFromProgram.d.ts

@@ -1,6 +0,0 @@
-import { LanguageFileCacheImpacts, LanguageFileDefinition } from "@flint.fyi/core";
-import * as ts from "typescript";
-export declare const NodeSyntaxKinds: typeof ts.SyntaxKind;
-export declare function collectTypeScriptFileCacheImpacts(program: ts.Program, sourceFile: ts.SourceFile): LanguageFileCacheImpacts;
-export declare function createTypeScriptFileFromProgram(program: ts.Program, sourceFile: ts.SourceFile): LanguageFileDefinition;
-//# sourceMappingURL=createTypeScriptFileFromProgram.d.ts.map

package/lib/createTypeScriptFileFromProgram.js

@@ -1,58 +0,0 @@
-import * as ts from "typescript";
-import { collectReferencedFilePaths } from "./collectReferencedFilePaths.js";
-import { convertTypeScriptDiagnosticToLanguageFileDiagnostic } from "./convertTypeScriptDiagnosticToLanguageFileDiagnostic.js";
-import { getFirstEnumValues } from "./getFirstEnumValues.js";
-import { normalizeRange } from "./normalizeRange.js";
-export const NodeSyntaxKinds = getFirstEnumValues(ts.SyntaxKind);
-export function collectTypeScriptFileCacheImpacts(program, sourceFile) {
-    return {
-        dependencies: [
-            // TODO: Add support for multi-TSConfig workspaces.
-            // https://github.com/flint-fyi/flint/issues/64 & more.
-            "tsconfig.json",
-            ...collectReferencedFilePaths(program, sourceFile),
-        ],
-    };
-}
-export function createTypeScriptFileFromProgram(program, sourceFile) {
-    return {
-        cache: collectTypeScriptFileCacheImpacts(program, sourceFile),
-        getDiagnostics() {
-            return ts
-                .getPreEmitDiagnostics(program, sourceFile)
-                .map(convertTypeScriptDiagnosticToLanguageFileDiagnostic);
-        },
-        async runRule(rule, options) {
-            const reports = [];
-            const context = {
-                program,
-                report: (report) => {
-                    reports.push({
-                        ...report,
-                        fix: report.fix && !Array.isArray(report.fix)
-                            ? [report.fix]
-                            : report.fix,
-                        message: rule.messages[report.message],
-                        range: normalizeRange(report.range, sourceFile),
-                    });
-                },
-                sourceFile,
-                typeChecker: program.getTypeChecker(),
-            };
-            const runtime = await rule.setup(context, options);
-            if (runtime?.visitors) {
-                const typeChecker = program.getTypeChecker();
-                const fileServices = { options, program, sourceFile, typeChecker };
-                const { visitors } = runtime;
-                const visit = (node) => {
-                    visitors[NodeSyntaxKinds[node.kind]]?.(node, fileServices);
-                    node.forEachChild(visit);
-                };
-                visit(sourceFile);
-            }
-            await runtime?.teardown?.();
-            return reports;
-        },
-    };
-}
-//# sourceMappingURL=createTypeScriptFileFromProgram.js.map

package/lib/createTypeScriptFileFromProjectService.d.ts

@@ -1,7 +0,0 @@
-import * as ts from "typescript";
-export declare function createTypeScriptFileFromProjectService(filePathAbsolute: string, program: ts.Program, service: ts.server.ProjectService): {
-    program: ts.Program;
-    sourceFile: ts.SourceFile;
-    [Symbol.dispose](): void;
-};
-//# sourceMappingURL=createTypeScriptFileFromProjectService.d.ts.map

package/lib/createTypeScriptFileFromProjectService.js

@@ -1,14 +0,0 @@
-export function createTypeScriptFileFromProjectService(filePathAbsolute, program, service) {
-    const sourceFile = program.getSourceFile(filePathAbsolute);
-    if (!sourceFile) {
-        throw new Error(`Could not retrieve source file for: ${filePathAbsolute}`);
-    }
-    return {
-        program,
-        sourceFile,
-        [Symbol.dispose]() {
-            service.closeClientFile(filePathAbsolute);
-        },
-    };
-}
-//# sourceMappingURL=createTypeScriptFileFromProjectService.js.map

package/lib/directives/parseDirectivesFromTypeScriptFile.d.ts

@@ -1,13 +0,0 @@
-import { NormalizedReportRangeObject } from "@flint.fyi/core";
-import ts from "typescript";
-export interface ExtractedDirective {
-    range: NormalizedReportRangeObject;
-    selection: string;
-    type: string;
-}
-export declare function extractDirectivesFromTypeScriptFile(sourceFile: ts.SourceFile): ExtractedDirective[];
-export declare function parseDirectivesFromTypeScriptFile(sourceFile: ts.SourceFile): {
-    directives: import("@flint.fyi/core").CommentDirective[];
-    reports: import("@flint.fyi/core").FileReport[];
-};
-//# sourceMappingURL=parseDirectivesFromTypeScriptFile.d.ts.map

package/lib/directives/parseDirectivesFromTypeScriptFile.js

@@ -1,29 +0,0 @@
-import { DirectivesCollector, } from "@flint.fyi/core";
-import * as tsutils from "ts-api-utils";
-import { normalizeRange } from "../normalizeRange.js";
-export function extractDirectivesFromTypeScriptFile(sourceFile) {
-    const directives = [];
-    tsutils.forEachComment(sourceFile, (fullText, sourceRange) => {
-        const commentText = fullText.slice(sourceRange.pos, sourceRange.end);
-        const match = /^\/\/\s*flint-(\S+)(?:\s+(.+))?/.exec(commentText);
-        if (!match) {
-            return;
-        }
-        const commentRange = {
-            begin: sourceRange.pos,
-            end: sourceRange.end,
-        };
-        const range = normalizeRange(commentRange, sourceFile);
-        const [type, selection] = match.slice(1);
-        directives.push({ range, selection, type });
-    });
-    return directives;
-}
-export function parseDirectivesFromTypeScriptFile(sourceFile) {
-    const collector = new DirectivesCollector(sourceFile.statements.at(0)?.getStart(sourceFile) ?? sourceFile.text.length);
-    for (const { range, selection, type } of extractDirectivesFromTypeScriptFile(sourceFile)) {
-        collector.add(range, selection, type);
-    }
-    return collector.collect();
-}
-//# sourceMappingURL=parseDirectivesFromTypeScriptFile.js.map

package/lib/directives/parseDirectivesFromTypeScriptFile.test.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=parseDirectivesFromTypeScriptFile.test.d.ts.map

package/lib/directives/parseDirectivesFromTypeScriptFile.test.js

@@ -1,92 +0,0 @@
-import ts from "typescript";
-import { describe, expect, it } from "vitest";
-import { parseDirectivesFromTypeScriptFile } from "./parseDirectivesFromTypeScriptFile.js";
-describe(parseDirectivesFromTypeScriptFile, () => {
-    it("returns empty arrays when there are no directives", () => {
-        const sourceFile = ts.createSourceFile("test.ts", "// unrelated", ts.ScriptTarget.ESNext, true);
-        const actual = parseDirectivesFromTypeScriptFile(sourceFile);
-        expect(actual).toEqual({
-            directives: [],
-            reports: [],
-        });
-    });
-    it("returns parsed directives when there are comment directives", () => {
-        const sourceFile = ts.createSourceFile("test.ts", `
-                // flint-disable-file a
-                // flint-disable-next-line b
-                // flint-invalid
-            `, ts.ScriptTarget.ESNext, true);
-        const actual = parseDirectivesFromTypeScriptFile(sourceFile);
-        expect(actual).toMatchInlineSnapshot(`
-			{
-			  "directives": [
-			    {
-			      "range": {
-			        "begin": {
-			          "column": 16,
-			          "line": 1,
-			          "raw": 17,
-			        },
-			        "end": {
-			          "column": 39,
-			          "line": 1,
-			          "raw": 40,
-			        },
-			      },
-			      "selections": [
-			        "a",
-			      ],
-			      "type": "disable-file",
-			    },
-			    {
-			      "range": {
-			        "begin": {
-			          "column": 16,
-			          "line": 2,
-			          "raw": 57,
-			        },
-			        "end": {
-			          "column": 44,
-			          "line": 2,
-			          "raw": 85,
-			        },
-			      },
-			      "selections": [
-			        "b",
-			      ],
-			      "type": "disable-next-line",
-			    },
-			  ],
-			  "reports": [
-			    {
-			      "about": {
-			        "id": "commentDirectiveUnknown",
-			      },
-			      "message": {
-			        "primary": "Unknown comment directive type: "invalid".",
-			        "secondary": [
-			          "TODO",
-			        ],
-			        "suggestions": [
-			          "TODO",
-			        ],
-			      },
-			      "range": {
-			        "begin": {
-			          "column": 16,
-			          "line": 3,
-			          "raw": 102,
-			        },
-			        "end": {
-			          "column": 32,
-			          "line": 3,
-			          "raw": 118,
-			        },
-			      },
-			    },
-			  ],
-			}
-		`);
-    });
-});
-//# sourceMappingURL=parseDirectivesFromTypeScriptFile.test.js.map

package/lib/getFirstEnumValues.d.ts

@@ -1,36 +0,0 @@
-/**
- * Removes TypeScript enum values that alias earlier values.
- * @param original Any TypeScript enum with numeric values.
- * @returns A version of the enum with only the first occurrence of each value.
- * @example
- * Given the following enum:
- * ```ts
- * enum Example {
- *   A = 1,
- *   B = 2,
- *   C = A
- * }
- * ```
- * Its original value looks like:
- * ```ts
- * {
- *   1: 'C', // <-- Points to 'C', the alias of 'A'
- *   2: 'B',
- *   A: 1,
- *   B: 2,
- *   C: 1,
- * }
- * ```
- * Calling `getFirstEnumValues(Example)` would return:
- * ```ts
- * {
- *   1: 'A', // <-- Corrected to the original 'A'
- *   2: 'B',
- *   A: 1,
- *   B: 2,
- *   C: 1,
- * }
- * ```
- */
-export declare function getFirstEnumValues<Keys extends string, Values extends number, Original extends Record<Keys | Values, Keys | Values>>(original: Original): Original;
-//# sourceMappingURL=getFirstEnumValues.d.ts.map

package/lib/getFirstEnumValues.js

@@ -1,52 +0,0 @@
-/**
- * Removes TypeScript enum values that alias earlier values.
- * @param original Any TypeScript enum with numeric values.
- * @returns A version of the enum with only the first occurrence of each value.
- * @example
- * Given the following enum:
- * ```ts
- * enum Example {
- *   A = 1,
- *   B = 2,
- *   C = A
- * }
- * ```
- * Its original value looks like:
- * ```ts
- * {
- *   1: 'C', // <-- Points to 'C', the alias of 'A'
- *   2: 'B',
- *   A: 1,
- *   B: 2,
- *   C: 1,
- * }
- * ```
- * Calling `getFirstEnumValues(Example)` would return:
- * ```ts
- * {
- *   1: 'A', // <-- Corrected to the original 'A'
- *   2: 'B',
- *   A: 1,
- *   B: 2,
- *   C: 1,
- * }
- * ```
- */
-export function getFirstEnumValues(original) {
-    const result = {};
-    for (const key in original) {
-        if (typeof original[key] !== "number") {
-            continue;
-        }
-        if (!(key in result)) {
-            result[key] = original[key];
-        }
-        if (!(original[key] in result)) {
-            // 🤷 enums are tricky to type.
-            // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-explicit-any
-            result[original[key]] = key;
-        }
-    }
-    return result;
-}
-//# sourceMappingURL=getFirstEnumValues.js.map

package/lib/getFirstEnumValues.test.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=getFirstEnumValues.test.d.ts.map

package/lib/getFirstEnumValues.test.js

@@ -1,46 +0,0 @@
-import { describe, expect, it } from "vitest";
-import { getFirstEnumValues } from "./getFirstEnumValues.js";
-describe("getFirstEnumValues", () => {
-    it("returns an empty object when given an empty enum", () => {
-        let Empty;
-        (function (Empty) {
-        })(Empty || (Empty = {}));
-        const result = getFirstEnumValues(Empty);
-        expect(result).toEqual({});
-    });
-    it("returns all original pairs when when given a non-repeating enum", () => {
-        let NonRepeating;
-        (function (NonRepeating) {
-            NonRepeating[NonRepeating["A"] = 1] = "A";
-            NonRepeating[NonRepeating["B"] = 2] = "B";
-            NonRepeating[NonRepeating["C"] = 3] = "C";
-        })(NonRepeating || (NonRepeating = {}));
-        const result = getFirstEnumValues(NonRepeating);
-        expect(result).toEqual({
-            1: "A",
-            2: "B",
-            3: "C",
-            A: 1,
-            B: 2,
-            C: 3,
-        });
-    });
-    it("returns the first key when when given a repeating-value enum", () => {
-        let Repeating;
-        (function (Repeating) {
-            Repeating[Repeating["A"] = 1] = "A";
-            Repeating[Repeating["B"] = 2] = "B";
-            // eslint-disable-next-line @typescript-eslint/prefer-literal-enum-member
-            Repeating[Repeating["C"] = 1] = "C";
-        })(Repeating || (Repeating = {}));
-        const result = getFirstEnumValues(Repeating);
-        expect(result).toEqual({
-            1: "A",
-            2: "B",
-            A: 1,
-            B: 2,
-            C: 1,
-        });
-    });
-});
-//# sourceMappingURL=getFirstEnumValues.test.js.map

package/lib/getTSNodeRange.d.ts

@@ -1,4 +0,0 @@
-import type * as ts from "typescript";
-import { CharacterReportRange } from "@flint.fyi/core";
-export declare function getTSNodeRange(node: ts.Node, sourceFile: ts.SourceFile): CharacterReportRange;
-//# sourceMappingURL=getTSNodeRange.d.ts.map

package/lib/getTSNodeRange.js

@@ -1,7 +0,0 @@
-export function getTSNodeRange(node, sourceFile) {
-    return {
-        begin: node.getStart(sourceFile),
-        end: node.getEnd(),
-    };
-}
-//# sourceMappingURL=getTSNodeRange.js.map

package/lib/language.d.ts

@@ -1,9 +0,0 @@
-import * as ts from "typescript";
-import { TSNodesByName } from "./nodes.js";
-export interface TypeScriptFileServices {
-    program: ts.Program;
-    sourceFile: ts.SourceFile;
-    typeChecker: ts.TypeChecker;
-}
-export declare const typescriptLanguage: import("@flint.fyi/core").Language<TSNodesByName, TypeScriptFileServices>;
-//# sourceMappingURL=language.d.ts.map

package/lib/language.js

@@ -1,20 +0,0 @@
-import { createLanguage } from "@flint.fyi/core";
-import { prepareTypeScriptBasedLanguage } from "./prepareTypeScriptBasedLanguage.js";
-import { prepareTypeScriptFile } from "./prepareTypeScriptFile.js";
-export const typescriptLanguage = createLanguage({
-    about: {
-        name: "TypeScript",
-    },
-    prepare: () => {
-        const lang = prepareTypeScriptBasedLanguage();
-        return {
-            prepareFromDisk(filePathAbsolute) {
-                return prepareTypeScriptFile(lang.createFromDisk(filePathAbsolute));
-            },
-            prepareFromVirtual(filePathAbsolute, sourceText) {
-                return prepareTypeScriptFile(lang.createFromVirtual(filePathAbsolute, sourceText));
-            },
-        };
-    },
-});
-//# sourceMappingURL=language.js.map