Skip to content

Updated eslint config for TailwindCSS #23739

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Conversation

peterzimon
Copy link
Contributor

Problem: classname ordering is getting messed up in monorepos using eslint-plugin-tailwindcss. This is especially a problem when you want to update classname ordering automatically on save because the wrong order would be saved which fails tests on CI.

According to this issue (francoismassart/eslint-plugin-tailwindcss#241) using absolute URL for the tailwind config file could help with the issue.

@peterzimon peterzimon changed the title Testing updated eslint config for TailwindCSS Updated eslint config for TailwindCSS Jun 9, 2025
Copy link
Contributor

coderabbitai bot commented Jun 9, 2025

Walkthrough

The ESLint configuration files for the apps/posts, apps/stats, and apps/admin-x-settings projects were updated to import the Node.js path module and use path.join(__dirname, 'tailwind.config.cjs') instead of the plain string 'tailwind.config.cjs' for specifying the Tailwind CSS config file path. This change was applied to the linting rules classnames-order, enforces-negative-arbitrary-values, enforces-shorthand, migration-from-tailwind-2, and no-contradicting-classname. No other changes were made to the ESLint configurations, and there were no modifications to exported or public entities.

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

apps/stats/.eslintrc.cjs

Oops! Something went wrong! :(

ESLint: 8.57.1

ESLint couldn't find the plugin "eslint-plugin-react-hooks".

(The package "eslint-plugin-react-hooks" was not found when loaded as a Node module from the directory "/apps/stats".)

It's likely that the plugin isn't installed correctly. Try reinstalling by running the following:

npm install eslint-plugin-react-hooks@latest --save-dev

The plugin "eslint-plugin-react-hooks" was referenced from the config file in "apps/stats/.eslintrc.cjs".

If you still can't figure out the problem, please stop by https://eslint.org/chat/help to chat with the team.

apps/posts/.eslintrc.cjs

Oops! Something went wrong! :(

ESLint: 8.57.1

ESLint couldn't find the plugin "eslint-plugin-react-hooks".

(The package "eslint-plugin-react-hooks" was not found when loaded as a Node module from the directory "/apps/posts".)

It's likely that the plugin isn't installed correctly. Try reinstalling by running the following:

npm install eslint-plugin-react-hooks@latest --save-dev

The plugin "eslint-plugin-react-hooks" was referenced from the config file in "apps/posts/.eslintrc.cjs".

If you still can't figure out the problem, please stop by https://eslint.org/chat/help to chat with the team.

apps/admin-x-settings/.eslintrc.cjs

Oops! Something went wrong! :(

ESLint: 8.57.1

ESLint couldn't find the plugin "eslint-plugin-react-hooks".

(The package "eslint-plugin-react-hooks" was not found when loaded as a Node module from the directory "/apps/admin-x-settings".)

It's likely that the plugin isn't installed correctly. Try reinstalling by running the following:

npm install eslint-plugin-react-hooks@latest --save-dev

The plugin "eslint-plugin-react-hooks" was referenced from the config file in "apps/admin-x-settings/.eslintrc.cjs".

If you still can't figure out the problem, please stop by https://eslint.org/chat/help to chat with the team.


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between cdb2b50 and 97b620d.

📒 Files selected for processing (3)
  • apps/admin-x-settings/.eslintrc.cjs (2 hunks)
  • apps/posts/.eslintrc.cjs (2 hunks)
  • apps/stats/.eslintrc.cjs (2 hunks)
✅ Files skipped from review due to trivial changes (1)
  • apps/admin-x-settings/.eslintrc.cjs
🚧 Files skipped from review as they are similar to previous changes (2)
  • apps/posts/.eslintrc.cjs
  • apps/stats/.eslintrc.cjs
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Admin-X Settings tests
  • GitHub Check: Unit tests (Node 22.13.1)
  • GitHub Check: Unit tests (Node 20.11.1)
✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (2)
apps/posts/.eslintrc.cjs (1)

51-54: Use a DRY approach for repeated path.join calls
Consider caching path.join(__dirname, 'tailwind.config.cjs') in a variable to reduce repetition across rule configs:

+ const tailwindConfigPath = path.join(__dirname, 'tailwind.config.cjs');
...
- 'tailwindcss/classnames-order': ['error', {config: path.join(__dirname, 'tailwind.config.cjs')}],
- 'tailwindcss/enforces-negative-arbitrary-values': ['warn', {config: path.join(__dirname, 'tailwind.config.cjs')}],
- 'tailwindcss/enforces-shorthand': ['warn', {config: path.join(__dirname, 'tailwind.config.cjs')}],
- 'tailwindcss/migration-from-tailwind-2': ['warn', {config: path.join(__dirname, 'tailwind.config.cjs')}],
- 'tailwindcss/no-contradicting-classname': ['error', {config: path.join(__dirname, 'tailwind.config.cjs')}]
+ 'tailwindcss/classnames-order': ['error', {config: tailwindConfigPath}],
+ 'tailwindcss/enforces-negative-arbitrary-values': ['warn', {config: tailwindConfigPath}],
+ 'tailwindcss/enforces-shorthand': ['warn', {config: tailwindConfigPath}],
+ 'tailwindcss/migration-from-tailwind-2': ['warn', {config: tailwindConfigPath}],
+ 'tailwindcss/no-contradicting-classname': ['error', {config: tailwindConfigPath}]

Also applies to: 57-57

apps/stats/.eslintrc.cjs (1)

51-54: Consolidate repeated config paths into a single variable
To make future updates easier and keep the file DRY, extract the common path.join call into a constant:

+ const tailwindConfigPath = path.join(__dirname, 'tailwind.config.cjs');
...
- 'tailwindcss/classnames-order': ['error', {config: path.join(__dirname, 'tailwind.config.cjs')}],
- 'tailwindcss/enforces-negative-arbitrary-values': ['warn', {config: path.join(__dirname, 'tailwind.config.cjs')}],
- 'tailwindcss/enforces-shorthand': ['warn', {config: path.join(__dirname, 'tailwind.config.cjs')}],
- 'tailwindcss/migration-from-tailwind-2': ['warn', {config: path.join(__dirname, 'tailwind.config.cjs')}],
- 'tailwindcss/no-contradicting-classname': ['error', {config: path.join(__dirname, 'tailwind.config.cjs')}]
+ 'tailwindcss/classnames-order': ['error', {config: tailwindConfigPath}],
+ 'tailwindcss/enforces-negative-arbitrary-values': ['warn', {config: tailwindConfigPath}],
+ 'tailwindcss/enforces-shorthand': ['warn', {config: tailwindConfigPath}],
+ 'tailwindcss/migration-from-tailwind-2': ['warn', {config: tailwindConfigPath}],
+ 'tailwindcss/no-contradicting-classname': ['error', {config: tailwindConfigPath}]

Also applies to: 57-57

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8baab10 and cdb2b50.

📒 Files selected for processing (2)
  • apps/posts/.eslintrc.cjs (2 hunks)
  • apps/stats/.eslintrc.cjs (2 hunks)
🔇 Additional comments (2)
apps/posts/.eslintrc.cjs (1)

2-3: Importing Node 'path' for absolute Tailwind config resolution
The path module is correctly required with a disable comment for the var-requires rule.

apps/stats/.eslintrc.cjs (1)

2-3: Importing Node 'path' for absolute Tailwind config resolution
The path module import is correct and appropriately silenced for var-requires.

Problem: classname ordering is getting messed up in monorepos using eslint-plugin-tailwindcss. This is especially a problem when you want to update classname ordering automatically on save because the wrong order would be saved which fails tests on CI.

According to this issue (francoismassart/eslint-plugin-tailwindcss#241) using absolute URL for the tailwind config file could help with the issue.
@peterzimon peterzimon force-pushed the test-tailwind-eslint branch from b6d0260 to 97b620d Compare June 9, 2025 09:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant