@appium/oxc-config
v2.0.0
Published
Shared Oxlint and Oxfmt config for Appium projects
Readme
@appium/oxc-config
Shared Oxlint and Oxfmt configuration for Appium and Appium-adjacent projects.
This package pins compatible oxlint, oxlint-tsgolint, and oxfmt versions. Import lint and format settings from their respective subpaths:
@appium/oxc-config/oxlint@appium/oxc-config/oxfmt
Usage
Install the package:
npm install @appium/oxc-config --save-devOxlint
Create oxlint.config.mjs in your project root:
import appiumConfig, {defineConfig, ignorePatterns} from '@appium/oxc-config/oxlint';
export default defineConfig({
extends: [appiumConfig],
ignorePatterns: [...ignorePatterns],
});Run Oxlint:
npx oxlint -c oxlint.config.mjs .Oxfmt
Create oxfmt.config.mjs in your project root:
import appiumConfig, {defineConfig, ignorePatterns as appiumIgnorePatterns} from '@appium/oxc-config/oxfmt';
export default defineConfig({
...appiumConfig,
ignorePatterns: [...appiumIgnorePatterns],
});Run Oxfmt:
npx oxfmt -c oxfmt.config.mjs .Notes
- Type-aware linting: Oxlint config enables
options.typeAwarevia the bundledoxlint-tsgolintdependency. .editorconfig: Oxfmt reads.editorconfigfor unset formatting options (printWidth,tabWidth,useTabs,endOfLine,insertFinalNewline). The shared Oxfmt config applies Appium fallbacks only for options not defined in the nearest.editorconfig; defined options stay unset so Oxfmt can still apply section-specific values at format time..gitignore: Oxlint and Oxfmt respect.gitignoreautomatically.ignorePatterns: Oxlint does not inheritignorePatternsviaextends— import and spread the exported arrays in your root config.
Rules without Oxlint equivalents
| Legacy rule | Notes |
| --- | --- |
| @typescript-eslint/member-ordering | Class member ordering |
| n/no-deprecated-api | Node.js deprecated API usage |
| jsdoc/require-jsdoc | JSDoc on exported functions |
| perfectionist/sort-modules | Export-before-non-export module ordering |
| @stylistic/* | Replaced by Oxfmt |
License
Licensed Apache-2.0
