feat: adding sort-scripts-elements rule

Author: axel7083

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

@@ -382,6 +382,11 @@ export interface RuleOptions {
    * @see https://sveltejs.github.io/eslint-plugin-svelte/rules/sort-attributes/
    */
   'svelte/sort-attributes'?: Linter.RuleEntry<SvelteSortAttributes>
+	/**
+	 * enforce order of elements in Svelte scripts section
+	 * @see https://sveltejs.github.io/eslint-plugin-svelte/rules/sort-scripts-elements/
+	 */
+	'svelte/sort-scripts-sections'?: Linter.RuleEntry<SvelteSortScriptsElements>
   /**
    * enforce consistent spacing after the `<!--` and before the `-->` in a HTML comment
    * @see https://sveltejs.github.io/eslint-plugin-svelte/rules/spaced-html-comment/
@@ -417,9 +422,9 @@ export interface RuleOptions {
 /* ======= Declarations ======= */
 // ----- svelte/@typescript-eslint/no-unnecessary-condition -----
 type SvelteTypescriptEslintNoUnnecessaryCondition = []|[{
-  
+
   allowConstantLoopConditions?: boolean
-  
+
   allowRuleToRunWithoutStrictNullChecksIKnowWhatIAmDoing?: boolean
 }]
 // ----- svelte/block-lang -----
@@ -442,7 +447,7 @@ type SvelteCommentDirective = []|[{
 // ----- svelte/consistent-selector-style -----
 type SvelteConsistentSelectorStyle = []|[{
   checkGlobal?: boolean
-  
+
   style?: []|[("class" | "id" | "type")]|[("class" | "id" | "type"), ("class" | "id" | "type")]|[("class" | "id" | "type"), ("class" | "id" | "type"), ("class" | "id" | "type")]
 }]
 // ----- svelte/first-attribute-linebreak -----
@@ -537,11 +542,11 @@ type SvelteNoReactiveReassign = []|[{
 }]
 // ----- svelte/no-restricted-html-elements -----
 type SvelteNoRestrictedHtmlElements = [(string | {
-  
+
   elements?: [string, ...(string)[]]
   message?: string
 }), ...((string | {
-  
+
   elements?: [string, ...(string)[]]
   message?: string
 }))[]]
@@ -557,7 +562,7 @@ type SvelteNoTrailingSpaces = []|[{
 }]
 // ----- svelte/no-unknown-style-directive-property -----
 type SvelteNoUnknownStyleDirectiveProperty = []|[{
-  
+
   ignoreProperties?: [string, ...(string)[]]
   ignorePrefixed?: boolean
 }]
@@ -613,6 +618,12 @@ type SvelteSortAttributes = []|[{
   })[]
   alphabetical?: boolean
 }]
+// ----- svelte/sort-scripts-elements -----
+type SvelteSortScriptsElements = []|[{
+	order?: (string | [string, ...(string)[]] | {
+		match: (string | [string, ...(string)[]])
+	})[]
+}]
 // ----- svelte/spaced-html-comment -----
 type SvelteSpacedHtmlComment = []|[("always" | "never")]
 // ----- svelte/valid-compile -----

packages/eslint-plugin-svelte/src/rules/sort-scripts-elements.ts

@@ -0,0 +1,115 @@
+import { createRule } from '../utils/index.js';
+import type { RuleContext } from '../types.js';
+import type { AST } from 'svelte-eslint-parser';
+
+const DEFAULT_ORDER: string[] = [
+	'ImportDeclaration',
+	'TSTypeAliasDeclaration',
+	'VariableDeclaration',
+	'FunctionDeclaration'
+];
+
+// creating and exporting the rule
+export default createRule('sort-scripts-elements', {
+	meta: {
+		docs: {
+			description: 'enforce order of elements in the Svelte scripts sections',
+			category: 'Stylistic Issues',
+			recommended: false,
+			conflictWithPrettier: false
+		},
+		schema: [],
+		messages: {
+			scriptsIsNotSorted: 'Scripts is not sorted.'
+		},
+		type: 'layout',
+		fixable: 'code'
+	},
+	create(context: RuleContext) {
+		const sourceCode = context.sourceCode;
+		const MAPPING = new Map<string, number>(DEFAULT_ORDER.map((value, index) => [value, index]));
+
+		return {
+			SvelteScriptElement(node: AST.SvelteScriptElement) {
+				// do not accept scripts without closing tags
+				if (node.endTag === null) return;
+				const svelteEndTag: AST.SvelteEndTag = node.endTag;
+
+				// collect scripts statement
+				const statements = node.body;
+				// do not sort when we only have one elements
+				if (statements.length <= 1) return;
+
+				const seens = new Set<string>();
+				let current: string = statements[0].type;
+
+				let sortingRequired = false;
+				for (let i = 0; i < statements.length; i++) {
+					// if we are the same as previous
+					if (seens.has(statements[i].type) && statements[i].type === current) {
+						continue;
+					}
+
+					if (i > 0) {
+						const previousOrderIndex = MAPPING.get(current);
+						const currentOrderIndex = MAPPING.get(statements[i].type);
+						if (previousOrderIndex !== undefined && currentOrderIndex !== undefined) {
+							if (previousOrderIndex > currentOrderIndex) {
+								sortingRequired = true;
+								break;
+							}
+						}
+					}
+
+					// mark the node type as seen
+					seens.add(statements[i].type);
+					current = statements[i].type;
+				}
+
+				if (!sortingRequired) return;
+
+				context.report({
+					node,
+					messageId: 'scriptsIsNotSorted',
+					fix: (fixer) => {
+						const foo: { order: number; text: string }[] = [];
+
+						for (let i = 0; i < statements.length; i++) {
+							// Getting the comments between previous and current statement
+							const comments = sourceCode
+								.getCommentsInside({
+									type: 'Null',
+									range: [
+										// Get comment between the last statement and current
+										i === 0 ? node.startTag.range[1] : statements[i - 1].range[1],
+										i === statements.length - 1 ? svelteEndTag.range[0] : statements[i].range[0]
+									]
+								})
+								.map((comment) => sourceCode.getText(comment));
+
+							/**
+							 * We need to handle the missing \t\n
+							 * Example when i === 0 we should take the startTag.range[1] up to the first statement if no comments
+							 * Same between statements etc.
+							 * sourceCode.getText(statements[i], (statements[i].range[0]) - (node.startTag.range[1] + 1))
+							 */
+							foo.push({
+								order: MAPPING.get(statements[i].type) ?? Number.MAX_SAFE_INTEGER,
+								text: comments.join('') + sourceCode.getText(statements[i])
+							});
+						}
+
+						const text = foo
+							.sort((a, b) => a.order - b.order)
+							.map(({ text }) => text)
+							.join('\n');
+
+						return [
+							fixer.replaceTextRange([node.startTag.range[1] + 1, svelteEndTag.range[0] - 1], text)
+						];
+					}
+				});
+			}
+		};
+	}
+});

packages/eslint-plugin-svelte/src/utils/rules.ts

@@ -75,6 +75,7 @@ import requireStoresInit from '../rules/require-stores-init.js';
 import shorthandAttribute from '../rules/shorthand-attribute.js';
 import shorthandDirective from '../rules/shorthand-directive.js';
 import sortAttributes from '../rules/sort-attributes.js';
+import sortScriptsElements from '../rules/sort-scripts-elements.js';
 import spacedHtmlComment from '../rules/spaced-html-comment.js';
 import system from '../rules/system.js';
 import validCompile from '../rules/valid-compile.js';
@@ -156,6 +157,7 @@ export const rules = [
 	shorthandAttribute,
 	shorthandDirective,
 	sortAttributes,
+	sortScriptsElements,
 	spacedHtmlComment,
 	system,
 	validCompile,

packages/eslint-plugin-svelte/tests/fixtures/rules/sort-scripts-elements/invalid/default/type-before-import-errors.yaml

@@ -0,0 +1,4 @@
+- message: Scripts is not sorted.
+  line: 1
+  column: 1
+  suggestions: null

packages/eslint-plugin-svelte/tests/fixtures/rules/sort-scripts-elements/invalid/default/type-before-import-input.svelte

@@ -0,0 +1,8 @@
+<script lang="ts">
+	type Foo = string;
+	import Bar from './bar.svelte';
+	
+	function hello(): string {
+		return 'world';
+	}
+</script>

packages/eslint-plugin-svelte/tests/fixtures/rules/sort-scripts-elements/invalid/default/type-before-import-output.svelte

@@ -0,0 +1,4 @@
+<script lang="ts">
+	import Bar from './bar.svelte';
+	type Foo = string;
+</script>

packages/eslint-plugin-svelte/tests/fixtures/rules/sort-scripts-elements/valid/default/single-import-input.svelte

@@ -0,0 +1,3 @@
+<script>
+	import component from './foo';
+</script>

packages/eslint-plugin-svelte/tests/src/rules/sort-scripts-elements.ts

@@ -0,0 +1,12 @@
+import { RuleTester } from '../../utils/eslint-compat.js';
+import rule from '../../../src/rules/sort-scripts-elements.js';
+import { loadTestCases } from '../../utils/utils.js';
+
+const tester = new RuleTester({
+	languageOptions: {
+		ecmaVersion:"latest",
+		sourceType: 'module'
+	}
+});
+
+tester.run('sort-scripts-elements', rule as any, loadTestCases('sort-scripts-elements'));