feat: add no-not-data-props-in-kit-pages

Author: baseballyama

README.md

@@ -289,6 +289,7 @@ These rules relate to possible syntax or logic errors in Svelte code:
 | [svelte/no-dupe-style-properties](https://ota-meshi.github.io/eslint-plugin-svelte/rules/no-dupe-style-properties/) | disallow duplicate style properties | :star: |
 | [svelte/no-dynamic-slot-name](https://ota-meshi.github.io/eslint-plugin-svelte/rules/no-dynamic-slot-name/) | disallow dynamic slot name | :star::wrench: |
 | [svelte/no-export-load-in-svelte-module-in-kit-pages](https://ota-meshi.github.io/eslint-plugin-svelte/rules/no-export-load-in-svelte-module-in-kit-pages/) | Disallow exporting load functions in `*.svelte` module in Svelte Kit page components. | :star: |
+| [svelte/no-not-data-props-in-kit-pages](https://ota-meshi.github.io/eslint-plugin-svelte/rules/no-not-data-props-in-kit-pages/) | Disallow props other than data or errors in Svelte Kit page components. |  |
 | [svelte/no-not-function-handler](https://ota-meshi.github.io/eslint-plugin-svelte/rules/no-not-function-handler/) | disallow use of not function in event handler | :star: |
 | [svelte/no-object-in-text-mustaches](https://ota-meshi.github.io/eslint-plugin-svelte/rules/no-object-in-text-mustaches/) | disallow objects in text mustache interpolation | :star: |
 | [svelte/no-shorthand-style-property-overrides](https://ota-meshi.github.io/eslint-plugin-svelte/rules/no-shorthand-style-property-overrides/) | disallow shorthand style properties that override related longhand properties | :star: |

docs/rules.md

@@ -20,6 +20,7 @@ These rules relate to possible syntax or logic errors in Svelte code:
 | [svelte/no-dupe-style-properties](./rules/no-dupe-style-properties.md) | disallow duplicate style properties | :star: |
 | [svelte/no-dynamic-slot-name](./rules/no-dynamic-slot-name.md) | disallow dynamic slot name | :star::wrench: |
 | [svelte/no-export-load-in-svelte-module-in-kit-pages](./rules/no-export-load-in-svelte-module-in-kit-pages.md) | Disallow exporting load functions in `*.svelte` module in Svelte Kit page components. | :star: |
+| [svelte/no-not-data-props-in-kit-pages](./rules/no-not-data-props-in-kit-pages.md) | Disallow props other than data or errors in Svelte Kit page components. |  |
 | [svelte/no-not-function-handler](./rules/no-not-function-handler.md) | disallow use of not function in event handler | :star: |
 | [svelte/no-object-in-text-mustaches](./rules/no-object-in-text-mustaches.md) | disallow objects in text mustache interpolation | :star: |
 | [svelte/no-shorthand-style-property-overrides](./rules/no-shorthand-style-property-overrides.md) | disallow shorthand style properties that override related longhand properties | :star: |

docs/rules/no-not-data-props-in-kit-pages.md

@@ -0,0 +1,66 @@
+---
+pageClass: "rule-details"
+sidebarDepth: 0
+title: "svelte/no-not-data-props-in-kit-pages"
+description: "Disallow props other than data or errors in Svelte Kit page components."
+---
+
+# svelte/no-not-data-props-in-kit-pages
+
+> Disallow props other than data or errors in Svelte Kit page components.
+
+- :exclamation: <badge text="This rule has not been released yet." vertical="middle" type="error"> **_This rule has not been released yet._** </badge>
+
+## :book: Rule Details
+
+This rule reports ???.
+
+<script>
+  const config = {settings: {
+    kit: {
+      files: {
+        routes: "",
+      },
+    },
+  },
+  }
+</script>
+
+<ESLintCodeBlock config="{config}">
+
+<!--eslint-skip-->
+
+```svelte
+<script>
+  /* eslint svelte/no-not-data-props-in-kit-pages: "error" */
+  /** ✓ GOOD */
+  export let data
+  export let errors
+  /** ✗ BAD */
+  export let foo
+  export let bar
+</script>
+
+{foo}, {bar}
+```
+
+</ESLintCodeBlock>
+
+## :wrench: Options
+
+```json
+{
+  "svelte/no-not-data-props-in-kit-pages": ["error", {}]
+}
+```
+
+-
+
+## :books: Further Reading
+
+-
+
+## :mag: Implementation
+
+- [Rule source](https://github.com/ota-meshi/eslint-plugin-svelte/blob/main/src/rules/no-not-data-props-in-kit-pages.ts)
+- [Test source](https://github.com/ota-meshi/eslint-plugin-svelte/blob/main/tests/src/rules/no-not-data-props-in-kit-pages.ts)

src/rules/no-not-data-props-in-kit-pages.ts

@@ -0,0 +1,57 @@
+import type * as ESTree from "estree"
+import { createRule } from "../utils"
+import { isKitPageComponent, hasSvelteKit } from "./kit-helpers/kit-helpers"
+
+const EXPECTED_PROP_NAMES = ["data", "errors"]
+
+export default createRule("no-not-data-props-in-kit-pages", {
+  meta: {
+    docs: {
+      description:
+        "Disallow props other than data or errors in Svelte Kit page components.",
+      category: "Possible Errors",
+      recommended: false,
+    },
+    schema: [],
+    messages: {
+      unexpected:
+        "Disallow props other than data or errors in Svelte Kit page components.",
+    },
+    type: "problem",
+  },
+  create(context) {
+    if (!hasSvelteKit || !isKitPageComponent(context)) return {}
+    let isModule = false
+    return {
+      // <script context="module">
+      [`Program > SvelteScriptElement > SvelteStartTag > SvelteAttribute[key.name="context"] > SvelteLiteral[value="module"]`]:
+        () => {
+          isModule = true
+        },
+
+      // <script>
+      [`Program > SvelteScriptElement > SvelteStartTag > SvelteAttribute[key.name="context"] > SvelteLiteral[value!="module"]`]:
+        () => {
+          isModule = false
+        },
+
+      // </script>
+      ["SvelteEndTag"]: () => {
+        isModule = false
+      },
+
+      // export let xxx
+      [`ExportNamedDeclaration > VariableDeclaration > VariableDeclarator > Identifier`]:
+        (node: ESTree.Identifier) => {
+          if (isModule) return {}
+          const { name } = node
+          if (EXPECTED_PROP_NAMES.includes(name)) return {}
+          return context.report({
+            node,
+            loc: node.loc!,
+            messageId: "unexpected",
+          })
+        },
+    }
+  },
+})

src/utils/rules.ts

@@ -18,6 +18,7 @@ import noDynamicSlotName from "../rules/no-dynamic-slot-name"
 import noExportLoadInSvelteModuleInKitPages from "../rules/no-export-load-in-svelte-module-in-kit-pages"
 import noExtraReactiveCurlies from "../rules/no-extra-reactive-curlies"
 import noInnerDeclarations from "../rules/no-inner-declarations"
+import noNotDataPropsInKitPages from "../rules/no-not-data-props-in-kit-pages"
 import noNotFunctionHandler from "../rules/no-not-function-handler"
 import noObjectInTextMustaches from "../rules/no-object-in-text-mustaches"
 import noReactiveFunctions from "../rules/no-reactive-functions"
@@ -62,6 +63,7 @@ export const rules = [
   noExportLoadInSvelteModuleInKitPages,
   noExtraReactiveCurlies,
   noInnerDeclarations,
+  noNotDataPropsInKitPages,
   noNotFunctionHandler,
   noObjectInTextMustaches,
   noReactiveFunctions,

tests/fixtures/rules/no-not-data-props-in-kit-pages/invalid/_config.json

@@ -0,0 +1,9 @@
+{
+  "settings": {
+    "kit": {
+      "files": {
+        "routes": "tests/fixtures"
+      }
+    }
+  }
+}

tests/fixtures/rules/no-not-data-props-in-kit-pages/invalid/test01-errors.yaml

@@ -0,0 +1,8 @@
+- message: Disallow props other than data or errors in Svelte Kit page components.
+  line: 2
+  column: 14
+  suggestions: null
+- message: Disallow props other than data or errors in Svelte Kit page components.
+  line: 3
+  column: 14
+  suggestions: null

tests/fixtures/rules/no-not-data-props-in-kit-pages/invalid/test01-input.svelte

@@ -0,0 +1,6 @@
+<script>
+  export let foo
+  export let bar
+</script>
+
+{foo}, {bar}

tests/fixtures/rules/no-not-data-props-in-kit-pages/valid/_config.json

@@ -0,0 +1,9 @@
+{
+  "settings": {
+    "kit": {
+      "files": {
+        "routes": "tests/fixtures"
+      }
+    }
+  }
+}

tests/fixtures/rules/no-not-data-props-in-kit-pages/valid/not-page/test01-input.svelte

@@ -0,0 +1,8 @@
+<script>
+  export let data
+  export let errors
+  export let foo
+  export let bar
+</script>
+
+{data}, {errors}, {foo}, {bar}

tests/fixtures/rules/no-not-data-props-in-kit-pages/valid/test01-input.svelte

@@ -0,0 +1,6 @@
+<script>
+  export let data
+  export let errors
+</script>
+
+{data}, {errors}

tests/fixtures/rules/no-not-data-props-in-kit-pages/valid/test02-input.svelte

@@ -0,0 +1,8 @@
+<script context="module">
+  export let data
+  export let errors
+  export let foo
+  export let bar
+</script>
+
+{data}, {errors}, {foo}, {bar}

tests/src/rules/no-not-data-props-in-kit-pages.ts

@@ -0,0 +1,16 @@
+import { RuleTester } from "eslint"
+import rule from "../../../src/rules/no-not-data-props-in-kit-pages"
+import { loadTestCases } from "../../utils/utils"
+
+const tester = new RuleTester({
+  parserOptions: {
+    ecmaVersion: 2020,
+    sourceType: "module",
+  },
+})
+
+tester.run(
+  "no-not-data-props-in-kit-pages",
+  rule as any,
+  loadTestCases("no-not-data-props-in-kit-pages"),
+)