@wistia/oxlint-config 0.0.1 → 0.3.0

package/rules/vitest.ts

@@ -0,0 +1,324 @@
+import type { RuleFile } from '../types.ts';
+
+// NOTE: oxlint splits vitest-related rules across two plugin namespaces:
+//   - "vitest/" for rules that are vitest-specific (no Jest equivalent)
+//   - "jest/" for rules that originated in eslint-plugin-jest and are shared with vitest
+// Both namespaces are used here for VITEST projects only. Despite the "jest/" prefix,
+// these rules apply to vitest code. This is an oxlint naming convention, not a dependency on Jest.
+export const vitestRules = {
+  plugins: ['vitest', 'jest'],
+  jsPlugins: [
+    { name: 'vitest-js', specifier: '@vitest/eslint-plugin' },
+    'eslint-plugin-no-only-tests',
+  ],
+  rules: {
+    // -- vitest-specific rules (no Jest equivalent) --
+
+    // Require .test test file pattern
+    // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/consistent-test-filename.md
+    'vitest/consistent-test-filename': 'error',
+
+    // Enforce consistent usage of each with for...of
+    // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/consistent-each-for.md
+    'vitest/consistent-each-for': 'error',
+
+    // Enforce consistent usage of vi vs vitest
+    // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/consistent-vitest-vi.md
+    'vitest/consistent-vitest-vi': 'error',
+
+    // Ensure hoisted APIs (vi.mock, vi.hoisted, etc.) are at the top
+    // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/hoisted-apis-on-top.md
+    'vitest/hoisted-apis-on-top': 'error',
+
+    // Disallow conditional tests
+    // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/no-conditional-tests.md
+    'vitest/no-conditional-tests': 'error',
+
+    // Disallow importing node:test
+    // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/no-import-node-test.md
+    'vitest/no-import-node-test': 'error',
+
+    // Prefer toHaveBeenCalledOnce() over toHaveBeenCalledTimes(1)
+    // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/prefer-called-once.md
+    // decision: conflicts with prefer-called-times (jest plugin), which is enabled
+    'vitest/prefer-called-once': 'off',
+
+    // Prefer toHaveBeenCalledTimes over multiple assertions
+    // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/prefer-called-times.md
+    'vitest/prefer-called-times': 'error',
+
+    // Enforce describe titles to match function names
+    // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/prefer-describe-function-title.md
+    'vitest/prefer-describe-function-title': 'error',
+
+    // Prefer expect.typeOf() usage
+    // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/prefer-expect-type-of.md
+    'vitest/prefer-expect-type-of': 'error',
+
+    // Prefer vi.importActual/vi.importMock in vi.mock factories
+    // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/prefer-import-in-mock.md
+    // decision: potentially helpful but causes too many type errors
+    'vitest/prefer-import-in-mock': 'off',
+
+    // Prefer strict boolean matchers (toBe(true) over toBeTruthy())
+    // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/prefer-strict-boolean-matchers.md
+    'vitest/prefer-strict-boolean-matchers': 'error',
+
+    // Suggest using toBeFalsy()
+    // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/prefer-to-be-falsy.md
+    // decision: not necessary to be prescriptive here
+    'vitest/prefer-to-be-falsy': 'off',
+
+    // Prefer toBeObject()
+    // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/prefer-to-be-object.md
+    'vitest/prefer-to-be-object': 'error',
+
+    // Suggest using toBeTruthy
+    // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/prefer-to-be-truthy.md
+    // decision: not necessary to be prescriptive here
+    'vitest/prefer-to-be-truthy': 'off',
+
+    // Require local Test Context for concurrent snapshot tests
+    // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/require-local-test-context-for-concurrent-snapshots.md
+    'vitest/require-local-test-context-for-concurrent-snapshots': 'error',
+
+    // -- Shared vitest/jest rules (oxlint uses the "jest/" prefix for these) --
+
+    // Prefer test or it but not both
+    // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/consistent-test-it.md
+    'jest/consistent-test-it': 'error',
+
+    // Enforce having expectation in test body
+    // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/expect-expect.md
+    'jest/expect-expect': 'error',
+
+    // Enforce a maximum number of expect per test
+    // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/max-expects.md
+    'jest/max-expects': [
+      'error',
+      {
+        max: 15,
+      },
+    ],
+
+    // Nested describe block should be less than set max value or default value
+    // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/max-nested-describe.md
+    'jest/max-nested-describe': 'error',
+
+    // Disallow alias methods
+    // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/no-alias-methods.md
+    'jest/no-alias-methods': 'error',
+
+    // Disallow commented out tests
+    // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/no-commented-out-tests.md
+    'jest/no-commented-out-tests': 'error',
+
+    // Disallow conditional expects
+    // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/no-conditional-expect.md
+    'jest/no-conditional-expect': 'error',
+
+    // Disallow conditional tests
+    // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/no-conditional-in-test.md
+    // decision: disabled in oxlint — the native jest/ prefix doesn't match existing
+    // `eslint-disable vitest/no-conditional-in-test` comments, and the jsPlugin vitest-js/
+    // alias has the same problem. Eslint still enforces this rule.
+    'jest/no-conditional-in-test': 'off',
+
+    // Disallow disabled tests
+    // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/no-disabled-tests.md
+    // decision: it is often useful to be allowed to add a .skip
+    'jest/no-disabled-tests': 'off',
+
+    // Disallow duplicate hooks and teardown hooks
+    // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/no-duplicate-hooks.md
+    'jest/no-duplicate-hooks': 'error',
+
+    // Disallow focused tests
+    // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/no-focused-tests.md
+    'jest/no-focused-tests': 'error',
+
+    // Disallow setup and teardown hooks
+    // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/no-hooks.md
+    'jest/no-hooks': 'off',
+
+    // Disallow identical titles
+    // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/no-identical-title.md
+    'jest/no-identical-title': 'error',
+
+    // Disallow string interpolation in snapshots
+    // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/no-interpolation-in-snapshots.md
+    'jest/no-interpolation-in-snapshots': 'error',
+
+    // Disallow large snapshots
+    // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/no-large-snapshots.md
+    'jest/no-large-snapshots': [
+      'error',
+      {
+        maxSize: 500,
+      },
+    ],
+
+    // Disallow importing from mocks directory
+    // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/no-mocks-import.md
+    'jest/no-mocks-import': 'error',
+
+    // Disallow the use of certain matchers
+    // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/no-restricted-matchers.md
+    'jest/no-restricted-matchers': 'error',
+
+    // Disallow using expect outside of it or test blocks
+    // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/no-standalone-expect.md
+    'jest/no-standalone-expect': 'error',
+
+    // Disallow using test as a prefix
+    // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/no-test-prefixes.md
+    'jest/no-test-prefixes': 'error',
+
+    // Disallow return statements in tests
+    // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/no-test-return-statement.md
+    'jest/no-test-return-statement': 'error',
+
+    // Disallow unnecessary async in expect functions
+    // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/no-unneeded-async-expect-function.md
+    'jest/no-unneeded-async-expect-function': 'error',
+
+    // Enforce padding around test blocks
+    // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/padding-around-test-blocks.md
+    'jest/padding-around-test-blocks': 'error',
+
+    // Suggest using toBeCalledWith() or toHaveBeenCalledWith()
+    // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/prefer-called-with.md
+    'jest/prefer-called-with': 'error',
+
+    // Suggest using the built-in comparison matchers
+    // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/prefer-comparison-matcher.md
+    'jest/prefer-comparison-matcher': 'error',
+
+    // Prefer each rather than manual loops
+    // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/prefer-each.md
+    'jest/prefer-each': 'error',
+
+    // Suggest using the built-in equality matchers
+    // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/prefer-equality-matcher.md
+    'jest/prefer-equality-matcher': 'error',
+
+    // Suggest using expect().resolves over expect(await ...) syntax
+    // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/prefer-expect-resolves.md
+    'jest/prefer-expect-resolves': 'error',
+
+    // Prefer having hooks in consistent order
+    // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/prefer-hooks-in-order.md
+    'jest/prefer-hooks-in-order': 'error',
+
+    // Suggest having hooks before any test cases
+    // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/prefer-hooks-on-top.md
+    'jest/prefer-hooks-on-top': 'error',
+
+    // Enforce lowercase titles
+    // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/prefer-lowercase-title.md
+    'vitest/prefer-lowercase-title': 'off',
+
+    // Prefer mock resolved/rejected shorthands for promises
+    // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/prefer-mock-promise-shorthand.md
+    'jest/prefer-mock-promise-shorthand': 'error',
+
+    // Prefer mock return shorthands
+    // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/prefer-mock-return-shorthand.md
+    'jest/prefer-mock-return-shorthand': 'error',
+
+    // Suggest using vi.spyOn
+    // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/prefer-spy-on.md
+    'jest/prefer-spy-on': 'error',
+
+    // Prefer strict equal over equal
+    // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/prefer-strict-equal.md
+    'jest/prefer-strict-equal': 'error',
+
+    // Suggest using toBe()
+    // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/prefer-to-be.md
+    'jest/prefer-to-be': 'error',
+
+    // Prefer using toContain()
+    // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/prefer-to-contain.md
+    'jest/prefer-to-contain': 'error',
+
+    // Suggest using toHaveLength()
+    // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/prefer-to-have-length.md
+    'jest/prefer-to-have-length': 'error',
+
+    // Suggest using test.todo
+    // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/prefer-todo.md
+    'jest/prefer-todo': 'error',
+
+    // Require setup and teardown to be within a hook
+    // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/require-hook.md
+    'jest/require-hook': 'error',
+
+    // Require toThrow() to be called with an error message
+    // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/require-to-throw-message.md
+    'jest/require-to-throw-message': 'error',
+
+    // Enforce that all tests are in a top-level describe
+    // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/require-top-level-describe.md
+    'jest/require-top-level-describe': 'error',
+
+    // Enforce valid describe callback
+    // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/valid-describe-callback.md
+    'jest/valid-describe-callback': 'error',
+
+    // Enforce valid expect() usage
+    // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/valid-expect.md
+    'jest/valid-expect': 'error',
+
+    // Enforce valid titles
+    // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/valid-title.md
+    // decision: `allowArguments` avoids conflict with `prefer-describe-function-title` rule, which is enabled
+    'jest/valid-title': ['error', { allowArguments: true }],
+
+    // -- Rules via jsPlugins (@vitest/eslint-plugin + no-only-tests) --
+
+    // Disallow .only tests
+    // https://github.com/levibuzolic/eslint-plugin-no-only-tests
+    'eslint-plugin-no-only-tests/no-only-tests': 'error',
+
+    // Disallow the use of certain vi methods
+    // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/no-restricted-vi-methods.md
+    'vitest-js/no-restricted-vi-methods': 'error',
+
+    // Prefer toHaveBeenCalledExactlyOnceWith over manual assertions
+    // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/prefer-called-exactly-once-with.md
+    'vitest-js/prefer-called-exactly-once-with': 'error',
+
+    // Prefer importing vitest globals
+    // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/prefer-importing-vitest-globals.md
+    'vitest-js/prefer-importing-vitest-globals': 'error',
+
+    // Prefer snapshot hint for inline/external snapshots
+    // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/prefer-snapshot-hint.md
+    'vitest-js/prefer-snapshot-hint': 'error',
+
+    // Enforce padding around afterAll blocks
+    // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/padding-around-after-all-blocks.md
+    'vitest-js/padding-around-after-all-blocks': 'error',
+
+    // Enforce padding around afterEach blocks
+    // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/padding-around-after-each-blocks.md
+    'vitest-js/padding-around-after-each-blocks': 'error',
+
+    // Enforce padding around beforeAll blocks
+    // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/padding-around-before-all-blocks.md
+    'vitest-js/padding-around-before-all-blocks': 'error',
+
+    // Enforce padding around beforeEach blocks
+    // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/padding-around-before-each-blocks.md
+    'vitest-js/padding-around-before-each-blocks': 'error',
+
+    // Enforce padding around expect groups
+    // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/padding-around-expect-groups.md
+    'vitest-js/padding-around-expect-groups': 'error',
+
+    // Enforce padding around describe blocks
+    // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/padding-around-describe-blocks.md
+    'vitest-js/padding-around-describe-blocks': 'error',
+  },
+} satisfies RuleFile;

package/types.ts

@@ -0,0 +1,24 @@
+import type { DummyRule, ExternalPluginEntry } from 'oxlint';
+
+type LintPlugin =
+  | 'eslint'
+  | 'import'
+  | 'jest'
+  | 'jsdoc'
+  | 'jsx-a11y'
+  | 'nextjs'
+  | 'node'
+  | 'oxc'
+  | 'promise'
+  | 'react'
+  | 'react-perf'
+  | 'typescript'
+  | 'unicorn'
+  | 'vitest'
+  | 'vue';
+
+export type RuleFile = {
+  plugins?: LintPlugin[];
+  jsPlugins?: ExternalPluginEntry[];
+  rules: Record<string, DummyRule>;
+};

package/.tool-versions

@@ -1 +0,0 @@
-nodejs 24.14.1