docs: add ESLint configuration section to installation docs

[ollema]

with this commit, a .eslintrc file should be added to the .../components/ui folder when initialising a new project with npx shadcn-svelte@latest init.

I write should because I do not know how to test this 😅 so I have coded it "blind"

I added this because it's a common problem that people run into, this solution works without modifying existing project wide .eslintrc.cjs files.

a downside is that this is added without checking if the project uses eslint to begin with. a check for that could be added I guess!

feel free to close if you dislike this idea - no problem

[changeset-bot]

⚠️ No Changeset found

Latest commit: f0c70a7

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
shadcn-svelte	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Dec 9, 2023 0:15am

[huntabyte]

Hey @ollema, I thought about this recently but ultimately decided against it, because as you mentioned, we have to make a lot of assumptions that are outside the scope of this project. We don't want to be in the business of modifying/setting ESLint configs on the project's behalf.

One thing we could do instead is add a section to the installation page of the docs, which would include something like 'Recommended ESLint Config' and include those pieces and why they are recommended!

Will also loop in @AdrianGonz97 for his thoughts on this as well!

[huntabyte]

Hey @ollema, are you wanting to add this to the docs or should we close this issue for now?

[ollema]

Hey @ollema, are you wanting to add this to the docs or should we close this issue for now?

sure, I can do that. I missed that suggestion in your original message

[niemyjski]

We shouldn't be adding any eslint overrides to the components folder. We should fix any default rule errors in this code base.

[huntabyte]

It's not an issue with this code base, it's an issue with the default eslint rules, which tbh will be resolved in Svelte 5 but in the meantime requires you to ignore the $$Events & $$Props if unused. Otherwise you looks intellisense/type safety for the HTMLAttributes props on certain elements that don't have other props.

Here's an eslint config you can use to ignore these in your codebase, but we're not going to be modifying/messing with anyone's eslint config.

ESLint Config

[ollema]

ready for review @huntabyte

[huntabyte]

Thanks man! Love the multiple options!