@wistia/oxlint-config 0.7.4 → 0.8.0

package/README.md

@@ -12,9 +12,23 @@ Wistia's Oxlint configurations. This is a shared config package for [oxlint](htt
 ## How to install
 
 ```bash
-yarn add -D @wistia/oxlint-config oxlint
+yarn add -D @wistia/oxlint-config oxlint eslint
 ```
 
+> **Why `eslint`?** This package uses oxlint's [jsPlugins](https://oxc.rs/docs/guide/usage/linter/js-plugins) feature to run ESLint plugins (e.g. `eslint-plugin-import-x`, `@eslint-react/eslint-plugin`, `eslint-plugin-testing-library`, etc.) natively inside oxlint. These plugins import utilities from the `eslint` package at runtime, so it must be installed even though you won't run `eslint` directly.
+>
+> **Note:** jsPlugins do not support rules that rely on TypeScript type information. Any type-aware rules in this config use native oxlint rules instead.
+
+### Type-aware linting
+
+The `typescriptConfig` enables [type-aware linting](https://oxc.rs/docs/guide/usage/linter/type-aware), which requires the `oxlint-tsgolint` package:
+
+```bash
+yarn add -D oxlint-tsgolint
+```
+
+`oxlint-tsgolint` is a separate Go-based tool that builds your TypeScript program using `typescript-go` and runs type-aware rules (e.g. detecting unhandled promises, unsafe assignments). Without it installed, type-aware rules will not run.
+
 ## Quick start
 
 Create an `oxlint.config.ts` in your project root:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wistia/oxlint-config",
-  "version": "0.7.4",
+  "version": "0.8.0",
   "description": "Wistia's Oxlint configurations",
   "packageManager": "yarn@4.14.1",
   "type": "module",
@@ -42,6 +42,7 @@
   },
   "scripts": {
     "changeset": "changeset",
+    "disabled": "node scripts/list-disabled-rules.mjs",
     "format": "oxfmt .",
     "format:ci": "oxfmt --check .",
     "outdated": "yarn upgrade-interactive",
@@ -54,16 +55,16 @@
     "oxlint-tsgolint": ">= 1.0.0"
   },
   "dependencies": {
-    "@eslint-react/eslint-plugin": "^5.7.6",
-    "@vitest/eslint-plugin": "^1.6.16",
+    "@eslint-react/eslint-plugin": "^5.8.3",
+    "@vitest/eslint-plugin": "^1.6.17",
     "confusing-browser-globals": "^1.0.11",
     "eslint-plugin-barrel-files": "^3.0.1",
     "eslint-plugin-import-x": "^4.16.2",
     "eslint-plugin-jest-dom": "^5.5.0",
     "eslint-plugin-n": "^18.0.1",
     "eslint-plugin-no-only-tests": "^3.4.0",
-    "eslint-plugin-playwright": "^2.10.2",
-    "eslint-plugin-storybook": "^10.3.6",
+    "eslint-plugin-playwright": "^2.10.4",
+    "eslint-plugin-storybook": "^10.4.0",
     "eslint-plugin-styled-components": "^0.0.0",
     "eslint-plugin-styled-components-a11y": "^2.2.1",
     "eslint-plugin-testing-library": "^7.16.2",
@@ -72,12 +73,12 @@
   "devDependencies": {
     "@changesets/changelog-github": "^0.7.0",
     "@changesets/cli": "^2.31.0",
-    "eslint": "^10.3.0",
-    "oxfmt": "^0.48.0",
-    "oxlint": "^1.64.0",
-    "oxlint-tsgolint": "^0.22.1",
-    "storybook": "^10.3.6",
-    "vitest": "^4.1.5"
+    "eslint": "^10.4.0",
+    "oxfmt": "^0.51.0",
+    "oxlint": "^1.66.0",
+    "oxlint-tsgolint": "^0.23.0",
+    "storybook": "^10.4.0",
+    "vitest": "^4.1.7"
   },
   "engines": {
     "node": "^20.19.0 || ^22.13.0 || >=24 || >=26"

package/rules/barrel-files.mjs

@@ -5,14 +5,17 @@ export const barrelFilesRules = {
   rules: {
     // Avoid barrel files
     // https://github.com/thepassle/eslint-plugin-barrel-files/blob/main/docs/rules/avoid-barrel-files.md
+    // Decision: too opinionated for general use
     'eslint-plugin-barrel-files/avoid-barrel-files': 'off',
 
     // Avoid importing barrel files
     // https://github.com/thepassle/eslint-plugin-barrel-files/blob/main/docs/rules/avoid-importing-barrel-files.md
+    // Decision: too opinionated for general use
     'eslint-plugin-barrel-files/avoid-importing-barrel-files': 'off',
 
     // Avoid namespace imports from barrel files
     // https://github.com/thepassle/eslint-plugin-barrel-files/blob/main/docs/rules/avoid-namespace-import.md
+    // Decision: too opinionated for general use
     'eslint-plugin-barrel-files/avoid-namespace-import': 'off',
 
     // Avoid re-export all from barrel files

package/rules/base.mjs

@@ -229,6 +229,7 @@ export const baseRules = {
 
     // Require braces around arrow function bodies
     // https://oxc.rs/docs/guide/usage/linter/rules/eslint/arrow-body-style.html
+    // Decision: stylistic choice best left to formatter
     'eslint/arrow-body-style': 'off',
 
     // Enforce the use of variables within the scope they are defined
@@ -271,6 +272,11 @@ export const baseRules = {
     // https://oxc.rs/docs/guide/usage/linter/rules/eslint/grouped-accessor-pairs.html
     'eslint/grouped-accessor-pairs': 'error',
 
+    // Require identifiers to match a specified regular expression
+    // https://oxc.rs/docs/guide/usage/linter/rules/eslint/id-match.html
+    // Decision: too opinionated for general use
+    'eslint/id-match': 'off',
+
     // Enforce minimum and maximum identifier lengths
     // https://oxc.rs/docs/guide/usage/linter/rules/eslint/id-length.html
     'eslint/id-length': [
@@ -373,6 +379,14 @@ export const baseRules = {
     // https://oxc.rs/docs/guide/usage/linter/rules/eslint/no-implicit-coercion.html
     'eslint/no-implicit-coercion': 'error',
 
+    // Disallow declarations in the global scope
+    // https://oxc.rs/docs/guide/usage/linter/rules/eslint/no-implicit-globals.html
+    'eslint/no-implicit-globals': 'error',
+
+    // Disallow the use of eval()-like methods
+    // https://oxc.rs/docs/guide/usage/linter/rules/eslint/no-implied-eval.html
+    'eslint/no-implied-eval': 'error',
+
     // Disallow the use of the __iterator__ property
     // https://oxc.rs/docs/guide/usage/linter/rules/eslint/no-iterator.html
     'eslint/no-iterator': 'error',
@@ -399,7 +413,7 @@ export const baseRules = {
 
     // Disallow magic numbers
     // https://oxc.rs/docs/guide/usage/linter/rules/eslint/no-magic-numbers.html
-    // decision: this rule is too noisy to be a default and was commonly disabled inline
+    // Decision: this rule is too noisy to be a default and was commonly disabled inline
     'eslint/no-magic-numbers': 'off',
 
     // Disallow use of chained assignment expressions
@@ -492,7 +506,7 @@ export const baseRules = {
 
     // Disallow specified modules when loaded by import
     // https://oxc.rs/docs/guide/usage/linter/rules/eslint/no-restricted-imports.html
-    // decision: this should be set at a project-level config if necessary
+    // Decision: this should be set at a project-level config if necessary
     'eslint/no-restricted-imports': 'off',
 
     // Disallow assignment operators in return statements
@@ -576,6 +590,13 @@ export const baseRules = {
     // https://oxc.rs/docs/guide/usage/linter/rules/eslint/operator-assignment.html
     'eslint/operator-assignment': ['error', 'always'],
 
+    // Require using arrow functions for callbacks
+    // https://oxc.rs/docs/guide/usage/linter/rules/eslint/prefer-arrow-callback.html
+    'eslint/prefer-arrow-callback': [
+      'error',
+      { allowNamedFunctions: false, allowUnboundThis: true },
+    ],
+
     // Require const declarations for variables that are never reassigned after declared
     // https://oxc.rs/docs/guide/usage/linter/rules/eslint/prefer-const.html
     'eslint/prefer-const': ['error', { destructuring: 'any', ignoreReadBeforeAssign: true }],
@@ -607,6 +628,10 @@ export const baseRules = {
     // https://oxc.rs/docs/guide/usage/linter/rules/eslint/prefer-object-spread.html
     'eslint/prefer-object-spread': 'error',
 
+    // Disallow use of the RegExp constructor in favor of regular expression literals
+    // https://oxc.rs/docs/guide/usage/linter/rules/eslint/prefer-regex-literals.html
+    'eslint/prefer-regex-literals': ['error', { disallowRedundantWrapping: true }],
+
     // Require using Error objects as Promise rejection reasons
     // https://oxc.rs/docs/guide/usage/linter/rules/eslint/prefer-promise-reject-errors.html
     'eslint/prefer-promise-reject-errors': ['error', { allowEmptyReject: true }],
@@ -657,134 +682,162 @@ export const baseRules = {
 
     // Enforce or disallow capitalization of the first letter of a comment
     // https://oxc.rs/docs/guide/usage/linter/rules/eslint/capitalized-comments.html
+    // Decision: too opinionated for general use
     'eslint/capitalized-comments': 'off',
 
     // Enforce a maximum cyclomatic complexity allowed in a program
     // https://oxc.rs/docs/guide/usage/linter/rules/eslint/complexity.html
+    // Decision: too opinionated for general use
     'eslint/complexity': 'off',
 
     // Require following curly brace conventions
     // https://oxc.rs/docs/guide/usage/linter/rules/eslint/curly.html
+    // Decision: stylistic choice best left to formatter
     'eslint/curly': 'off',
 
     // Require function names to match the name of the variable or property to which they are assigned
     // https://oxc.rs/docs/guide/usage/linter/rules/eslint/func-name-matching.html
+    // Decision: too opinionated for general use
     'eslint/func-name-matching': 'off',
 
     // Require or disallow initialization in variable declarations
     // https://oxc.rs/docs/guide/usage/linter/rules/eslint/init-declarations.html
+    // Decision: too opinionated for general use
     'eslint/init-declarations': 'off',
 
     // Require or disallow logical assignment operator shorthand
     // https://oxc.rs/docs/guide/usage/linter/rules/eslint/logical-assignment-operators.html
+    // Decision: too opinionated for general use
     'eslint/logical-assignment-operators': 'off',
 
     // Enforce a maximum depth that blocks can be nested
     // https://oxc.rs/docs/guide/usage/linter/rules/eslint/max-depth.html
+    // Decision: too opinionated for general use
     'eslint/max-depth': 'off',
 
     // Enforce a maximum number of lines per file
     // https://oxc.rs/docs/guide/usage/linter/rules/eslint/max-lines.html
+    // Decision: too opinionated for general use
     'eslint/max-lines': 'off',
 
     // Enforce a maximum number of lines of code in a function
     // https://oxc.rs/docs/guide/usage/linter/rules/eslint/max-lines-per-function.html
+    // Decision: too opinionated for general use
     'eslint/max-lines-per-function': 'off',
 
     // Enforce a maximum depth that callbacks can be nested
     // https://oxc.rs/docs/guide/usage/linter/rules/eslint/max-nested-callbacks.html
+    // Decision: too opinionated for general use
     'eslint/max-nested-callbacks': 'off',
 
     // Enforce a maximum number of parameters in function definitions
     // https://oxc.rs/docs/guide/usage/linter/rules/eslint/max-params.html
+    // Decision: too opinionated for general use
     'eslint/max-params': 'off',
 
     // Enforce a maximum number of statements allowed in function blocks
     // https://oxc.rs/docs/guide/usage/linter/rules/eslint/max-statements.html
+    // Decision: too opinionated for general use
     'eslint/max-statements': 'off',
 
     // Require regex literals to escape division operators
     // https://oxc.rs/docs/guide/usage/linter/rules/eslint/no-div-regex.html
+    // Decision: too opinionated for general use
     'eslint/no-div-regex': 'off',
 
     // Disallow duplicate module imports
     // https://oxc.rs/docs/guide/usage/linter/rules/eslint/no-duplicate-imports.html
+    // Decision: handled by import plugin
     'eslint/no-duplicate-imports': 'off',
 
     // Disallow null comparisons without type-checking operators
     // https://oxc.rs/docs/guide/usage/linter/rules/eslint/no-eq-null.html
+    // Decision: too opinionated for general use
     'eslint/no-eq-null': 'off',
 
     // Disallow inline comments after code
     // https://oxc.rs/docs/guide/usage/linter/rules/eslint/no-inline-comments.html
+    // Decision: inline comments are occasionally necessary
     'eslint/no-inline-comments': 'off',
 
     // Disallow negated conditions
     // https://oxc.rs/docs/guide/usage/linter/rules/eslint/no-negated-condition.html
+    // Decision: too opinionated for general use
     'eslint/no-negated-condition': 'off',
 
     // Disallow specified names in exports
     // https://oxc.rs/docs/guide/usage/linter/rules/eslint/no-restricted-exports.html
+    // Decision: requires project-specific configuration
     'eslint/no-restricted-exports': 'off',
 
     // Disallow certain properties on certain objects
     // https://oxc.rs/docs/guide/usage/linter/rules/eslint/no-restricted-properties.html
+    // Decision: requires project-specific configuration
     'eslint/no-restricted-properties': 'off',
 
     // Disallow ternary operators
     // https://oxc.rs/docs/guide/usage/linter/rules/eslint/no-ternary.html
+    // Decision: restricts valid language feature
     'eslint/no-ternary': 'off',
 
     // Disallow the use of undeclared variables unless mentioned in global comments
     // https://oxc.rs/docs/guide/usage/linter/rules/eslint/no-undef.html
+    // Decision: handled by TypeScript
     'eslint/no-undef': 'off',
 
     // Disallow the use of undefined as an identifier
     // https://oxc.rs/docs/guide/usage/linter/rules/eslint/no-undefined.html
+    // Decision: restricts valid language feature
     'eslint/no-undefined': 'off',
 
     // Disallow dangling underscores in identifiers
     // https://oxc.rs/docs/guide/usage/linter/rules/eslint/no-underscore-dangle.html
+    // Decision: too opinionated for general use
     'eslint/no-underscore-dangle': 'off',
 
     // Disallow confusing multiline expressions
     // https://oxc.rs/docs/guide/usage/linter/rules/eslint/no-unexpected-multiline.html
+    // Decision: stylistic choice best left to formatter
     'eslint/no-unexpected-multiline': 'off',
 
     // Disallow assignments that are never used
     // https://oxc.rs/docs/guide/usage/linter/rules/eslint/no-useless-assignment.html
+    // Decision: handled by TypeScript noUnusedLocals
     'eslint/no-useless-assignment': 'off',
 
     // Disallow unnecessary calls to .call() and .apply()
     // https://oxc.rs/docs/guide/usage/linter/rules/eslint/no-useless-call.html
+    // Decision: too opinionated for general use
     'eslint/no-useless-call': 'off',
 
     // Disallow specified warning terms in comments
     // https://oxc.rs/docs/guide/usage/linter/rules/eslint/no-warning-comments.html
+    // Decision: too opinionated for general use
     'eslint/no-warning-comments': 'off',
 
     // Require or disallow method and property shorthand syntax for object literals
     // https://oxc.rs/docs/guide/usage/linter/rules/eslint/object-shorthand.html
+    // Decision: feels overprescriptive to enforce this style choice
     'eslint/object-shorthand': 'off',
 
-    // Disallow use of Object.create(null) in favor of using regex literals
-    // https://oxc.rs/docs/guide/usage/linter/rules/eslint/prefer-regex-literals.html
-    'eslint/prefer-regex-literals': 'off',
-
     // Enforce the use of u or v flag on regular expressions
     // https://oxc.rs/docs/guide/usage/linter/rules/eslint/require-unicode-regexp.html
+    // Decision: too opinionated for general use
     'eslint/require-unicode-regexp': 'off',
 
     // Enforce sorted import declarations within modules
     // https://oxc.rs/docs/guide/usage/linter/rules/eslint/sort-imports.html
+    // Decision: handled by import plugin
     'eslint/sort-imports': 'off',
 
     // Require object keys to be sorted
     // https://oxc.rs/docs/guide/usage/linter/rules/eslint/sort-keys.html
+    // Decision: too opinionated for general use
     'eslint/sort-keys': 'off',
 
     // Require variables within the same declaration block to be sorted
     // https://oxc.rs/docs/guide/usage/linter/rules/eslint/sort-vars.html
+    // Decision: too opinionated for general use
     'eslint/sort-vars': 'off',
 
     //oxc rules - these are bug-catchers that oxlint can detect natively.
@@ -851,6 +904,7 @@ export const baseRules = {
 
     // Disallow branches in if/else that share identical code
     // https://oxc.rs/docs/guide/usage/linter/rules/oxc/branches-sharing-code.html
+    // Decision: too noisy in practice
     'oxc/branches-sharing-code': 'off',
 
     // Disallow misrefactored compound assignment operators
@@ -863,18 +917,22 @@ export const baseRules = {
 
     // Disallow use of async/await syntax
     // https://oxc.rs/docs/guide/usage/linter/rules/oxc/no-async-await.html
+    // Decision: restricts valid language feature
     'oxc/no-async-await': 'off',
 
     // Disallow use of async functions as Express endpoint handlers without error handling
     // https://oxc.rs/docs/guide/usage/linter/rules/oxc/no-async-endpoint-handlers.html
+    // Decision: framework-specific, not universally applicable
     'oxc/no-async-endpoint-handlers': 'off',
 
     // Disallow barrel files (index files that re-export from other modules)
     // https://oxc.rs/docs/guide/usage/linter/rules/oxc/no-barrel-file.html
+    // Decision: handled by barrel-files plugin
     'oxc/no-barrel-file': 'off',
 
     // Disallow TypeScript const enums
     // https://oxc.rs/docs/guide/usage/linter/rules/oxc/no-const-enum.html
+    // Decision: too opinionated for general use
     'oxc/no-const-enum': 'off',
 
     // Disallow spreading keys from a map-like object into an object literal
@@ -883,14 +941,17 @@ export const baseRules = {
 
     // Disallow use of optional chaining
     // https://oxc.rs/docs/guide/usage/linter/rules/oxc/no-optional-chaining.html
+    // Decision: restricts valid language feature
     'oxc/no-optional-chaining': 'off',
 
     // Disallow use of rest and spread properties
     // https://oxc.rs/docs/guide/usage/linter/rules/oxc/no-rest-spread-properties.html
+    // Decision: restricts valid language feature
     'oxc/no-rest-spread-properties': 'off',
 
     // Disallow use of this in exported functions
     // https://oxc.rs/docs/guide/usage/linter/rules/oxc/no-this-in-exported-function.html
+    // Decision: too opinionated for general use
     'oxc/no-this-in-exported-function': 'off',
   },
 };