@soleil-se/eslint-config 0.3.2 → 1.0.0

package/CHANGELOG.md

@@ -0,0 +1,28 @@
+# Changelog
+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).
+
+## [1.0.0] - 2020-01-13
+### Ändrat
+- Uppdaterat till ESLint 6.
+
+## [0.3.3] - 2019-12-06
+### Ändrat
+- Det får nu vara max 3 attribut per rad i Vue (`vue/max-attributes-per-line`).
+
+## [0.3.2] - 2019-06-03
+### Fixat
+- Lagt till `server_src/api` i server på den globala configen.
+
+## [0.3.1] - 2019-05-20
+### Ändrat
+- Slagit av `global-require` för att kunna skriva `require` innanför IIFE i `src/index.js` i en WebApp.
+
+## [0.3.0] - 2019-05-20
+### Nytt
+- 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`.
+
+
+

package/LICENSE.md

@@ -1 +1 @@
-(c) Copyright 2019 Soleil AB, all rights reserved.
+(c) Copyright 2020 Soleil AB, all rights reserved.

package/README.md

@@ -21,26 +21,27 @@ https://eslint.org/docs/rules/
 
 - [1. Innehållsförteckning](#1-innehållsförteckning)
 - [2. Installera](#2-installera)
-- [3. Config](#3-config)
-  - [3.1 Konfigurationsfiler](#31-konfigurationsfiler)
-  - [3.2. Importera config](#32-importera-config)
-- [3. Editors](#3-editors)
-  - [3.1. VS Code](#31-vs-code)
-    - [3.3.1. End of line](#331-end-of-line)
-    - [3.3.2. Autofix](#332-autofix)
-    - [3.3.3. Max length](#333-max-length)
-    - [3.3.4. Velocity](#334-velocity)
-    - [3.3.5. Vue](#335-vue)
-    - [3.3.6 Global konfig i underkatalog](#336-global-konfig-i-underkatalog)
-    - [3.3.7. Komplett config](#337-komplett-config)
-- [4. CLI](#4-cli)
-- [5. Git](#5-git)
-- [6. Byggmiljö](#6-byggmiljö)
-- [7. Undantag](#7-undantag)
-  - [7.1. Server - ES2015+](#71-server---es2015)
-  - [7.2. Client](#72-client)
-  - [7.3. Server - ES5](#73-server---es5)
-    - [7.3.1. Velocity](#731-velocity)
+- [3. Migrering 0.x.x -> 1.x.x](#3-migrering-0xx---1xx)
+- [4. Config](#4-config)
+  - [4.1. Konfigurationsfiler](#41-konfigurationsfiler)
+  - [4.2. Importera config](#42-importera-config)
+  - [4.3. ESLint ignore](#43-eslint-ignore)
+- [5. Editors](#5-editors)
+  - [5.1. VS Code](#51-vs-code)
+    - [5.1.1. End of line](#511-end-of-line)
+    - [5.1.2. Autofix](#512-autofix)
+    - [5.1.3. Max length](#513-max-length)
+    - [5.1.4. Velocity](#514-velocity)
+    - [5.1.5. Vue](#515-vue)
+    - [5.1.6 Global konfig i underkatalog](#516-global-konfig-i-underkatalog)
+    - [5.1.7. Komplett config](#517-komplett-config)
+- [6. CLI](#6-cli)
+- [7. Git](#7-git)
+- [8. Undantag](#8-undantag)
+  - [8.1. Server - ES2015+](#81-server---es2015)
+  - [8.2. Client](#82-client)
+  - [8.3. Server - ES5](#83-server---es5)
+    - [8.3.1. Velocity](#831-velocity)
 
 <!-- /TOC -->
 
@@ -49,14 +50,17 @@ https://eslint.org/docs/rules/
 Installera konfigurationen och `eslint` i ditt projekt genom att köra:   
 `yarn add eslint @soleil-se/eslint-config-sitevision --dev` 
 
-## 3. Config
+## 3. Migrering 0.x.x -> 1.x.x
+
+Se till att version 6 eller senare av ESLint är intstallerat i projektet.
+
+## 4. Config
 ESLint läster främst från `.eslintrc` filer i projektet.   
 https://eslint.org/docs/user-guide/configuring#using-configuration-files-1   
 
-### 3.1 Konfigurationsfiler
+### 4.1. Konfigurationsfiler
 
-Man behöver skapa upp `.eslintrc` filer i sitt projekt.
-[yeoman-generatorn](https://github.com/soleilit/generator-sitevision) kan göra detta automatiskt med kommandot `yo @soleil-se/sitevision:eslint`  
+Man behöver skapa upp `.eslintrc` filer i sitt projekt. Dessa skapas automatiskt om du generar ditt projekt med [yeoman-generatorn](https://github.com/soleilit/generator-sitevision)
 
 Ett projekt som kör `@soleil-se/sv-gulp-build@^3.0.0` och inläsning global config.
 ```
