pi-lens 2.2.9 → 3.0.0

package/clients/amain-types.js

@@ -0,0 +1,164 @@
+/**
+ * Amain State Types: 57 syntax types + 15 token types
+ *
+ * Adapted from Amain paper's Java AST structure for TypeScript.
+ * 57 syntax types (non-leaf AST nodes) + 15 token types (leaf categories) = 72 states
+ *
+ * Reference: https://github.com/CGCL-codes/Amain (ASE 2022)
+ */
+import * as ts from "typescript";
+// ============================================================================
+// 57 Syntax Types (non-leaf AST nodes, indices 0-56)
+// ============================================================================
+export const SYNTAX_TYPES = [
+    // Declarations (0-9)
+    "FunctionDeclaration", // 0
+    "ArrowFunction", // 1
+    "FunctionExpression", // 2
+    "ClassDeclaration", // 3
+    "InterfaceDeclaration", // 4
+    "TypeAliasDeclaration", // 5
+    "EnumDeclaration", // 6
+    "MethodDeclaration", // 7
+    "Constructor", // 8
+    "GetAccessor", // 9
+    // More declarations (10-19)
+    "SetAccessor", // 10
+    "PropertyDeclaration", // 11
+    "Parameter", // 12
+    "VariableDeclaration", // 13
+    "ModuleDeclaration", // 14
+    "ImportDeclaration", // 15
+    "ExportDeclaration", // 16
+    "NamespaceExportDeclaration", // 17
+    "ImportClause", // 18
+    "NamespaceImport", // 19
+    // Statements (20-39)
+    "IfStatement", // 20
+    "ForStatement", // 21
+    "ForOfStatement", // 22
+    "ForInStatement", // 23
+    "WhileStatement", // 24
+    "DoWhileStatement", // 25
+    "SwitchStatement", // 26
+    "CaseClause", // 27
+    "DefaultClause", // 28
+    "TryStatement", // 29
+    "CatchClause", // 30
+    "ThrowStatement", // 31
+    "ReturnStatement", // 32
+    "BreakStatement", // 33
+    "ContinueStatement", // 34
+    "Block", // 35
+    "EmptyStatement", // 36
+    // More statements (37-39)
+    "DebuggerStatement", // 37
+    "LabeledStatement", // 38
+    "WithStatement", // 39
+    // Expressions (40-56)
+    "BinaryExpression", // 40
+    "UnaryExpression", // 41
+    "PrefixUnaryExpression", // 42
+    "PostfixUnaryExpression", // 43
+    "ConditionalExpression", // 44
+    "CallExpression", // 45
+    "PropertyAccessExpression", // 46
+    "ElementAccessExpression", // 47
+    "NewExpression", // 48
+    "ParenthesizedExpression", // 49
+    "TypeAssertionExpression", // 50
+    "AsExpression", // 51
+    "NonNullExpression", // 52
+    "TemplateExpression", // 53
+    "ArrayLiteralExpression", // 54
+    "ObjectLiteralExpression", // 55
+    "ExpressionStatement", // 56
+];
+// ============================================================================
+// 15 Token Types (leaf node categories, indices 57-71)
+// ============================================================================
+export const TOKEN_TYPES = [
+    "Identifier", // 57
+    "StringLiteral", // 58
+    "NumericLiteral", // 59
+    "TrueKeyword", // 60
+    "FalseKeyword", // 61
+    "NullKeyword", // 62
+    "UndefinedKeyword", // 63
+    "ThisKeyword", // 64
+    "SuperKeyword", // 65
+    "RegularExpressionLiteral", // 66
+    "NoSubstitutionTemplateLiteral", // 67
+    "TemplateHead", // 68
+    "TemplateMiddle", // 69
+    "TemplateTail", // 70
+    "ComputedPropertyName", // 71
+];
+// ============================================================================
+// Constants
+// ============================================================================
+export const NUM_SYNTAX = SYNTAX_TYPES.length; // 57
+export const NUM_TOKEN = TOKEN_TYPES.length; // 15
+export const NUM_STATES = NUM_SYNTAX + NUM_TOKEN; // 72
+// ============================================================================
+// State Index Mapping
+// ============================================================================
+/**
+ * Map a TypeScript AST node to its Amain state index (0-71)
+ */
+export function getStateIndex(node) {
+    // Try syntax types first (0-56)
+    const kindName = ts.SyntaxKind[node.kind];
+    const syntaxIdx = SYNTAX_TYPES.indexOf(kindName);
+    if (syntaxIdx !== -1)
+        return syntaxIdx;
+    // Map to token types (57-71) based on node kind
+    if (ts.isIdentifier(node))
+        return 57;
+    if (ts.isStringLiteral(node))
+        return 58;
+    if (ts.isNumericLiteral(node))
+        return 59;
+    if (node.kind === ts.SyntaxKind.TrueKeyword)
+        return 60;
+    if (node.kind === ts.SyntaxKind.FalseKeyword)
+        return 61;
+    if (node.kind === ts.SyntaxKind.NullKeyword)
+        return 62;
+    if (node.kind === ts.SyntaxKind.UndefinedKeyword)
+        return 63;
+    if (node.kind === ts.SyntaxKind.ThisKeyword)
+        return 64;
+    if (node.kind === ts.SyntaxKind.SuperKeyword)
+        return 65;
+    if (node.kind === ts.SyntaxKind.RegularExpressionLiteral)
+        return 66;
+    if (node.kind === ts.SyntaxKind.NoSubstitutionTemplateLiteral)
+        return 67;
+    if (node.kind === ts.SyntaxKind.TemplateHead)
+        return 68;
+    if (node.kind === ts.SyntaxKind.TemplateMiddle)
+        return 69;
+    if (node.kind === ts.SyntaxKind.TemplateTail)
+        return 70;
+    if (node.kind === ts.SyntaxKind.ComputedPropertyName)
+        return 71;
+    // Default: treat as identifier for any other leaf node
+    return 57;
+}
+/**
+ * Check if a node is a syntax type (non-leaf) vs token type (leaf)
+ */
+export function isSyntaxNode(node) {
+    return getStateIndex(node) < NUM_SYNTAX;
+}
+/**
+ * Get state name for debugging
+ */
+export function getStateName(index) {
+    if (index < NUM_SYNTAX)
+        return SYNTAX_TYPES[index];
+    if (index < NUM_STATES)
+        return TOKEN_TYPES[index - NUM_SYNTAX];
+    return "Unknown";
+}

