@soleil-se/eslint-config 0.1.4

package/LICENSE.md

@@ -0,0 +1 @@
+(c) Copyright 2018 Soleil IT Sweden AB, all rights reserved.

package/README.md

@@ -0,0 +1,251 @@
+# eslint-config-sitevision
+
+ESLint configs anpassade för SiteVision som bygger på Airbnbs Javascript styleguide.   
+
+**Klient**   
+https://github.com/airbnb/javascript   
+
+**Server**   
+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/
+
+## 1. Innehållsförteckning
+
+<!-- TOC depthFrom:2 updateOnSave:false -->
+
+- [1. Innehållsförteckning](#1-innehållsförteckning)
+- [2. Installera](#2-installera)
+- [3. Editors](#3-editors)
+  - [3.1. Skapa config](#31-skapa-config)
+  - [3.2. Importera config](#32-importera-config)
+  - [3.3. VS Code](#33-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. Komplett config](#336-komplett-config)
+- [4. Git](#4-git)
+- [5. CLI](#5-cli)
+- [6. Byggmiljö](#6-byggmiljö)
+- [7. Undantag för SiteVision](#7-undantag-för-sitevision)
+  - [7.1. Server](#71-server)
+- [8. Undantag från Airbnb](#8-undantag-från-airbnb)
+  - [8.1. Vue](#81-vue)
+  - [8.2. Server](#82-server)
+
+<!-- /TOC -->
+
+## 2. Installera
+
+Installera i ditt projekt genom att köra:   
+`yarn add github:soleilit/eslint-config-sitevision --dev`   
+eller   
+`npm i --save-dev github:soleilit/eslint-config-sitevision`
+
+## 3. Editors
+Lättaste sättet att komma igång med ESLint är att installera det som extension i din editor.   
+
+### 3.1. Skapa config
+Man behöver skapa upp tre `.eslintrc` filer i sitt projekt.
+[yeoman-generatorn](https://github.com/soleilit/sv_yeoman_generator) kan göra detta automatiskt med kommandot `yo soleil:eslint`
+```
+<sitevision_projekt>
+      |
+      +---- client_src
+      |      |
+      |      +---- js
+      |      |      |
+      |      |      +---- .eslintrc
+      |      |
+      |      +---- vue
+      |             |
+      |             +---- .eslintrc
+      |
+      |
+      +---- server_src
+             |
+             +---- .eslintrc
+```
+
+### 3.2. Importera config
+
+`client_src/js/.eslintrc`
+```json
+{
+  "extends": "sitevision/client"
+}
+```
+`client_src/vue/.eslintrc`
+```json
+{
+  "extends": "sitevision/vue"
+}
+```
+`server_src/.eslintrc`
+```json
+{
+  "extends": "sitevision/server"
+}
+```
+
+### 3.3. VS Code
+
+Installera [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
+ till VS Code. Sedan ska det bara vara att tuta och köra.  
+
+#### 3.3.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
+{
+  "files.eol": "\n"
+}
+```  
+
+#### 3.3.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.
+
+```json
+{
+ "eslint.autoFixOnSave": true,
+ "editor.formatOnSave": false
+}
+```
+
+#### 3.3.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).
+
+```json
+{
+  "editor.rulers": [
+      100
+    ]
+}
+```
+
+Eller om man bara vill visa för JavaScript och Vue:
+```json
+{
+  "[javascript]": {
+    "editor.rulers": [
+      100
+    ]
+  },
+  "[vue]": {
+    "editor.rulers": [
+      100
+    ]
+  }
+}
+```
+#### 3.3.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": [
+    "javascript",
+    "javascriptreact",
+   {
+      "language": "velocity",
+      "autoFix": true
+    }
+  ]
+```
+#### 3.3.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": [
+    "javascript",
+    "javascriptreact",
+    {
+      "language": "vue",
+      "autoFix": true
+    }
+  ]
+```
+#### 3.3.6. Komplett config  
+```json
+{
+  "files.eol": "\n",
+  "files.insertFinalNewline": true,
+  "editor.rulers": [
+      100
+    ],
+  "eslint.validate": [
+    "javascript",
+    "javascriptreact",
+    {
+      "language": "vue",
+      "autoFix": true
+    },
+    {
+      "language": "html",
+      "autoFix": true
+    },
+    {
+      "language": "velocity",
+      "autoFix": true
+    }
+  ],
+  "eslint.autoFixOnSave": true,
+  "editor.formatOnSave": false
+}
+```
+
+## 4. 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.
+
+Mer info:   
+https://stackoverflow.com/questions/9976986/force-lf-eol-in-git-repo-and-working-copy/34810209#34810209
+
+## 5. CLI
+Om man vill köra ESLint i sin teminal.    
+https://eslint.org/docs/user-guide/command-line-interface
+
+## 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 för SiteVision
+
+### 7.1. Server
+`no-unused-vars` - Se till att visa vilka variabler som används 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.
+
+## 8. Undantag från Airbnb
+
+### 8.1. Vue
+
+`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...)   
+
+### 8.2. Server
+
+#### 8.2.1 JavaScript
+ 
+`vars-on-top` - Avslaget, blir helt crazy annars - Linh.   
+`no-param-reassign` - Undantag för `data` i våra dataCreators, vi använder oss av accumilator pattern.
+`import/no-unresolved` - Kan såklart inte resolva SiteVision dependencies och utils.
+
+#### 8.2.1 Velocity
+`vars-on-top` - Avslaget, blir helt crazy annars - Linh.    
+`no-template-curly-in-string` - Avslaget, Velocity variabler ser ut som template variabler i ES6.
+
+**Globala variabler**   
+`scriptVariables`   
+`Packages`  
+`request`   
+`svimport`   
+`Api`   
+`print`   
+`out`

package/client.js

@@ -0,0 +1,8 @@
+module.exports = {
+  "extends": "airbnb-base",
+  "env": {
+    "browser": true,
+    "jquery": true
+  },
+  "rules": {}
+}

package/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "@soleil-se/eslint-config",
+  "version": "0.1.4",
+  "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.9.0",
+    "eslint-config-airbnb-base": "^13.1.0",
+    "eslint-plugin-html": "^5.0.0",
+    "eslint-plugin-import": "^2.14.0",
+    "eslint-plugin-vue": "^5.0.0"
+  },
+  "devDependencies": {}
+}

package/server-es6.js

@@ -0,0 +1,29 @@
+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,
+    "solimport": true
+  },
+  "rules": {
+    //"no-unused-vars": 0, //https://eslint.org/docs/rules/no-unused-vars
+    "import/no-unresolved": 0,
+    "vars-on-top": 0,
+    "no-param-reassign": ["error", {
+      "props": true,
+      "ignorePropertyModificationsFor": ["data"]
+    }]
+  }
+}

package/server.js

@@ -0,0 +1,50 @@
+module.exports = {
+  "extends": "airbnb-base/legacy",
+  "plugins": ["html"],
+  "settings": {
+    "html/html-extensions": [".html", ".vm"], // consider .html and .wm files as HTML
+  },
+  "overrides": [{
+      "files": ['*.js'],
+      "env": {
+        "amd": true,
+        "nashorn": true,
+        "node": false,
+        "commonjs": false
+      },
+      "globals": {
+        "scriptVariables": false,
+        "Packages": false,
+        "request": false,
+        "svimport": false,
+        "print": false,
+        "out": false,
+        "Api": true,
+        "solimport": true
+      },
+      "rules": {
+        //"no-unused-vars": 0, //https://eslint.org/docs/rules/no-unused-vars
+        "vars-on-top": 0,
+        "no-param-reassign": ["error", {
+          "props": true,
+          "ignorePropertyModificationsFor": ["data"]
+        }]
+      }
+    },
+    {
+      "files": ['*.vm', '*.html'],
+      "env": {
+        "browser": true,
+        "jquery": true
+      },
+      "globals": {
+        "$svjq": false,
+        "Soleil": false
+      },
+      "rules": {
+        "vars-on-top": 0,
+        "no-template-curly-in-string": 0
+      }
+    }
+  ]
+}

package/vue.js

@@ -0,0 +1,20 @@
+module.exports = {
+  "extends": ["airbnb-base", "plugin:vue/recommended"],
+  "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
+      }
+    }]
+  }
+}