Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/not-jayden/eslint-plugin-svelte-runes
A collection of lint rules to enforce best practices and prevent footguns of Svelte 5 runes
https://github.com/not-jayden/eslint-plugin-svelte-runes
eslint eslint-plugin svelte
Last synced: 27 days ago
JSON representation
A collection of lint rules to enforce best practices and prevent footguns of Svelte 5 runes
- Host: GitHub
- URL: https://github.com/not-jayden/eslint-plugin-svelte-runes
- Owner: Not-Jayden
- License: mit
- Created: 2023-10-30T17:16:47.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2023-11-05T12:51:14.000Z (about 1 year ago)
- Last Synced: 2024-10-11T17:22:01.422Z (27 days ago)
- Topics: eslint, eslint-plugin, svelte
- Language: TypeScript
- Homepage:
- Size: 315 KB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# eslint-plugin-svelte-runes
This plugin intends to provide a collection of rules specifically tailored for enforcing correct and safe usage of [Svelte 5 runes](https://svelte.dev/blog/runes).
> 🚧 NOTE: This plugin is still in early development and is subject to breaking changes.
## 🎯 Why This Plugin?
This plugin proactively prepares for the upcoming Svelte 5 release by establishing rules for best practices and addressing the nuanced universal reactivity challenges between Svelte and non-Svelte code in js/ts files. While the official [eslint-plugin-svelte](https://github.com/sveltejs/eslint-plugin-svelte) may take time to support Svelte 5 and js/ts files, this plugin aims to fill that void.
## 📦 Installation
Using npm:
```bash
# Using npm
npm install eslint-plugin-svelte-runes --save-dev
# Using yarn
yarn add eslint-plugin-svelte-runes --dev
# Using pnpm
pnpm add -D eslint-plugin-svelte-runes
# Using bun
bun add eslint-plugin-svelte-runes --dev
```
## 🚀 Usage
Add `eslint-plugin-svelte-runes` to the plugins section of your `.eslintrc` configuration file:
```json
{
"plugins": ["eslint-plugin-svelte-runes"]
}
```
Then configure the rules you want to use under the rules section.
### 🔧 Recommended Configuration
This plugin ships with a `recommended` configuration that sets up all the provided rules to their default values:
```json
{
"extends": ["plugin:eslint-plugin-svelte-runes/recommended"]
}
```
## 📜 Rules
| Rule Name | Description | 💼 |
| -------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------- |
| [no-external-svelte-imports](docs/rules/no-external-svelte-imports.md) | Disallow importing from .svelte.js/ts files outside of .svelte.js/ts files and .svelte files. | ✅ |
| [no-external-svelte-exports](docs/rules/no-external-svelte-exports.md) | Disallow exporting directly from .svelte.js/ts files outside of .svelte.js/ts files. | ✅ |
| [no-external-rune-calls](docs/rules/no-external-rune-calls.md) | Disallow the usage of $derived(), $effect(), $state(), and $props() in non-Svelte files unless explicitly declared or imported. | ✅ |
| [no-effect-outside-components](docs/rules/no-effect-outside-components.md) | Disallow usage of the $effect rune outside of .svelte files. | |
| [no-props-outside-components](docs/rules/no-props-outside-components.md) | Disallow usage of the $props rune outside of .svelte files. | ✅ |
| [no-direct-rune-assign](docs/rules/no-direct-rune-assign.md) | Disallow the assignment of Svelte runes as object properties or direct variable assignments. | ✅ |
| [no-initialized-rune-exports](docs/rules/no-initialized-rune-exports.md) | Disallow the export of variables or values initialized with a Svelte rune CallExpression. | ✅ |
| [no-initialized-rune-return](docs/rules/no-initialized-rune-return.md) | Disallow returning variables or values initialized with a Svelte rune directly from functions. | ✅ |
| [require-extensions](docs/rules/require-extensions.md) | Require using a full .svelte.js or .svelte.ts file extension, unless there is a component that exists as just .svelte. | ✅ |
## 🤝 Contributions
Contributions to `eslint-plugin-svelte-runes` are always welcome!
## 📄 License
`eslint-plugin-svelte-runes` is licensed under the [MIT License](./LICENSE).