package/clients/amain-types.ts

@@ -0,0 +1,165 @@
+/**
+ * Amain State Types: 57 syntax types + 15 token types
+ *
+ * Adapted from Amain paper's Java AST structure for TypeScript.
+ * 57 syntax types (non-leaf AST nodes) + 15 token types (leaf categories) = 72 states
+ *
+ * Reference: https://github.com/CGCL-codes/Amain (ASE 2022)
+ */
+
+import * as ts from "typescript";
+
+// ============================================================================
+// 57 Syntax Types (non-leaf AST nodes, indices 0-56)
+// ============================================================================
+
+export const SYNTAX_TYPES = [
+	// Declarations (0-9)
+	"FunctionDeclaration", // 0
+	"ArrowFunction", // 1
+	"FunctionExpression", // 2
+	"ClassDeclaration", // 3
+	"InterfaceDeclaration", // 4
+	"TypeAliasDeclaration", // 5
+	"EnumDeclaration", // 6
+	"MethodDeclaration", // 7
+	"Constructor", // 8
+	"GetAccessor", // 9
+
+	// More declarations (10-19)
+	"SetAccessor", // 10
+	"PropertyDeclaration", // 11
+	"Parameter", // 12
+	"VariableDeclaration", // 13
+	"ModuleDeclaration", // 14
+	"ImportDeclaration", // 15
+	"ExportDeclaration", // 16
+	"NamespaceExportDeclaration", // 17
+	"ImportClause", // 18
+	"NamespaceImport", // 19
+
+	// Statements (20-39)
+	"IfStatement", // 20
+	"ForStatement", // 21
+	"ForOfStatement", // 22
+	"ForInStatement", // 23
+	"WhileStatement", // 24
+	"DoWhileStatement", // 25
+	"SwitchStatement", // 26
+	"CaseClause", // 27
+	"DefaultClause", // 28
+	"TryStatement", // 29
+	"CatchClause", // 30
+	"ThrowStatement", // 31
+	"ReturnStatement", // 32
+	"BreakStatement", // 33
+	"ContinueStatement", // 34
+	"Block", // 35
+	"EmptyStatement", // 36
+
+	// More statements (37-39)
+	"DebuggerStatement", // 37
+	"LabeledStatement", // 38
+	"WithStatement", // 39
+
+	// Expressions (40-56)
+	"BinaryExpression", // 40
+	"UnaryExpression", // 41
+	"PrefixUnaryExpression", // 42
+	"PostfixUnaryExpression", // 43
+	"ConditionalExpression", // 44
+	"CallExpression", // 45
+	"PropertyAccessExpression", // 46
+	"ElementAccessExpression", // 47
+	"NewExpression", // 48
+	"ParenthesizedExpression", // 49
+	"TypeAssertionExpression", // 50
+	"AsExpression", // 51
+	"NonNullExpression", // 52
+	"TemplateExpression", // 53
+	"ArrayLiteralExpression", // 54
+	"ObjectLiteralExpression", // 55
+	"ExpressionStatement", // 56
+] as const;
+
+// ============================================================================
+// 15 Token Types (leaf node categories, indices 57-71)
+// ============================================================================
+
+export const TOKEN_TYPES = [
+	"Identifier", // 57
+	"StringLiteral", // 58
+	"NumericLiteral", // 59
+	"TrueKeyword", // 60
+	"FalseKeyword", // 61
+	"NullKeyword", // 62
+	"UndefinedKeyword", // 63
+	"ThisKeyword", // 64
+	"SuperKeyword", // 65
+	"RegularExpressionLiteral", // 66
+	"NoSubstitutionTemplateLiteral", // 67
+	"TemplateHead", // 68
+	"TemplateMiddle", // 69
+	"TemplateTail", // 70
+	"ComputedPropertyName", // 71
+] as const;
+
+// ============================================================================
+// Constants
+// ============================================================================
+
+export const NUM_SYNTAX = SYNTAX_TYPES.length; // 57
+export const NUM_TOKEN = TOKEN_TYPES.length; // 15
+export const NUM_STATES = NUM_SYNTAX + NUM_TOKEN; // 72
+
+// ============================================================================
+// State Index Mapping
+// ============================================================================
+
+/**
+ * Map a TypeScript AST node to its Amain state index (0-71)
+ */
+export function getStateIndex(node: ts.Node): number {
+	// Try syntax types first (0-56)
+	const kindName = ts.SyntaxKind[node.kind];
+	const syntaxIdx = SYNTAX_TYPES.indexOf(
+		kindName as (typeof SYNTAX_TYPES)[number],
+	);
+	if (syntaxIdx !== -1) return syntaxIdx;
+
+	// Map to token types (57-71) based on node kind
+	if (ts.isIdentifier(node)) return 57;
+	if (ts.isStringLiteral(node)) return 58;
+	if (ts.isNumericLiteral(node)) return 59;
+	if (node.kind === ts.SyntaxKind.TrueKeyword) return 60;
+	if (node.kind === ts.SyntaxKind.FalseKeyword) return 61;
+	if (node.kind === ts.SyntaxKind.NullKeyword) return 62;
+	if (node.kind === ts.SyntaxKind.UndefinedKeyword) return 63;
+	if (node.kind === ts.SyntaxKind.ThisKeyword) return 64;
+	if (node.kind === ts.SyntaxKind.SuperKeyword) return 65;
+	if (node.kind === ts.SyntaxKind.RegularExpressionLiteral) return 66;
+	if (node.kind === ts.SyntaxKind.NoSubstitutionTemplateLiteral) return 67;
+	if (node.kind === ts.SyntaxKind.TemplateHead) return 68;
+	if (node.kind === ts.SyntaxKind.TemplateMiddle) return 69;
+	if (node.kind === ts.SyntaxKind.TemplateTail) return 70;
+	if (node.kind === ts.SyntaxKind.ComputedPropertyName) return 71;
+
+	// Default: treat as identifier for any other leaf node
+	return 57;
+}
+
+/**
+ * Check if a node is a syntax type (non-leaf) vs token type (leaf)
+ */
+export function isSyntaxNode(node: ts.Node): boolean {
+	return getStateIndex(node) < NUM_SYNTAX;
+}
+
+/**
+ * Get state name for debugging
+ */
+export function getStateName(index: number): string {
+	if (index < NUM_SYNTAX) return SYNTAX_TYPES[index];
+	if (index < NUM_STATES) return TOKEN_TYPES[index - NUM_SYNTAX];
+	return "Unknown";
+}

