@flint.fyi/ts 0.14.4 → 0.14.5

package/src/rules/unnecessaryBlocks.test.ts

@@ -0,0 +1,148 @@
+import { ruleTester } from "./ruleTester.js";
+import rule from "./unnecessaryBlocks.js";
+
+ruleTester.describe(rule, {
+	invalid: [
+		{
+			code: `
+{
+    const x = 1;
+}
+`,
+			snapshot: `
+{
+~
+This standalone block statement is unnecessary and doesn't change any variable scopes.
+    const x = 1;
+}
+`,
+		},
+		{
+			code: `
+function test() {
+    {
+        const y = 2;
+    }
+}
+`,
+			snapshot: `
+function test() {
+    {
+    ~
+    This standalone block statement is unnecessary and doesn't change any variable scopes.
+        const y = 2;
+    }
+}
+`,
+		},
+		{
+			code: `
+if (condition) {
+    doSomething();
+    {
+        const nested = true;
+    }
+}
+`,
+			snapshot: `
+if (condition) {
+    doSomething();
+    {
+    ~
+    This standalone block statement is unnecessary and doesn't change any variable scopes.
+        const nested = true;
+    }
+}
+`,
+		},
+		{
+			code: `
+{
+    console.log("standalone");
+}
+`,
+			snapshot: `
+{
+~
+This standalone block statement is unnecessary and doesn't change any variable scopes.
+    console.log("standalone");
+}
+`,
+		},
+		{
+			code: `
+function outer() {
+    {
+        console.log("inner");
+    }
+    {
+        console.log("another");
+    }
+}
+`,
+			snapshot: `
+function outer() {
+    {
+    ~
+    This standalone block statement is unnecessary and doesn't change any variable scopes.
+        console.log("inner");
+    }
+    {
+    ~
+    This standalone block statement is unnecessary and doesn't change any variable scopes.
+        console.log("another");
+    }
+}
+`,
+		},
+	],
+	valid: [
+		`if (condition) { doSomething(); }`,
+		`for (let i = 0; i < 10; i++) { console.log(i); }`,
+		`while (condition) { doWork(); }`,
+		`do { doWork(); } while (condition);`,
+		`function test() { return 42; }`,
+		`const arrow = () => { return 1; };`,
+		`
+switch (value) {
+    case 1: {
+        const x = 1;
+        break;
+    }
+    case 2: {
+        const y = 2;
+        break;
+    }
+}
+`,
+		`
+try {
+    doSomething();
+} catch (error) {
+    handleError(error);
+}
+`,
+		`
+class MyClass {
+    method() {
+        return 1;
+    }
+}
+`,
+		`
+for (const item of items) {
+    processItem(item);
+}
+`,
+		`
+for (const key in object) {
+    processKey(key);
+}
+`,
+		`
+label: {
+    break label;
+}
+`,
+	],
+});

package/src/rules/unnecessaryBlocks.ts

