@flint.fyi/ts 0.14.6 → 0.18.0

package/lib/utils/isGlobalDeclarationOfName.js

@@ -1,35 +0,0 @@
-import * as ts from "typescript";
-import { declarationIncludesGlobal } from "./declarationIncludesGlobal.js";
-/**
- * TODO: Use a scope analyzer (#400).
- */
-export function isGlobalDeclarationOfName(node, name, typeChecker) {
-    const declarations = typeChecker.getSymbolAtLocation(node)?.getDeclarations();
-    if (!declarations) {
-        return false;
-    }
-    return declarations.every((declaration) => {
-        // Special case: a variable set to a known identifier. E.g.:
-        // const CustomFunction = Function;
-        if (ts.isVariableDeclaration(declaration) &&
-            declaration.initializer &&
-            declaration.initializer.kind === ts.SyntaxKind.Identifier) {
-            return isGlobalDeclarationOfName(declaration.initializer, name, typeChecker);
-        }
-        // Special case: a property of an interface
-        if (ts.isPropertySignature(declaration)) {
-            return isGlobalDeclarationOfName(declaration.parent, name, typeChecker);
-        }
-        return (isDeclarationOfName(declaration, name) &&
-            declarationIncludesGlobal(declaration));
-    });
-}
-function isDeclarationOfName(node, name) {
-    if (ts.isClassDeclaration(node) ||
-        ts.isFunctionDeclaration(node) ||
-        ts.isInterfaceDeclaration(node) ||
-        ts.isVariableDeclaration(node)) {
-        return node.name && ts.isIdentifier(node.name) && node.name.text === name;
-    }
-    return false;
-}

package/lib/utils/isGlobalVariable.d.ts

@@ -1,8 +0,0 @@
-import * as ts from "typescript";
-/**
- * Checks if a node is a reference to a global variable (e.g., Object, undefined, NaN).
- * Global variables are those declared in TypeScript's lib files or are global identifiers
- * like undefined which have symbols but no user-defined declarations.
- * TODO: Use a scope manager (#400).
- */
-export declare function isGlobalVariable(node: ts.Expression, typeChecker: ts.TypeChecker): boolean;

package/lib/utils/isGlobalVariable.js

@@ -1,21 +0,0 @@
-import { declarationsIncludeGlobal } from "./declarationsIncludeGlobal.js";
-/**
- * Checks if a node is a reference to a global variable (e.g., Object, undefined, NaN).
- * Global variables are those declared in TypeScript's lib files or are global identifiers
- * like undefined which have symbols but no user-defined declarations.
- * TODO: Use a scope manager (#400).
- */
-export function isGlobalVariable(node, typeChecker) {
-    const symbol = typeChecker.getSymbolAtLocation(node);
-    if (!symbol) {
-        return false;
-    }
-    const declarations = symbol.getDeclarations();
-    // undefined, NaN, Infinity etc. may have no declarations in some contexts
-    // but are still global identifiers. Check if they're global scope symbols.
-    if (!declarations?.length) {
-        // If there are no declarations, it's likely a built-in global like undefined
-        return true;
-    }
-    return declarationsIncludeGlobal(declarations);
-}

package/lib/utils/unwrapParentParenthesizedExpressions.d.ts

@@ -1,2 +0,0 @@
-import * as ts from "typescript";
-export declare function unwrapParenthesizedExpressionsParent(node: ts.Node): ts.Node;

package/lib/utils/unwrapParentParenthesizedExpressions.js

@@ -1,6 +0,0 @@
-import * as ts from "typescript";
-export function unwrapParenthesizedExpressionsParent(node) {
-    return ts.isParenthesizedExpression(node.parent)
-        ? unwrapParenthesizedExpressionsParent(node.parent)
-        : node.parent;
-}

package/lib/utils/unwrapParenthesizedExpression.d.ts

@@ -1,2 +0,0 @@
-import * as ts from "typescript";
-export declare function unwrapParenthesizedExpression(expression: ts.Expression): ts.Expression;

package/lib/utils/unwrapParenthesizedExpression.js

@@ -1,6 +0,0 @@
-import * as ts from "typescript";
-export function unwrapParenthesizedExpression(expression) {
-    return ts.isParenthesizedExpression(expression)
-        ? unwrapParenthesizedExpression(expression.expression)
-        : expression;
-}

package/src/collectReferencedFilePaths.ts