@@ -164,7 +168,7 @@ Ett projekt som kör `@soleil-se/sv-gulp-build@^2.0.0`
                                   +---- .eslintrc (@soleil-se/eslint-config-sitevision/client)
 ```
 
-### 3.2. Importera config
+### 4.2. Importera config
 
 Global konfig om man kör `@soleil-se/sv-gulp-build@^3.0.0`
 ```json
@@ -195,15 +199,24 @@ I server context:
 }
 ```
 
-## 3. Editors
+### 4.3. ESLint ignore
+Lägg med en `.eslintignore` fil i roten av projektet för att slå av linting av filer i `node_modules`, `dist` och velocityfiler.
+```
+dist
+node_nodules
+**/node_nodules
+**/*.vm
+```
+
+## 5. Editors
 Lättaste sättet att komma igång med ESLint är att installera det som extension i din editor.   
 
-### 3.1. VS Code
+### 5.1. VS Code
 
 Installera [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) till VS Code.   
 Byt package manager till `yarn` i settings för eslint. 
 
-#### 3.3.1. End of line   
+#### 5.1.1. 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 VS Code.    
 Ändra `\r\n` till `\n`.
 ```json
@@ -212,7 +225,7 @@ Airbnb använder sig av LF för EOL. Ställs in under [settings](https://code.vi
 }
 ```  
 
-#### 3.3.2. Autofix
+#### 5.1.2. Autofix
 Man kan ställa in så enklare fel åtgärdas automatiskt under [settings](https://code.visualstudio.com/docs/getstarted/settings) i VS Code.   
 Se till att stänga av VS Codes inbyggda automatiska formatering.
 
@@ -223,7 +236,7 @@ Se till att stänga av VS Codes inbyggda automatiska formatering.
 }
 ```
 
-#### 3.3.3. Max length
+#### 5.1.3. Max length
 Airbnb föresrpåkar en maxlängd på 100 tecken på en rad.
 Man kan ställa så man visar en linje i VS Code för att visualisera detta. Görs i  [settings](https://code.visualstudio.com/docs/getstarted/settings).
 
@@ -250,7 +263,7 @@ Eller om man bara vill visa för JavaScript och Vue:
   }
 }
 ```
-#### 3.3.4. Velocity  
+#### 5.1.4. Velocity  
 För att få stöd för skripttaggar i Velocity behöver man lägga in följande i [settings](https://code.visualstudio.com/docs/getstarted/settings).
 ```json
 "eslint.validate": [
@@ -262,7 +275,7 @@ För att få stöd för skripttaggar i Velocity behöver man lägga in följande
     }
   ]
 ```
-#### 3.3.5. Vue  
+#### 5.1.5. Vue  
 För att få stöd för Vue behöver man lägga in följande i [settings](https://code.visualstudio.com/docs/getstarted/settings).
 ```json
 "eslint.validate": [
@@ -274,7 +287,7 @@ För att få stöd för Vue behöver man lägga in följande i [settings](https:
     }
   ]
 ```
-#### 3.3.6 Global konfig i underkatalog
+#### 5.1.6 Global konfig i underkatalog
 Om man vill köra ESLint i en underkatalog som kör `@soleil-se/sv-gulp-build^3.0.0` behöver man lägga till denna som `workingDirectory` i ESLint tilläggets inställningar.   
 Läs mer här: https://github.com/microsoft/vscode-eslint#settings-options
 
@@ -283,7 +296,7 @@ Exempelvis om det ligger i mappen `@next`:
 "eslint.workingDirectories": [".", { "directory": "./@next", "changeProcessCWD": true }],
 ```
 
-#### 3.3.7. Komplett config  
+#### 5.1.7. Komplett config  
 ```json
 {
   "files.eol": "\n",
@@ -312,11 +325,11 @@ Exempelvis om det ligger i mappen `@next`:
 }
 ```
 
-## 4. CLI
+## 6. CLI
 Om man vill köra ESLint i sin teminal.    
 https://eslint.org/docs/user-guide/command-line-interface
 
-## 5. Git
+## 7. 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`.
@@ -328,22 +341,18 @@ Om man har problem med linebreaks i git kan man behöva göra följande:
 Mer info:   
 https://stackoverflow.com/questions/9976986/force-lf-eol-in-git-repo-and-working-copy/34810209#34810209
 
-## 6. Byggmiljö
-
-Om tid och intresse finns kan vi bygga in stöd för ESLint i [sv_gulp_build](https://github.com/soleilit/sv_gulp_build)
-
-## 7. Undantag
+## 8. Undantag
 
-### 7.1. Server - ES2015+
+### 8.1. Server - ES2015+
 `import/no-unresolved` - För att kunna importera SiteVisions API:er utan fel.   
 `func-names` - Borde inte vara en varning, Airbnb tillåter anonyma funktioner.   
 
-### 7.2. Client
+### 8.2. Client
 `no-param-reassign` - Undantag för `state` i Vuex [mutations](https://vuex.vuejs.org/en/mutations.html).    
 `vue/max-attributes-per-line` - Undantag för `allowFirstLine`, blev svårläst när det enforcas på element med korta namn (`<p> <a>` osv...)   
 `vue/component-name-in-template-casing` - Enforca PascalCase i Vue komponenter.   
 
-### 7.3. Server - ES5
+### 8.3. Server - ES5
 `no-unused-vars` - Se till att visa vilka variabler som används i Velocity med `/* exported var1 var2 */` i toppen av filen.   
 `no-undef` - Om en variabel är global, definera det med `/* global var1 var2 */` i toppen av filen.   
 `vars-on-top` - Avslaget, blir helt crazy annars - Linh.    
@@ -352,5 +361,5 @@ Om tid och intresse finns kan vi bygga in stöd för ESLint i [sv_gulp_build](ht
 `import/no-unresolved` - För att kunna importera SiteVisions API:er utan fel.   
 `global-require` - För att kunna skriva `require` innanför IIFE i `src/index.js` i en Webapp.   
 
-#### 7.3.1. Velocity 
+#### 8.3.1. Velocity 
 `no-template-curly-in-string` - Avslaget, Velocity variabler ser ut som template variabler i ES6.

package/client.js

@@ -11,7 +11,7 @@ module.exports = {
       ignorePropertyModificationsFor: ['state'],
     }],
     'vue/max-attributes-per-line': ['error', {
-      singleline: 1,
+      singleline: 3,
       multiline: {
         max: 1,
         allowFirstLine: true,

package/global.js

@@ -1,114 +1,114 @@
-module.exports = {
-  extends: ['airbnb-base', 'plugin:vue/recommended'],
-  plugins: ['vue', 'html'],
-  overrides: [{
-    /*
-     * Configuration for server code.
-     */
-    files: [
-      'server_src/api/**/*.js',
-      'server_src/scripts/**/*.js',
-      'server_src/restapps/**/*.js',
-      'server_src/webapps/api/**/*.js',
-      'server_src/webapps/**/app_src/server/**/*.js',
-      'server_src/webapps/**/app_src/config/index.js',
-      'server_src/webapps/**/app_src/config/server/**/*.js',
-    ],
-    env: {
-      amd: true,
-      nashorn: true,
-      node: false,
-      commonjs: false,
-    },
-    globals: {
-      scriptVariables: false,
-      Packages: false,
-      request: false,
-      print: false,
-      out: false,
-    },
-    rules: {
-      'import/no-unresolved': 0,
-      'func-names': 0,
-    },
-    settings: {
-      'import/resolver': {
-        alias: {
-          map: [
-            ['#api', './server_src/api'],
-            ['#api/scripts', './server_src/scripts/api'],
-            ['#api/webapps', './server_src/webapps/api'],
-            ['#api/restapps', './server_src/restapps/api'],
-          ],
-          extensions: ['.js', '.json'],
-        },
-      },
-    },
-  },
-  {
-    /*
-     * Configuration for JavaScript in Velocity templates.
-     */
-    files: ['server_src/scripts/**/*.vm'],
-    env: {
-      browser: true,
-      jquery: true,
-    },
-    globals: {
-      $svjq: false,
-      Soleil: false,
-    },
-    rules: {
-      'vars-on-top': 0,
-      'func-names': 0,
-    },
-  },
-  {
-    /*
-     * Configuration for client code.
-     */
-    files: [
-      '*.vue',
-      'client_src/js/**/*.js',
-      'server_src/webapps/**/app_src/client/**/*.js',
-      'server_src/webapps/**/app_src/config/config.js',
-      'server_src/webapps/**/app_src/config/client/**/*.js',
-    ],
-    env: {
-      browser: true,
-      jquery: true,
-    },
-    rules: {
-      'no-param-reassign': ['error', {
-        props: true,
-        ignorePropertyModificationsFor: ['state'],
-      }],
-      'vue/max-attributes-per-line': ['error', {
-        singleline: 1,
-        multiline: {
-          max: 1,
-          allowFirstLine: true,
-        },
-      }],
-      'vue/component-name-in-template-casing': ['error', 'PascalCase', {
-        registeredComponentsOnly: true,
-        ignores: [],
-      }],
-    },
-    settings: {
-      'import/resolver': {
-        alias: {
-          map: [
-            ['#js', './client_src/js'],
-            ['#api', './client_src/js/api'],
-            ['#vue', './client_src/js/vue'],
-          ],
-          extensions: ['.js', '.json', '.vue'],
-        },
-      },
-    },
-  }],
-  settings: {
-    'html/html-extensions': ['.html', '.vm'],
-  },
-};
+module.exports = {
+  extends: ['airbnb-base', 'plugin:vue/recommended'],
+  plugins: ['vue', 'html'],
+  overrides: [{
+    /*
+     * Configuration for server code.
+     */
+    files: [
+      'server_src/api/**/*.js',
+      'server_src/scripts/**/*.js',
+      'server_src/restapps/**/*.js',
+      'server_src/webapps/api/**/*.js',
+      'server_src/webapps/**/app_src/server/**/*.js',
+      'server_src/webapps/**/app_src/config/index.js',
+      'server_src/webapps/**/app_src/config/server/**/*.js',
+    ],
+    env: {
+      amd: true,
+      nashorn: true,
+      node: false,
+      commonjs: false,
+    },
+    globals: {
+      scriptVariables: false,
+      Packages: false,
+      request: false,
+      print: false,
+      out: false,
+    },
+    rules: {
+      'import/no-unresolved': 0,
+      'func-names': 0,
+    },
+    settings: {
+      'import/resolver': {
+        alias: {
+          map: [
+            ['#api', './server_src/api'],
+            ['#api/scripts', './server_src/scripts/api'],
+            ['#api/webapps', './server_src/webapps/api'],
+            ['#api/restapps', './server_src/restapps/api'],
+          ],
+          extensions: ['.js', '.json'],
+        },
+      },
+    },
+  },
+  {
+    /*
+     * Configuration for JavaScript in Velocity templates.
+     */
+    files: ['server_src/scripts/**/*.vm'],
+    env: {
+      browser: true,
+      jquery: true,
+    },
+    globals: {
+      $svjq: false,
+      Soleil: false,
+    },
+    rules: {
+      'vars-on-top': 0,
+      'func-names': 0,
+    },
+  },
+  {
+    /*
+     * Configuration for client code.
+     */
+    files: [
+      '*.vue',
+      'client_src/js/**/*.js',
+      'server_src/webapps/**/app_src/client/**/*.js',
+      'server_src/webapps/**/app_src/config/config.js',
+      'server_src/webapps/**/app_src/config/client/**/*.js',
+    ],
+    env: {
+      browser: true,
+      jquery: true,
+    },
+    rules: {
+      'no-param-reassign': ['error', {
+        props: true,
+        ignorePropertyModificationsFor: ['state'],
+      }],
+      'vue/max-attributes-per-line': ['error', {
+        singleline: 3,
+        multiline: {
+          max: 1,
+          allowFirstLine: true,
+        },
+      }],
+      'vue/component-name-in-template-casing': ['error', 'PascalCase', {
+        registeredComponentsOnly: true,
+        ignores: [],
+      }],
+    },
+    settings: {
+      'import/resolver': {
+        alias: {
+          map: [
+            ['#js', './client_src/js'],
+            ['#api', './client_src/js/api'],
+            ['#vue', './client_src/js/vue'],
+          ],
+          extensions: ['.js', '.json', '.vue'],
+        },
+      },
+    },
+  }],
+  settings: {
+    'html/html-extensions': ['.html', '.vm'],
+  },
+};

package/package.json

@@ -1,21 +1,21 @@
 {
   "name": "@soleil-se/eslint-config",
-  "version": "0.3.2",
+  "version": "1.0.0",
   "description": "Settings for ESLint in a SiteVision project",
   "author": "Soleil AB",
   "license": "UNLICENSED",
   "private": false,
   "homepage": "https://github.com/soleilit/eslint-config#readme",
   "dependencies": {
-    "eslint": "^5.14.1",
-    "eslint-config-airbnb-base": "^13.1.0",
+    "eslint": "^6.8.0",
+    "eslint-config-airbnb-base": "^14.0.0",
     "eslint-import-resolver-alias": "^1.1.2",
-    "eslint-plugin-html": "^5.0.3",
-    "eslint-plugin-import": "^2.16.0",
-    "eslint-plugin-vue": "^5.2.2"
+    "eslint-plugin-html": "^6.0.0",
+    "eslint-plugin-import": "^2.20.0",
+    "eslint-plugin-vue": "^6.1.2"
   },
   "devDependencies": {
-    "fs-extra": "^7.0.1"
+    "fs-extra": "^8.1.0"
   },
   "scripts": {
     "publish-scope": "node ./publish"

package/server-es6.js

@@ -1,40 +1,40 @@
-module.exports = {
-  extends: 'airbnb-base',
-  env: {
-    amd: true,
-    nashorn: true,
-    node: false,
-    commonjs: false,
-  },
-  globals: {
-    scriptVariables: false,
-    Packages: false,
-    request: false,
-    svimport: false,
-    solimport: false,
-    print: false,
-    out: false,
-    Api: true,
-  },
-  rules: {
-    'import/no-unresolved': 0,
-    'vars-on-top': 0,
-    'no-param-reassign': ['error', {
-      props: true,
-      ignorePropertyModificationsFor: ['data'],
-    }],
-  },
-  settings: {
-    'import/resolver': {
-      alias: {
-        map: [
-          ['#api', './server_src/api'],
-          ['#api/scripts', './server_src/scripts/api'],
-          ['#api/webapps', './server_src/webapps/api'],
-          ['#api/restapps', './server_src/restapps/api'],
-        ],
-        extensions: ['.js', '.json', '.vue'],
-      },
-    },
-  },
-};
+module.exports = {
+  extends: 'airbnb-base',
+  env: {
+    amd: true,
+    nashorn: true,
+    node: false,
+    commonjs: false,
+  },
+  globals: {
+    scriptVariables: false,
+    Packages: false,
+    request: false,
+    svimport: false,
+    solimport: false,
+    print: false,
+    out: false,
+    Api: true,
+  },
+  rules: {
+    'import/no-unresolved': 0,
+    'vars-on-top': 0,
+    'no-param-reassign': ['error', {
+      props: true,
+      ignorePropertyModificationsFor: ['data'],
+    }],
+  },
+  settings: {
+    'import/resolver': {
+      alias: {
+        map: [
+          ['#api', './server_src/api'],
+          ['#api/scripts', './server_src/scripts/api'],
+          ['#api/webapps', './server_src/webapps/api'],
+          ['#api/restapps', './server_src/restapps/api'],
+        ],
+        extensions: ['.js', '.json', '.vue'],
+      },
+    },
+  },
+};

package/vue.js

@@ -10,7 +10,7 @@ module.exports = {
       ignorePropertyModificationsFor: ['state'],
     }],
     'vue/max-attributes-per-line': ['error', {
-      singleline: 1,
+      singleline: 3,
       multiline: {
         max: 1,
         allowFirstLine: true,