electron/script/create-api-json.mjs
Charles Kerr 8e548dbf87
chore: use oxfmt and oxlint in 41-x-y (#51443)
* build: replace eslint with oxlint and add oxfmt

Replace ESLint and its plugin ecosystem with oxlint (oxc.rs).
Add oxfmt alongside oxlint for JS/TS formatting and import sorting.

- Consolidate root .eslintrc.json plus 13 nested configs into .oxlintrc.json
- script/lint.js spawns oxlint binary directly instead of ESLint Node API
- Per-process no-restricted-imports rules preserved as oxlintrc overrides
- mocha/no-exclusive-tests replaced by in-repo plugin (no-only-tests.mjs)
- docs ESLint pass replaced by inline node: protocol check in lint.js
- .oxfmtrc.json matching repo style (single quotes, semicolons, 2-space)
- yarn lint:fmt (oxfmt --check) chained into yarn lint
- yarn format (oxfmt --write) for local fixup
- lint-staged runs oxfmt --write on staged JS/TS files

This commit contains only rule/tooling infrastructure changes and is
intended to be cherry-picked to other maintenance branches, where
formatting and lint fixes can be applied separately.

Manual backport of electron/electron@e1af67c698 (#50691) and
electron/electron@3c7fd34f47 (#50692).

* chore: apply oxfmt formatting and oxlint fixes

One-time application of the new linting and formatting rules to the
41-x-y codebase:

- yarn format (oxfmt --write) over all JS/TS sources
- oxlint --fix to restore curly braces where oxfmt removed them
- Prefix unused parameters with _ (no-unused-vars)
- Add eslint-disable-next-line comments for intentional patterns:
  - prefer-promise-reject-errors in desktop-capturer.ts
  - no-throw-literal in preload.ts
  - no-only-tests/no-only-tests in spec-helpers.ts
- Restore bare require() in preload-sandbox.js test assertions
  (oxfmt incorrectly converted bare specifiers to node: protocol,
  defeating the equivalence test)

Pure formatting and lint suppression; no behavioral changes.
2026-05-02 15:22:30 -07:00

20 lines
550 B
JavaScript

import { parseDocs } from '@electron/docs-parser';
import { promises } from 'node:fs';
import { resolve } from 'node:path';
import { getElectronVersion } from './lib/get-version.js';
parseDocs({
baseDirectory: resolve(import.meta.dirname, '..'),
packageMode: 'single',
useReadme: false,
moduleVersion: getElectronVersion()
})
.then((api) => {
return promises.writeFile(resolve(import.meta.dirname, '..', 'electron-api.json'), JSON.stringify(api, null, 2));
})
.catch((err) => {
console.error(err);
process.exit(1);
});