@soleil-se/eslint-config 6.0.0 → 6.0.2

package/CHANGELOG.md

@@ -7,6 +7,15 @@ 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.2] - 2025-02-07
+
+* Uppdatera definitioner i package.json.
+
+## [6.0.1] - 2025-02-05
+
+* Läs in Svelte konfiguration dynamiskt.
+* Uppdatera referenser för publicering på npm.
+
 ## [6.0.0] - 2025-02-04
 
 * Uppdatera till ESLint 9 och format på konfigurationsfiler till flat config.

package/README.md

@@ -1,261 +1,5 @@
+# @soleil-se/eslint-config
 
-ESLint konfiguration för Sitevision projekt som bygger på Airbnbs JavaScript styleguide.
+ESLint configuration for Sitevision apps and projects.
 
-**ES2015+**  
-<https://github.com/airbnb/javascript>
-
-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 dependencies och sätt upp konfigurationsfiler:
-
-```sh
-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 --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[Manuellt]
-::::steps
-  :::step[Avinstallera plugins]
-  Avinstallera alla gamla plugins med:
-
-  ```sh
-  npm remove eslint-config-airbnb-base eslint-plugin-import eslint-plugin-svelte
-  ```
-
-  :::
-  :::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]
-
-  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 `eslint.config.js` filer i projektet.  
-<https://eslint.org/docs/user-guide/configuring#using-configuration-files-1>
-
-### Importera config
-
-```js
-// eslint.config.js
-import sitevision from '@soleil-se/eslint-config-sitevision';
-
-export default [
-  ...sitevision,
-];
-
-```
-
-Config för skriptmoduler och Rhino.
-
-```js
-// eslint.config.js
-import script from '@soleil-se/eslint-config-sitevision/script-module';
-
-export default [
-  ...script,
-];
-
-```
-
-## Editors
-
-Enklaste sättet att komma igång med ESLint är att installera det som extension i din editor.
-
-### Visual Studio Code
-
-Installera [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) till Visual Studio Code.
-
-#### End of line
-
-Airbnb använder sig av LF för EOL. Ställs in under [settings](https://code.visualstudio.com/docs/getstarted/settings) i Visual Studio Code.  
-Ändra `\r\n` till `\n`.  
-Sen vill man även ha att en ny rad inkluderas i filerna.  
-
-```json
-"files.eol": "\n",
-"files.insertFinalNewline": true
-```  
-
-#### Indentation
-
-Airbnb indenterar med två spaces.
-
-```json
-"editor.tabSize": 2,
-"editor.insertSpaces": true
-```  
-
-#### Autofix
-
-Man kan ställa in så enklare fel åtgärdas automatiskt under [settings](https://code.visualstudio.com/docs/getstarted/settings) i Visual Studio Code.
-
-```json
-"editor.codeActionsOnSave": {
-  "source.fixAll.eslint": true
-}
-```
-
-#### Max length
-
-Airbnb förespråkar en maxlängd på 100 tecken på en rad.  
-Man kan ställa in så man visar en linje i Visual Studio Code för att visualisera detta. Görs i [settings](https://code.visualstudio.com/docs/getstarted/settings).
-
-```json
-"editor.rulers": [
-  100
-]
-```
-
-#### Svelte  
-
-För att få stöd för Svelte behöver man lägga in följande i [settings](https://code.visualstudio.com/docs/getstarted/settings).
-
-```json
-"eslint.validate": [
-  "javascript",
-  "javascriptreact",
-  "svelte"
-]
-```
-
-#### Konfig i underkatalog
-
-Om man vill köra ESLint i en underkatalog som har en egen installation och konfiguration av `eslint`
-behöver man antingen lägga till katalogens sökväg i inställningen `eslint.workingDirectories` eller ändra till `{ "mode": "auto" }`.  
-Läs mer här: <https://github.com/microsoft/vscode-eslint#settings-options>
-
-Exempelvis om en standalone WebApp har en egen konfiguration och plugins som läses in.
-
-```json
-"eslint.workingDirectories": ["./standalone_apps/MyApp"]
-```
-
-Slår man på `{ "mode": "auto" }` försöker den automatiskt hitta rätt konfiguration.
-
-```json
-"eslint.workingDirectories": [{ "mode": "auto" }]
-```
-
-#### Komplett config
-
-`Ctrl` + `Shift` + `P` och skriv settings och öppna `settings.json`.
-
-```json
-// settings.json
-
-"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
-
-Om man vill köra ESLint i sin terminal.  
-<https://eslint.org/docs/user-guide/command-line-interface>
-
-## Svelte
-
-Installera [Svelte](https://marketplace.visualstudio.com/items?itemName=svelte.svelte-vscode) tillägget till Visual Studio Code.
-
-### Kodformatering
-
-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 `prettier.config.js` i roten av appen eller projektet.
-
-```js
-// 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.
-
-```json
-// settings.json
-{
-  "[svelte]": {
-    "editor.formatOnSave": true,
-    "editor.defaultFormatter": "svelte.svelte-vscode"
-  },
-}
-```
-
-Man kan även stänga av formateringen av skript genom att lägga till kommentaren `<!-- prettier-ignore -->` före skripttaggen om det blir krockar och problem.
-
-```svelte
-// App.svelte
-<!-- prettier-ignore -->
-<script>
-  const foo = 'bar';
-</script>
-
-<p>{foo}</p>
-```
-
-## Git
-
-Om man har problem med linebreaks i git kan man behöva göra följande:
-
-1. Pusha upp / stasha alla förändringar.
-2. Skapa en fil i roten av projektet med namnet `.gitattributes`.
-3. Ange innehåll i filen: `* text=auto eol=lf`.
-4. Kör: `git rm --cached -r .`
-5. Kör: `git reset --hard`.
-6. Pusha upp filen.
-
-<https://stackoverflow.com/questions/9976986/force-lf-eol-in-git-repo-and-working-copy/34810209#34810209>
+[Documentation](https://docs.soleil.se/packages/eslint-config)

package/index.js

@@ -1,11 +1,46 @@
 import globals from 'globals';
 import importPlugin from 'eslint-plugin-import';
-import eslintPluginSvelte from 'eslint-plugin-svelte';
-import eslintConfigPrettier from 'eslint-config-prettier';
 
 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(() => []);
+}
+
 export default [
   {
     name: 'soleil/base',
@@ -19,7 +54,7 @@ export default [
         ...globals.browser,
       },
     },
-    ignores: ['dist', 'node_modules'],
+    ignores: ['dist', 'node_modules', 'prettier.config.js'],
     plugins: { import: importPlugin },
     rules: jsRules,
     settings: {
@@ -31,31 +66,5 @@ export default [
       },
     },
   },
-  ...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,
-    },
-  },
+  ...await loadSvelteConfig(),
 ];

package/package.json

@@ -1,19 +1,25 @@
 {
   "name": "@soleil-se/eslint-config",
-  "version": "6.0.0",
-  "description": "ESLint konfiguration för Sitevision utveckling",
+  "version": "6.0.2",
+  "description": "ESLint configuration for Sitevision apps and projects.",
+  "keywords": [
+    "eslint",
+    "eslint-config",
+    "sitevision"
+  ],
   "author": "Soleil AB",
   "license": "UNLICENSED",
   "private": false,
-  "homepage": "https://docs.soleil.se/packages/@soleil-se/eslint-config/",
+  "homepage": "https://docs.soleil.se/packages/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"
+    "./prettier": "./prettier.js",
+    "./script-module": "./script-module.js",
+    "./node": "./node-config.js",
+    "./rules":"./rules/**/*.js"
   },
   "dependencies": {
     "eslint-config-prettier": "^10.0.1",
@@ -28,4 +34,4 @@
   "peerDependencies": {
     "eslint": ">= 9"
   }
-}
+}

package/setup.js

@@ -11,10 +11,10 @@ const dependencies = {
   eslint: '^9.18.0',
 };
 
-const eslintConfigFileContent = `import sitevision from '${name}';
+const eslintConfigFileContent = `import config from '${name}';
 
 export default [
-  ...sitevision,
+  ...config,
 ];
 `;