@wistia/oxlint-config 1.5.0 → 1.6.0

package/README.md

@@ -154,6 +154,49 @@ export default defineConfig({
 }
 ```
 
+## Formatting with oxfmt
+
+This package also ships Wistia's shared [oxfmt](https://oxc.rs/docs/guide/usage/formatter) config as `oxfmtConfig`, exported from the `@wistia/oxlint-config/oxfmtConfig` subpath. It is only tangentially related to linting, so `oxfmt` is an **optional** peer dependency — install it only if you use the formatter:
+
+```bash
+yarn add -D oxfmt
+```
+
+Create an `oxfmt.config.mts` in your project root. Spread `oxfmtConfig` and override any field; use `satisfies OxfmtConfig` for type checking:
+
+```ts
+import type { OxfmtConfig } from 'oxfmt';
+import { defineConfig } from 'oxfmt';
+import { oxfmtConfig } from '@wistia/oxlint-config/oxfmtConfig';
+
+// oxlint-disable-next-line import-x/no-default-export
+export default defineConfig({
+  ...oxfmtConfig,
+  printWidth: 120,
+  ignorePatterns: [...oxfmtConfig.ignorePatterns, 'dist/**'],
+} satisfies OxfmtConfig);
+```
+
+Every field is overrideable. Because `oxfmtConfig` is a plain object, spread it and replace whichever keys you need — nested keys such as `sortImports` and `ignorePatterns` are replaced wholesale, so reference the base value (as above) when you only want to extend it.
+
+To use the config as-is with no overrides, point oxfmt at the package's default export directly:
+
+```ts
+// oxfmt.config.mts
+export { default } from '@wistia/oxlint-config/oxfmtConfig';
+```
+
+Add a script to run it:
+
+```json
+{
+  "scripts": {
+    "format": "oxfmt .",
+    "format:ci": "oxfmt --check ."
+  }
+}
+```
+
 ## Guidelines for adding new rules
 
 1. Preference given for autofixable rules

package/oxfmtConfig.mjs

@@ -0,0 +1,27 @@
+import { defineConfig } from 'oxfmt';
+
+export const oxfmtConfig = {
+  printWidth: 100,
+  singleQuote: true,
+  trailingComma: 'all',
+  singleAttributePerLine: true,
+  sortImports: {
+    groups: [
+      'type-builtin',
+      'type-external',
+      ['type-internal', 'type-parent', 'type-sibling', 'type-index'],
+      'value-builtin',
+      'value-external',
+      'value-internal',
+      'value-index',
+      ['value-parent', 'value-sibling'],
+      'unknown',
+    ],
+    newlinesBetween: false,
+  },
+  ignorePatterns: ['node_modules/**', '.yarn/**'],
+  sortPackageJson: false,
+};
+
+// oxlint-disable-next-line import-x/no-default-export
+export default defineConfig(oxfmtConfig);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wistia/oxlint-config",
-  "version": "1.5.0",
+  "version": "1.6.0",
   "description": "Wistia's Oxlint configurations",
   "packageManager": "yarn@4.17.0",
   "type": "module",
@@ -9,7 +9,8 @@
     "rules",
     "plugins",
     "index.mjs",
-    "index.d.mts"
+    "index.d.mts",
+    "oxfmtConfig.mjs"
   ],
   "exports": {
     "./package.json": "./package.json",
@@ -26,6 +27,7 @@
     "./storybook": "./configs/storybook.mjs",
     "./styled-components": "./configs/styled-components.mjs",
     "./testing-library": "./configs/testing-library.mjs",
+    "./oxfmtConfig": "./oxfmtConfig.mjs",
     "./rules/barrel-files": "./rules/barrel-files.mjs",
     "./rules/base": "./rules/base.mjs",
     "./rules/custom": "./rules/custom.mjs",
@@ -54,9 +56,15 @@
   },
   "peerDependencies": {
     "eslint": ">= 10.5.0",
+    "oxfmt": ">= 0.55.0",
     "oxlint": ">= 1.71.0",
     "oxlint-tsgolint": ">= 0.23.0"
   },
+  "peerDependenciesMeta": {
+    "oxfmt": {
+      "optional": true
+    }
+  },
   "dependencies": {
     "@eslint-react/eslint-plugin": "^5.9.0",
     "@vitest/eslint-plugin": "^1.6.20",