@soleil-se/eslint-config 6.0.2 → 6.2.0

package/CHANGELOG.md

@@ -2,192 +2,205 @@
 title: Changelog
 ---
 
-Alla förändringar i detta repository antecknas här.
+All changes in this repository are noted here.
 
-Formatet baseras på [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
-och projektet använder [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and the project uses [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [6.2.0] - 2025-03-31
+
+* Update `eslint-plugin-svelte` version 3.
+* Enable `svelte/html-self-closing`.
+* Enable `svelte/prefer-const`.
+* Allow caught errors to unused in `no-unused-vars`.
+* Add path group override for `#` in `import/extensions`.
+
+## [6.1.0] - 2025-03-18
+
+* Adjust config for script modules to correct sourceType.
+* Allow `underscore-dangle` for `__rekai`.
 
 ## [6.0.2] - 2025-02-07
 
-* Uppdatera definitioner i package.json.
+* Update definitions in package.json.
 
 ## [6.0.1] - 2025-02-05
 
-* Läs in Svelte konfiguration dynamiskt.
-* Uppdatera referenser för publicering på npm.
+* Load Svelte configuration dynamically.
+* Update references for publishing on npm.
 
 ## [6.0.0] - 2025-02-04
 
-* Uppdatera till ESLint 9 och format på konfigurationsfiler till flat config.
-* Ändra `trailingComma` till 'all' i Prettier-konfigurationen.
-* Lägg till global för `envision`.
-* Döpt om `legacy` till `script-module` då det är det den används till.
+* Update to ESLint 9 and format configuration files to flat config.
+* Change `trailingComma` to 'all' in the Prettier configuration.
+* Add global for `envision`.
+* Renamed `legacy` to `script-module-config` as that is what it is used for.
 
 ## [5.3.2] - 2024-12-13
 
-* Stäng av regeln `svelte/no-unused-svelte-ignore` då den strular.
+* Turn off the rule `svelte/no-unused-svelte-ignore` as it causes issues.
 
 ## [5.3.1] - 2024-11-15
 
-* Ta bort `svelte-preprocess` från dependencies då det inte är relevant för eslint.
+* Remove `svelte-preprocess` from the installation script as it is not relevant for eslint.
 
 ## [5.3.0] - 2024-10-21
 
-* Justerat regler för `prefer-const` och `max-len` för att fungera bättre med Svelte 5.
+* Adjust rules for `prefer-const` and `max-len` to work better with Svelte 5.
 
 ## [5.2.0] - 2024-06-03
 
-* Nytt kommando för att installera dependencies och skapa konfigurationsfiler, `npx @soleil/eslint-config-sitevision --setup`.
+* New command to install dependencies and create configuration files, `npx @soleil/eslint-config --setup`.
 
 ## [5.1.2] - 2023-10-26
 
-- Uppdatera inställningarna för `max-len` i Svelte-filer då det bråkar med prettier.
+- Update settings for `max-len` in Svelte files as it conflicts with prettier.
 
 ## [5.1.1] - 2023-08-22
 
-- Lägg till undantag för Sveltes submoduler då import-pluginet inte kan resolva dessa trots att de finns tillgängliga.
+- Add exceptions for Svelte's submodules as the import plugin cannot resolve these even though they are available.
 
 ## [5.1.0] - 2023-06-01
 
-- Lägg till varningar för API:er vars instanser inte borde importeras direkt utan skapas via andra API:er.
+- Add warnings for APIs whose instances should not be imported directly but created via other APIs.
 
 ## [5.0.1] - 2023-05-31
 
-- Ignorera `max-len` för importer i style taggar i Svelte komponenter.
+- Ignore `max-len` for imports in style tags in Svelte components.
 
 ## [5.0.0] - 2023-05-26
 
-- Nytt plugin för linting av Svelte.
+- New plugin for linting Svelte.
 
 ## [4.0.1] - 2023-03-27
 
-- Läs bara in overrides för Svelte-filer när Svelte är installerat i projektet.
+- Only load overrides for Svelte files when Svelte is installed in the project.
 
 ## [4.0.0] - 2022-06-22
 
-- Förenkla genom att ta bort de de olika konfigurationerna och använd en och samma config för allt utom legacy kod.
-- Modernisera legacy konfigurationen för att tillåta begränsad användning av ES2015+ som stöds av Rhino.
-- Använd `eslint-config-prettier` i Svelte komponenter för att undvika krockar med ESLint.
-- Ta bort stöd för Vue.
+- Simplify by removing the different configurations and using the same config for everything except legacy code.
+- Modernize the legacy configuration to allow limited use of ES2015+ supported by Rhino.
+- Use `eslint-config-prettier` in Svelte components to avoid conflicts with ESLint.
+- Remove support for Vue.
 
 ## [3.1.0] - 2022-04-11
 
-- Tillåt användning av `console.error()` - för exempelvis try catch.
+- Allow the use of `console.error()` - for example, in try catch.
 
 ## [3.0.1] - 2022-02-07
 
-- Ignorera `import/no-unresolved` för importer som börjar med `@sitevision/api/server`,
- `@sitevision/api/common` och `@sitevision/api/client` då alla API:er inte finns dokumenterade.
+- Ignore `import/no-unresolved` for imports starting with `@sitevision/api/server`,
+ `@sitevision/api/common` and `@sitevision/api/client` as not all APIs are documented.
 
 ## [3.0.0] - 2022-02-07
 
-- Tillåt enbart importer av Sitevisions API:er via `@sitevision/api`.
-- Uppdaterat sökvägarna i den globala och webapp configen för att stödja WebApps 2 strukturen.
-- Uppdaterat `peerDependencies` till senaste major versionerna.
+- Only allow imports of Sitevision's APIs via `@sitevision/api`.
+- Update paths in the global and webapp config to support the WebApps 2 structure.
+- Update `peerDependencies` to the latest major versions.
 
 ## [2.4.5] - 2021-11-04
 
-- Sätt `ecmaVersion` till 2021 i client kontfigurationen om Vue används.
+- Set `ecmaVersion` to 2021 in the client configuration if Vue is used.
 
 ## [2.4.4] - 2021-09-09
 
-- Lägg till `options` i `svelteSortOrder`.
+- Add `options` to `svelteSortOrder`.
 
 ## [2.4.3] - 2021-08-27
 
-- Felstavning i regeln `no-return-assign` i Svelte-filer.
+- Typo in the rule `no-return-assign` in Svelte files.
 
 ## [2.4.2] - 2021-08-17
 
-- Om Vue används i projektet sätt `ecmaVersion` till 2021 istället då pluginet använder Espree vilket inte klarar av samma versionsnamn som ESLint.
+- If Vue is used in the project, set `ecmaVersion` to 2021 instead as the plugin uses Espree which cannot handle the same version names as ESLint.
 
 ## [2.4.1] - 2021-08-17
 
-- Sätt `ecmaVersion` till `latest` för att slippa uppdatera version varje år.
+- Set `ecmaVersion` to `latest` to avoid updating the version every year.
 
 ## [2.4.0] - 2021-03-24
 
-- Meddelande av deprekering för konfigurationerna `@soleil/eslint-config-sitevision/universal` och `@soleil/eslint-config-sitevision/server`
-- Nya konfigurationer med tydligare namn: `@soleil/eslint-config-sitevision/webapp` och `@soleil/eslint-config-sitevision/server-legacy`
-- Tillåt fler properties per rad i ett objekt i `object-curly-newline`.
+- Deprecation notice for the configurations `@soleil/eslint-config/universal` and `@soleil/eslint-config/server`
+- New configurations with clearer names: `@soleil/eslint-config/webapp` and `@soleil/eslint-config/server-legacy`
+- Allow more properties per line in an object in `object-curly-newline`.
 
 ## [2.3.1] - 2021-02-24
 
-- Dra tillbaka till `ecmaVersion` till 2020.
+- Revert `ecmaVersion` to 2020.
 
 ## [2.3.0] - 2021-02-24
 
-- Fler regler överlappar när man skriver universell kod.
-- Slagit av `import/prefer-default-export`.
-- Slagit av `no-return-assig` i Svelte komponenter.
-- Tagit bort linting av skript i HTML för server konfigurationen för ES5-kod.
+- More rules overlap when writing universal code.
+- Turned off `import/prefer-default-export`.
+- Turned off `no-return-assign` in Svelte components.
+- Removed linting of scripts in HTML for the server configuration for ES5 code.
 
 ## [2.2.1] - 2021-01-07
 
-- Tagit bort `babel-eslint` från dependencies.
+- Removed `babel-eslint` from dependencies.
 
 ## [2.2.0] - 2021-01-07
 
-- Tagit bort `babel-eslint` och använder standardparsern med ES2020.
-- Förenklat `svelte.config.js`, oftast behövs inte plugin för globbing.
-- Lagt till paketet `cache` som undantag för SiteVision paket.
+- Removed `babel-eslint` and use the standard parser with ES2020.
+- Simplified `svelte.config.js`, usually the plugin for globbing is not needed.
+- Added the package `cache` as an exception for SiteVision packages.
 
 ## [2.1.4] - 2020-10-26
 
-- Tagit bort felaktig konfiguration av `a11y-no-onchange`.
+- Removed incorrect configuration of `a11y-no-onchange`.
 
 ## [2.1.3] - 2020-10-21
 
-- Lagt till `app_src/views/**/*.js` i server configen.
+- Added `app_src/views/**/*.js` in the server config.
 
 ## [2.1.2] - 2020-10-06
 
-- Åträgrdat felaktiga `parserOptions` i `server-es6` configen.
+- Fixed incorrect `parserOptions` in the `server-es6` config.
 
 ## [2.1.1] - 2020-10-06
 
-- Ändrat ordning på config så de inställningar Svelte behöver för serversidan kommer med.
+- Changed the order of the config so the settings Svelte needs for the server side are included.
 
 ## [2.1.0] - 2020-09-28
 
-- Dependencies som behövs som standard ligger som peerDependencies
-- Dependencies för ramverksspecifika plugins behöver installeras utöver peerDependencies.
+- Dependencies needed by default are listed as peerDependencies.
+- Dependencies for framework-specific plugins need to be installed in addition to peerDependencies.
 
 ## [2.0.0] - 2020-09-28
 
-- Stöd för Svelte.
-- Uppdaterad struktur.
-- Uppdatering till ESLint 7.
-- Tagit bort konfigurationen för Vue, ligger nu i client.
+- Support for Svelte.
+- Updated structure.
+- Update to ESLint 7.
+- Removed the configuration for Vue, now in the client.
 
 ## [1.1.2] - 2020-02-05
 
-- Ändrat regeln `import/extensions` så den ignorerar json-filer.
+- Changed the rule `import/extensions` to ignore json files.
 
 ## [1.1.1] - 2020-01-27
 
-- Ändrat regeln `import/extensions` så den ignorerar vue-filer.
+- Changed the rule `import/extensions` to ignore vue files.
 
 ## [1.1.0] - 2020-01-21
 
-- Ändrat regeln `import/extensions` så den ignorerar paket, löser problem med import via alias.
+- Changed the rule `import/extensions` to ignore packages, solving issues with import via alias.
 
 ## [1.0.0] - 2020-01-13
 
-- Uppdaterat till ESLint 6.
+- Updated to ESLint 6.
 
 ## [0.3.3] - 2019-12-06
 
-- Det får nu vara max 3 attribut per rad i Vue (`vue/max-attributes-per-line`).
+- Now allows a maximum of 3 attributes per line in Vue (`vue/max-attributes-per-line`).
 
 ## [0.3.2] - 2019-06-03
 
-- Lagt till `server_src/api` i server på den globala configen.
+- Added `server_src/api` in the server to the global config.
 
 ## [0.3.1] - 2019-05-20
 
-- Slagit av `global-require` för att kunna skriva `require` innanför IIFE i `src/index.js` i en WebApp.
+- Turned off `global-require` to allow writing `require` inside IIFE in `src/index.js` in a WebApp.
 
 ## [0.3.0] - 2019-05-20
 
-- Lagt till en global config som kan användas i roten av ett projekt som använder standardstrukturen och `@soleil/sv-gulp-build@^3.0.0`.
+- Added a global config that can be used in the root of a project using the standard structure and `@soleil/sv-gulp-build@^3.0.0`.

package/README.md

@@ -2,4 +2,4 @@
 
 ESLint configuration for Sitevision apps and projects.
 
-[Documentation](https://docs.soleil.se/packages/eslint-config)
+[Documentation](https://docs.soleil.se/packages/eslint-config) | [Changelog](https://docs.soleil.se/packages/eslint-config/changelog)

package/config/base.js

@@ -0,0 +1,30 @@
+import globals from 'globals';
+import importPlugin from 'eslint-plugin-import';
+import jsRules from '../rules/js/index.js';
+
+export default function base() {
+  return [{
+    name: 'soleil/base',
+    languageOptions: {
+      ecmaVersion: 'latest',
+      sourceType: 'module',
+      globals: {
+        process: 'readonly',
+        Packages: 'readonly',
+        envision: 'readonly',
+        ...globals.browser,
+      },
+    },
+    ignores: ['dist', 'node_modules', 'prettier.config.js'],
+    plugins: { import: importPlugin },
+    rules: jsRules,
+    settings: {
+      svelte: {
+      // Ignore max-len in template and style, still works for script tags.
+        ignoreWarnings: [
+          'max-len',
+        ],
+      },
+    },
+  }];
+}

package/config/svelte.js

@@ -0,0 +1,31 @@
+import svelteRules from '../rules/svelte/index.js';
+
+async function hasSvelte() {
+  try {
+    await import('svelte');
+    return true;
+  } catch (e) {
+    return false;
+  }
+}
+
+export default async function svelte() {
+  if (!await hasSvelte()) return [];
+
+  const { default: eslintPluginSvelte } = await import('eslint-plugin-svelte');
+  const { default: eslintConfigPrettier } = await import('eslint-config-prettier');
+
+  return [
+    ...eslintPluginSvelte.configs.recommended,
+    ...eslintPluginSvelte.configs.prettier,
+    {
+      name: 'soleil/svelte',
+      files: ['**/*.svelte', '**/*.svelte.js', '**/*.svelte.ts'],
+      rules: svelteRules,
+    }, {
+      name: 'soleil/svelte.prettier',
+      files: ['**/*.svelte'],
+      rules: eslintConfigPrettier.rules,
+    },
+  ];
+}

package/eslint.config.js

@@ -2,4 +2,9 @@ import config from './node-config.js';
 
 export default [
   ...config,
+  {
+    rules: {
+      'import/no-extraneous-dependencies': 0,
+    },
+  },
 ];

package/index.js

@@ -1,70 +1,7 @@
-import globals from 'globals';
-import importPlugin from 'eslint-plugin-import';
-
-import jsRules from './rules/js/index.js';
-import svelteRules from './rules/svelte/index.js';
-
-function loadSvelteConfig() {
-  // eslint-disable-next-line import/no-extraneous-dependencies
-  return import('svelte').then(async () => {
-    const { default: eslintPluginSvelte } = await import('eslint-plugin-svelte');
-    const { default: eslintConfigPrettier } = await import('eslint-config-prettier');
-    return [
-      ...eslintPluginSvelte.configs['flat/recommended'],
-      ...eslintPluginSvelte.configs['flat/prettier'],
-      {
-        name: 'soleil/svelte',
-        files: ['**/*.svelte'],
-        rules: {
-          ...svelteRules,
-          ...eslintConfigPrettier.rules,
-        },
-      }, {
-        name: 'soleil/svelte.js',
-        files: ['**/*.svelte.js', '**/*.svelte.ts'],
-        languageOptions: {
-          ecmaVersion: 'latest',
-          sourceType: 'module',
-          globals: {
-            $state: 'readonly',
-            $derived: 'readonly',
-            $effect: 'readonly',
-            $inspect: 'readonly',
-          },
-        },
-        rules: {
-        // Do not enforce const because of reactivity for runes in Svelte 5.
-          'prefer-const': 0,
-        },
-      },
-    ];
-  }).catch(() => []);
-}
+import base from './config/base.js';
+import svelte from './config/svelte.js';
 
 export default [
-  {
-    name: 'soleil/base',
-    languageOptions: {
-      ecmaVersion: 'latest',
-      sourceType: 'module',
-      globals: {
-        process: 'readonly',
-        Packages: 'readonly',
-        envision: 'readonly',
-        ...globals.browser,
-      },
-    },
-    ignores: ['dist', 'node_modules', 'prettier.config.js'],
-    plugins: { import: importPlugin },
-    rules: jsRules,
-    settings: {
-      svelte: {
-      // Ignore max-len in template and style, still works for script tags.
-        ignoreWarnings: [
-          'max-len',
-        ],
-      },
-    },
-  },
-  ...await loadSvelteConfig(),
+  ...base(),
+  ...await svelte(),
 ];

package/node-config.js

@@ -1,9 +1,11 @@
-import config from './index.js';
+import base from './config/base.js';
 
-export default [...config, {
-  rules: {
-    'import/extensions': ['error', 'ignorePackages', {
-      js: 'always',
-    }],
-  },
-}];
+export default [
+  ...base(),
+  {
+    rules: {
+      'import/extensions': ['error', 'ignorePackages', {
+        js: 'always',
+      }],
+    },
+  }];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@soleil-se/eslint-config",
-  "version": "6.0.2",
+  "version": "6.2.0",
   "description": "ESLint configuration for Sitevision apps and projects.",
   "keywords": [
     "eslint",
@@ -19,17 +19,21 @@
     "./prettier": "./prettier.js",
     "./script-module": "./script-module.js",
     "./node": "./node-config.js",
-    "./rules":"./rules/**/*.js"
+    "./typescript": "./typescript.js",
+    "./config/base": "./config/base.js",
+    "./config/svelte": "./config/svelte.js",
+    "./rules/js":"./rules/js/index.js",
+    "./rules/svelte":"./rules/svelte/index.js"
   },
   "dependencies": {
-    "eslint-config-prettier": "^10.0.1",
+    "eslint-config-prettier": "^10.1.1",
     "eslint-plugin-import": "^2.31.0",
-    "eslint-plugin-svelte": "^2.46.1",
-    "globals": "^15.14.0"
+    "eslint-plugin-svelte": "^3.4.0",
+    "globals": "^16.0.0"
   },
   "devDependencies": {
-    "eslint": "^9.18.0",
-    "svelte": "^5.17.4"
+    "eslint": "^9.23.0",
+    "svelte": "^5.25.3"
   },
   "peerDependencies": {
     "eslint": ">= 9"

package/rules/js/imports.js

@@ -89,11 +89,24 @@ export default {
 
   // Ensure consistent use of file extension within the import path
   // https://github.com/import-js/eslint-plugin-import/blob/master/docs/rules/extensions.md
-  'import/extensions': ['error', 'ignorePackages', {
-    js: 'never',
-    mjs: 'never',
-    jsx: 'never',
-  }],
+
+  'import/extensions': ['error', {
+    ignorePackages: true,
+    pattern: {
+      js: 'never',
+      mjs: 'never',
+      jsx: 'never',
+      json: 'always',
+    },
+    pathGroupOverrides: [{
+      pattern: '**/*.svelte.js',
+      action: 'ignore',
+    }, {
+      pattern: '#*',
+      action: 'ignore',
+    }],
+  },
+  ],
 
   // ensure absolute imports are above relative imports and that unassigned imports are ignored
   // https://github.com/import-js/eslint-plugin-import/blob/master/docs/rules/order.md

package/rules/js/style.js

@@ -372,7 +372,7 @@ export default {
   // disallow dangling underscores in identifiers
   // https://eslint.org/docs/rules/no-underscore-dangle
   'no-underscore-dangle': ['error', {
-    allow: [],
+    allow: ['__rekai'],
     allowAfterThis: false,
     allowAfterSuper: false,
     enforceInMethodNames: true,

package/rules/js/variables.js

@@ -109,7 +109,7 @@ export default {
   'no-undefined': 'off',
 
   // disallow declaration of variables that are not used in the code
-  'no-unused-vars': ['error', { vars: 'all', args: 'after-used', ignoreRestSiblings: true }],
+  'no-unused-vars': ['error', { vars: 'all', args: 'after-used', ignoreRestSiblings: true, caughtErrors: 'none' }],
 
   // disallow use of variables before they are defined
   'no-use-before-define': ['error', { functions: true, classes: true, variables: true }],

package/rules/svelte/bestPractices.js

@@ -5,4 +5,5 @@ export default {
   'svelte/no-reactive-literals': 'warn',
   'svelte/no-useless-mustaches': 'warn',
   'svelte/no-unused-svelte-ignore': 0,
+  'svelte/prefer-const': 'error',
 };

package/rules/svelte/style.js

@@ -1,6 +1,47 @@
 export default {
   'svelte/no-extra-reactive-curlies': 'warn',
   'svelte/prefer-style-directive': 'warn',
-  'svelte/sort-attributes': 'warn',
   'svelte/spaced-html-comment': 'warn',
+  'svelte/html-self-closing': 'warn',
+  'svelte/html-quotes': 'warn',
+  'svelte/sort-attributes': [
+    'warn', {
+      order: [
+        // `this` property.
+        'this',
+        // `bind:this` directive.
+        'bind:this',
+        // `id` attribute.
+        'id',
+        // `name` attribute.
+        'name',
+        // `slot` attribute.
+        'slot',
+        // `--style-props` (Alphabetical order within the same group.)
+        { match: '/^--/u', sort: 'alphabetical' },
+        // `style` attribute, and `style:` directives.
+        ['style', '/^style:/u'],
+        // `class` attribute.
+        'class',
+        // `class:` directives. (Alphabetical order within the same group.)
+        { match: '/^class:/u', sort: 'alphabetical' },
+        // other attributes.
+        ['!/:/u', '!/^(?:this|id|name|style|class)$/u', '!/^--/u'],
+        // `bind:` directives (other then `bind:this`), and `on:` directives.
+        ['/^bind:/u', '!bind:this', '/^on:/u'],
+        // `use:` directives. (Alphabetical order within the same group.)
+        { match: '/^use:/u', sort: 'alphabetical' },
+        // `transition:` directive.
+        { match: '/^transition:/u', sort: 'alphabetical' },
+        // `in:` directive.
+        { match: '/^in:/u', sort: 'alphabetical' },
+        // `out:` directive.
+        { match: '/^out:/u', sort: 'alphabetical' },
+        // `animate:` directive.
+        { match: '/^animate:/u', sort: 'alphabetical' },
+        // `let:` directives. (Alphabetical order within the same group.)
+        { match: '/^let:/u', sort: 'alphabetical' },
+      ],
+    },
+  ],
 };

package/script-module.js

@@ -5,11 +5,12 @@ import variables from './rules/js/variables.js';
 
 export default [
   {
-    name: 'soleil/base',
+    name: 'soleil/script-module',
     languageOptions: {
       ecmaVersion: 'latest',
-      sourceType: 'commonjs',
+      sourceType: 'script',
       globals: {
+        require: 'readonly',
         scriptVariables: 'readonly',
         Packages: 'readonly',
         request: 'readonly',

package/setup.js

@@ -97,12 +97,12 @@ function setupFiles() {
 function setup() {
   printStartup();
   let packageFile = readJsonFileSync('./package.json');
-  if (packageFile?.devDependencies?.eslint) {
-    packageFile = removeDependencies(packageFile);
-  }
+  packageFile = removeDependencies(packageFile);
+
   if (packageFile.type !== 'module') {
     packageFile.type = 'module';
   }
+
   writeJsonFileSync('./package.json', packageFile);
   installDependencies();
   setupFiles();

package/typescript.js

@@ -0,0 +1,22 @@
+// eslint-disable-next-line import/no-unresolved
+import tseslint from 'typescript-eslint';
+import base from './config/base.js';
+import svelte from './config/svelte.js';
+
+const svelteTypescript = {
+  files: ['**/*.svelte', '**/*.svelte.js', '**/*.svelte.ts'],
+  languageOptions: {
+    parserOptions: {
+      projectService: true,
+      extraFileExtensions: ['.svelte'],
+      parser: tseslint.parser,
+    },
+  },
+};
+
+export default tseslint.config(
+  ...base(),
+  tseslint.configs.recommended,
+  ...await svelte(),
+  svelteTypescript,
+);