From 58a21a3cd939dcbb7d4282575a4e943bf30165ad Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Mon, 27 Nov 2023 09:26:33 +0900 Subject: [PATCH] chore: allow passing more roots to lint.js (#40571) --- script/lint.js | 38 +++++++++++++++++++++++++++++++------- 1 file changed, 31 insertions(+), 7 deletions(-) diff --git a/script/lint.js b/script/lint.js index 4789973de5..d6016560da 100755 --- a/script/lint.js +++ b/script/lint.js @@ -95,7 +95,7 @@ function isObjCHeader (filename) { } const LINTERS = [{ - key: 'c++', + key: 'cpp', roots: ['shell'], test: filename => filename.endsWith('.cc') || (filename.endsWith('.h') && !isObjCHeader(filename)), run: (opts, filenames) => { @@ -136,7 +136,9 @@ const LINTERS = [{ cache: !process.env.CI, cacheLocation: `node_modules/.eslintcache.${crypto.createHash('md5').update(fs.readFileSync(__filename)).digest('hex')}`, extensions: ['.js', '.ts'], - fix: opts.fix + fix: opts.fix, + overrideConfigFile: path.join(ELECTRON_ROOT, '.eslintrc.json'), + resolvePluginsRelativeTo: ELECTRON_ROOT }); const formatter = await eslint.loadFormatter(); let successCount = 0; @@ -363,18 +365,39 @@ const LINTERS = [{ function parseCommandLine () { let help; + const langs = ['cpp', 'objc', 'javascript', 'python', 'gn', 'patches', 'markdown']; + const langRoots = langs.map(lang => lang + '-roots'); + const langIgnoreRoots = langs.map(lang => lang + '-ignore-roots'); const opts = minimist(process.argv.slice(2), { - boolean: ['c++', 'objc', 'javascript', 'python', 'gn', 'patches', 'markdown', 'help', 'changed', 'fix', 'verbose', 'only'], - alias: { 'c++': ['cc', 'cpp', 'cxx'], javascript: ['js', 'es'], python: 'py', markdown: 'md', changed: 'c', help: 'h', verbose: 'v' }, + boolean: [...langs, 'help', 'changed', 'fix', 'verbose', 'only'], + alias: { cpp: ['c++', 'cc', 'cxx'], javascript: ['js', 'es'], python: 'py', markdown: 'md', changed: 'c', help: 'h', verbose: 'v' }, + string: [...langRoots, ...langIgnoreRoots], unknown: () => { help = true; } }); if (help || opts.help) { - console.log('Usage: script/lint.js [--cc] [--js] [--py] [--md] [-c|--changed] [-h|--help] [-v|--verbose] [--fix] [--only -- file1 file2]'); + const langFlags = langs.map(lang => `[--${lang}]`).join(' '); + console.log(`Usage: script/lint.js ${langFlags} [-c|--changed] [-h|--help] [-v|--verbose] [--fix] [--only -- file1 file2]`); process.exit(0); } return opts; } +function populateLinterWithArgs (linter, opts) { + const extraRoots = opts[`${linter.key}-roots`]; + if (extraRoots) { + linter.roots.push(...extraRoots.split(',')); + } + const extraIgnoreRoots = opts[`${linter.key}-ignore-roots`]; + if (extraIgnoreRoots) { + const list = extraIgnoreRoots.split(','); + if (linter.ignoreRoots) { + linter.ignoreRoots.push(...list); + } else { + linter.ignoreRoots = list; + } + } +} + async function findChangedFiles (top) { const result = await GitProcess.exec(['diff', '--name-only', '--cached'], top); if (result.exitCode !== 0) { @@ -432,13 +455,14 @@ async function main () { const opts = parseCommandLine(); // no mode specified? run 'em all - if (!opts['c++'] && !opts.javascript && !opts.objc && !opts.python && !opts.gn && !opts.patches && !opts.markdown) { - opts['c++'] = opts.javascript = opts.objc = opts.python = opts.gn = opts.patches = opts.markdown = true; + if (!opts.cpp && !opts.javascript && !opts.objc && !opts.python && !opts.gn && !opts.patches && !opts.markdown) { + opts.cpp = opts.javascript = opts.objc = opts.python = opts.gn = opts.patches = opts.markdown = true; } const linters = LINTERS.filter(x => opts[x.key]); for (const linter of linters) { + populateLinterWithArgs(linter, opts); const filenames = await findFiles(opts, linter); if (filenames.length) { if (opts.verbose) { console.log(`linting ${filenames.length} ${linter.key} ${filenames.length === 1 ? 'file' : 'files'}`); }