mirror of
https://github.com/electron/electron.git
synced 2026-05-02 03:00:22 -04:00
* 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.
55 lines
1.4 KiB
JavaScript
55 lines
1.4 KiB
JavaScript
const { Octokit } = require('@octokit/rest');
|
|
const minimist = require('minimist');
|
|
|
|
const args = minimist(process.argv.slice(2));
|
|
|
|
const octokit = new Octokit();
|
|
|
|
async function checkIfDocOnlyChange() {
|
|
let { prNumber, prURL } = args;
|
|
|
|
if (prNumber || prURL) {
|
|
try {
|
|
// extract the PR number from the PR URL.
|
|
if (!prNumber || isNaN(prNumber)) {
|
|
if (args.prURL) {
|
|
prNumber = prURL.split('/').pop();
|
|
}
|
|
}
|
|
|
|
const filesChanged = await octokit.paginate(
|
|
octokit.pulls.listFiles.endpoint.merge({
|
|
owner: 'electron',
|
|
repo: 'electron',
|
|
pull_number: prNumber,
|
|
per_page: 100
|
|
})
|
|
);
|
|
|
|
console.log(
|
|
'Changed Files: ',
|
|
filesChanged.map((fileInfo) => fileInfo.filename)
|
|
);
|
|
|
|
const nonDocChange =
|
|
filesChanged.length === 0 ||
|
|
filesChanged.find(({ filename }) => {
|
|
const fileDirs = filename.split('/');
|
|
if (fileDirs[0] !== 'docs') return true;
|
|
return false;
|
|
});
|
|
|
|
process.exit(nonDocChange ? 1 : 0);
|
|
} catch (error) {
|
|
console.error('Error getting list of files changed: ', error);
|
|
process.exit(-1);
|
|
}
|
|
} else {
|
|
console.error(`Check if only the docs were changed for a commit.
|
|
Usage: doc-only-change.js --prNumber=PR_NUMBER || --prURL=PR_URL`);
|
|
process.exit(-1);
|
|
}
|
|
}
|
|
|
|
checkIfDocOnlyChange();
|