@@ -1,37 +0,0 @@
-import * as path from "node:path";
-import * as ts from "typescript";
-
-export function collectReferencedFilePaths(
-	program: ts.Program,
-	sourceFile: ts.SourceFile,
-) {
-	// TODO: Also handle inline import()s
-	// https://github.com/JoshuaKGoldberg/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/JoshuaKGoldberg/flint/issues/73
-				ts.sys,
-			);
-
-			return (
-				resolved.resolvedModule?.isExternalLibraryImport === false &&
-				path.relative(process.cwd(), resolved.resolvedModule.resolvedFileName)
-			);
-		})
-		.filter((resolvedFileName) => resolvedFileName !== false);
-}
-
-function isImportDeclarationWithStringLiteral(
-	statement: ts.Statement,
-): statement is ts.ImportDeclaration & { moduleSpecifier: ts.StringLiteral } {
-	return (
-		ts.isImportDeclaration(statement) &&
-		ts.isStringLiteral(statement.moduleSpecifier)
-	);
-}

package/src/createTypeScriptFileFromProgram.ts

@@ -1,86 +0,0 @@
-import {
-	LanguageFileDefinition,
-	NormalizedReport,
-	RuleReport,
-} from "@flint.fyi/core";
-import * as ts from "typescript";
-
-import { collectReferencedFilePaths } from "./collectReferencedFilePaths.js";
-import { formatDiagnostic } from "./formatDiagnostic.js";
-import { getFirstEnumValues } from "./getFirstEnumValues.js";
-import { normalizeRange } from "./normalizeRange.js";
-
-const NodeSyntaxKinds = getFirstEnumValues(ts.SyntaxKind);
-
-export function createTypeScriptFileFromProgram(
-	program: ts.Program,
-	sourceFile: ts.SourceFile,
-): LanguageFileDefinition {
-	return {
-		cache: {
-			dependencies: [
-				// TODO: Add support for multi-TSConfig workspaces.
-				// https://github.com/JoshuaKGoldberg/flint/issues/64 & more.
-				"tsconfig.json",
-
-				...collectReferencedFilePaths(program, sourceFile),
-			],
-		},
-		getDiagnostics() {
-			return ts
-				.getPreEmitDiagnostics(program, sourceFile)
-				.map((diagnostic) => ({
-					code: `TS${diagnostic.code}`,
-					text: formatDiagnostic({
-						...diagnostic,
-						// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-						length: diagnostic.length!,
-						message: ts.flattenDiagnosticMessageText(
-							diagnostic.messageText,
-							"\n",
-						),
-						name: `TS${diagnostic.code}`,
-						// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-						start: diagnostic.start!,
-					}),
-				}));
-		},
-		async runRule(rule, options) {
-			const reports: NormalizedReport[] = [];
-
-			const context = {
-				program,
-				report: (report: RuleReport) => {
-					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) {
-				return reports;
-			}
-
-			const { visitors } = runtime;
-			const visit = (node: ts.Node) => {
-				visitors[NodeSyntaxKinds[node.kind]]?.(node);
-
-				node.forEachChild(visit);
-			};
-
-			visit(sourceFile);
-
-			return reports;
-		},
-	};
-}

package/src/createTypeScriptFileFromProjectService.ts

@@ -1,31 +0,0 @@
-import { debugForFile } from "debug-for-file";
-import * as ts from "typescript";
-
-import { createTypeScriptFileFromProgram } from "./createTypeScriptFileFromProgram.js";
-
-const log = debugForFile(import.meta.filename);
-
-export function createTypeScriptFileFromProjectService(
-	filePathAbsolute: string,
-	program: ts.Program,
-	service: ts.server.ProjectService,
-) {
-	const sourceFile = program.getSourceFile(filePathAbsolute);
-	if (!sourceFile) {
-		throw new Error(`Could not retrieve source file for: ${filePathAbsolute}`);
-	}
-
-	log("Retrieved source file and type checker for file %s:", filePathAbsolute);
-
-	const file = createTypeScriptFileFromProgram(program, sourceFile);
-
-	return {
-		languageFile: {
-			...file,
-			[Symbol.dispose]() {
-				service.closeClientFile(filePathAbsolute);
-			},
-		},
-		sourceFile,
-	};
-}

package/src/directives/parseDirectivesFromTypeScriptFile.test.ts

@@ -1,108 +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,
-			        },
-			      },
-			    },
-			  ],
-			}
-		`);
-	});
-});

package/src/directives/parseDirectivesFromTypeScriptFile.ts

@@ -1,31 +0,0 @@
-import { DirectivesCollector } from "@flint.fyi/core";
-import * as tsutils from "ts-api-utils";
-import ts from "typescript";
-
-import { normalizeRange } from "../normalizeRange.js";
-
-export function parseDirectivesFromTypeScriptFile(sourceFile: ts.SourceFile) {
-	const collector = new DirectivesCollector(
-		sourceFile.statements.at(0)?.getStart(sourceFile) ?? sourceFile.text.length,
-	);
-
-	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);
-
-		collector.add(range, selection, type);
-	});
-
-	return collector.collect();
-}

package/src/formatDiagnostic.ts

@@ -1,166 +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 ts, {
-	flattenDiagnosticMessageText,
-	getLineAndCharacterOfPosition,
-	getPositionOfLineAndCharacter,
-	type SourceFile,
-} from "typescript";
-
-export interface RawDiagnostic {
-	file?: ts.SourceFile;
-	length: number;
-	message: string;
-	name: string;
-	relatedInformation?: ts.DiagnosticRelatedInformation[];
-	start: number;
-}
-
-export function formatDiagnostic(diagnostic: RawDiagnostic) {
-	let output = "";
-
-	if (diagnostic.file !== undefined) {
-		output += formatLocation(diagnostic.file, diagnostic.start);
-		output += " - ";
-	}
-	output += color(diagnostic.name, COLOR.Grey);
-	output += ": ";
-	output += diagnostic.message;
-	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;
-}
-
-function color(text: string, formatStyle: string) {
-	return formatStyle + text + resetEscapeSequence;
-}
-
-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: string) {
-	if (name.startsWith("./")) {
-		return name.slice(2);
-	}
-	return name.slice(process.cwd().length + 1);
-}
-
-function formatCodeSpan(
-	file: SourceFile,
-	start: number,
-	length: number,
-	indent: string,
-	squiggleColor: string,
-) {
-	const { character: firstLineChar, line: firstLine } =
-		getLineAndCharacterOfPosition(file, start);
-	const { character: lastLineChar, line: lastLine } =
-		getLineAndCharacterOfPosition(file, start + length);
-	const lastLineInFile = getLineAndCharacterOfPosition(
-		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 = getPositionOfLineAndCharacter(file, i, 0);
-		const lineEnd =
-			i < lastLineInFile
-				? getPositionOfLineAndCharacter(file, i + 1, 0)
-				: 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: SourceFile, start: number): string {
-	const { character, line } = getLineAndCharacterOfPosition(file, start);
-	const relativeFileName = displayFilename(file.fileName);
-	let output = "";
-	output += color(relativeFileName, COLOR.Cyan);
-	output += ":";
-	output += color(`${line + 1}`, COLOR.Yellow);
-	output += ":";
-	output += color(`${character + 1}`, COLOR.Yellow);
-	return output;
-}

package/src/getFirstEnumValues.test.ts

@@ -1,51 +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", () => {
-		enum Empty {}
-
-		const result = getFirstEnumValues(Empty);
-
-		expect(result).toEqual({});
-	});
-
-	it("returns all original pairs when when given a non-repeating enum", () => {
-		enum NonRepeating {
-			A = 1,
-			B = 2,
-			C = 3,
-		}
-
-		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", () => {
-		enum Repeating {
-			A = 1,
-			B = 2,
-			// eslint-disable-next-line @typescript-eslint/prefer-literal-enum-member
-			C = A,
-		}
-
-		const result = getFirstEnumValues(Repeating);
-
-		expect(result).toEqual({
-			1: "A",
-			2: "B",
-			A: 1,
-			B: 2,
-			C: 1,
-		});
-	});
-});

package/src/getFirstEnumValues.ts

@@ -1,59 +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<
-	Keys extends string,
-	Values extends number,
-	Original extends Record<Keys | Values, Keys | Values>,
->(original: Original) {
-	const result = {} as Original;
-
-	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 as any;
-		}
-	}
-
-	return result;
-}

package/src/getTSNodeRange.ts

@@ -1,13 +0,0 @@
-import type * as ts from "typescript";
-
-import { CharacterReportRange } from "@flint.fyi/core";
-
-export function getTSNodeRange(
-	node: ts.Node,
-	sourceFile: ts.SourceFile,
-): CharacterReportRange {
-	return {
-		begin: node.getStart(sourceFile),
-		end: node.getEnd(),
-	};
-}

package/src/index.ts

@@ -1,7 +0,0 @@
-export { getTSNodeRange } from "./getTSNodeRange.js";
-export * from "./language.js";
-export { ts } from "./plugin.js";
-export { getDeclarationsIfGlobal } from "./utils/getDeclarationsIfGlobal.js";
-export { isGlobalDeclaration } from "./utils/isGlobalDeclaration.js";
-export { isGlobalDeclarationOfName } from "./utils/isGlobalDeclarationOfName.js";
-export { isGlobalVariable } from "./utils/isGlobalVariable.js";