eslint-config-uphold 1.0.0 → 2.2.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Uphold
+
+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

@@ -1,22 +1,27 @@
 # eslint-config-uphold
 
-Uphold-flavored ESLint config.
+Uphold-flavored [ESLint](https://eslint.org/) config.
+
+The [rules defined here](https://github.com/uphold/eslint-config-uphold/blob/master/src/index.js)
+extend the [eslint-recommended](https://github.com/eslint/eslint/blob/master/conf/eslint-recommended.js) preset,
+as well as the [overrides](https://github.com/prettier/eslint-config-prettier/blob/master/index.js)
+that allow the [Prettier](https://prettier.io) pretty-printer to reformat the code without conflicts.
 
 ## Installation
 
 ```sh
-$ npm install eslint eslint-config-uphold --save-dev
+$ npm install eslint eslint-config-uphold prettier --save-dev
 ```
 
 ## Usage
 
-Create an `.eslintrc.yml` file with the following:
+Create an `.eslintrc.yml` file with the following content:
 
 ```yaml
 extends: uphold
 ```
 
-Add the following `script` to your `package.json`:
+Add a `lint` command to the `scripts` section of your `package.json`, like so:
 
 ```json
 {
@@ -31,3 +36,17 @@ and run the linter with:
 ```sh
 $ npm run lint
 ```
+
+To automatically fix all lint issues, use the `--fix` option:
+
+```sh
+$ npm run lint --fix
+```
+
+## Upgrading eslint
+
+See the [eslint repo](https://github.com/eslint/eslint#semantic-versioning-policy) for eslint's guidelines on semantic versioning.
+
+A [tilde range](https://docs.npmjs.com/cli/v6/using-npm/semver#tilde-ranges-123-12-1) is set for the eslint dependency to pick up any patch changes by default.
+
+For any minor/major upgrades to `eslint` it is recommended to update both eslint and `eslint-config-uphold` and keep them in parallel. This is down to the fact that no guarantee is made that minor upgrades do not cause conflicts or issues with existing or new rules. The downside here is a package update is required for any security or other bug fixes. The benefit however is the included rules are always guaranteed to be stable.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-config-uphold",
-  "version": "1.0.0",
+  "version": "2.2.0",
   "description": "Uphold-flavored ESLint config",
   "keywords": [
     "config",
@@ -19,37 +19,42 @@
     "type": "git",
     "url": "git+ssh://git@github.com/uphold/eslint-config-uphold.git"
   },
+  "files": [
+    "src"
+  ],
   "scripts": {
-    "changelog": "github-changelog-generator --future-release=v$npm_config_future_release > CHANGELOG.md",
-    "lint": "eslint --config src/index.js src/index.js test/index.js",
+    "changelog": "echo \"$(github-changelog-generator --owner uphold --repo eslint-config-uphold --future-release=$npm_package_version)\n$(tail -n +2 CHANGELOG.md)\" > CHANGELOG.md",
+    "lint": "eslint src test/index.js",
     "test": "mocha $npm_package_options_mocha",
     "version": "npm run changelog --future-release=$npm_package_version && git add -A CHANGELOG.md"
   },
   "dependencies": {
-    "babel-eslint": "^10.0.2",
-    "eslint-config-prettier": "^6.0.0",
+    "@babel/core": "^7.16.12",
+    "@babel/eslint-parser": "^7.16.5",
+    "eslint-config-prettier": "^7.2.0",
     "eslint-plugin-mocha": "^5.3.0",
-    "eslint-plugin-prettier": "^3.1.0",
+    "eslint-plugin-prettier": "^3.3.1",
+    "eslint-plugin-rulesdir": "^0.1.0",
     "eslint-plugin-sort-imports-es6": "^0.0.3",
     "eslint-plugin-sql-template": "^2.0.0"
   },
   "devDependencies": {
-    "@uphold/github-changelog-generator": "^0.7.0",
-    "eslint": "^6.0.1",
-    "mocha": "^3.1.1",
+    "@uphold/github-changelog-generator": "^3.0.0",
+    "eslint": "~8.7.0",
+    "mocha": "^9.2.0",
     "pre-commit": "^1.2.2",
-    "prettier": "^1.18.2",
+    "prettier": "^2.2.1",
     "should": "^9.0.2"
   },
   "peerDependencies": {
-    "eslint": "^6.0.1",
-    "prettier": "^1.18.2"
+    "eslint": "~8.7.0",
+    "prettier": "^2.2.1"
   },
   "pre-commit": [
     "lint"
   ],
   "engines": {
-    "node": ">=8.10.0"
+    "node": ">=10.23.2"
   },
   "options": {
     "mocha": "-t 10000 --require should test"

package/src/index.js

@@ -1,3 +1,15 @@
+/**
+ * Module dependencies.
+ */
+
+const rulesDir = require('eslint-plugin-rulesdir');
+
+/**
+ * Configure the rulesdir plugin.
+ */
+
+rulesDir.RULES_DIR = `${__dirname}/rules`;
+
 /**
  * Export `uphold` shared configuration preset.
  */
@@ -11,8 +23,11 @@ module.exports = {
     node: true
   },
   extends: ['eslint:recommended', 'plugin:prettier/recommended'],
-  parser: 'babel-eslint',
-  plugins: ['mocha', 'sort-imports-es6', 'sql-template'],
+  parser: '@babel/eslint-parser',
+  parserOptions: {
+    requireConfigFile: false
+  },
+  plugins: ['mocha', 'rulesdir', 'sort-imports-es6', 'sql-template'],
   root: true,
   rules: {
     'accessor-pairs': 'error',
@@ -22,26 +37,12 @@ module.exports = {
     'default-case': 'error',
     'dot-notation': 'error',
     eqeqeq: ['error', 'smart'],
-    'func-style': [
-      'error',
-      'declaration',
-      {
-        allowArrowFunctions: true
-      }
-    ],
-    'id-length': [
-      'error',
-      {
-        exceptions: ['_', 'e', 'i']
-      }
-    ],
+    'func-style': ['error', 'declaration', { allowArrowFunctions: true }],
+    'id-length': ['error', { exceptions: ['_', 'e', 'i'] }],
     'id-match': [
       'error',
       '^_$|^[$_a-zA-Z]*[_a-zA-Z0-9]*[a-zA-Z0-9]*$|^[A-Z][_A-Z0-9]+[A-Z0-9]$',
-      {
-        onlyDeclarations: true,
-        properties: true
-      }
+      { onlyDeclarations: true, properties: true }
     ],
     'max-depth': 'error',
     'max-params': ['error', 4],
@@ -64,6 +65,7 @@ module.exports = {
     'no-extra-bind': 'error',
     'no-implied-eval': 'error',
     'no-inline-comments': 'error',
+    'no-irregular-whitespace': ['error', { skipComments: false, skipStrings: false, skipTemplates: false }],
     'no-iterator': 'error',
     'no-labels': 'error',
     'no-lone-blocks': 'error',
@@ -88,6 +90,7 @@ module.exports = {
     'no-self-compare': 'error',
     'no-sequences': 'error',
     'no-sync': 'error',
+    'no-tabs': ['error', { allowIndentationTabs: true }],
     'no-throw-literal': 'error',
     'no-undef-init': 'error',
     'no-underscore-dangle': 'error',
@@ -110,14 +113,8 @@ module.exports = {
     'prefer-destructuring': [
       'error',
       {
-        AssignmentExpression: {
-          array: false,
-          object: false
-        },
-        VariableDeclarator: {
-          array: true,
-          object: true
-        }
+        AssignmentExpression: { array: false, object: false },
+        VariableDeclarator: { array: true, object: true }
       },
       {
         enforceForRenamedProperties: false
@@ -125,16 +122,11 @@ module.exports = {
     ],
     'prefer-spread': 'error',
     'prefer-template': 'error',
-    'prettier/prettier': [
-      'error',
-      {
-        printWidth: 120,
-        singleQuote: true
-      }
-    ],
+    'prettier/prettier': ['error', { arrowParens: 'avoid', printWidth: 120, singleQuote: true, trailingComma: 'none' }],
     radix: 'error',
     'require-atomic-updates': 'off',
     'require-await': 'error',
+    'rulesdir/explicit-sinon-use-fake-timers': 'error',
     'sort-imports-es6/sort-imports-es6': [
       'error',
       {
@@ -143,13 +135,7 @@ module.exports = {
         memberSyntaxSortOrder: ['none', 'all', 'multiple', 'single']
       }
     ],
-    'sort-keys': [
-      'error',
-      'asc',
-      {
-        natural: true
-      }
-    ],
+    'sort-keys': ['error', 'asc', { natural: true }],
     'spaced-comment': 'error',
     'sql-template/no-unsafe-query': 'error',
     'valid-jsdoc': 'error',

package/src/rules/explicit-sinon-use-fake-timers.js

@@ -0,0 +1,50 @@
+'use strict';
+
+// ------------------------------------------------------------------------------
+// Validates that `sinon.useFakeTimers()` is always called with an explicit `toFake` property.
+// ------------------------------------------------------------------------------
+
+module.exports = {
+  meta: {
+    messages: {
+      avoidName: 'Calls to `sinon.useFakeTimers()` must provide a `toFake` configuration'
+    }
+  },
+  // eslint-disable-next-line sort-keys
+  create(context) {
+    return {
+      CallExpression(node) {
+        if (!node.callee || !node.callee.object || !node.callee.property) {
+          return;
+        }
+
+        if (node.callee.object.name === 'sinon' && node.callee.property.name === 'useFakeTimers') {
+          if (!node.arguments.length) {
+            context.report({
+              message: 'Must pass an object with `toFake` configuration',
+              node
+            });
+          }
+
+          for (const argument of node.arguments) {
+            if (argument.type === 'ObjectExpression') {
+              if (!argument.properties.find(({ key: { name } }) => name === 'toFake')) {
+                context.report({
+                  message: 'Object must contain `toFake` configuration',
+                  node
+                });
+              }
+
+              continue;
+            }
+
+            context.report({
+              message: 'Not an object',
+              node
+            });
+          }
+        }
+      }
+    };
+  }
+};

package/.travis.yml

@@ -1,12 +0,0 @@
-language: node_js
-
-cache: yarn
-
-node_js:
-  - 8
-  - 10
-  - 12
-
-script:
-  - yarn lint
-  - yarn test

package/CHANGELOG.md

@@ -1,28 +0,0 @@
-# Changelog
-
-## [v1.0.0](https://github.com/uphold/eslint-config-uphold/releases/tag/v1.0.0) (2019-07-25)
-- Remove redundant rules [\#19](https://github.com/uphold/eslint-config-uphold/pull/19) ([rplopes](https://github.com/rplopes))
-- Add peer dependencies [\#20](https://github.com/uphold/eslint-config-uphold/pull/20) ([rplopes](https://github.com/rplopes))
-- Add prettier and replace redundant rules [\#18](https://github.com/uphold/eslint-config-uphold/pull/18) ([rplopes](https://github.com/rplopes))
-- Update eslint@6.0.1 [\#16](https://github.com/uphold/eslint-config-uphold/pull/16) ([rplopes](https://github.com/rplopes))
-- Improve `id-match` [\#14](https://github.com/uphold/eslint-config-uphold/pull/14) ([rplopes](https://github.com/rplopes))
-
-## [v0.2.0](https://github.com/uphold/eslint-config-uphold/releases/tag/v0.2.0) (2018-07-16)
-- Add @uphold/github-changelog-generator [\#13](https://github.com/uphold/eslint-config-uphold/pull/13) ([Americas](https://github.com/Americas))
-- Replace drone with travis [\#10](https://github.com/uphold/eslint-config-uphold/pull/10) ([Americas](https://github.com/Americas))
-- Add pre-commit lint hook [\#12](https://github.com/uphold/eslint-config-uphold/pull/12) ([Americas](https://github.com/Americas))
-- Raise minimum node engine requirement to 6 [\#11](https://github.com/uphold/eslint-config-uphold/pull/11) ([Americas](https://github.com/Americas))
-- Fix linting errors [\#9](https://github.com/uphold/eslint-config-uphold/pull/9) ([Americas](https://github.com/Americas))
-- Add new mocha rules [\#8](https://github.com/uphold/eslint-config-uphold/pull/8) ([rplopes](https://github.com/rplopes))
-- Update eslint-plugin-mocha@^5.1.0 [\#7](https://github.com/uphold/eslint-config-uphold/pull/7) ([Americas](https://github.com/Americas))
-
-## [v0.1.1](https://github.com/uphold/eslint-config-uphold/releases/tag/v0.1.1) (2018-03-20)
-- Allow computed properties in prefer destructuring [\#5](https://github.com/uphold/eslint-config-uphold/pull/5) ([nunofgs](https://github.com/nunofgs))
-
-## [v0.1.0](https://github.com/uphold/eslint-config-uphold/releases/tag/v0.1.0) (2017-12-26)
-- Add `jasmine` and `jest` to eslint environments [\#4](https://github.com/uphold/eslint-config-uphold/pull/4) ([nunofgs](https://github.com/nunofgs))
-
-## [v0.0.1](https://github.com/uphold/eslint-config-uphold/releases/tag/v0.0.1) (2017-09-07)
-- Add prefer-destructuring rule [\#2](https://github.com/uphold/eslint-config-uphold/pull/2) ([nunofgs](https://github.com/nunofgs))
-- Replace travis with drone [\#3](https://github.com/uphold/eslint-config-uphold/pull/3) ([franciscocardoso](https://github.com/franciscocardoso))
-- Update eslint@4.4.1 [\#1](https://github.com/uphold/eslint-config-uphold/pull/1) ([nunofgs](https://github.com/nunofgs))

package/test/fixtures/correct.js

@@ -1,210 +0,0 @@
-// env: jasmine.
-try {
-  fail();
-} catch (e) {
-  // eslint-disable-line no-empty
-}
-
-// env: jest and mocha.
-describe();
-
-// Avoid extra `no-unused-vars` violations.
-function noop() {
-  // do nothing
-}
-
-// `consistent-this`.
-const self = this;
-
-noop(self);
-
-// `curly`.
-let mixedRules = true;
-
-if (mixedRules) {
-  mixedRules = false;
-} else {
-  mixedRules = true;
-}
-
-// `dot-notation`.
-const dotNotation = {};
-
-dotNotation.foo = 'bar';
-
-// `id-match`.
-let idmatch;
-let idMatch;
-let IdMatch;
-let IDMatch;
-let IDMATCH;
-let ID_MATCH;
-let ID_M_ATCH;
-
-noop(idmatch);
-noop(idMatch);
-noop(IdMatch);
-noop(IDMatch);
-noop(IDMATCH);
-noop(ID_MATCH);
-noop(ID_M_ATCH);
-noop(__dirname);
-noop(`${__dirname}`);
-
-// `mocha/no-exclusive-tests`.
-describe('noExclusiveTests', () => {
-  it('should work');
-});
-
-// `new-cap`.
-const Cap = require('cap');
-const newCap = new Cap();
-
-noop(newCap);
-
-// `no-class-assign`.
-class NoClassAssign {}
-
-noop(NoClassAssign);
-
-// `no-const-assign`.
-let noConstAssign = true;
-
-noConstAssign = false;
-
-noop(noConstAssign);
-
-// `no-constant-condition`.
-const noConstantCondition = true;
-
-if (noConstantCondition) {
-  noop(noConstantCondition);
-}
-
-// `no-dupe-class-members`.
-class NoDupeClassMembers {
-  bar() {
-    return 'bar';
-  }
-
-  foo() {
-    return 'foo';
-  }
-}
-
-noop(NoDupeClassMembers);
-
-// `no-labels`.
-const noLabels = { label: true };
-
-while (noLabels.label) {
-  break;
-}
-
-// `no-multi-str`.
-const noMultiStr = `Line 1
-  Line 2`;
-
-noop(noMultiStr);
-
-// `no-this-before-super`.
-const NoThisBeforeSuper = require('no-this-before-super');
-
-class Child extends NoThisBeforeSuper {
-  constructor() {
-    super();
-    this.foo = 'bar';
-  }
-}
-
-noop(Child);
-
-// `padding-line-between-statements`.
-const newLineAfterVar = 'foo';
-
-noop(newLineAfterVar);
-
-function funcThatReturns(bar) {
-  if (!bar) {
-    return;
-  }
-
-  return bar;
-}
-
-funcThatReturns('foo');
-
-// `prefer-destructuring`.
-let { bar } = {};
-let [biz] = bar;
-let baz = bar[biz];
-
-bar.baz = bar.biz;
-bar = biz.bar;
-biz = baz[0];
-baz = bar;
-
-// `prettier/prettier`.
-const singleQuote = 'true';
-
-noop(singleQuote);
-
-const maximumLineLength = '120';
-
-noop(maximumLineLength);
-
-// `require-atomic-updates`.
-(async (foo = {}) => {
-  await foo;
-
-  foo.bar = 'biz';
-})();
-
-// `require-await`.
-(async () => {
-  await noop();
-})();
-
-// `sort-imports`.
-import 'import-1';
-import * as Import6 from 'import-2';
-import { Import5, import4 } from 'import-3';
-import { import3 } from 'import-4';
-import Import2 from 'import-5';
-import import1 from 'import-6';
-
-noop(Import2);
-noop(Import5);
-noop(Import6);
-noop(import1);
-noop(import3);
-noop(import4);
-
-// `sort-keys`.
-const sortObjectProps = {
-  var1: 'foo',
-  var9: 'bar',
-  var10: 'biz'
-};
-
-noop(sortObjectProps);
-
-// `spaced-comment`.
-// spaced comment.
-
-// `sql-template/no-unsafe-query`.
-const db = {
-  query: noop()
-};
-const foo = 'foo';
-const sql = 'sql-tag';
-
-db.query(sql`SELECT ${foo} FROM bar`);
-db.query(`SELECT foo FROM bar`);
-
-// `yoda`.
-let yoda = true;
-
-if (yoda === true) {
-  yoda = false;
-}