feat: add oxlint configuration and custom rule plugins

joyenjoyer · joyenjoyer · commit 41a0afe3fe2e · 2026-07-28T13:44:42.000+02:00
Add .oxlintrc.json (workspace root and regression-test), porting the
ESLint ruleset to oxlint and covering gaps with two custom rules and a
jsPlugins bridge:

- react-js/* (jsPlugins bridge to eslint-plugin-react): covers no-deprecated, prop-types, no-typos,
  require-default-props, forbid-foreign-prop-types, missing from oxlint's native react plugin.
- instructure/no-relative-imports (custom): blocks relative imports that reach into another
  package's src, bypassing that package's public API.
- notice/notice (custom): requires the MIT license header at the top of source files.
- vitest/valid-expect (override, ui-truncate-text only): disabled because oxlint's vitest plugin
  does not recognize the chai-style assertions used in those tests.

Nothing consumes oxlint yet. ESLint still runs via lint-staged,
ui-scripts lint, and regression-test's lint script.
diff --git a/.oxlintrc.json b/.oxlintrc.json
diff --git a/package.json b/package.json
@@ -106,6 +106,7 @@
     "lerna": "9.0.7",
     "lint-staged": "^17.0.8",
     "moment-timezone": "^0.6.2",
+    "oxlint": "^1.72.0",
     "prettier": "2.8.8",
     "playwright": "1.61.1",
     "react": "18.3.1",
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/regression-test/.oxlintrc.json b/regression-test/.oxlintrc.json
@@ -0,0 +1,24 @@
+{
+  "$schema": "../node_modules/oxlint/configuration_schema.json",
+  "extends": ["../.oxlintrc.json"],
+  "jsPlugins": [
+    {
+      "name": "react-js",
+      "specifier": "eslint-plugin-react"
+    },
+    "../scripts/oxlint/no-relative-imports-plugin.mjs",
+    "../scripts/oxlint/notice-plugin.mjs"
+  ],
+  "settings": {
+    "react": {
+      "version": "19.2.7"
+    }
+  },
+  "ignorePatterns": [
+    "**/node_modules/**",
+    "**/.next/**",
+    "**/next-env.d.ts",
+    "out/**",
+    "coverage/**"
+  ]
+}
diff --git a/scripts/oxlint/__node_tests__/__testfixtures__/no-relative-imports/pkg-a/package.json b/scripts/oxlint/__node_tests__/__testfixtures__/no-relative-imports/pkg-a/package.json
@@ -0,0 +1,4 @@
+{
+  "name": "@fixtures/pkg-a",
+  "private": true
+}
diff --git a/scripts/oxlint/__node_tests__/__testfixtures__/no-relative-imports/pkg-a/src/index.ts b/scripts/oxlint/__node_tests__/__testfixtures__/no-relative-imports/pkg-a/src/index.ts
@@ -0,0 +1,28 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2015 - present Instructure, Inc.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+import sibling from './sibling'
+import other from '../../pkg-b/src/index'
+
+export default { sibling, other }
diff --git a/scripts/oxlint/__node_tests__/__testfixtures__/no-relative-imports/pkg-a/src/sibling.ts b/scripts/oxlint/__node_tests__/__testfixtures__/no-relative-imports/pkg-a/src/sibling.ts
@@ -0,0 +1,25 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2015 - present Instructure, Inc.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+export default 'sibling'
diff --git a/scripts/oxlint/__node_tests__/__testfixtures__/no-relative-imports/pkg-b/package.json b/scripts/oxlint/__node_tests__/__testfixtures__/no-relative-imports/pkg-b/package.json
@@ -0,0 +1,4 @@
+{
+  "name": "@fixtures/pkg-b",
+  "private": true
+}
diff --git a/scripts/oxlint/__node_tests__/__testfixtures__/no-relative-imports/pkg-b/src/index.ts b/scripts/oxlint/__node_tests__/__testfixtures__/no-relative-imports/pkg-b/src/index.ts
@@ -0,0 +1,25 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2015 - present Instructure, Inc.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+export default 'pkg-b'
diff --git a/scripts/oxlint/__node_tests__/no-relative-imports-plugin.test.ts b/scripts/oxlint/__node_tests__/no-relative-imports-plugin.test.ts
@@ -0,0 +1,117 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2015 - present Instructure, Inc.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+import { describe, expect, it } from 'vitest'
+import path from 'node:path'
+import plugin, {
+  checkImportForRelativePackage,
+  findNamedPackage
+} from '../no-relative-imports-plugin.mjs'
+
+const FIXTURES = path.join(__dirname, '__testfixtures__', 'no-relative-imports')
+const PKG_A_INDEX = path.join(FIXTURES, 'pkg-a', 'src', 'index.ts')
+
+describe('no-relative-imports-plugin', () => {
+  describe('findNamedPackage', () => {
+    it('walks up from a file to the nearest named package.json', () => {
+      const found = findNamedPackage(PKG_A_INDEX)
+      expect(found.packageJson?.name).toBe('@fixtures/pkg-a')
+    })
+  })
+
+  describe('checkImportForRelativePackage (pure rule logic)', () => {
+    it('flags a cross-package relative import, with the real error message format', () => {
+      const message = checkImportForRelativePackage(
+        '../../pkg-b/src/index',
+        PKG_A_INDEX
+      )
+      expect(message).toBe(
+        'Relative import from another package is not allowed. ' +
+          'Use "@fixtures/pkg-b/index" instead of "../../pkg-b/src/index"'
+      )
+    })
+
+    it('stays silent on a same-package sibling import', () => {
+      const message = checkImportForRelativePackage('./sibling', PKG_A_INDEX)
+      expect(message).toBeNull()
+    })
+
+    it('stays silent on a non-relative (bare specifier) import', () => {
+      const message = checkImportForRelativePackage(
+        '@instructure/ui-buttons',
+        PKG_A_INDEX
+      )
+      expect(message).toBeNull()
+    })
+
+    it('stays silent when there is no context filename', () => {
+      const message = checkImportForRelativePackage('../../pkg-b/src/index', '')
+      expect(message).toBeNull()
+    })
+  })
+
+  describe('the oxlint rule (create/visitor), independent of the oxlint CLI', () => {
+    function lintWithVisitor(filename: string, imports: string[]) {
+      const reports: unknown[] = []
+      const context = {
+        filename,
+        report: (report: unknown) => reports.push(report)
+      }
+      const visitor = plugin.rules['no-relative-imports'].create(
+        context as never
+      )
+      for (const source of imports) {
+        visitor.ImportDeclaration({ source: { value: source } } as never)
+      }
+      return reports
+    }
+
+    it('reports exactly one violation for a cross-package import, none for a sibling import', () => {
+      const reports = lintWithVisitor(PKG_A_INDEX, [
+        './sibling',
+        '../../pkg-b/src/index'
+      ])
+      expect(reports).toHaveLength(1)
+      expect((reports[0] as { message: string }).message).toMatch(
+        /Relative import from another package/
+      )
+    })
+
+    it('handles CallExpression require() the same way as ImportDeclaration', () => {
+      const reports: unknown[] = []
+      const context = {
+        filename: PKG_A_INDEX,
+        report: (report: unknown) => reports.push(report)
+      }
+      const visitor = plugin.rules['no-relative-imports'].create(
+        context as never
+      )
+      visitor.CallExpression({
+        callee: { type: 'Identifier', name: 'require' },
+        arguments: [{ type: 'Literal', value: '../../pkg-b/src/index' }]
+      } as never)
+      expect(reports).toHaveLength(1)
+    })
+  })
+})
diff --git a/scripts/oxlint/__node_tests__/notice-plugin.test.ts b/scripts/oxlint/__node_tests__/notice-plugin.test.ts
@@ -0,0 +1,109 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2015 - present Instructure, Inc.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+import { describe, expect, it } from 'vitest'
+import plugin, {
+  COPYRIGHT_NOTICE,
+  hasNoticeHeader,
+  insertNoticeHeader
+} from '../notice-plugin.mjs'
+
+const CLEAN_SOURCE = 'export const x = 1\n'
+
+describe('notice-plugin', () => {
+  describe('hasNoticeHeader (pure rule logic)', () => {
+    it('is false for a file missing the header', () => {
+      expect(hasNoticeHeader(CLEAN_SOURCE)).toBe(false)
+    })
+
+    it('is true for a file that already has the real header', () => {
+      expect(hasNoticeHeader(COPYRIGHT_NOTICE + '\n' + CLEAN_SOURCE)).toBe(true)
+    })
+
+    it('is false for a header that merely resembles the real one (wrong text)', () => {
+      expect(
+        hasNoticeHeader('/* Copyright someone else */\n' + CLEAN_SOURCE)
+      ).toBe(false)
+    })
+  })
+
+  describe('insertNoticeHeader (fixer logic)', () => {
+    it('prepends the exact real MIT header text', () => {
+      const fixed = insertNoticeHeader(CLEAN_SOURCE)
+      expect(fixed).toBe(COPYRIGHT_NOTICE + '\n' + CLEAN_SOURCE)
+      expect(fixed).toContain('The MIT License (MIT)')
+      expect(fixed).toContain('Copyright (c) 2015 - present Instructure, Inc.')
+    })
+
+    it('the fix is idempotent: applying it only when missing never duplicates the header', () => {
+      const applyFixIfNeeded = (text: string) =>
+        hasNoticeHeader(text) ? text : insertNoticeHeader(text)
+
+      const once = applyFixIfNeeded(CLEAN_SOURCE)
+      const twice = applyFixIfNeeded(once)
+
+      expect(twice).toBe(once)
+      expect(once.match(/The MIT License \(MIT\)/g)).toHaveLength(1)
+    })
+  })
+
+  describe('the oxlint rule (create/visitor), independent of the oxlint CLI', () => {
+    function lint(sourceText: string) {
+      const reports: Array<{
+        message: string
+        fix?: (fixer: unknown) => unknown
+      }> = []
+      const context = {
+        sourceCode: { getText: () => sourceText },
+        report: (report: {
+          message: string
+          fix?: (fixer: unknown) => unknown
+        }) => reports.push(report)
+      }
+      const visitor = plugin.rules.notice.create(context as never)
+      visitor.Program({} as never)
+      return reports
+    }
+
+    it('reports a missing header and the fix inserts the exact real header', () => {
+      const reports = lint(CLEAN_SOURCE)
+      expect(reports).toHaveLength(1)
+
+      const fixer = {
+        insertTextBefore: (_node: unknown, text: string) => ({ text })
+      }
+      const fixResult = reports[0].fix?.(fixer) as { text: string } | undefined
+      expect(fixResult?.text).toBe(COPYRIGHT_NOTICE + '\n')
+    })
+
+    it('stays silent when the header is already present', () => {
+      const reports = lint(COPYRIGHT_NOTICE + '\n' + CLEAN_SOURCE)
+      expect(reports).toHaveLength(0)
+    })
+
+    it('declares meta.fixable so oxlint accepts its fixer', () => {
+      expect(plugin.rules.notice.meta?.fixable).toBe('code')
+    })
+  })
+})
diff --git a/scripts/oxlint/no-relative-imports-plugin.mjs b/scripts/oxlint/no-relative-imports-plugin.mjs
diff --git a/scripts/oxlint/notice-plugin.mjs b/scripts/oxlint/notice-plugin.mjs

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +{
 +  "name": "@fixtures/pkg-a",
 +  "private": true
 +}