feat(no-navigation-without-base): added configuration options

Author: marekdedic

packages/eslint-plugin-svelte/src/rule-types.ts

@@ -184,7 +184,7 @@ export interface RuleOptions {
    * 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<[]>
+  'svelte/no-navigation-without-base'?: Linter.RuleEntry<SvelteNoNavigationWithoutBase>
   /**
    * disallow use of not function in event handler
    * @see https://sveltejs.github.io/eslint-plugin-svelte/rules/no-not-function-handler/
@@ -448,6 +448,13 @@ type SvelteNoInlineStyles = []|[{
 type SvelteNoInnerDeclarations = []|[("functions" | "both")]|[("functions" | "both"), {
   blockScopedFunctions?: ("allow" | "disallow")
 }]
+// ----- svelte/no-navigation-without-base -----
+type SvelteNoNavigationWithoutBase = []|[{
+  ignoreGoto?: boolean
+  ignoreLinks?: boolean
+  ignorePushState?: boolean
+  ignoreReplaceState?: boolean
+}]
 // ----- svelte/no-reactive-reassign -----
 type SvelteNoReactiveReassign = []|[{
   props?: boolean

packages/eslint-plugin-svelte/src/rules/no-navigation-without-base.ts

@@ -14,7 +14,26 @@ export default createRule('no-navigation-without-base', {
 			category: 'SvelteKit',
 			recommended: false
 		},
-		schema: [],
+		schema: [
+			{
+				type: 'object',
+				properties: {
+					ignoreGoto: {
+						type: 'boolean'
+					},
+					ignoreLinks: {
+						type: 'boolean'
+					},
+					ignorePushState: {
+						type: 'boolean'
+					},
+					ignoreReplaceState: {
+						type: 'boolean'
+					}
+				},
+				additionalProperties: false
+			}
+		],
 		messages: {
 			gotoNotPrefixed: "Found a goto() call with a url that isn't prefixed with the base path.",
 			linkNotPrefixed: "Found a link with a url that isn't prefixed with the base path.",
@@ -38,23 +57,35 @@ export default createRule('no-navigation-without-base', {
 					pushState: pushStateCalls,
 					replaceState: replaceStateCalls
 				} = extractFunctionCallReferences(referenceTracker);
-				for (const gotoCall of gotoCalls) {
-					checkGotoCall(context, gotoCall, basePathNames);
+				if (context.options[0]?.ignoreGoto !== true) {
+					for (const gotoCall of gotoCalls) {
+						checkGotoCall(context, gotoCall, basePathNames);
+					}
 				}
-				for (const pushStateCall of pushStateCalls) {
-					checkShallowNavigationCall(context, pushStateCall, basePathNames, 'pushStateNotPrefixed');
+				if (context.options[0]?.ignorePushState !== true) {
+					for (const pushStateCall of pushStateCalls) {
+						checkShallowNavigationCall(
+							context,
+							pushStateCall,
+							basePathNames,
+							'pushStateNotPrefixed'
+						);
+					}
 				}
-				for (const replaceStateCall of replaceStateCalls) {
-					checkShallowNavigationCall(
-						context,
-						replaceStateCall,
-						basePathNames,
-						'replaceStateNotPrefixed'
-					);
+				if (context.options[0]?.ignoreReplaceState !== true) {
+					for (const replaceStateCall of replaceStateCalls) {
+						checkShallowNavigationCall(
+							context,
+							replaceStateCall,
+							basePathNames,
+							'replaceStateNotPrefixed'
+						);
+					}
 				}
 			},
 			SvelteAttribute(node) {
 				if (
+					context.options[0]?.ignoreLinks === true ||
 					node.parent.parent.type !== 'SvelteElement' ||
 					node.parent.parent.kind !== 'html' ||
 					node.parent.parent.name.type !== 'SvelteName' ||

packages/eslint-plugin-svelte/tests/fixtures/rules/no-navigation-without-base/valid/ignoreGoto/_config.json

@@ -0,0 +1,7 @@
+{
+	"options": [
+		{
+			"ignoreGoto": true
+		}
+	]
+}

packages/eslint-plugin-svelte/tests/fixtures/rules/no-navigation-without-base/valid/ignoreGoto/goto-ignored01-input.svelte

@@ -0,0 +1,5 @@
+<script>
+	import { goto } from '$app/navigation';
+
+	goto('/foo');
+</script>

packages/eslint-plugin-svelte/tests/fixtures/rules/no-navigation-without-base/valid/ignoreLinks/_config.json

@@ -0,0 +1,7 @@
+{
+	"options": [
+		{
+			"ignoreLinks": true
+		}
+	]
+}

packages/eslint-plugin-svelte/tests/fixtures/rules/no-navigation-without-base/valid/ignoreLinks/link-ignored01-input.svelte

@@ -0,0 +1,3 @@
+<a href="/foo">Click me!</a>
+<a href={'/foo'}>Click me!</a>
+<a href={'/' + 'foo'}>Click me!</a>

packages/eslint-plugin-svelte/tests/fixtures/rules/no-navigation-without-base/valid/ignorePushState/_config.json

@@ -0,0 +1,7 @@
+{
+	"options": [
+		{
+			"ignorePushState": true
+		}
+	]
+}

packages/eslint-plugin-svelte/tests/fixtures/rules/no-navigation-without-base/valid/ignorePushState/pushState-ignored01-input.svelte

@@ -0,0 +1,5 @@
+<script>
+	import { pushState } from '$app/navigation';
+
+	pushState('/foo');
+</script>

packages/eslint-plugin-svelte/tests/fixtures/rules/no-navigation-without-base/valid/ignoreReplaceState/_config.json

@@ -0,0 +1,7 @@
+{
+	"options": [
+		{
+			"ignoreReplaceState": true
+		}
+	]
+}

packages/eslint-plugin-svelte/tests/fixtures/rules/no-navigation-without-base/valid/ignoreReplaceState/replaceState-ignored01-input.svelte

@@ -0,0 +1,5 @@
+<script>
+	import { replaceState } from '$app/navigation';
+
+	replaceState('/foo');
+</script>