package/clients/architect-client.js

@@ -15,7 +15,6 @@ import { minimatch } from "minimatch";
 export class ArchitectClient {
     constructor(verbose = false) {
         this.config = null;
-        this.configPath = null;
         this.isUserConfig = false;
         this.log = verbose
             ? (msg) => console.error(`[architect] ${msg}`)
@@ -47,18 +46,32 @@ export class ArchitectClient {
         }
         // Fall back to built-in default
         try {
+            // Try multiple possible locations for the default config
+            const possibleDefaultPaths = [
+                path.join(projectRoot, "default-architect.yaml"),
+                path.join(projectRoot, "..", "default-architect.yaml"),
+                path.join(process.cwd(), "default-architect.yaml"),
+            ];
             // Handle both CommonJS and ESM environments
-            let currentDir = ".";
             if (typeof __dirname !== "undefined") {
-                currentDir = __dirname;
+                possibleDefaultPaths.push(path.join(__dirname, "..", "default-architect.yaml"));
+                possibleDefaultPaths.push(path.join(__dirname, "..", "..", "default-architect.yaml"));
             }
-            const defaultPath = path.join(currentDir, "..", "default-architect.yaml");
-            const content = fs.readFileSync(defaultPath, "utf-8");
-            this.config = this.parseYaml(content);
-            this.configPath = defaultPath;
-            this.isUserConfig = false;
-            this.log("Using default architect rules (create .pi-lens/architect.yaml to customize)");
-            return true;
+            for (const defaultPath of possibleDefaultPaths) {
+                try {
+                    const content = fs.readFileSync(defaultPath, "utf-8");
+                    this.config = this.parseYaml(content);
+                    this.configPath = defaultPath;
+                    this.isUserConfig = false;
+                    this.log("Using default architect rules (create .pi-lens/architect.yaml to customize)");
+                    return true;
+                }
+                catch {
+                    // Try next path
+                }
+            }
+            this.log("No architect config available");
+            return false;
         }
         catch {
             this.log("No architect config available");
@@ -113,6 +126,8 @@ export class ArchitectClient {
                         pattern: rule.pattern,
                         message: check.message,
                         line: lineNum,
+                        fix: check.fix,
+                        note: check.note,
                     });
                     // Prevent infinite loop on empty matches
                     if (match.index === regex.lastIndex) {
@@ -209,9 +224,14 @@ export class ArchitectClient {
                     section = "must";
                     continue;
                 }
-                // Message for current violation
+                // Message for current violation (handle nested quotes)
                 if (trimmed.startsWith("message:") && violation) {
-                    const match = trimmed.match(/message:\s*["'](.+?)["']/);
+                    // Match "..." or '...' allowing the other quote type inside
+                    const dquoteMatch = trimmed.match(/message:\s*"([^"]*)"/);
+                    const squoteMatch = !dquoteMatch
+                        ? trimmed.match(/message:\s*'([^']*)'/)
+                        : null;
+                    const match = dquoteMatch || squoteMatch;
                     if (match) {
                         violation.message = match[1];
                         if (rule) {
@@ -222,6 +242,30 @@ export class ArchitectClient {
                     }
                     continue;
                 }
+                // Fix guidance for current violation
+                if (trimmed.startsWith("fix:") && violation) {
+                    const dquoteMatch = trimmed.match(/fix:\s*"([^"]*)"/);
+                    const squoteMatch = !dquoteMatch
+                        ? trimmed.match(/fix:\s*'([^']*)'/)
+                        : null;
+                    const match = dquoteMatch || squoteMatch;
+                    if (match) {
+                        violation.fix = match[1];
+                    }
+                    continue;
+                }
+                // Note guidance for current violation
+                if (trimmed.startsWith("note:") && violation) {
+                    const dquoteMatch = trimmed.match(/note:\s*"([^"]*)"/);
+                    const squoteMatch = !dquoteMatch
+                        ? trimmed.match(/note:\s*'([^']*)'/)
+                        : null;
+                    const match = dquoteMatch || squoteMatch;
+                    if (match) {
+                        violation.note = match[1];
+                    }
+                    continue;
+                }
                 // Must items (simple strings)
                 if (section === "must" && trimmed.startsWith("- ") && rule) {
                     const item = trimmed.slice(2).replace(/^["']|["']$/g, "");

package/clients/architect-client.ts

@@ -19,11 +19,18 @@ export interface ArchitectViolation {
 	pattern: string;
 	message: string;
 	line?: number;
+	fix?: string;
+	note?: string;
 }
 
 export interface ArchitectRule {
 	pattern: string;
-	must_not?: Array<{ pattern: string; message: string }>;
+	must_not?: Array<{
+		pattern: string;
+		message: string;
+		fix?: string;
+		note?: string;
+	}>;
 	must?: string[];
 	max_lines?: number;
 }
@@ -44,8 +51,8 @@ export interface FileArchitectResult {
 
 export class ArchitectClient {
 	private config: ArchitectConfig | null = null;
-	private configPath: string | null = null;
 	private isUserConfig: boolean = false;
+	private configPath: string | undefined;
 	private log: (msg: string) => void;
 
 	constructor(verbose = false) {
@@ -81,20 +88,40 @@ export class ArchitectClient {
 
 		// Fall back to built-in default
 		try {
+			// Try multiple possible locations for the default config
+			const possibleDefaultPaths = [
+				path.join(projectRoot, "default-architect.yaml"),
+				path.join(projectRoot, "..", "default-architect.yaml"),
+				path.join(process.cwd(), "default-architect.yaml"),
+			];
+
 			// Handle both CommonJS and ESM environments
-			let currentDir = ".";
 			if (typeof __dirname !== "undefined") {
-				currentDir = __dirname;
+				possibleDefaultPaths.push(
+					path.join(__dirname, "..", "default-architect.yaml"),
+				);
+				possibleDefaultPaths.push(
+					path.join(__dirname, "..", "..", "default-architect.yaml"),
+				);
 			}
-			const defaultPath = path.join(currentDir, "..", "default-architect.yaml");
-			const content = fs.readFileSync(defaultPath, "utf-8");
-			this.config = this.parseYaml(content);
-			this.configPath = defaultPath;
-			this.isUserConfig = false;
-			this.log(
-				"Using default architect rules (create .pi-lens/architect.yaml to customize)",
-			);
-			return true;
+
+			for (const defaultPath of possibleDefaultPaths) {
+				try {
+					const content = fs.readFileSync(defaultPath, "utf-8");
+					this.config = this.parseYaml(content);
+					this.configPath = defaultPath;
+					this.isUserConfig = false;
+					this.log(
+						"Using default architect rules (create .pi-lens/architect.yaml to customize)",
+					);
+					return true;
+				} catch {
+					// Try next path
+				}
+			}
+
+			this.log("No architect config available");
+			return false;
 		} catch {
 			this.log("No architect config available");
 			return false;
@@ -154,6 +181,8 @@ export class ArchitectClient {
 						pattern: rule.pattern,
 						message: check.message,
 						line: lineNum,
+						fix: check.fix,
+						note: check.note,
 					});
 
 					// Prevent infinite loop on empty matches
@@ -226,7 +255,12 @@ export class ArchitectClient {
 			const lines = block.split("\n");
 			let rule: ArchitectRule | null = null;
 			let section: "must_not" | "must" | null = null;
-			let violation: { pattern: string; message: string } | null = null;
+			let violation: {
+				pattern: string;
+				message: string;
+				fix?: string;
+				note?: string;
+			} | null = null;
 
 			for (const line of lines) {
 				const trimmed = line.trim();
@@ -269,9 +303,14 @@ export class ArchitectClient {
 					continue;
 				}
 
-				// Message for current violation
+				// Message for current violation (handle nested quotes)
 				if (trimmed.startsWith("message:") && violation) {
-					const match = trimmed.match(/message:\s*["'](.+?)["']/);
+					// Match "..." or '...' allowing the other quote type inside
+					const dquoteMatch = trimmed.match(/message:\s*"([^"]*)"/);
+					const squoteMatch = !dquoteMatch
+						? trimmed.match(/message:\s*'([^']*)'/)
+						: null;
+					const match = dquoteMatch || squoteMatch;
 					if (match) {
 						violation.message = match[1];
 						if (rule) {
@@ -283,6 +322,32 @@ export class ArchitectClient {
 					continue;
 				}
 
+				// Fix guidance for current violation
+				if (trimmed.startsWith("fix:") && violation) {
+					const dquoteMatch = trimmed.match(/fix:\s*"([^"]*)"/);
+					const squoteMatch = !dquoteMatch
+						? trimmed.match(/fix:\s*'([^']*)'/)
+						: null;
+					const match = dquoteMatch || squoteMatch;
+					if (match) {
+						violation.fix = match[1];
+					}
+					continue;
+				}
+
+				// Note guidance for current violation
+				if (trimmed.startsWith("note:") && violation) {
+					const dquoteMatch = trimmed.match(/note:\s*"([^"]*)"/);
+					const squoteMatch = !dquoteMatch
+						? trimmed.match(/note:\s*'([^']*)'/)
+						: null;
+					const match = dquoteMatch || squoteMatch;
+					if (match) {
+						violation.note = match[1];
+					}
+					continue;
+				}
+
 				// Must items (simple strings)
 				if (section === "must" && trimmed.startsWith("- ") && rule) {
 					const item = trimmed.slice(2).replace(/^["']|["']$/g, "");

package/clients/ast-grep-client.js

@@ -182,7 +182,7 @@ message: found
             const result = spawnSync("npx", ["sg", "scan", "--config", configPath, "--json", absolutePath], {
                 encoding: "utf-8",
                 timeout: 15000,
-                shell: true,
+                shell: process.platform === "win32",
             });
             // ast-grep exits 1 when it finds issues
             const output = result.stdout || result.stderr || "";
@@ -192,7 +192,7 @@ message: found
             return parser.parseOutput(output, absolutePath);
         }
         catch (err) {
-            this.log(`Scan error: ${err.message}`);
+            this.log(`Scan error: ${err instanceof Error ? err.message : String(err)}`);
             return [];
         }
     }