test(no-navigation-without-base): added test for pushState, replaceState and links

marekdedic · marekdedic · commit 4bfb401c1068 · 2024-11-29T21:20:00.000+01:00
diff --git a/README.md b/README.md
@@ -474,7 +474,7 @@ These rules relate to SvelteKit and its best Practices.
 
 | Rule ID | Description |    |
 |:--------|:------------|:---|
-| [svelte/no-navigation-without-base](https://sveltejs.github.io/eslint-plugin-svelte/rules/no-navigation-without-base/) | disallow using goto() without the base path |  |
+| [svelte/no-navigation-without-base](https://sveltejs.github.io/eslint-plugin-svelte/rules/no-navigation-without-base/) | disallow using navigation (links, goto, pushState, replaceState) without the base path |  |
 
 ## Experimental
 
diff --git a/docs/rules.md b/docs/rules.md
@@ -109,9 +109,9 @@ These rules extend the rules provided by ESLint itself, or other plugins to work
 
 These rules relate to SvelteKit and its best Practices.
 
-| Rule ID                                                                    | Description                                 |     |
-| :------------------------------------------------------------------------- | :------------------------------------------ | :-- |
-| [svelte/no-navigation-without-base](./rules/no-navigation-without-base.md) | disallow using goto() without the base path |     |
+| Rule ID                                                                    | Description                                                                            |     |
+| :------------------------------------------------------------------------- | :------------------------------------------------------------------------------------- | :-- |
+| [svelte/no-navigation-without-base](./rules/no-navigation-without-base.md) | disallow using navigation (links, goto, pushState, replaceState) without the base path |     |
 
 ## Experimental
 
diff --git a/docs/rules/no-navigation-without-base.md b/docs/rules/no-navigation-without-base.md
@@ -2,13 +2,13 @@
 pageClass: 'rule-details'
 sidebarDepth: 0
 title: 'svelte/no-navigation-without-base'
-description: 'disallow using goto() without the base path'
+description: 'disallow using navigation (links, goto, pushState, replaceState) without the base path'
 since: 'v2.36.0-next.9'
 ---
 
 # svelte/no-navigation-without-base
 
-> disallow using goto() without the base path
+> disallow using navigation (links, goto, pushState, replaceState) without the base path
 
 ## :book: Rule Details
 
diff --git a/packages/eslint-plugin-svelte/src/rule-types.ts b/packages/eslint-plugin-svelte/src/rule-types.ts
@@ -181,7 +181,7 @@ export interface RuleOptions {
    */
   'svelte/no-inspect'?: Linter.RuleEntry<[]>
   /**
-   * disallow using goto() without the base path
+   * disallow using navigation (links, goto, pushState, replaceState) without the base path
    * @see https://sveltejs.github.io/eslint-plugin-svelte/rules/no-navigation-without-base/
    */
   'svelte/no-navigation-without-base'?: Linter.RuleEntry<[]>
diff --git a/packages/eslint-plugin-svelte/tests/fixtures/rules/no-navigation-without-base/invalid/goto-aliased01-errors.yaml b/packages/eslint-plugin-svelte/tests/fixtures/rules/no-navigation-without-base/invalid/goto-aliased01-errors.yaml
diff --git a/packages/eslint-plugin-svelte/tests/fixtures/rules/no-navigation-without-base/invalid/goto-aliased01-input.svelte b/packages/eslint-plugin-svelte/tests/fixtures/rules/no-navigation-without-base/invalid/goto-aliased01-input.svelte
diff --git a/packages/eslint-plugin-svelte/tests/fixtures/rules/no-navigation-without-base/invalid/goto-base-not-as-prefix01-errors.yaml b/packages/eslint-plugin-svelte/tests/fixtures/rules/no-navigation-without-base/invalid/goto-base-not-as-prefix01-errors.yaml
diff --git a/packages/eslint-plugin-svelte/tests/fixtures/rules/no-navigation-without-base/invalid/goto-base-not-as-prefix01-input.svelte b/packages/eslint-plugin-svelte/tests/fixtures/rules/no-navigation-without-base/invalid/goto-base-not-as-prefix01-input.svelte
diff --git a/packages/eslint-plugin-svelte/tests/fixtures/rules/no-navigation-without-base/invalid/goto-no-base01-errors.yaml b/packages/eslint-plugin-svelte/tests/fixtures/rules/no-navigation-without-base/invalid/goto-no-base01-errors.yaml
diff --git a/packages/eslint-plugin-svelte/tests/fixtures/rules/no-navigation-without-base/invalid/goto-no-base01-input.svelte b/packages/eslint-plugin-svelte/tests/fixtures/rules/no-navigation-without-base/invalid/goto-no-base01-input.svelte
diff --git a/packages/eslint-plugin-svelte/tests/fixtures/rules/no-navigation-without-base/invalid/link-base-not-as-prefix01-errors.yaml b/packages/eslint-plugin-svelte/tests/fixtures/rules/no-navigation-without-base/invalid/link-base-not-as-prefix01-errors.yaml
@@ -0,0 +1,8 @@
+- message: Found a link with a url that isn't prefixed with the base path.
+  line: 5
+  column: 9
+  suggestions: null
+- message: Found a link with a url that isn't prefixed with the base path.
+  line: 6
+  column: 9
+  suggestions: null
diff --git a/packages/eslint-plugin-svelte/tests/fixtures/rules/no-navigation-without-base/invalid/link-base-not-as-prefix01-input.svelte b/packages/eslint-plugin-svelte/tests/fixtures/rules/no-navigation-without-base/invalid/link-base-not-as-prefix01-input.svelte
@@ -0,0 +1,6 @@
+<script>
+	import { base } from '$app/paths';
+</script>
+
+<a href={'/foo/' + base}>Click me!</a>
+<a href={`/foo/${base}`}>Click me!</a>
diff --git a/packages/eslint-plugin-svelte/tests/fixtures/rules/no-navigation-without-base/invalid/link-no-base01-errors.yaml b/packages/eslint-plugin-svelte/tests/fixtures/rules/no-navigation-without-base/invalid/link-no-base01-errors.yaml
@@ -0,0 +1,12 @@
+- message: Found a link with a url that isn't prefixed with the base path.
+  line: 1
+  column: 10
+  suggestions: null
+- message: Found a link with a url that isn't prefixed with the base path.
+  line: 2
+  column: 9
+  suggestions: null
+- message: Found a link with a url that isn't prefixed with the base path.
+  line: 3
+  column: 9
+  suggestions: null
diff --git a/packages/eslint-plugin-svelte/tests/fixtures/rules/no-navigation-without-base/invalid/link-no-base01-input.svelte b/packages/eslint-plugin-svelte/tests/fixtures/rules/no-navigation-without-base/invalid/link-no-base01-input.svelte
@@ -0,0 +1,3 @@
+<a href="/foo">Click me!</a>
+<a href={'/foo'}>Click me!</a>
+<a href={'/' + 'foo'}>Click me!</a>
diff --git a/packages/eslint-plugin-svelte/tests/fixtures/rules/no-navigation-without-base/invalid/pushState-aliased01-errors.yaml b/packages/eslint-plugin-svelte/tests/fixtures/rules/no-navigation-without-base/invalid/pushState-aliased01-errors.yaml
@@ -0,0 +1,4 @@
+- message: Found a pushState() call with a url that isn't prefixed with the base path.
+  line: 4
+  column: 8
+  suggestions: null
diff --git a/packages/eslint-plugin-svelte/tests/fixtures/rules/no-navigation-without-base/invalid/pushState-aliased01-input.svelte b/packages/eslint-plugin-svelte/tests/fixtures/rules/no-navigation-without-base/invalid/pushState-aliased01-input.svelte
@@ -0,0 +1,5 @@
+<script>
+	import { pushState as alias } from '$app/navigation';
+
+	alias('/foo');
+</script>
diff --git a/packages/eslint-plugin-svelte/tests/fixtures/rules/no-navigation-without-base/invalid/pushState-base-not-as-prefix01-errors.yaml b/packages/eslint-plugin-svelte/tests/fixtures/rules/no-navigation-without-base/invalid/pushState-base-not-as-prefix01-errors.yaml
@@ -0,0 +1,8 @@
+- message: Found a pushState() call with a url that isn't prefixed with the base path.
+  line: 5
+  column: 12
+  suggestions: null
+- message: Found a pushState() call with a url that isn't prefixed with the base path.
+  line: 6
+  column: 12
+  suggestions: null
diff --git a/packages/eslint-plugin-svelte/tests/fixtures/rules/no-navigation-without-base/invalid/pushState-base-not-as-prefix01-input.svelte b/packages/eslint-plugin-svelte/tests/fixtures/rules/no-navigation-without-base/invalid/pushState-base-not-as-prefix01-input.svelte
@@ -0,0 +1,7 @@
+<script>
+	import { base } from '$app/paths';
+	import { pushState } from '$app/navigation';
+
+	pushState('/foo/' + base);
+	pushState(`/foo/${base}`);
+</script>
diff --git a/packages/eslint-plugin-svelte/tests/fixtures/rules/no-navigation-without-base/invalid/pushState-no-base01-errors.yaml b/packages/eslint-plugin-svelte/tests/fixtures/rules/no-navigation-without-base/invalid/pushState-no-base01-errors.yaml
@@ -0,0 +1,4 @@
+- message: Found a pushState() call with a url that isn't prefixed with the base path.
+  line: 4
+  column: 12
+  suggestions: null
diff --git a/packages/eslint-plugin-svelte/tests/fixtures/rules/no-navigation-without-base/invalid/pushState-no-base01-input.svelte b/packages/eslint-plugin-svelte/tests/fixtures/rules/no-navigation-without-base/invalid/pushState-no-base01-input.svelte
@@ -0,0 +1,5 @@
+<script>
+	import { pushState } from '$app/navigation';
+
+	pushState('/foo');
+</script>
diff --git a/packages/eslint-plugin-svelte/tests/fixtures/rules/no-navigation-without-base/invalid/replaceState-aliased01-errors.yaml b/packages/eslint-plugin-svelte/tests/fixtures/rules/no-navigation-without-base/invalid/replaceState-aliased01-errors.yaml
@@ -0,0 +1,5 @@
+- message: Found a replaceState() call with a url that isn't prefixed with the
+    base path.
+  line: 4
+  column: 8
+  suggestions: null
diff --git a/packages/eslint-plugin-svelte/tests/fixtures/rules/no-navigation-without-base/invalid/replaceState-aliased01-input.svelte b/packages/eslint-plugin-svelte/tests/fixtures/rules/no-navigation-without-base/invalid/replaceState-aliased01-input.svelte
@@ -0,0 +1,5 @@
+<script>
+	import { replaceState as alias } from '$app/navigation';
+
+	alias('/foo');
+</script>
diff --git a/packages/eslint-plugin-svelte/tests/fixtures/rules/no-navigation-without-base/invalid/replaceState-base-not-as-prefix01-errors.yaml b/packages/eslint-plugin-svelte/tests/fixtures/rules/no-navigation-without-base/invalid/replaceState-base-not-as-prefix01-errors.yaml
@@ -0,0 +1,10 @@
+- message: Found a replaceState() call with a url that isn't prefixed with the
+    base path.
+  line: 5
+  column: 15
+  suggestions: null
+- message: Found a replaceState() call with a url that isn't prefixed with the
+    base path.
+  line: 6
+  column: 15
+  suggestions: null
diff --git a/packages/eslint-plugin-svelte/tests/fixtures/rules/no-navigation-without-base/invalid/replaceState-base-not-as-prefix01-input.svelte b/packages/eslint-plugin-svelte/tests/fixtures/rules/no-navigation-without-base/invalid/replaceState-base-not-as-prefix01-input.svelte
@@ -0,0 +1,7 @@
+<script>
+	import { base } from '$app/paths';
+	import { replaceState } from '$app/navigation';
+
+	replaceState('/foo/' + base);
+	replaceState(`/foo/${base}`);
+</script>
diff --git a/packages/eslint-plugin-svelte/tests/fixtures/rules/no-navigation-without-base/invalid/replaceState-no-base01-errors.yaml b/packages/eslint-plugin-svelte/tests/fixtures/rules/no-navigation-without-base/invalid/replaceState-no-base01-errors.yaml
@@ -0,0 +1,5 @@
+- message: Found a replaceState() call with a url that isn't prefixed with the
+    base path.
+  line: 4
+  column: 15
+  suggestions: null
diff --git a/packages/eslint-plugin-svelte/tests/fixtures/rules/no-navigation-without-base/invalid/replaceState-no-base01-input.svelte b/packages/eslint-plugin-svelte/tests/fixtures/rules/no-navigation-without-base/invalid/replaceState-no-base01-input.svelte
@@ -0,0 +1,5 @@
+<script>
+	import { replaceState } from '$app/navigation';
+
+	replaceState('/foo');
+</script>
diff --git a/packages/eslint-plugin-svelte/tests/fixtures/rules/no-navigation-without-base/valid/absolute-uri01-input.svelte b/packages/eslint-plugin-svelte/tests/fixtures/rules/no-navigation-without-base/valid/absolute-uri01-input.svelte
diff --git a/packages/eslint-plugin-svelte/tests/fixtures/rules/no-navigation-without-base/valid/goto-base-aliased01-input.svelte b/packages/eslint-plugin-svelte/tests/fixtures/rules/no-navigation-without-base/valid/goto-base-aliased01-input.svelte
diff --git a/packages/eslint-plugin-svelte/tests/fixtures/rules/no-navigation-without-base/valid/goto-base-prefixed01-input.svelte b/packages/eslint-plugin-svelte/tests/fixtures/rules/no-navigation-without-base/valid/goto-base-prefixed01-input.svelte
diff --git a/packages/eslint-plugin-svelte/tests/fixtures/rules/no-navigation-without-base/valid/link-absolute-url01-input.svelte b/packages/eslint-plugin-svelte/tests/fixtures/rules/no-navigation-without-base/valid/link-absolute-url01-input.svelte
@@ -0,0 +1,13 @@
+<script>
+	const protocol = 'https';
+</script>
+
+<a href="http://svelte.dev">Click me!</a>
+<a href="https://svelte.dev">Click me!</a>
+<a href={'http://svelte.dev'}>Click me!</a>
+<a href={'https://svelte.dev'}>Click me!</a>
+<a href={'http://svelte' + '.dev'}>Click me!</a>
+<a href={'https://svelte' + '.dev'}>Click me!</a>
+<a href={'http' + '://svelte.dev'}>Click me!</a>
+<a href={'https' + '://svelte.dev'}>Click me!</a>
+<a href={`${protocol}://svelte.dev`}>Click me!</a>
diff --git a/packages/eslint-plugin-svelte/tests/fixtures/rules/no-navigation-without-base/valid/link-base-aliased01-input.svelte b/packages/eslint-plugin-svelte/tests/fixtures/rules/no-navigation-without-base/valid/link-base-aliased01-input.svelte
@@ -0,0 +1,6 @@
+<script>
+	import { base as alias } from '$app/paths';
+</script>
+
+<a href={alias + '/foo/'}>Click me!</a>;
+<a href={`${alias}/foo/`}>Click me!</a>;
diff --git a/packages/eslint-plugin-svelte/tests/fixtures/rules/no-navigation-without-base/valid/link-base-prefixed01-input.svelte b/packages/eslint-plugin-svelte/tests/fixtures/rules/no-navigation-without-base/valid/link-base-prefixed01-input.svelte
@@ -0,0 +1,6 @@
+<script>
+	import { base } from '$app/paths';
+</script>
+
+<a href={base + '/foo/'}>Click me!</a>
+<a href={`${base}/foo/`}>Click me!</a>
diff --git a/packages/eslint-plugin-svelte/tests/fixtures/rules/no-navigation-without-base/valid/pushState-base-aliased01-input.svelte b/packages/eslint-plugin-svelte/tests/fixtures/rules/no-navigation-without-base/valid/pushState-base-aliased01-input.svelte
@@ -0,0 +1,8 @@
+<script>
+	import { base as alias } from '$app/paths';
+	import { pushState } from '$app/navigation';
+
+	// eslint-disable-next-line prefer-template -- Testing both variants
+	pushState(alias + '/foo/');
+	pushState(`${alias}/foo/`);
+</script>
diff --git a/packages/eslint-plugin-svelte/tests/fixtures/rules/no-navigation-without-base/valid/pushState-base-prefixed01-input.svelte b/packages/eslint-plugin-svelte/tests/fixtures/rules/no-navigation-without-base/valid/pushState-base-prefixed01-input.svelte
@@ -0,0 +1,8 @@
+<script>
+	import { base } from '$app/paths';
+	import { pushState } from '$app/navigation';
+
+	// eslint-disable-next-line prefer-template -- Testing both variants
+	pushState(base + '/foo/');
+	pushState(`${base}/foo/`);
+</script>
diff --git a/packages/eslint-plugin-svelte/tests/fixtures/rules/no-navigation-without-base/valid/pushState-empty-url01-input.svelte b/packages/eslint-plugin-svelte/tests/fixtures/rules/no-navigation-without-base/valid/pushState-empty-url01-input.svelte
@@ -0,0 +1,6 @@
+<script>
+	import { pushState } from '$app/navigation';
+
+	pushState('');
+	pushState(``);
+</script>
diff --git a/packages/eslint-plugin-svelte/tests/fixtures/rules/no-navigation-without-base/valid/replaceState-base-aliased01-input.svelte b/packages/eslint-plugin-svelte/tests/fixtures/rules/no-navigation-without-base/valid/replaceState-base-aliased01-input.svelte
@@ -0,0 +1,8 @@
+<script>
+	import { base as alias } from '$app/paths';
+	import { replaceState } from '$app/navigation';
+
+	// eslint-disable-next-line prefer-template -- Testing both variants
+	replaceState(alias + '/foo/');
+	replaceState(`${alias}/foo/`);
+</script>
diff --git a/packages/eslint-plugin-svelte/tests/fixtures/rules/no-navigation-without-base/valid/replaceState-base-prefixed01-input.svelte b/packages/eslint-plugin-svelte/tests/fixtures/rules/no-navigation-without-base/valid/replaceState-base-prefixed01-input.svelte
@@ -0,0 +1,8 @@
+<script>
+	import { base } from '$app/paths';
+	import { replaceState } from '$app/navigation';
+
+	// eslint-disable-next-line prefer-template -- Testing both variants
+	replaceState(base + '/foo/');
+	replaceState(`${base}/foo/`);
+</script>
diff --git a/packages/eslint-plugin-svelte/tests/fixtures/rules/no-navigation-without-base/valid/replaceState-empty-url01-input.svelte b/packages/eslint-plugin-svelte/tests/fixtures/rules/no-navigation-without-base/valid/replaceState-empty-url01-input.svelte
@@ -0,0 +1,6 @@
+<script>
+	import { replaceState } from '$app/navigation';
+
+	replaceState('');
+	replaceState(``);
+</script>
