Linter plugins: `eslint-plugin-better-tailwindcss` failed to run with Oxlint JS plugins

[magic-akari]

Core issue

eslint-plugin-better-tailwindcss requires Configuring Shared Settings.

Reproduce Steps

clone this repo

git clone https://gist.github.com/d71a60666a875fef03858dbc6a32d28a.git oxlint-jsplugins-tailwindcss

install dependencies

pnpm i

run tests

pnpm test

check the errors

❯ pnpm test

> oxlint-jsplugins-tailwindcss@1.0.0 test /Users/akari/Developer/oxlint-jsplugins-tailwindcss
> oxlint test.jsx

WARNING: JS plugins are experimental and not subject to semver.
Breaking changes are possible while JS plugins support is under development.

  × Error running JS plugin.
  │ File path: /Users/akari/Developer/oxlint-jsplugins-tailwindcss/test.jsx
  │ TypeError: Cannot read properties of undefined (reading 'eslint-plugin-better-tailwindcss')
  │     at getOption (file:///Users/akari/Developer/oxlint-jsplugins-tailwindcss/node_modules/.pnpm/eslint-plugin-better-tailwindcss@3.7.10_eslint@9.37.0_jiti@2.6.1__tailwindcss@4.1.14/node_modules/eslint-plugin-better-tailwindcss/lib/esm/utils/options.js:26:49)
  │     at getCommonOptions (file:///Users/akari/Developer/oxlint-jsplugins-tailwindcss/node_modules/.pnpm/eslint-plugin-better-tailwindcss@3.7.10_eslint@9.37.0_jiti@2.6.1__tailwindcss@4.1.14/node_modules/eslint-plugin-better-tailwindcss/lib/esm/utils/options.js:5:24)
  │     at getOptions (file:///Users/akari/Developer/oxlint-jsplugins-tailwindcss/node_modules/.pnpm/eslint-plugin-better-tailwindcss@3.7.10_eslint@9.37.0_jiti@2.6.1__tailwindcss@4.1.14/node_modules/eslint-plugin-better-tailwindcss/lib/esm/rules/enforce-consistent-important-position.js:91:20)
  │     at createRuleListener (file:///Users/akari/Developer/oxlint-jsplugins-tailwindcss/node_modules/.pnpm/eslint-plugin-better-tailwindcss@3.7.10_eslint@9.37.0_jiti@2.6.1__tailwindcss@4.1.14/node_modules/eslint-plugin-better-tailwindcss/lib/esm/utils/rule.js:15:54)
  │     at Object.create (file:///Users/akari/Developer/oxlint-jsplugins-tailwindcss/node_modules/.pnpm/eslint-plugin-better-tailwindcss@3.7.10_eslint@9.37.0_jiti@2.6.1__tailwindcss@4.1.14/node_modules/eslint-plugin-better-tailwindcss/lib/esm/rules/enforce-consistent-important-position.js:20:24)
  │     at lintFileImpl (file:///Users/akari/Developer/oxlint-jsplugins-tailwindcss/node_modules/.pnpm/oxlint@1.23.0/node_modules/oxlint/dist/plugins.js:4169:40)
  │     at lintFile (file:///Users/akari/Developer/oxlint-jsplugins-tailwindcss/node_modules/.pnpm/oxlint@1.23.0/node_modules/oxlint/dist/plugins.js:4147:10)
  │     at lintFileWrapper (file:///Users/akari/Developer/oxlint-jsplugins-tailwindcss/node_modules/.pnpm/oxlint@1.23.0/node_modules/oxlint/dist/cli.js:411:9)

Found 0 warnings and 1 error.
Finished in 81ms on 1 file using 10 threads.
 ELIFECYCLE  Test failed. See above for more details.

[schoero]

I'm the author of eslint-plugin-better-tailwindcss and I have played around a bit with oxlint trying to get it to work.

There is currently one additional API that is missing that causes it to fail with oxlint which is the cwd property on the ESLint context object. I can work around that by falling back to process.cwd() for oxlint.

Other than that, the main thing that is missing is the support for rule options. The plugin is required to read the tailwind config (or css entryPoint) to function properly, and that needs to be configured because it is different in every project.

This can be done via rule options for each rule separately or with the shared settings as magic-akari has mentioned.

[schoero]

What's probably also worth mentioning is that I had to add a default export to the package.json:

 "exports": {
     ".": {
       "require": "./lib/cjs/configs/cjs.js",
       "import": "./lib/esm/configs/esm.js",
+      "default": "./lib/esm/configs/esm.js"
     }
 }

The "import" or "require" alone weren't enough and I got this error:

WARNING: JS plugins are experimental and not subject to semver.
Breaking changes are possible while JS plugins support is under development.
Failed to parse configuration file.

  × Failed to load JS plugin: eslint-plugin-better-tailwindcss
  │   Package subpath '.' is not defined by "exports" in /Users/schoero/oxlint-test/node_modules/eslint-plugin-better-tailwindcss/package.json

[overlookmotel]

@schoero cwd property added in #14814, and #15248 hopefully fixes the need for default in exports. Adding support for options and settings are still a work in progress.