@kouts/eslint-config 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Giannis Koutsaftakis
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,69 @@
+# @kouts/eslint-config
+
+> Custom ESLint and Prettier config with sensible defaults
+
+## Installation
+
+```bash
+npm i -D @kouts/eslint-config
+```
+
+## Usage
+
+There are 4 ESLint config presets that you can use:
+
+- `plugin:@kouts/eslint-config/javascript` for JavaScript / TypeScript projects
+- `plugin:@kouts/eslint-config/vue2` for Vue.js 2 projects
+- `plugin:@kouts/eslint-config/vue3` for Vue.js 3 projects
+- `plugin:@kouts/eslint-config/vue3-typescript` for Vue.js 3 / TypeScript projects
+
+Add the desired config preset into your `.eslintrc.js` file:
+
+```javascript
+module.exports = {
+  extends: ['plugin:@kouts/eslint-config/vue2']
+}
+```
+
+Add a `prettier.config.js` file with contents:
+
+```javascript
+module.exports = require('@kouts/eslint-config/prettier.config.js')
+```
+
+You can add ESLint commands to `.package-json`
+
+```json
+{
+  "lint": "eslint \"**/*.{vue,ts,js}\"",
+  "lint-fix": "eslint --fix \"**/*.{vue,ts,js}\""
+}
+```
+
+and VS Code settings for autofix on save
+
+`.vscode/settings.json`
+
+```json
+{
+  "editor.formatOnSave": true,
+  "editor.codeActionsOnSave": {
+    "source.fixAll.eslint": true
+  }
+}
+```
+
+## Features
+
+- Based on [eslint-config-standard](https://github.com/standard/eslint-config-standard)
+- [Prettier](https://prettier.io) for code formatting
+- Plugins
+  - [eslint-plugin-html](https://github.com/BenoitZugmeyer/eslint-plugin-html) for linting inline scripts contained in HTML files
+  - [eslint-plugin-vue](https://github.com/vuejs/eslint-plugin-vue/) for linting Vue.js files
+  - [eslint-config-prettier](https://github.com/prettier/eslint-config-prettier) for disabling all rules that conflict with Prettier
+  - [eslint-plugin-prettier](https://github.com/prettier/eslint-plugin-prettier) for using prettier as a code formatter for `eslint --fix`
+  - [sort-imports-es6-autofix](https://github.com/marudor/eslint-plugin-sort-imports-es6-autofix) for auto-fixing imports order
+
+## License
+
+[MIT](http://opensource.org/licenses/MIT)

package/base.js

@@ -0,0 +1,64 @@
+const configVars = require('./configVars.js')
+
+module.exports = {
+  root: true,
+  env: {
+    node: true,
+    browser: true
+  },
+  extends: ['standard'],
+  plugins: ['html', 'sort-imports-es6-autofix'],
+  ignorePatterns: ['**/node_modules/**', '{tmp,temp}/**', '**/*.min.js', 'vendor/**', 'dist/**', 'public/**'],
+  overrides: [
+    {
+      files: ['*.json'],
+      rules: {
+        quotes: [2, 'double']
+      }
+    },
+    {
+      files: ['**/*.spec.{j,t}s?(x)'],
+      env: {
+        jest: true
+      }
+    }
+  ],
+  rules: {
+    // Sort imports
+    'sort-imports-es6-autofix/sort-imports-es6': [
+      'error',
+      {
+        ignoreCase: false,
+        ignoreMemberSort: false,
+        memberSyntaxSortOrder: ['all', 'single', 'multiple', 'none']
+      }
+    ],
+
+    // Enforce a new line after the imports section
+    'import/newline-after-import': ['error', { count: 1 }],
+
+    // Enforce blank lines between the given 2 kinds of statements
+    'padding-line-between-statements': [
+      'error',
+      { blankLine: 'always', prev: '*', next: 'return' },
+      { blankLine: 'always', prev: ['const', 'let', 'var'], next: '*' },
+      { blankLine: 'any', prev: ['const', 'let', 'var'], next: ['const', 'let', 'var'] },
+      { blankLine: 'always', prev: 'directive', next: '*' },
+      { blankLine: 'any', prev: 'directive', next: 'directive' }
+    ],
+
+    // Console and debugger settings depending whether we're on production or not
+    'no-console': process.env.NODE_ENV === 'production' ? 'warn' : 'off',
+    'no-debugger': process.env.NODE_ENV === 'production' ? 'warn' : 'off',
+
+    // Print width setting
+    'max-len': [
+      'error',
+      {
+        code: configVars.printWidth,
+        ignoreComments: true,
+        ignoreUrls: true
+      }
+    ]
+  }
+}

package/configVars.js

@@ -0,0 +1,3 @@
+module.exports = {
+  printWidth: 128
+}

package/index.js

@@ -0,0 +1,18 @@
+const base = require('./base')
+const javascript = require('./javascript')
+const vue = require('./vue')
+const vue2 = require('./vue2')
+const vue3 = require('./vue3')
+const vue3Typescript = require('./vue3')
+
+
+module.exports = {
+  configs: {
+    base,
+    javascript,
+    vue,
+    vue2,
+    vue3,
+    'vue3-typescript': vue3Typescript
+  }
+}

package/javascript.js

@@ -0,0 +1,5 @@
+const base = require.resolve('./base.js')
+
+module.exports = {
+  extends: [base, 'plugin:prettier/recommended']
+}

package/package.json

@@ -0,0 +1,64 @@
+{
+  "name": "@kouts/eslint-config",
+  "version": "0.0.1",
+  "description": "Kouts's ESLint config",
+  "main": "index.js",
+  "files": [
+    "index.js",
+    "base.js",
+    "javascript.js",
+    "vue.js",
+    "vue2.js",
+    "vue3.js",
+    "vue3-typescript.js",
+    "prettier.config.js",
+    "configVars.js"
+  ],
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "lint": "eslint \"**/*.js\"",
+    "lint-fix": "eslint --fix \"**/*.js\"",
+    "lint-debug": "eslint -c vue3-typescript.js --print-config \"**/*.js\" > ./eslint-debug.json"
+  },
+  "keywords": [
+    "lint",
+    "eslint",
+    "eslintplugin",
+    "eslintconfig",
+    "standard",
+    "vue",
+    "vue3"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/kouts/eslint-config.git"
+  },
+  "author": "kouts",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/kouts/eslint-config/issues"
+  },
+  "homepage": "https://github.com/kouts/eslint-config#readme",
+  "dependencies": {
+    "@typescript-eslint/parser": "^5.31.0",
+    "@vue/eslint-config-typescript": "^11.0.0",
+    "eslint-config-prettier": "^8.5.0",
+    "eslint-config-standard": "^17.0.0",
+    "eslint-plugin-html": "^7.1.0",
+    "eslint-plugin-import": "^2.26.0",
+    "eslint-plugin-n": "^15.2.4",
+    "eslint-plugin-prettier": "^4.2.1",
+    "eslint-plugin-promise": "^6.0.0",
+    "eslint-plugin-sort-imports-es6-autofix": "^0.6.0",
+    "eslint-plugin-vue": "^9.3.0",
+    "prettier": "^2.7.1",
+    "typescript": "^4.6.3",
+    "vue-eslint-parser": "^9.0.3"
+  },
+  "devDependencies": {
+    "eslint": "^8.23.0"
+  },
+  "peerDependencies": {
+    "eslint": "^8.20.0"
+  }
+}

package/prettier.config.js

@@ -0,0 +1,9 @@
+const configVars = require('./configVars.js')
+
+module.exports = {
+  trailingComma: 'none',
+  printWidth: configVars.printWidth,
+  tabWidth: 2,
+  semi: false,
+  singleQuote: true
+}

package/vue.js

@@ -0,0 +1,8 @@
+module.exports = {
+  rules: {
+    // Overrides for vue/(vue3-)recommended preset
+    'vue/max-attributes-per-line': 'off',
+    'vue/html-self-closing': 'off',
+    'vue/singleline-html-element-content-newline': 'off'
+  }
+}

package/vue2.js

@@ -0,0 +1,6 @@
+const javascript = require.resolve('./javascript.js')
+const vue = require.resolve('./vue.js')
+
+module.exports = {
+  extends: ['plugin:vue/recommended', vue, javascript]
+}

package/vue3-typescript.js

@@ -0,0 +1,27 @@
+const javascript = require.resolve('./javascript.js')
+const vue = require.resolve('./vue.js')
+
+module.exports = {
+  env: {
+    'vue/setup-compiler-macros': true
+  },
+  extends: ['plugin:vue/vue3-recommended', '@vue/eslint-config-typescript/recommended', vue, javascript],
+  overrides: [
+    {
+      files: ['*.vue'],
+      parser: 'vue-eslint-parser',
+      parserOptions: {
+        parser: '@typescript-eslint/parser'
+      }
+    }
+  ],
+  rules: {
+    /* Typescript */
+
+    // Disable 'no-unused-vars' as TypeScript has its own version
+    'no-unused-vars': 'off',
+
+    // Prefer T[] instead of Array<T>
+    '@typescript-eslint/array-type': ['error', { default: 'array' }]
+  }
+}

package/vue3.js

@@ -0,0 +1,9 @@
+const javascript = require.resolve('./javascript.js')
+const vue = require.resolve('./vue.js')
+
+module.exports = {
+  env: {
+    'vue/setup-compiler-macros': true
+  },
+  extends: ['plugin:vue/vue3-recommended', vue, javascript]
+}