eslint-config-uphold 1.0.1 → 2.3.0

package/CHANGELOG.md

@@ -1,5 +1,33 @@
 # Changelog
 
+## [2.3.0](https://github.com/uphold/eslint-config-uphold/releases/tag/2.3.0) (2022-02-21)
+- Enable array-callback-return rule [\#52](https://github.com/uphold/eslint-config-uphold/pull/52) ([satazor](https://github.com/satazor))
+- Bump minimum node version to 12.22 [\#51](https://github.com/uphold/eslint-config-uphold/pull/51) ([diogotorres97](https://github.com/diogotorres97))
+
+## [2.2.0](https://github.com/uphold/eslint-config-uphold/releases/tag/2.2.0) (2022-02-11)
+- Update `no-irregular-whitespace` rule [\#50](https://github.com/uphold/eslint-config-uphold/pull/50) ([Americas](https://github.com/Americas))
+- Release v2.1.0 [\#49](https://github.com/uphold/eslint-config-uphold/pull/49) ([Finglas](https://github.com/Finglas))
+
+## [2.1.0](https://github.com/uphold/eslint-config-uphold/releases/tag/2.1.0) (2022-02-03)
+- Upgrade github-changelog-generator to version 3.0.0 [\#48](https://github.com/uphold/eslint-config-uphold/pull/48) ([Finglas](https://github.com/Finglas))
+- Replace travis with github actions [\#45](https://github.com/uphold/eslint-config-uphold/pull/45) ([diogotorres97](https://github.com/diogotorres97))
+- Set eslint version to allow patch upgrades [\#46](https://github.com/uphold/eslint-config-uphold/pull/46) ([Finglas](https://github.com/Finglas))
+- Update to use `eslint-parser` [\#44](https://github.com/uphold/eslint-config-uphold/pull/44) ([Finglas](https://github.com/Finglas))
+- Bump y18n from 4.0.0 to 4.0.1 [\#38](https://github.com/uphold/eslint-config-uphold/pull/38) ([dependabot](https://github.com/apps/dependabot))
+
+## [v2.0.0](https://github.com/uphold/eslint-config-uphold/releases/tag/v2.0.0) (2021-01-29)
+- Add `files` property to package.json [\#37](https://github.com/uphold/eslint-config-uphold/pull/37) ([Americas](https://github.com/Americas))
+- Bump prettier@2.2.1 [\#36](https://github.com/uphold/eslint-config-uphold/pull/36) ([Americas](https://github.com/Americas))
+- Bump eslint@7.18.0 [\#35](https://github.com/uphold/eslint-config-uphold/pull/35) ([Americas](https://github.com/Americas))
+- Bump ini from 1.3.5 to 1.3.7 [\#32](https://github.com/uphold/eslint-config-uphold/pull/32) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Bump node-fetch from 2.6.0 to 2.6.1 [\#31](https://github.com/uphold/eslint-config-uphold/pull/31) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Bump lodash from 4.17.15 to 4.17.20 [\#34](https://github.com/uphold/eslint-config-uphold/pull/34) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Add `explicit-sinon-use-fake-timers` rule [\#30](https://github.com/uphold/eslint-config-uphold/pull/30) ([nunofgs](https://github.com/nunofgs))
+- Bump dependencies to fix security vulnerabilities [\#28](https://github.com/uphold/eslint-config-uphold/pull/28) ([waldyrious](https://github.com/waldyrious))
+- Bump eslint-utils from 1.3.1 to 1.4.3 [\#25](https://github.com/uphold/eslint-config-uphold/pull/25) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Bump acorn from 6.2.0 to 6.4.1 [\#26](https://github.com/uphold/eslint-config-uphold/pull/26) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Bump https-proxy-agent from 2.2.2 to 2.2.4 [\#27](https://github.com/uphold/eslint-config-uphold/pull/27) ([dependabot[bot]](https://github.com/apps/dependabot))
+
 ## [v1.0.1](https://github.com/uphold/eslint-config-uphold/releases/tag/v1.0.1) (2019-10-11)
 - Update @uphold/github-changelog-generator@1.0.1 [\#24](https://github.com/uphold/eslint-config-uphold/pull/24) ([rplopes](https://github.com/rplopes))
 - Update @uphold/github-changelog-generator@1.0.0 [\#23](https://github.com/uphold/eslint-config-uphold/pull/23) ([rplopes](https://github.com/rplopes))

package/README.md

@@ -42,3 +42,11 @@ 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.1",
+  "version": "2.3.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": "^1.0.1",
-    "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.5.1",
-    "prettier": "^1.18.2"
+    "eslint": "~8.7.0",
+    "prettier": "^2.2.1"
   },
   "pre-commit": [
     "lint"
   ],
   "engines": {
-    "node": ">=8.10.0"
+    "node": ">=12.22"
   },
   "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,37 +23,27 @@ 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',
+    'array-callback-return': 'error',
     'block-scoped-var': 'error',
     'consistent-this': ['error', 'self'],
     curly: 'error',
     '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 +66,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 +91,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 +114,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 +123,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 +136,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/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;
-}

package/test/fixtures/incorrect.js

@@ -1,184 +0,0 @@
-// Avoid extra `no-unused-vars` violations.
-function noop() {
-  // do nothing
-}
-
-// `consistent-this`.
-const consistentThis = this;
-
-noop(consistentThis);
-
-// `curly`.
-let curly = true;
-
-if (curly) curly = false;
-
-// `dot-notation`.
-const dotNotation = {};
-
-dotNotation['foo'] = 'bar';
-
-// `id-match`.
-let id_mátch;
-
-noop(id_mátch);
-
-// `mocha/no-exclusive-tests`.
-describe.only('noExclusiveTests', () => {
-  it('should not work');
-});
-
-// `mocha/no-identical-title`.
-describe('noIdenticalTitle', () => {
-  it('should not work');
-  it('should not work');
-});
-
-// `mocha/no-nested-tests`.
-it('noNestedTests', () => {
-  it('should not work');
-});
-
-// `mocha/no-sibling-hooks`.
-describe('noSiblingHooks', () => {
-  before(() => {});
-  before(() => {});
-});
-
-// `new-cap`.
-const cap = require('cap');
-
-new cap();
-
-// `no-class-assign`.
-class NoClassAssign {}
-
-NoClassAssign = 'foobar';
-
-noop(NoClassAssign);
-
-// `no-const-assign`.
-const noConstAssign = true;
-
-noConstAssign = false;
-
-noop(noConstAssign);
-
-// `no-constant-condition`.
-if (true) {
-  noop(true);
-}
-
-// `no-dupe-class-members`.
-class NoDupeClassMembers {
-  foo() {
-    return 'bar';
-  }
-
-  foo() {
-    return 'foo';
-  }
-}
-
-noop(NoDupeClassMembers);
-
-// `no-labels`.
-noLabels: {
-  break noLabels;
-}
-
-// `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() {
-    this.foo = 'bar';
-    super();
-  }
-}
-
-noop(Child);
-
-// `no-underscore-dangle`.
-class NoUnderscoreDangle {
-  constructor() {
-    this._foo();
-  }
-}
-
-noop(new NoUnderscoreDangle());
-
-// `no-unused-vars`
-const foobar = '';
-
-// `padding-line-between-statements`.
-const newLineAfterVar = 'foo';
-noop(newLineAfterVar);
-
-function funcThatReturns(bar) {
-  if (!bar) {
-    return;
-  }
-  return bar;
-}
-
-funcThatReturns('foo');
-
-// `prefer-destructuring`.
-const bar = {};
-const biz = bar.biz;
-const baz = biz[0];
-
-noop(biz, baz);
-
-// `prettier/prettier`.
-const singleQuote = "true";
-
-noop(singleQuote);
-
-const maximumLineLength = 'prettier dictates that lines of code must not exceed a length limit of 120 characters maximum';
-
-noop(maximumLineLength);
-
-// `require-await`.
-(async () => {})();
-
-// `sort-imports`.
-import import1 from 'import-1';
-import { import2 } from 'import-2';
-
-noop(import1);
-noop(import2);
-
-// `sort-keys`.
-const sortObjectProps = {
-  var1: 'foo',
-  var10: 'bar',
-  var9: 'biz'
-};
-
-noop(sortObjectProps);
-
-// `spaced-comment`.
-//Comment missing space.
-
-// `sql-template/no-unsafe-query`.
-const db = {
-  query: noop()
-};
-const foo = 'foo';
-
-db.query(`SELECT ${foo} FROM bar`);
-
-// `yoda`.
-let yoda = true;
-
-if (true === yoda) {
-  yoda = false;
-}