@@ -0,0 +1,89 @@
+import * as ts from "typescript";
+
+import { typescriptLanguage } from "../language.js";
+
+export default typescriptLanguage.createRule({
+	about: {
+		description:
+			"Reports standalone block statements that don't create a meaningful scope.",
+		id: "unnecessaryBlocks",
+		preset: "stylistic",
+	},
+	messages: {
+		unnecessaryBlock: {
+			primary:
+				"This standalone block statement is unnecessary and doesn't change any variable scopes.",
+			secondary: [
+				"Standalone block statements that aren't part of control flow (if/else, loops, switch) or don't create a meaningful lexical scope can be confusing and should be avoided.",
+				"In modern JavaScript and TypeScript, blocks primarily serve to create lexical scope for `let` and `const` variables, but this is often better achieved through other means.",
+			],
+			suggestions: [
+				"Remove the block statement and move its contents to the parent scope.",
+				"If you need lexical scoping, consider using an IIFE (Immediately Invoked Function Expression) or extracting to a separate function.",
+			],
+		},
+	},
+	setup(context) {
+		function isValidBlock(node: ts.Block): boolean {
+			const parent = node.parent;
+
+			// Valid blocks: function bodies, arrow functions, class/interface bodies, etc.
+			if (
+				ts.isFunctionDeclaration(parent) ||
+				ts.isFunctionExpression(parent) ||
+				ts.isArrowFunction(parent) ||
+				ts.isMethodDeclaration(parent) ||
+				ts.isConstructorDeclaration(parent) ||
+				ts.isGetAccessorDeclaration(parent) ||
+				ts.isSetAccessorDeclaration(parent) ||
+				ts.isModuleBlock(parent)
+			) {
+				return true;
+			}
+
+			// Valid blocks: control flow statements
+			if (
+				ts.isIfStatement(parent) ||
+				ts.isForStatement(parent) ||
+				ts.isForInStatement(parent) ||
+				ts.isForOfStatement(parent) ||
+				ts.isWhileStatement(parent) ||
+				ts.isDoStatement(parent) ||
+				ts.isWithStatement(parent) ||
+				ts.isTryStatement(parent) ||
+				ts.isCatchClause(parent)
+			) {
+				return true;
+			}
+
+			// Valid block: switch case/default clause with block
+			// In ES6+, blocks in switch cases create scope for let/const
+			if (ts.isCaseClause(parent) || ts.isDefaultClause(parent)) {
+				return true;
+			}
+
+			// Valid block: labeled statement
+			if (ts.isLabeledStatement(parent)) {
+				return true;
+			}
+
+			return false;
+		}
+
+		return {
+			visitors: {
+				Block: (node) => {
+					if (!isValidBlock(node)) {
+						context.report({
+							message: "unnecessaryBlock",
+							range: {
+								begin: node.getStart(context.sourceFile),
+								end: node.getStart(context.sourceFile) + 1,
+							},
+						});
+					}
+				},
+			},
+		};
+	},
+});

package/src/rules/unnecessaryConcatenation.test.ts

@@ -0,0 +1,88 @@
+import { ruleTester } from "./ruleTester.js";
+import rule from "./unnecessaryConcatenation.js";
+
+ruleTester.describe(rule, {
+	invalid: [
+		{
+			code: `
+const message = "Hello" + "World";
+`,
+			snapshot: `
+const message = "Hello" + "World";
+                        ~
+                        This string concatenation can be streamlined into a single string literal.
+`,
+		},
+		{
+			code: `
+const path = 'foo' + 'bar';
+`,
+			snapshot: `
+const path = 'foo' + 'bar';
+                   ~
+                   This string concatenation can be streamlined into a single string literal.
+`,
+		},
+		{
+			code: `
+const result = "abc" + "def" + "ghi";
+`,
+			snapshot: `
+const result = "abc" + "def" + "ghi";
+                     ~
+                     This string concatenation can be streamlined into a single string literal.
+`,
+		},
+		{
+			code: `
+const text = "first" + "second";
+`,
+			snapshot: `
+const text = "first" + "second";
+                     ~
+                     This string concatenation can be streamlined into a single string literal.
+`,
+		},
+		{
+			code: `
+const mixed = 'single' + "double";
+`,
+			snapshot: `
+const mixed = 'single' + "double";
+                       ~
+                       This string concatenation can be streamlined into a single string literal.
+`,
+		},
+		{
+			code: `
+const withSpace = "Hello " + "World";
+`,
+			snapshot: `
+const withSpace = "Hello " + "World";
+                           ~
+                           This string concatenation can be streamlined into a single string literal.
+`,
+		},
+		{
+			code: `
+const longString = "This is a very long string that " +
+    "continues on the next line";
+`,
+			snapshot: `
+const longString = "This is a very long string that " +
+                                                      ~
+                                                      This string concatenation can be streamlined into a single string literal.
+    "continues on the next line";
+`,
+		},
+	],
+	valid: [
+		`const message = "Hello" + variable;`,
+		`const message = variable + "World";`,
+		`const result = variable1 + variable2;`,
+		`const template = \`Hello\${name}World\`;`,
+		`const number = 1 + 2;`,
+		`const mixed = "Hello" + getName() + "World";`,
+		`const value = "prefix" + getValue();`,
+	],
+});

