eslint-plugin-svelte: $page is an illegal variable name
Before You File a Bug Report Please Confirm You Have Done The Following…
- I have tried restarting my IDE and the issue persists.
- I have updated to the latest version of the packages.
What version of ESLint are you using?
8.56.0
What version of eslint-plugin-svelte are you using?
2.36.0-next.3
What did you do?
Configuration
/** @type { import("eslint").Linter.FlatConfig } */
module.exports = {
root: true,
extends: [
'eslint:recommended',
'plugin:@typescript-eslint/recommended',
'plugin:svelte/recommended'
],
parser: '@typescript-eslint/parser',
plugins: ['@typescript-eslint'],
parserOptions: {
sourceType: 'module',
ecmaVersion: 2020,
extraFileExtensions: ['.svelte']
},
env: {
browser: true,
es2017: true,
node: true
},
overrides: [
{
files: ['*.svelte'],
parser: 'svelte-eslint-parser',
parserOptions: {
parser: '@typescript-eslint/parser'
}
}
]
};
pnpm create svelte@latest- Choose Skeleton Project, Typescript, Eslint, Svelte 5
- install dependencies
- Realize eslint-plugin-svelte@next isn’t installed, so
pnpm i -D eslint-plugin-svelte@next
<!-- src/routes/+page.svelte -->
<script lang="ts">
import { page } from "$app/stores"
console.log($page.data) // $page is an illegal variable name.
</script>
What did you expect to happen?
$page to be a legal variable name
What actually happened?
$page is an illegal variable name. To reference a global variable called $page, use globalThis.$page(illegal-global)eslint[svelte/valid-compile](https://sveltejs.github.io/eslint-plugin-svelte/rules/valid-compile/)
let $page: Page<Record<string, string>, string | null>
4:14 error $page is an illegal variable name. To reference a global variable called $page, use globalThis.$page(illegal-global) svelte/valid-compile
Link to GitHub Repo with Minimal Reproducible Example
https://github.com/huntabyte/s5-illegal-variable-repro
Additional comments
I noticed this only occurs when using Typescript. If I go through the create svelte flow and choose “Javascript with JSDoc” everything is good.
About this issue
- Original URL
- State: closed
- Created 3 years ago
- Reactions: 50
- Comments: 19 (4 by maintainers)
This also happens for a custom store (in my case
secretor$secret) as well.Also Svelte 5, Eslint, TS.
This plugin appears to be incorrectly transforming the
<script>tag (perhaps via TypeScript?) before passing it to the compiler.Something like
is getting transformed into
presumably because it’s only operating on the
<script>tag and it thinkspageis unused and it’s safe to turn that into a bareimport '$page/stores'.Putting a bare reference to
page;in the<script>tag seems to be a workaround for the time being.gets transformed into
but the real solution is going to be fixing this transformation that the plugin does to the script tag before passing it to the Svelte compiler. If this is related to TypeScript, I think the solution is going to be to just stop running the
<script>tag through TypeScript in Svelte 5, because that should be already handled by the Svelte compiler.The
getproposal is also unsuitable as a general workaround because it’s non-reactive. It subscribes and immediately unsubscribes, whereas$subscribes and doesn’t unsubscribe until the component is destroyed.@christophsturm @huntabyte
I’m not entirely sure if this is correct, but I was able to find a workaround using the following method:
@dummdidumm In Svelte 5, is there a reason to transpile the
<script>tag at all before passing it to the Svelte compiler, though?@unlocomqx
The following can be used as a workaround
Disable in one line
Disable in project
.eslintrc.cjs
Check here for additional details https://eslint.org/docs/latest/use/configure/rules
Use
"eslint-plugin-svelte": "^2.43.0"I’m running into this as well.
Went about converting my app from Svelte 4 -> 5 today, update process was fairly smooth, but the eslint errors in this ticket are showing up. Would be good to see a proper fix for this that doesn’t involve disabling eslint checks everywhere