Skip to content
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

Roadmap #303

Closed
5 of 6 tasks
danielroe opened this issue Aug 9, 2023 · 12 comments · Fixed by #332
Closed
5 of 6 tasks

Roadmap #303

danielroe opened this issue Aug 9, 2023 · 12 comments · Fixed by #332
Assignees

Comments

@danielroe
Copy link
Member

danielroe commented Aug 9, 2023

The aim for this repo is to be a single source for first-class Nuxt integration with eslint (configuration + plugin(s)). We currently have a few issues.

  • @nuxt/eslint-config is rebuilt for Nuxt 3 support without much opinion and is our preferred choice
  • we still have legacy opinionated @nuxtjs/eslint-config and @nuxtjs/eslint-config-typescript configurations that are in use
  • https://github.com/nuxt/eslint-plugin-nuxt is not yet updated for Nuxt 3

We'll use this issue to track key changes/tasks that need to take place. See also #240.

Tasks

@AndrewTannerNA
Copy link

Hi @danielroe

Thanks for this. I've been struggling today to wrap my head around the Nuxt 3 eslint ecosystem and I am unsure if I should continue trying right now or wait.

In your opinion, is it reasonably possible to have eslint working with Nuxt 3 right now? I say reasonably as I am keen to avoid losing time to trying packages that are not expected to work.

@danielroe
Copy link
Member Author

Yes, @nuxt/eslint-config should work 👍

@AndrewTannerNA
Copy link

Thanks @danielroe - does it require integrating with any other package (other than eslint)? I am not seeing any eslint related output when running yarn dev.

@danielroe
Copy link
Member Author

It's an eslint config rather than a Nuxt module so you will need to configure it in your eslintrc. Details should be in the README of this repository.

@Vincent-HD
Copy link

I'm unsure what's the difference between this repo and this repo: https://github.com/nuxt-modules/eslint
I understand that this repo is a config for eslint, but what is the purpose of the module then ?

@dargmuesli
Copy link
Member

The module enables projects to e.g. fail the build if there are any eslint errors. With the config only, the build would run fine and you'd have to run eslint separately. Just to give an example.
The Nuxt module makes eslint influence Nuxt's behavior. Without it you just configure eslint.

@Vincent-HD
Copy link

@dargmuesli ohhh it makes way more sense, thanks ! 👌
It should be fine with a precommit hook for now on my project, but it's good to know 😁

@ColtHands
Copy link

Any plans not using "no-udef": "off"? That's more maintenance ik, but it seems disabling defining variables in vue components isn't all that safe, imo.

@MuhammadM1998
Copy link

Hello guys is there a rough estimate for the roadmap?

@MickL
Copy link

MickL commented Feb 15, 2024

Since @nuxt/eslint-config is not opinionated, what is your recommendation to add up some recommended rules in TypeScript projects?

Before with @nuxtjs/eslint-config-typescript I got tons of useful linting rules but with @nuxt/eslint-config it complains about nothing anymore. Should we maybe extend plugin:@typescript-eslint/eslint-recommended or something?

It would be nice to add this info to the docs, too. A simple sentence like "If you prefer to have more opionated linting, add ..."

@thread-koder
Copy link

Do I need to use typescript-eslint or this plugin include it by default?

@maxdzin
Copy link

maxdzin commented Feb 22, 2024

@thread-koder, it includes typescript-eslint plugin. Take a look here

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 a pull request may close this issue.

10 participants