valid-prop-names-in-kit-pages.md

pageClass	sidebarDepth	title	description	since
rule-details	0	svelte/valid-prop-names-in-kit-pages	disallow props other than data or errors in SvelteKit page components.	v2.12.0

svelte/valid-prop-names-in-kit-pages

disallow props other than data or errors in SvelteKit page components.

📖 Rule Details

This rule reports unexpected exported variables at <script>.
At SvelteKit v1.0.0-next.405, instead of having multiple props corresponding to the props returned from a load function, page components now have a single data prop.

<script> const config = {settings: { kit: { files: { routes: "", }, }, }, } </script>

<script>
  /* eslint svelte/valid-prop-names-in-kit-pages: "error" */
  /** ✓ GOOD */
  export let data;
  export let errors;
  export let form;
  export let snapshot;
  // export let { data, errors } = { data: {}, errors: {} }

  /** ✗ BAD */
  export let foo;
  export let bar;
  export let { baz, qux } = data;
  export let { data: data2, errors: errors2 } = { data: {}, errors: {} };
</script>

{foo}, {bar}

🔧 Options

Nothing. But if use are using not default routes folder, please set configuration according to the user guide.

📚 Further Reading

• SvelteKit Migration Guide (v1.0.0-next.405)

🚀 Version

This rule was introduced in eslint-plugin-svelte v2.12.0

🔍 Implementation

• Rule source
• Test source