mirror of
https://github.com/electron/electron.git
synced 2026-05-02 03:00:22 -04:00
2c94aac330
* build: add oxfmt for code formatting and import sorting
Adds oxfmt as a devDependency alongside oxlint and wires it into the
lint pipeline. The .oxfmtrc.json config matches Electron's current JS
style (single quotes, semicolons, 2-space indent, trailing commas off,
printWidth 100) and configures sortImports with custom groups that
mirror the import/order pathGroups previously enforced by ESLint:
@electron/internal, @electron/*, and {electron,electron/**} each get
their own ordered group ahead of external modules.
- `yarn lint:fmt` runs `oxfmt --check` over JS/TS sources and is
chained into `yarn lint` so CI enforces it automatically.
- `yarn format` runs `oxfmt --write` for local fix-up.
- lint-staged invokes `oxfmt --write` on staged .js/.ts/.mjs/.cjs
files before oxlint, so formatting is applied at commit time.
The next commit applies the formatter to the existing codebase so the
check actually passes.
* chore: apply oxfmt formatting to JS and TS sources
Runs `yarn format` across lib/, spec/, script/, build/, default_app/,
and npm/ to bring the codebase in line with the .oxfmtrc.json settings
added in the previous commit. This is a pure formatting pass: import
statements are sorted into the groups defined by the config, method
chains longer than printWidth are broken, single-quoted strings
containing apostrophes are switched to double quotes, and a handful of
single-statement `if` bodies are re-wrapped and get braces added by
`oxlint --fix` to satisfy the `curly: multi-line` rule.
No behavior changes.
45 lines
1.1 KiB
JavaScript
45 lines
1.1 KiB
JavaScript
/*
|
|
Usage:
|
|
|
|
$ node ./script/gn-check.js [--outDir=dirName]
|
|
*/
|
|
|
|
const minimist = require('minimist');
|
|
|
|
const cp = require('node:child_process');
|
|
const path = require('node:path');
|
|
|
|
const args = minimist(process.argv.slice(2), { string: ['outDir'] });
|
|
|
|
const { getDepotToolsEnv, getOutDir } = require('./lib/utils');
|
|
|
|
const SOURCE_ROOT = path.normalize(path.dirname(__dirname));
|
|
|
|
const OUT_DIR = getOutDir({ outDir: args.outDir });
|
|
if (!OUT_DIR) {
|
|
throw new Error('No viable out dir: one of Debug, Testing, or Release must exist.');
|
|
}
|
|
|
|
const env = {
|
|
...getDepotToolsEnv(),
|
|
CHROMIUM_BUILDTOOLS_PATH: path.resolve(SOURCE_ROOT, '..', 'buildtools'),
|
|
DEPOT_TOOLS_WIN_TOOLCHAIN: '0'
|
|
};
|
|
|
|
const gnCheckDirs = [
|
|
'//electron:electron_lib',
|
|
'//electron:electron_app',
|
|
'//electron/shell/common:mojo',
|
|
'//electron/shell/common:plugin',
|
|
'//electron:testing_build',
|
|
'//electron:release_build'
|
|
];
|
|
|
|
for (const dir of gnCheckDirs) {
|
|
const args = ['check', `../out/${OUT_DIR}`, dir];
|
|
const result = cp.spawnSync('gn', args, { env, stdio: 'inherit' });
|
|
if (result.status !== 0) process.exit(result.status);
|
|
}
|
|
|
|
process.exit(0);
|