From 94868e606a183b7dbc1dfaacbe10a80348a903f0 Mon Sep 17 00:00:00 2001 From: larabr <7375870+larabr@users.noreply.github.com> Date: Tue, 21 Feb 2023 14:56:46 +0100 Subject: [PATCH] ESLint: drop unnecessary rules Most rules are derived from the `airbnb` template. Some "bad" rule exceptions remain, but they require too many changes to fix, so we leave it to a future refactoring. --- .eslintrc.js | 266 ++----------------------------------- src/crypto/cmac.js | 2 +- src/key/helper.js | 4 +- src/key/key.js | 2 +- src/util.js | 4 +- test/general/openpgp.js | 2 +- test/general/testInputs.js | 2 +- 7 files changed, 22 insertions(+), 260 deletions(-) diff --git a/.eslintrc.js b/.eslintrc.js index d1a4b47e..6a58bb27 100644 --- a/.eslintrc.js +++ b/.eslintrc.js @@ -39,222 +39,35 @@ module.exports = { }, 'rules': { - // Auto generated rules: - 'accessor-pairs': 'error', - 'array-bracket-newline': 'error', - 'array-bracket-spacing': [ - 'error', - 'never' - ], - 'array-callback-return': 'error', - 'array-element-newline': 'off', 'arrow-body-style': 'off', - 'arrow-parens': [ - 'error', - 'as-needed' - ], - 'arrow-spacing': [ - 'error', - { - 'after': true, - 'before': true - } - ], - 'block-spacing': [ - 'error', - 'always' - ], - 'brace-style': 'off', - 'callback-return': 'error', - 'camelcase': [ - 'error', - { - 'properties': 'never' - } - ], - 'capitalized-comments': 'off', + 'arrow-parens': ['error','as-needed'], 'class-methods-use-this': 'off', - 'comma-dangle': [ 'error', 'never' ], + 'comma-dangle': ['error', 'never'], 'comma-spacing': 'off', - 'comma-style': [ - 'error', - 'last' - ], - 'complexity': 'off', - 'computed-property-spacing': [ - 'error', - 'never' - ], 'consistent-return': 'off', - 'consistent-this': 'error', - 'curly': 'error', 'default-case': 'off', 'default-param-last': 'off', - 'dot-location': 'error', - 'dot-notation': [ - 'error', - { - 'allowKeywords': true - } - ], 'eol-last': ['error', 'always'], - 'eqeqeq': 'error', - 'for-direction': 'error', - 'func-call-spacing': 'error', 'function-call-argument-newline': 'off', - 'func-name-matching': 'error', - 'func-names': [ - 'error', - 'never' - ], - 'func-style': 'off', + 'func-names': ['error', 'never'], 'function-paren-newline': 'off', - 'generator-star-spacing': 'error', - 'getter-return': 'error', 'global-require': 'off', - 'guard-for-in': 'off', - 'handle-callback-err': 'error', - 'id-blacklist': 'error', - 'id-length': 'off', - 'id-match': 'error', - 'implicit-arrow-linebreak': [ - 'error', - 'beside' - ], - 'init-declarations': 'off', - 'jsx-quotes': 'error', 'key-spacing': 'off', 'keyword-spacing': 'error', - 'line-comment-position': 'off', - 'linebreak-style': [ - 'error', - 'unix' - ], - 'lines-around-comment': 'off', - 'lines-around-directive': 'error', - 'lines-between-class-members': 'error', 'max-classes-per-file': 'off', - 'max-depth': 'off', 'max-len': 'off', - 'max-lines': 'off', - 'max-nested-callbacks': 'error', - 'max-params': 'off', - 'max-statements': 'off', - 'max-statements-per-line': 'off', - 'multiline-comment-style': 'off', - 'multiline-ternary': 'off', - 'new-parens': 'error', - 'newline-after-var': 'off', - 'newline-before-return': 'off', 'newline-per-chained-call': 'off', - 'no-alert': 'error', - 'no-array-constructor': 'error', 'no-bitwise': 'off', - 'no-buffer-constructor': 'error', - 'no-caller': 'error', - 'no-catch-shadow': 'error', - 'no-confusing-arrow': 'error', 'no-continue': 'off', - 'no-div-regex': 'error', - 'no-duplicate-imports': 'error', 'no-else-return': 'off', - 'no-empty': [ - 'error', - { - 'allowEmptyCatch': true - } - ], - 'no-empty-function': 'off', - 'no-eq-null': 'error', - 'no-eval': 'error', - 'no-extend-native': 'error', - 'no-extra-bind': 'error', - 'no-extra-label': 'error', - 'no-extra-parens': 'off', - 'no-floating-decimal': 'error', - 'no-implicit-globals': 'error', - 'no-implied-eval': 'error', - 'no-inline-comments': 'off', - 'no-inner-declarations': [ - 'error', - 'functions' - ], - 'no-invalid-this': 'error', - 'no-iterator': 'error', - 'no-label-var': 'error', - 'no-labels': 'error', - 'no-lone-blocks': 'error', - 'no-lonely-if': 'error', - 'no-loop-func': 'error', - 'no-magic-numbers': 'off', - 'no-mixed-operators': 'off', - 'no-mixed-requires': 'error', - 'no-multi-assign': 'error', - 'no-multi-spaces': [ - 'error', - { - 'ignoreEOLComments': true - } - ], - 'no-multi-str': 'error', + 'no-empty': ['error', { 'allowEmptyCatch': true }], 'no-multiple-empty-lines': ['error', { 'max': 2, 'maxEOF': 1, 'maxBOF':0 }], - 'no-native-reassign': 'error', - 'no-negated-condition': 'off', - 'no-negated-in-lhs': 'error', 'no-nested-ternary': 'off', - 'no-new': 'error', - 'no-new-func': 'error', - 'no-new-object': 'error', - 'no-new-require': 'error', - 'no-new-wrappers': 'error', - 'no-octal-escape': 'error', - 'no-param-reassign': 'off', - 'no-path-concat': 'error', + 'no-param-reassign': 'off', // TODO get rid of this 'no-plusplus': 'off', - 'no-process-env': 'error', - 'no-process-exit': 'error', - 'no-proto': 'error', - 'no-prototype-builtins': 'off', - 'no-restricted-globals': 'error', - 'no-restricted-imports': 'error', - 'no-restricted-modules': 'error', - 'no-restricted-properties': 'error', 'no-restricted-syntax': ['error', 'ForInStatement', 'LabeledStatement', 'WithStatement'], - 'no-return-assign': 'error', - 'no-return-await': 'error', - 'no-script-url': 'error', - 'no-self-compare': 'error', - 'no-shadow': 'off', - 'no-shadow-restricted-names': 'error', - 'no-spaced-func': 'error', - 'no-sync': 'error', - 'no-tabs': 'error', - 'no-template-curly-in-string': 'error', - 'no-ternary': 'off', - 'no-throw-literal': 'error', - 'no-undef-init': 'error', - 'no-undefined': 'off', - 'no-unmodified-loop-condition': 'error', - 'no-unneeded-ternary': [ - 'error', - { - 'defaultAssignment': true - } - ], - 'no-use-before-define': 'off', - 'no-useless-call': 'error', - 'no-useless-computed-key': 'error', - 'no-useless-concat': 'error', - 'no-useless-constructor': 'error', - 'no-useless-rename': 'error', - 'no-useless-return': 'error', - 'no-void': 'error', - 'no-warning-comments': 'off', - 'no-whitespace-before-property': 'error', - 'no-with': 'error', - 'nonblock-statement-body-position': 'error', 'object-curly-newline': 'off', - 'object-curly-spacing': 'error', + 'no-shadow': 'off', // TODO get rid of this 'object-property-newline': [ 'error', { @@ -262,89 +75,38 @@ module.exports = { } ], 'object-shorthand': 'off', - 'one-var-declaration-per-line': [ - 'error', - 'initializations' - ], 'operator-assignment': 'off', 'operator-linebreak': [ 'error', 'after' ], 'padded-blocks': 'off', - 'padding-line-between-statements': 'error', 'prefer-arrow-callback': 'off', 'prefer-destructuring': 'off', - 'prefer-numeric-literals': 'error', - 'prefer-promise-reject-errors': 'error', - 'prefer-reflect': 'off', - 'prefer-rest-params': 'off', - 'prefer-spread': 'off', + 'prefer-rest-params': 'off', // TODO get rid of this + 'prefer-spread': 'off', // TODO get rid of this 'prefer-template': 'off', 'quote-props': 'off', 'quotes': ['error', 'single', { 'avoidEscape': true }], - 'require-await': 'error', - 'require-jsdoc': 'off', - 'semi-spacing': [ - 'error', - { - 'after': true, - 'before': false - } - ], - 'semi-style': [ - 'error', - 'last' - ], - 'sort-imports': 'off', - 'sort-keys': 'off', - 'sort-vars': 'off', - 'space-before-blocks': 'off', 'space-before-function-paren': 'off', - 'space-in-parens': [ - 'error', - 'never' - ], - 'space-infix-ops': 'error', - 'space-unary-ops': 'error', 'spaced-comment': 'off', - 'strict': 'off', - 'switch-colon-spacing': 'error', - 'symbol-description': 'error', - 'template-curly-spacing': 'error', - 'template-tag-spacing': 'error', - 'unicode-bom': [ - 'error', - 'never' - ], - 'wrap-iife': 'error', - 'wrap-regex': 'off', - 'yield-star-spacing': 'error', - 'yoda': [ - 'error', - 'never' - ], 'indent': ['error', 2, { 'SwitchCase': 1 }], 'no-unused-vars': 'error', // eslint-plugin-import rules: 'import/named': 'error', 'import/extensions': 'error', - 'import/no-extraneous-dependencies': ['error', {'devDependencies': true, 'optionalDependencies': false, 'peerDependencies': false}], + 'import/no-extraneous-dependencies': ['error', { 'devDependencies': true, 'optionalDependencies': false, 'peerDependencies': false }], 'import/no-unassigned-import': 'error', 'import/prefer-default-export': 'off', // Custom silencers: - 'camelcase': 0, - 'require-await': 0, - 'no-multi-assign': 0, - 'no-underscore-dangle': 0, - 'no-await-in-loop': 0, + 'camelcase': 'off', // used in tests, need to fix separately + 'no-multi-assign': 'off', + 'no-underscore-dangle': 'off', + 'no-await-in-loop': 'off', // Custom errors: - 'no-undef': 2, - 'no-trailing-spaces': 2, - 'no-mixed-operators': [2, { 'groups': [['&', '|', '^', '~', '<<', '>>', '>>>'], ['&&', '||']] }], 'no-use-before-define': [2, { 'functions': false, 'classes': true, 'variables': false }], 'no-constant-condition': [2, { 'checkLoops': false }], 'new-cap': [2, { 'properties': false, 'capIsNewExceptionPattern': 'EAX|OCB|GCM|CMAC|CBC|OMAC|CTR', 'newIsCapExceptionPattern': 'type|hash*' }], @@ -353,6 +115,6 @@ module.exports = { 'chai-friendly/no-unused-expressions': [2, { 'allowShortCircuit': true }], // Custom warnings: - 'no-console': 1, + 'no-console': 1 } }; diff --git a/src/crypto/cmac.js b/src/crypto/cmac.js index 14bfb0d3..c183a70a 100644 --- a/src/crypto/cmac.js +++ b/src/crypto/cmac.js @@ -51,7 +51,7 @@ function pad(data, padding, padding2) { return rightXORMut(data, padding); } // else return (M || 10^(n−1−(|M| mod n))) xor→ P - const padded = new Uint8Array(data.length + (blockLength - data.length % blockLength)); + const padded = new Uint8Array(data.length + (blockLength - (data.length % blockLength))); padded.set(data); padded[data.length] = 0b10000000; return rightXORMut(padded, padding2); diff --git a/src/key/helper.js b/src/key/helper.js index ba8555b8..04afc156 100644 --- a/src/key/helper.js +++ b/src/key/helper.js @@ -62,8 +62,8 @@ export async function getLatestValidSignature(signatures, publicKey, signatureTy throw util.wrapError( `Could not find valid ${enums.read(enums.signature, signatureType)} signature in key ${publicKey.getKeyID().toHex()}` .replace('certGeneric ', 'self-') - .replace(/([a-z])([A-Z])/g, (_, $1, $2) => $1 + ' ' + $2.toLowerCase()) - , exception); + .replace(/([a-z])([A-Z])/g, (_, $1, $2) => $1 + ' ' + $2.toLowerCase()), + exception); } return latestValid; } diff --git a/src/key/key.js b/src/key/key.js index 773fd0e2..b7e8dc1f 100644 --- a/src/key/key.js +++ b/src/key/key.js @@ -63,7 +63,7 @@ class Key { if (packet instanceof UnparseablePacket) { const isUnparseableKeyPacket = keyPacketTags.has(packet.tag); - if (isUnparseableKeyPacket && !ignoreUntil){ + if (isUnparseableKeyPacket && !ignoreUntil) { // Since non-key packets apply to the preceding key packet, if a (sub)key is Unparseable we must // discard all non-key packets that follow, until another (sub)key packet is found. if (mainKeyPacketTags.has(packet.tag)) { diff --git a/src/util.js b/src/util.js index 3780d807..f250dcd9 100644 --- a/src/util.js +++ b/src/util.js @@ -35,11 +35,11 @@ const debugMode = (() => { const util = { isString: function(data) { - return typeof data === 'string' || String.prototype.isPrototypeOf(data); + return typeof data === 'string' || data instanceof String; }, isArray: function(data) { - return Array.prototype.isPrototypeOf(data); + return data instanceof Array; }, isUint8Array: stream.isUint8Array, diff --git a/test/general/openpgp.js b/test/general/openpgp.js index 512e3d21..7d830960 100644 --- a/test/general/openpgp.js +++ b/test/general/openpgp.js @@ -1130,7 +1130,7 @@ module.exports = () => describe('OpenPGP.js public api tests', function() { passphrase: 'incorrect' }).then(function() { throw new Error('Should not decrypt with incorrect passphrase'); - }).catch(function(error){ + }).catch(function(error) { expect(error.message).to.match(/Incorrect key passphrase/); // original key should be unchanged expect(privateKey.isDecrypted()).to.be.false; diff --git a/test/general/testInputs.js b/test/general/testInputs.js index b50ba61c..5879321b 100644 --- a/test/general/testInputs.js +++ b/test/general/testInputs.js @@ -1,7 +1,7 @@ /** * Generates a 64 character long javascript string out of the whole utf-8 range. */ -function createSomeMessage(){ +function createSomeMessage() { const arr = []; for (let i = 0; i < 30; i++) { arr.push(Math.floor(Math.random() * 10174) + 1);