Skip to content

docs: update readme#1498

Merged
ota-meshi merged 5 commits intosveltejs:mainfrom
sacrosanctic:sad-rook
Mar 19, 2026
Merged

docs: update readme#1498
ota-meshi merged 5 commits intosveltejs:mainfrom
sacrosanctic:sad-rook

Conversation

@sacrosanctic
Copy link
Contributor

there's discrepancy between the docs and the CLI output. This is an attempt to align them.

@changeset-bot
Copy link

changeset-bot bot commented Mar 18, 2026

⚠️ No Changeset found

Latest commit: a8e10f7

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

@github-actions
Copy link
Contributor

github-actions bot commented Mar 18, 2026

Try the Instant Preview in Online Playground

ESLint Online Playground

Install the Instant Preview to Your Local

npm i https://pkg.pr.new/eslint-plugin-svelte@a8e10f7

Published Instant Preview Packages:

View Commit

@ota-meshi
Copy link
Member

Thanks for the PR!
But what does CLI mean? Could you explain it further?

@sacrosanctic
Copy link
Contributor Author

From npx sv create and npx sv add

@ota-meshi
Copy link
Member

Hmm... I think the explanation of this plugin's config should focus on what to add to a configuration rather than how to create a new one, to make it easier to understand.
Therefore, I think it's better not to write about configs like includeIgnoreFile() or 'no-undef', as they are not related to Svelte configs.
I think the change regarding defineConfig() is good, as it will follow the current ESLint recommendations.

Furthermore, I think it would be good to add documentation that the CLI command you provided is helpful when creating a new config.

What do you think?

@sacrosanctic
Copy link
Contributor Author

Sounds good, I also tweaked the wording. Would like some clarity on svelte.config.base.

Copy link
Member

@ota-meshi ota-meshi left a comment

Choose a reason for hiding this comment

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

That's really cool! Thank you!

@ota-meshi ota-meshi merged commit b59c762 into sveltejs:main Mar 19, 2026
33 checks passed
@sacrosanctic sacrosanctic deleted the sad-rook branch March 19, 2026 10:00
@sacrosanctic
Copy link
Contributor Author

@ota-meshi wait! I left something funny in there!

- **`eslintPluginSvelte.configs.recommended`** ... Includes `base` configuration, plus rules to prevent errors or unintended behavior.
- **`eslintPluginSvelte.configs.prettier`** ... Disables rules that may conflict with [Prettier](https://prettier.io/). You still need to configure Prettier to work with Svelte manually, for example, by using [prettier-plugin-svelte](https://github.com/sveltejs/prettier-plugin-svelte).
- **`eslintPluginSvelte.configs.all`** ... Includes all available rules. **Note:** This configuration is not recommended for production use, as it changes with every minor and major version of `eslint-plugin-svelte`. Use at your own risk.
- **`svelte.configs.base`** - Enables correct Svelte parsing. What does this include exactly?
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Not supposed to be here!

Copy link
Member

Choose a reason for hiding this comment

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

Oh, I don't understand English, so I often misread things.
Could you please submit a pull request to correct it?
Here are the specific details of the config.

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.

2 participants