lwc-linter
Version:
A comprehensive CLI tool for linting Lightning Web Components v8.0.0+ with modern LWC patterns, decorators, lifecycle hooks, and Salesforce platform integration
200 lines • 8.25 kB
JavaScript
;
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || (function () {
var ownKeys = function(o) {
ownKeys = Object.getOwnPropertyNames || function (o) {
var ar = [];
for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
return ar;
};
return ownKeys(o);
};
return function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
__setModuleDefault(result, mod);
return result;
};
})();
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.LWCLinter = void 0;
const fs = __importStar(require("fs-extra"));
const path = __importStar(require("path"));
const glob = __importStar(require("glob"));
const ora_1 = __importDefault(require("ora"));
const rule_manager_1 = require("./rule-manager");
const file_processor_1 = require("./file-processor");
class LWCLinter {
constructor(config) {
this.config = config;
this.ruleManager = new rule_manager_1.RuleManager(config);
this.fileProcessor = new file_processor_1.FileProcessor(config);
}
async lintDirectory(dirPath) {
const spinner = (0, ora_1.default)('Scanning files...').start();
try {
// Find all LWC files
const files = await this.findLWCFiles(dirPath);
spinner.text = `Found ${files.length} files to lint`;
const results = [];
for (let i = 0; i < files.length; i++) {
const file = files[i];
spinner.text = `Linting ${path.relative(dirPath, file)} (${i + 1}/${files.length})`;
const result = await this.lintFile(file);
if (result.issues.length > 0 || this.config.fix) {
results.push(result);
}
}
spinner.succeed(`Linting completed. Processed ${files.length} files.`);
return results;
}
catch (error) {
spinner.fail('Linting failed');
throw error;
}
}
async lintFile(filePath) {
try {
const content = await fs.readFile(filePath, 'utf-8');
const fileExt = path.extname(filePath);
let issues = [];
let fixedContent = content;
let fixedCount = 0;
// Process file based on extension
if (fileExt === '.js') {
const jsIssues = await this.fileProcessor.processJavaScript(content, filePath);
issues.push(...jsIssues);
}
else if (fileExt === '.html') {
const htmlIssues = await this.fileProcessor.processHTML(content, filePath);
issues.push(...htmlIssues);
}
else if (fileExt === '.css') {
const cssIssues = await this.fileProcessor.processCSS(content, filePath);
issues.push(...cssIssues);
}
// Apply fixes if enabled
if (this.config.fix && issues.some(issue => issue.fixable)) {
const fixResult = await this.applyFixes(content, issues, filePath);
fixedContent = fixResult.content;
fixedCount = fixResult.fixedCount;
// Write fixed content back to file
await fs.writeFile(filePath, fixedContent);
}
// Filter issues by severity level
const filteredIssues = this.filterIssuesBySeverity(issues);
return {
filePath,
issues: filteredIssues,
fixedCount
};
}
catch (error) {
return {
filePath,
issues: [{
rule: 'file-processing-error',
message: `Failed to process file: ${error instanceof Error ? error.message : error}`,
severity: 'error',
category: 'code-quality'
}]
};
}
}
async findLWCFiles(dirPath) {
const patterns = [
'**/*.js',
'**/*.html',
'**/*.css'
];
const includePatterns = this.config.include || patterns;
const excludePatterns = this.config.exclude || ['node_modules/**', '**/*.test.*', '**/test/**'];
const files = [];
for (const pattern of includePatterns) {
try {
const matchedFiles = await new Promise((resolve, reject) => {
glob.glob(pattern, {
cwd: dirPath,
absolute: true,
ignore: excludePatterns
}, (err, matches) => {
if (err)
reject(err);
else
resolve(matches);
});
});
files.push(...matchedFiles);
}
catch (error) {
console.warn(`Warning: Failed to glob pattern ${pattern}: ${error}`);
}
}
// Remove duplicates and filter for LWC-related files
return [...new Set(files)].filter(file => this.isLWCFile(file));
}
isLWCFile(filePath) {
const dir = path.dirname(filePath);
const parentDir = path.basename(path.dirname(dir));
// Check if this is likely an LWC component (in lwc folder or has matching js/html/css files)
if (parentDir === 'lwc' || dir.includes('/lwc/')) {
return true;
}
// Check if there are corresponding LWC files in the same directory
const basename = path.basename(filePath, path.extname(filePath));
const dirFiles = fs.readdirSync(dir);
const hasMatchingFiles = dirFiles.some(file => file.startsWith(basename) && ['.js', '.html', '.css'].includes(path.extname(file)));
return hasMatchingFiles;
}
async applyFixes(content, issues, filePath) {
let fixedContent = content;
let fixedCount = 0;
const fixableIssues = issues.filter(issue => issue.fixable);
for (const issue of fixableIssues) {
const rule = this.ruleManager.getRule(issue.rule);
if (rule && rule.fix) {
try {
const newContent = rule.fix(fixedContent, [issue]);
if (newContent !== fixedContent) {
fixedContent = newContent;
fixedCount++;
}
}
catch (error) {
// Log fix error but continue
console.warn(`Failed to apply fix for rule ${issue.rule}: ${error}`);
}
}
}
return { content: fixedContent, fixedCount };
}
filterIssuesBySeverity(issues) {
if (!this.config.severity || this.config.severity === 'info') {
return issues;
}
const severityOrder = { info: 0, warn: 1, error: 2 };
const minLevel = severityOrder[this.config.severity];
return issues.filter(issue => severityOrder[issue.severity] >= minLevel);
}
}
exports.LWCLinter = LWCLinter;
//# sourceMappingURL=linter.js.map