@studio/eslint-config 1.1.1 → 2.3.0

package/CHANGES.md

@@ -1,25 +1,66 @@
 # Changes
 
+## 2.3.0
+
+- 🍏 [`bed55ec`](https://github.com/javascript-studio/eslint-config/commit/bed55ec462bab33db91990721e69201b00c598b6)
+  Allow eslint-plugin-mocha ^10
+- 🍏 [`361aeee`](https://github.com/javascript-studio/eslint-config/commit/361aeee06d6f2bb3e86fad0c5477a30d21ddb21c)
+  Support eslint 8
+- 🛡 [`28d99ca`](https://github.com/javascript-studio/eslint-config/commit/28d99ca887617c33f82e19370a5904a24f086608)
+  npm audit
+- ✨ [`41e0198`](https://github.com/javascript-studio/eslint-config/commit/41e01980b22034569bac376808a20ba604f4f90b)
+  Add test script to lint the linter config
+
+_Released by [Maximilian Antoni](https://github.com/mantoni) on 2022-01-05._
+
+## 2.2.0
+
+- 🍏 [`c4a37e7`](https://github.com/javascript-studio/eslint-config/commit/c4a37e7ed4743d91de1f0fb7386917fa66351b82)
+  Declare `**/*.integration.js` pattern as mocha env
+
+_Released by [Maximilian Antoni](https://github.com/mantoni) on 2021-07-27._
+
+## 2.1.0
+
+- 🍏 [`9b034bf`](https://github.com/javascript-studio/eslint-config/commit/9b034bf159367e054c4b44e9987e9fd88b961deb)
+  Add `eslint-plugin-mocha` v9 compatibility
+- 🛡 [`ea0686c`](https://github.com/javascript-studio/eslint-config/commit/ea0686c7948411fb7a14343232eaf886a70b5987)
+  Bump hosted-git-info from 3.0.4 to 3.0.8 (dependabot[bot])
+- 📚 [`c1ed531`](https://github.com/javascript-studio/eslint-config/commit/c1ed531d7b0fa6e309a7f1939ce9ad5ecb3306d5)
+  Rename project to remove studio prefix
+- 📚 [`630b341`](https://github.com/javascript-studio/eslint-config/commit/630b341564b9d16618a6ee55eadea69d251b661b)
+  Update install instructions
+- ✨ [`2b6b0b4`](https://github.com/javascript-studio/eslint-config/commit/2b6b0b4b819b11476f0fc6deb1c8b30a6bb422f1)
+  Update Studio Changes
+- ✨ [`2d3a2b8`](https://github.com/javascript-studio/eslint-config/commit/2d3a2b80c61fd4215cc59931864b7a8e0f789d89)
+  Use npm 7
+- ✨ [`854bcd2`](https://github.com/javascript-studio/eslint-config/commit/854bcd21cad1c25ecea20e95a11bfafaf016e2e9)
+  Add .gitignore
+
+_Released by [Maximilian Antoni](https://github.com/mantoni) on 2021-07-08._
+
+## 2.0.0
+
+- [`087bb93`](https://github.com/javascript-studio/eslint-config/commit/087bb9337644a279f6a34d1bb5e513b4fa4dc148)
+  Rewrite config and dependencies (#7)
+    >
+    > - Add node plugin and use recomended settings
+    > - Drop prettier integration with eslint
+    > - Rework mocha rules
+    > - Review all rules
+    > - Remove formatting related rules to avoid conflicts with prettier
+
+_Released by [Maximilian Antoni](https://github.com/mantoni) on 2020-11-22._
+
 ## 1.1.1
 
-- Fix syntax error (Morgan Roderick)
+- [`2ec0549`](https://github.com/javascript-studio/eslint-config/commit/2ec0549a3bca5b5d89e9089b440949bcab23af87)
+  Fix syntax errors (Morgan Roderick)
 
 ## 1.1.0
 
-- Allow early use of functions (Morgan Roderick)
-    >
-    > Function declarations are hoisted, so early use of functions (before
-    > they're declared) is safe.
-    >
-    > This allows organisation of code to read like a newspaper article, i.e.
-    > from higher to lower abstraction level, which is recommended by people
-    > like Robert C. Martin (Clean Code) and Kent C. Dodds.
-    >
-    > See:
-    >   * https://eslint.org/docs/rules/no-use-before-define#options
-    >   * https://books.google.es/books?id=_i6bDeoCQzsC&pg=PA136&lpg=PA136&dq=code+read+like+a+newspaper+article&source=bl&ots=epaNGi4a19&sig=ACfU3U1J0a7UzLLelJBJVgfENXgKxfNalw&hl=en&sa=X&ved=2ahUKEwjTkOfsv5LoAhWiyoUKHdlgAeEQ6AEwAnoECAoQAQ#v=onepage&q=code%20read%20like%20a%20newspaper%20article&f=false
-    >   * https://kentcdodds.com/blog/newspaper-code-structure
-    >
+- [`3d0a3bc`](https://github.com/javascript-studio/eslint-config/commit/3d0a3bcdb80bd1fb5652a62cbcd39eea6d801a2c)
+  Allow early use of functions (Morgan Roderick)
 
 ## 1.0.2
 

package/README.md

@@ -5,7 +5,7 @@ The [sharable eslint config][docs] for all JavaScript Studio projects.
 ## Install
 
 ```bash
-$ npm install @studio/eslint-config eslint --save-dev
+$ npm install @studio/eslint-config eslint eslint-plugin-mocha eslint-plugin-node --save-dev
 ```
 
 ## Usage
@@ -16,10 +16,6 @@ Make sure this is in your `package.json`:
 {
   "eslintConfig": {
     "extends": "@studio"
-  },
-  "devDependencies": {
-    "@studio/eslint-config": "^1.0.0",
-    "eslint": "^3.3.0"
   }
 }
 ```

package/index.js

@@ -14,101 +14,143 @@ module.exports = {
     es6: true
   },
 
-  extends: 'eslint:recommended',
+  plugins: [
+    'mocha'
+  ],
 
+  extends: [
+    'eslint:recommended',
+    'plugin:node/recommended'
+  ],
+
+  overrides: [{
+    files: [
+      '**/*.test.js',
+      '**/*-test.js',
+      '**/*.integration.js'
+    ],
+    env: {
+      mocha: true
+    }
+  }],
+
+  // Formatting should be handled by prettier.
   rules: {
-    'arrow-spacing': 2,
-    'keyword-spacing': 2,
-    'constructor-super': 2,
-    'no-class-assign': 2,
-    'no-const-assign': 2,
-    'no-dupe-class-members': 2,
-    'no-this-before-super': 2,
-    'no-var': 2,
-    'object-shorthand': 2,
-    'prefer-arrow-callback': 1,
-    'prefer-const': 1,
-    'prefer-spread': 2,
-    'prefer-template': 2,
+    // https://github.com/lo1tuma/eslint-plugin-mocha
+    'mocha/no-async-describe': 2,
+    'mocha/no-exclusive-tests': 2,
+    'mocha/no-identical-title': 2,
+    'mocha/no-return-and-callback': 2,
+    'mocha/prefer-arrow-callback': 2,
+
+    // https://github.com/mysticatea/eslint-plugin-node
+    'node/handle-callback-err': 2,
+    'node/no-callback-literal': 2,
+    'node/no-new-require': 2,
+    'node/global-require': 2,
+    'node/no-mixed-requires': 2,
+    'node/no-sync': 2,
+    'node/prefer-global/buffer': 2,
+    'node/prefer-global/console': 2,
+    'node/prefer-global/process': 2,
+    'node/prefer-global/text-decoder': 2,
+    'node/prefer-global/text-encoder': 2,
+    'node/prefer-global/url-search-params': 2,
+    'node/prefer-global/url': 2,
+    // node default tweaks
+    'node/no-unpublished-require': 0, // fails for @sinonjs/referee-sinon
+    'node/no-missing-require': [2, {
+      'tryExtensions': ['.js', '.json']
+    }],
+    'node/shebang': 0,
+    'no-process-exit': 0,
 
-    'array-bracket-spacing': [2, 'never'],
+    // eslint default tweaks
+    'no-unused-vars': [2, { args: 'after-used', argsIgnorePattern: '^_' }],
+
+    // Possible Errors (not in recommended)
+    'no-template-curly-in-string': 2,
+    'no-unreachable-loop': 2,
+    'no-useless-backreference': 2,
+    'require-atomic-updates': 2,
+
+    // Best Practices (not in recommended)
+    'array-callback-return': 2,
     'block-scoped-var': 2,
-    'block-spacing': 2,
-    'brace-style': [2, '1tbs', { allowSingleLine: true }],
-    'comma-spacing': [2, { before: false, after: true }],
-    'comma-style': [2, 'last'],
+    'complexity': 2,
     'consistent-return': 2,
-    curly: 2,
-    'dot-notation': 2,
-    'dot-location': [2, 'property'],
-    eqeqeq: 2,
-    'handle-callback-err': 2,
+    'curly': 2,
+    'default-case': 2,
+    'default-case-last': 2,
+    'default-param-last': 2,
+    'eqeqeq': 2,
     'guard-for-in': 2,
-    indent: ['error', 2, {
-      FunctionDeclaration: {
-        parameters: 2,
-        body: 1
-      },
-      FunctionExpression: {
-        parameters: 2,
-        body: 1
-      }
-    }],
-    'linebreak-style': [2, 'unix'],
-    'max-len': [2, 80, 4],
-    'new-cap': 2,
-    'new-parens': 2,
     'no-alert': 2,
     'no-caller': 2,
-    'no-catch-shadow': 2,
-    'no-console': 0,
+    'no-constructor-return': 2,
     'no-else-return': 2,
     'no-eq-null': 2,
     'no-eval': 2,
-    'no-extend-native': [2],
+    'no-extend-native': 2,
     'no-extra-bind': 2,
+    'no-extra-label': 2,
+    'no-floating-decimal': 2,
+    'no-implicit-coercion': 2,
     'no-implied-eval': 2,
-    'no-lonely-if': 2,
+    'no-iterator': 2,
+    'no-lone-blocks': 2,
     'no-loop-func': 2,
-    'no-multiple-empty-lines': [2, { max: 2 }],
+    'no-new': 2,
     'no-new-func': 2,
     'no-new-wrappers': 2,
-    'no-new': 2,
+    'no-octal-escape': 2,
+    'no-proto': 2,
+    'no-restricted-properties': 2,
     'no-return-assign': 2,
+    'no-return-await': 2,
     'no-self-compare': 2,
-    'no-spaced-func': 2,
-    'no-sync': 2,
+    'no-sequences': 2,
     'no-throw-literal': 2,
-    'no-trailing-spaces': 2,
-    'no-undef-init': 2,
-    'no-unneeded-ternary': 2,
+    'no-unmodified-loop-condition': 2,
     'no-unused-expressions': 2,
-    'no-unused-vars': [2, { args: 'after-used', argsIgnorePattern: '^_' }],
-    'no-use-before-define': ['error', { 'functions': false, 'classes': true }],
     'no-useless-call': 2,
     'no-useless-concat': 2,
+    'no-useless-return': 2,
     'no-void': 2,
-    'object-curly-spacing': [2, 'always'],
-    'operator-linebreak': [2, 'before'],
-    // 'quotes' adjusted to work well with prettier
-    // https://github.com/prettier/eslint-config-prettier#quotes
-    // https://eslint.org/docs/rules/quotes
-    'quotes': [
-      'error',
-      'single',
-      { 'avoidEscape': true, 'allowTemplateLiterals': false }
-    ],
-    'quote-props': [2, 'as-needed'],
-    radix: 2,
-    semi: [2, 'always'],
-    'semi-spacing': 2,
-    'space-before-blocks': 2,
-    'space-before-function-paren': [2, { anonymous: 'always', named: 'never' }],
-    'space-in-parens': [2, 'never'],
-    'space-infix-ops': 2,
-    'space-unary-ops': 2,
-    strict: [2, 'global'],
-    'wrap-iife': [2, 'outside'],
-    yoda: 2
+    'prefer-promise-reject-errors': 2,
+    'prefer-regex-literals': 2,
+    'radix': 2,
+    'require-await': 2,
+    'yoda': 2,
+    'strict': 2,
+
+    // Variables
+    'no-label-var': 2,
+    'no-restricted-globals': 2,
+    'no-shadow': 2,
+    'no-use-before-define': [2, "nofunc"],
+
+    // Stylistic Issues
+    'comma-dangle': 2,
+    'max-depth': 2,
+    'max-nested-callbacks': 2,
+    'new-cap': 2,
+    'new-parens': 2,
+    'no-array-constructor': 2,
+    'no-lonely-if': 2,
+    'no-new-object': 2,
+    'no-unneeded-ternary': 2,
+    'semi': 2,
+
+    // ECMAScript 6
+    'no-useless-computed-key': 2,
+    'no-useless-constructor': 2,
+    'no-useless-rename': 2,
+    'no-var': 2,
+    'object-shorthand': 2,
+    'prefer-arrow-callback': 2,
+    'prefer-const': 2,
+    'prefer-spread': 2,
+    'prefer-template': 2
   }
 };

package/package.json

@@ -1,20 +1,27 @@
 {
   "name": "@studio/eslint-config",
-  "version": "1.1.1",
+  "version": "2.3.0",
   "description": "The JavaScript Studio sharable eslint config",
   "main": "index.js",
   "author": "Maximilian Antoni <max@javascript.studio>",
-  "homepage": "https://github.com/javascript-studio/studio-eslint-config",
+  "homepage": "https://github.com/javascript-studio/eslint-config",
   "scripts": {
-    "version": "changes",
+    "test": "eslint --config index.js index.js",
+    "preversion": "npm test",
+    "version": "changes --commits --footer",
     "postversion": "git push --follow-tags && npm publish"
   },
   "devDependencies": {
-    "@studio/changes": "^2.0.0"
+    "@studio/changes": "^2.2.0"
+  },
+  "peerDependencies": {
+    "eslint": "^7 || ^8",
+    "eslint-plugin-mocha": "^8 || ^9 || ^10",
+    "eslint-plugin-node": "^11"
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/javascript-studio/studio-eslint-config.git"
+    "url": "https://github.com/javascript-studio/eslint-config.git"
   },
   "license": "MIT"
 }