package/src/rules/unnecessaryConcatenation.ts

@@ -0,0 +1,44 @@
+import * as ts from "typescript";
+
+import { getTSNodeRange } from "../getTSNodeRange.js";
+import { typescriptLanguage } from "../language.js";
+
+export default typescriptLanguage.createRule({
+	about: {
+		description:
+			"Reports string concatenation using the + operator when both operands are string literals.",
+		id: "unnecessaryConcatenation",
+		preset: "stylistic",
+	},
+	messages: {
+		unnecessaryConcatenation: {
+			primary:
+				"This string concatenation can be streamlined into a single string literal.",
+			secondary: [
+				"Concatenating string literals with the + operator is unnecessary and reduces code readability.",
+				"String literals can be combined into a single literal, which is clearer and potentially more performant.",
+			],
+			suggestions: [
+				"Combine the string literals into a single string literal.",
+			],
+		},
+	},
+	setup(context) {
+		return {
+			visitors: {
+				BinaryExpression: (node) => {
+					if (
+						node.operatorToken.kind === ts.SyntaxKind.PlusToken &&
+						ts.isStringLiteral(node.left) &&
+						ts.isStringLiteral(node.right)
+					) {
+						context.report({
+							message: "unnecessaryConcatenation",
+							range: getTSNodeRange(node.operatorToken, context.sourceFile),
+						});
+					}
+				},
+			},
+		};
+	},
+});

package/src/rules/voidOperator.test.ts

@@ -72,8 +72,8 @@ function process() {
 			snapshot: `
 function process() {
 	void doSomething();
- ~~~~~~~~~~~~~~~~~~
- Prefer an explicit value over using the void operator to produce undefined.
+	~~~~~~~~~~~~~~~~~~
+	Prefer an explicit value over using the void operator to produce undefined.
 }
 `,
 		},

package/src/utils/getDeclarationsIfGlobal.ts

@@ -0,0 +1,14 @@
+import * as ts from "typescript";
+
+import { declarationsIncludeGlobal } from "./declarationsIncludeGlobal.js";
+
+export function getDeclarationsIfGlobal(
+	node: ts.Expression,
+	typeChecker: ts.TypeChecker,
+) {
+	const declarations = typeChecker.getSymbolAtLocation(node)?.getDeclarations();
+
+	return !!declarations && declarationsIncludeGlobal(declarations)
+		? declarations
+		: undefined;
+}

package/src/utils/isGlobalDeclaration.ts

@@ -1,12 +1,10 @@
 import * as ts from "typescript";
 
-import { declarationsIncludeGlobal } from "./declarationsIncludeGlobal.js";
+import { getDeclarationsIfGlobal } from "./getDeclarationsIfGlobal.js";
 
 export function isGlobalDeclaration(
 	node: ts.Expression,
 	typeChecker: ts.TypeChecker,
-): boolean {
-	const declarations = typeChecker.getSymbolAtLocation(node)?.getDeclarations();
-
-	return !!declarations && declarationsIncludeGlobal(declarations);
+) {
+	return !!getDeclarationsIfGlobal(node, typeChecker);
 }

package/src/utils/isGlobalDeclarationOfName.ts

@@ -6,7 +6,7 @@ import { declarationIncludesGlobal } from "./declarationIncludesGlobal.js";
  * TODO: Use a scope analyzer (#400).
  */
 export function isGlobalDeclarationOfName(
-	node: ts.Expression,
+	node: ts.Node,
 	name: string,
 	typeChecker: ts.TypeChecker,
 ): boolean {
@@ -30,6 +30,11 @@ export function isGlobalDeclarationOfName(
 			);
 		}
 
+		// Special case: a property of an interface
+		if (ts.isPropertySignature(declaration)) {
+			return isGlobalDeclarationOfName(declaration.parent, name, typeChecker);
+		}
+
 		return (
 			isDeclarationOfName(declaration, name) &&
 			declarationIncludesGlobal(declaration)