@soleil-se/eslint-config 5.3.2 → 6.0.0

package/CHANGELOG.md

@@ -7,6 +7,13 @@ Alla förändringar i detta repository antecknas här.
 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).
 
+## [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.
+
 ## [5.3.2] - 2024-12-13
 
 * Stäng av regeln `svelte/no-unused-svelte-ignore` då den strular.

package/LICENSE.md

@@ -1 +1 @@
-(c) Copyright 2023 Soleil AB, all rights reserved.
+(c) Copyright 2025 Soleil AB, all rights reserved.

package/README.md

@@ -4,105 +4,92 @@ ESLint konfiguration för Sitevision projekt som bygger på Airbnbs JavaScript s
 **ES2015+**  
 <https://github.com/airbnb/javascript>
 
-**Legacy (ES5)**  
-<https://github.com/airbnb/javascript/tree/es5-deprecated/es5>
-
 Om man stöter på ett fel man inte förstår kan man kolla i styleguiden eller söka på ESLints hemsida.  
 <https://eslint.org/docs/rules/>
 
 ## Installera
 
-Installera konfigurationen, ESLint, Prettier, Svelte och de plugins som behövs genom att köra:
+Installera dependencies och sätt upp konfigurationsfiler:
 
 ```sh
-npx @soleil-se/eslint-config-sitevision --setup
+npx @soleil-se/eslint-config-sitevision@latest --setup
 ```
 
 För att installera manuellt installera följande dependencies och skapa upp konfigurationsfiler enligt [nedan](#config).
 
 ```sh
-npm i @soleil-se/eslint-config-sitevision eslint eslint-config-airbnb-base eslint-plugin-import eslint-plugin-svelte svelte svelte-preprocess eslint-config-prettier --save-dev
+npm i @soleil-se/eslint-config-sitevision eslint --save-dev
 ```
 
 ## Uppgradera
 
+Enklast är att köra setup skriptet för att uppdatera till senaste versionen.
+```sh
+npx @soleil-se/eslint-config-sitevision@latest --setup
+```
 
-:::details[Version 4.x.x > 5.x.x]
+:::::details[Manuellt]
+::::steps
+  :::step[Avinstallera plugins]
+  Avinstallera alla gamla plugins med:
 
-- Uppgradera `@soleil-se/eslint-config-sitevision` till version 5.
-- Avinstallera `eslint-plugin-svelte3`.
-- Installera `eslint-plugin-svelte`.
-- Installera `eslint-config-prettier` om det inte redan är installerat.
+  ```sh
+  npm remove eslint-config-airbnb-base eslint-plugin-import eslint-plugin-svelte
+  ```
 
-```sh
-npm i @soleil-se/eslint-config-sitevision@5 eslint-plugin-svelte eslint-plugin-prettier --save-dev && npm remove eslint-plugin-svelte3
-```
+  :::
+  :::step[Uppdatera dependencies]
+  Uppdatera `@soleil-se/eslint-config-sitevision` till version 6 och `eslint` till version 9:
+
+  ```sh
+  npm i @soleil-se/eslint-config-sitevision@6 eslint@9 --save-dev
+  ```
+
+  :::
+  :::step[Ta bort gammal konfiguration]
 
-:::
-:::details[Version 3.x.x > 4.x.x]
-
-- Om Vue används i projektet **stanna** på version 3, stödet för Vue plockas bort i denna version.
-- Uppgradera `@soleil-se/eslint-config-sitevision` till version 4.
-- Om Svelte används i projektet installera `eslint-config-prettier`.
-- Byt ut alla importer av konfigurationer:
-  - `@soleil-se/eslint-config-sitevision/global` > `@soleil-se/eslint-config-sitevision`
-  - `@soleil-se/eslint-config-sitevision/webapp` > `@soleil-se/eslint-config-sitevision`
-  - `@soleil-se/eslint-config-sitevision/client` > `@soleil-se/eslint-config-sitevision`
-  - `@soleil-se/eslint-config-sitevision/server-es6` > `@soleil-se/eslint-config-sitevision`
-  - `@soleil-se/eslint-config-sitevision/universal` > `@soleil-se/eslint-config-sitevision`
-- Byt ut alla importer av legacy-konfigurationer:
-  - `@soleil-se/eslint-config-sitevision/server-legacy` > `@soleil-se/eslint-config-sitevision/legacy`
-  - `@soleil-se/eslint-config-sitevision/server` > `@soleil-se/eslint-config-sitevision/legacy`
-:::
-:::details[Version 2.x.x > 3.x.x]
-
-- Uppgradera `@soleil-se/eslint-config-sitevision` till version 3.
-- Uppgradera `eslint` till version 8.
-- Uppgradera `eslint-config-airbnb-base` till version 15.
-- Ändra importer till Sitevisions API:er till `@sitevision/api/(server|common|client)/NamnPåAPI`.
-:::
-:::details[Version 1.x.x > 2.x.x]
-
-- Uppgradera `eslint` till version 7.
-- Installera alla dependencies enligt installationssteget.
-- Om `@soleil-se/eslint-config-sitevision/vue` används byt till `@soleil-se/eslint-config-sitevision/client`.
-:::
+  Ta bort gamla konfigurationsfiler.
+
+- `.eslintrc.cjs`
+- `.eslintignore`
+- `.prettierrc.cjs`
+  
+  :::
+  :::step[Skapa upp ny konfiguration]
+    Skapa upp nya konfigurationsfiler enligt [nedan](#config).
+  :::
+
+::::
+
+:::::
 
 ## Config
 
-ESLint läser främst från `.eslintrc.cjs` filer i projektet.  
+ESLint läser främst från `eslint.config.js` filer i projektet.  
 <https://eslint.org/docs/user-guide/configuring#using-configuration-files-1>
 
 ### Importera config
 
 ```js
-// .eslintrc.cjs
-module.exports = {
-  extends: '@soleil-se/eslint-config-sitevision',
-};
-```
+// eslint.config.js
+import sitevision from '@soleil-se/eslint-config-sitevision';
 
-Legacy config som används i en kontext med stöd för ES5 och delvis ES2015+.  
-Till exempel serverkod som ska laddas upp som den är till Sitevision utan kompilering.
+export default [
+  ...sitevision,
+];
 
-```js
-// .eslintrc.cjs
-module.exports = {
-  extends: '@soleil-se/eslint-config-sitevision/legacy',
-  root: true,
-};
 ```
 
-### ESLint ignore
+Config för skriptmoduler och Rhino.
+
+```js
+// eslint.config.js
+import script from '@soleil-se/eslint-config-sitevision/script-module';
 
-Lägg med en `.eslintignore` fil i roten för att slå av linting av filer i bland annat `node_modules` och `dist`.
+export default [
+  ...script,
+];
 
-```text
-// .eslintignore
-dist
-node_nodules
-**/node_nodules
-svelte.config
 ```
 
 ## Editors
@@ -190,28 +177,28 @@ Slår man på `{ "mode": "auto" }` försöker den automatiskt hitta rätt konfig
 
 ```json
 // settings.json
-{
-  "files.eol": "\n",
-  "files.insertFinalNewline": true,
-  "editor.codeActionsOnSave": {
-    "source.fixAll.eslint": true
-  },
-  "editor.rulers": [
-    100
-  ],  
-  "editor.formatOnSave": false,
-  "editor.tabSize": 2,
-  "editor.insertSpaces": true,
-  "eslint.validate": [    
-    "javascript",
-    "javascriptreact",    
-    "svelte",
-  ], 
-  "[svelte]": {
-    "editor.formatOnSave": true
-  },
-  "eslint.workingDirectories": [{ "mode": "auto" }],
-}
+
+"files.eol": "\n",
+"files.insertFinalNewline": true,
+"editor.codeActionsOnSave": {
+  "source.fixAll.eslint": "explicit"
+},
+"editor.rulers": [
+  100
+],  
+"editor.formatOnSave": false,
+"editor.tabSize": 2,
+"editor.insertSpaces": true,
+"eslint.validate": [    
+  "javascript",
+  "javascriptreact",    
+  "svelte",
+], 
+"[svelte]": {
+  "editor.formatOnSave": true
+},
+"eslint.workingDirectories": [{ "mode": "auto" }],
+
 ```
 
 ## CLI
@@ -228,11 +215,12 @@ Installera [Svelte](https://marketplace.visualstudio.com/items?itemName=svelte.s
 Formatering av kod i Svelte använder Prettier så man behöver lägga till insällningar för det så HTML kan formateras,
 dessvärre påverkar detta även JavaScript så några regler som man är van vid har fått stängas av så
 det inte krockar med Prettier.
-Skapa en fil som heter `.prettierrc.js` i roten av projektet.
+Skapa en fil som heter `prettier.config.js` i roten av appen eller projektet.
 
 ```js
-// .prettierrc.cjs
-module.exports = require('@soleil-se/eslint-config-sitevision/svelte.prettier');
+// prettier.config.js
+export { default } from '@soleil-se/eslint-config-sitevision/prettier';
+
 ```
 
 För att formatera automatiskt behöver man lägga till följande i `settings.json` i Visual Studio Code.

package/bin/index.js

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 
 if (process.argv.includes('--setup')) {
-  require('../setup');
+  import('../setup.js');
 } else {
-  console.log('Available commands:\n--setup: Setup ESLint + Prettier configuration and dependencies needed for @soleil/eslint-config.');
+  console.log('Available commands:\n--setup: Setup ESLint + Prettier configuration and dependencies needed for @soleil/eslint-config-sitevision.');
 }

package/eslint.config.js

@@ -0,0 +1,5 @@
+import config from './node-config.js';
+
+export default [
+  ...config,
+];

package/index.js

@@ -1,121 +1,61 @@
-const { hasSvelte, hasPrettier } = require('./utils/hasDependency');
-const restrictedImports = require('./utils/restrictedImports');
+import globals from 'globals';
+import importPlugin from 'eslint-plugin-import';
+import eslintPluginSvelte from 'eslint-plugin-svelte';
+import eslintConfigPrettier from 'eslint-config-prettier';
 
-module.exports = {
-  extends: ['airbnb-base'],
-  parserOptions: {
-    ecmaVersion: 'latest',
-    sourceType: 'module',
-  },
-  env: {
-    browser: true,
-    jquery: true,
-  },
-  globals: {
-    process: 'readonly',
-    Packages: 'readonly',
-  },
-  rules: {
-    'import/extensions': ['error', 'never', {
-      ignorePackages: true,
-      pattern: {
-        svelte: 'always',
-        json: 'always',
+import jsRules from './rules/js/index.js';
+import svelteRules from './rules/svelte/index.js';
+
+export default [
+  {
+    name: 'soleil/base',
+    languageOptions: {
+      ecmaVersion: 'latest',
+      sourceType: 'module',
+      globals: {
+        process: 'readonly',
+        Packages: 'readonly',
+        envision: 'readonly',
+        ...globals.browser,
       },
-    }],
-    'import/no-unresolved': [2, { ignore: ['#', '@sitevision/api/server', '@sitevision/api/common', '@sitevision/api/client', 'svelte/'] }],
-    'import/prefer-default-export': 0,
-    'object-curly-newline': ['error', {
-      ObjectExpression: { minProperties: 8, multiline: true, consistent: true },
-      ObjectPattern: { minProperties: 8, multiline: true, consistent: true },
-      ImportDeclaration: { minProperties: 8, multiline: true, consistent: true },
-      ExportDeclaration: { minProperties: 8, multiline: true, consistent: true },
-    }],
-    'no-console': [1, { allow: ['error'] }],
-    'no-restricted-imports': restrictedImports,
-    'max-len': ['error', 100, 2, {
-      ignoreUrls: true,
-      ignoreComments: true,
-      ignoreRegExpLiterals: true,
-      ignoreStrings: true,
-      ignoreTemplateLiterals: true,
-    }],
-  },
-  settings: {
-    svelte: {
+    },
+    ignores: ['dist', 'node_modules'],
+    plugins: { import: importPlugin },
+    rules: jsRules,
+    settings: {
+      svelte: {
       // Ignore max-len in template and style, still works for script tags.
-      ignoreWarnings: [
-        'max-len',
-      ],
+        ignoreWarnings: [
+          'max-len',
+        ],
+      },
     },
   },
-  overrides: hasSvelte ? [{
-    files: ['*.svelte'],
-    extends: ['plugin:svelte/recommended', 'plugin:svelte/prettier']
-      .concat(hasPrettier ? ['prettier'] : []),
+  ...eslintPluginSvelte.configs['flat/recommended'],
+  ...eslintPluginSvelte.configs['flat/prettier'],
+  {
+    name: 'soleil/svelte',
+    files: ['**/*.svelte'],
     rules: {
-      // Turn off rules not applicable for Svelte
-      'import/no-mutable-exports': 0,
-      'import/no-named-as-default': 0,
-      'import/no-named-as-default-member': 0,
-      'import/named': 0,
-      'import/namespace': 0,
-      'import/default': 0,
-      'import/no-cycle': 0,
-      'import/no-unused-modules': 0,
-      'import/no-deprecated': 0,
-      'no-multiple-empty-lines': 0,
-      'no-label-var': 0,
-      'no-undef-init': 0,
-      'no-return-assign': 0,
-      'operator-linebreak': 'off',
-      'object-curly-newline': 'off',
-      // Security Vulnerability
-      'svelte/no-at-html-tags': 'warn',
-      // Possible Errors
-      'svelte/infinite-reactive-loop': 'error',
-      'svelte/no-dupe-else-if-blocks': 'error',
-      'svelte/no-dupe-on-directives': 'error',
-      'svelte/no-reactive-reassign': 'error',
-      'svelte/no-store-async': 'error',
-      'svelte/require-store-reactive-access': 'error',
-      'svelte/valid-compile': 0,
-      // Best Practices
-      'svelte/no-at-debug-tags': 'warn',
-      'svelte/no-immutable-reactive-statements': 'warn',
-      'svelte/no-reactive-functions': 'warn',
-      'svelte/no-reactive-literals': 'warn',
-      'svelte/no-useless-mustaches': 'warn',
-      'svelte/no-unused-svelte-ignore': 0,
-      // Stylistic
-      'svelte/no-extra-reactive-curlies': 'warn',
-      'svelte/prefer-style-directive': 'warn',
-      'svelte/sort-attributes': 'warn',
-      'svelte/spaced-html-comment': 'warn',
-      // Extension Rules
-      'svelte/no-trailing-spaces': 'error',
-      // Same value as airbnb-base.
-      'max-len': ['error', 100, 2, {
-        ignoreUrls: true,
-        ignoreComments: true,
-        ignoreRegExpLiterals: true,
-        ignoreStrings: true,
-        ignoreTemplateLiterals: true,
-      }],
-      // Do not enforce const because of reactivity for runes in Svelte 5.
-      'prefer-const': 0,
+      ...svelteRules,
+      ...eslintConfigPrettier.rules,
     },
   }, {
-    files: ['svelte.config.js'],
-    rules: {
-      'import/no-extraneous-dependencies': 0,
+    name: 'soleil/svelte.js',
+    files: ['**/*.svelte.js', '**/*.svelte.ts'],
+    languageOptions: {
+      ecmaVersion: 'latest',
+      sourceType: 'module',
+      globals: {
+        $state: 'readonly',
+        $derived: 'readonly',
+        $effect: 'readonly',
+        $inspect: 'readonly',
+      },
     },
-  },
-  {
-    files: ['*.svelte.js, *.svelte.ts'],
     rules: {
       // Do not enforce const because of reactivity for runes in Svelte 5.
       'prefer-const': 0,
     },
-  }] : [],
-};
+  },
+];

package/node-config.js

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

package/package.json

@@ -1,24 +1,31 @@
 {
   "name": "@soleil-se/eslint-config",
-  "version": "5.3.2",
+  "version": "6.0.0",
   "description": "ESLint konfiguration för Sitevision utveckling",
   "author": "Soleil AB",
   "license": "UNLICENSED",
   "private": false,
   "homepage": "https://docs.soleil.se/packages/@soleil-se/eslint-config/",
+  "type": "module",
   "bin": "./bin/index.js",
+  "main": "./index.js",
+  "exports": {
+    ".": "./index.js",
+    "./prettier": "./prettier-config.js",
+    "./script-module": "./script-module-config.js",
+    "./node": "./node-config.js"
+  },
+  "dependencies": {
+    "eslint-config-prettier": "^10.0.1",
+    "eslint-plugin-import": "^2.31.0",
+    "eslint-plugin-svelte": "^2.46.1",
+    "globals": "^15.14.0"
+  },
   "devDependencies": {
-    "eslint": "^8.57.0",
-    "eslint-config-airbnb-base": "^15.0.0",
-    "eslint-plugin-import": "^2.29.1",
-    "eslint-plugin-svelte": "^2.39.0",
-    "eslint-config-prettier": "^9.1.0",
-    "svelte": "^4.2.17"
+    "eslint": "^9.18.0",
+    "svelte": "^5.17.4"
   },
   "peerDependencies": {
-    "eslint": "^8.0.0",
-    "eslint-config-airbnb-base": "^15.0.0",
-    "eslint-plugin-import": "^2.25.0"
-  },
-  "dependencies": {}
+    "eslint": ">= 9"
+  }
 }

package/{svelte.prettier.js → prettier-config.js}

@@ -1,10 +1,10 @@
-module.exports = {
+export default {
   printWidth: 100,
   tabWidth: 2,
   singleQuote: true,
   arrowParens: 'always',
   svelteStrictMode: false,
-  trailingComma: 'es5',
+  trailingComma: 'all',
   svelteSortOrder: 'options-scripts-markup-styles',
   bracketSameLine: false,
 };