Skip to content
This repository has been archived by the owner on Jan 2, 2025. It is now read-only.

Feat/add tsci lint #79

Merged
merged 6 commits into from
Jul 10, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions lib/cmd-fns/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -38,3 +38,4 @@ export { openCmd as open } from "./open"
export { versionCmd as version } from "./version"
export { exportGerbersCmd as exportGerbers } from "./export-gerbers"
export { devServerFulfillExportRequests } from "./dev-server-fulfill-export-requests"
export { lintCmd as lint } from "./lint"
37 changes: 37 additions & 0 deletions lib/cmd-fns/lint.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
import { AppContext } from "lib/util/app-context"
import { z } from "zod"
import kleur from "kleur"
import { lintProject } from "../util/lint-project"

export const lintCmd = async (ctx: AppContext, args: any) => {
const params = z
.object({
fix: z.boolean().optional().default(false),
})
.parse(args)

const { cwd } = ctx
const { fix } = params

console.log(kleur.blue("Running tscircuit linter..."))

const results = lintProject(cwd, fix);

let errorCount = 0;
for (const result of results) {
if (result.messages.length > 0) {
console.log(kleur.yellow(`\nFile: ${result.filePath}`));
for (const message of result.messages) {
console.log(` Line ${message.line}, Column ${message.column}: ${message.message}`);
errorCount++;
}
}
}

if (errorCount > 0) {
console.log(kleur.yellow(`\nFound ${errorCount} issue${errorCount === 1 ? '' : 's'} in your tscircuit code.`));
process.exit(1);
} else {
console.log(kleur.green("\nNo tscircuit-specific issues found!"));
}
}
6 changes: 6 additions & 0 deletions lib/get-program.ts
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,12 @@ export const getProgram = (ctx: AppContext) => {
.argument("<packages...>", "Packages to remove")
.action((packages, flags) => CMDFN.remove(ctx, { packages, flags }))

cmd
.command("lint")
.description("Lint all TypeScript files in the project")
.option("--fix", "Automatically fix problems")
.action((args) => CMDFN.lint(ctx, args))

const authCmd = cmd.command("auth").description("Login/logout")
authCmd
.command("login")
Expand Down
112 changes: 112 additions & 0 deletions lib/util/lint-project.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,112 @@
import * as ts from 'typescript';
import * as fs from 'fs';
import * as path from 'path';

interface LintResult {
filePath: string;
messages: LintMessage[];
}

interface LintMessage {
line: number;
column: number;
message: string;
fix?: {
range: [number, number];
text: string;
};
}

export function lintProject(projectPath: string, fix: boolean = false): LintResult[] {
const results: LintResult[] = [];
const files = getTypeScriptFiles(projectPath);

for (const file of files) {
const sourceFile = ts.createSourceFile(
file,
fs.readFileSync(file, 'utf8'),
ts.ScriptTarget.Latest,
true
);

const result = lintFile(sourceFile, fix);
if (result.messages.length > 0) {
results.push({ filePath: file, messages: result.messages });
}

if (fix && result.messages.some(m => m.fix)) {
const newContent = applyFixes(sourceFile.text, result.messages);
fs.writeFileSync(file, newContent);
}
}

return results;
}

function lintFile(sourceFile: ts.SourceFile, fix: boolean): { messages: LintMessage[] } {
const messages: LintMessage[] = [];

function visit(node: ts.Node) {
if (ts.isCallExpression(node) && ts.isIdentifier(node.expression) && node.expression.text === 'capacitor') {
const valueArg = node.arguments.find(arg => ts.isObjectLiteralExpression(arg));
if (valueArg && ts.isObjectLiteralExpression(valueArg)) {
const valueProp = valueArg.properties.find(
prop => ts.isPropertyAssignment(prop) && ts.isIdentifier(prop.name) && prop.name.text === 'value'
);
if (valueProp && ts.isPropertyAssignment(valueProp) && ts.isStringLiteral(valueProp.initializer)) {
const value = valueProp.initializer.text;
if (!value.match(/[µuμ]F$/)) {
const { line, character } = sourceFile.getLineAndCharacterOfPosition(valueProp.getStart());
messages.push({
line: line + 1,
column: character + 1,
message: 'Capacitor value should include units (e.g., "100F")',
fix: fix ? {
range: [valueProp.initializer.getStart(), valueProp.initializer.getEnd()],
text: `"${value}F"`
} : undefined
});
}
}
}
}

ts.forEachChild(node, visit);
}

visit(sourceFile);

return { messages };
}

function getTypeScriptFiles(dir: string): string[] {
const files: string[] = [];
const entries = fs.readdirSync(dir, { withFileTypes: true });

for (const entry of entries) {
const fullPath = path.join(dir, entry.name);
if (entry.isDirectory()) {
if (entry.name !== 'node_modules' && entry.name !== 'dist') {
files.push(...getTypeScriptFiles(fullPath));
}
} else if (entry.isFile() && /\.tsx?$/.test(entry.name)) {
files.push(fullPath);
}
}

return files;
}

function applyFixes(source: string, messages: LintMessage[]): string {
const fixes = messages
.filter(m => m.fix)
.sort((a, b) => (b.fix!.range[0] - a.fix!.range[0]));

let result = source;
for (const message of fixes) {
const [start, end] = message.fix!.range;
result = result.slice(0, start) + message.fix!.text + result.slice(end);
}

return result;
}
6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
"edgespec": "^0.0.69",
"esbuild": "^0.20.2",
"fast-glob": "^3.3.2",
"glob": "^10.3.10",
"glob": "^10.4.5",
"hono": "^4.1.0",
"ignore": "^5.3.1",
"json5": "^2.2.3",
Expand All @@ -70,9 +70,9 @@
"peerDependencies": {
"@tscircuit/builder": "*",
"@tscircuit/layout": "*",
"@tscircuit/manual-edit-events": "*",
"@tscircuit/react-fiber": "*",
"@tscircuit/soup-util": "*",
"@tscircuit/manual-edit-events": "*"
"@tscircuit/soup-util": "*"
},
"devDependencies": {
"@tscircuit/builder": "*",
Expand Down
Loading