eslint-plugin-jest-formatting 1.1.1 → 3.0.0

package/.circleci/config.yml

@@ -7,7 +7,7 @@ version: 2
 defaults: &defaults
   working_directory: ~/repo
   docker:
-    - image: circleci/node:8.10.0
+    - image: circleci/node:10
 
 jobs:
   test:
@@ -28,7 +28,7 @@ jobs:
           command: yarn test
 
       - run: yarn lint
-      
+
       - save_cache:
           paths:
             - node_modules

package/.eslintrc

@@ -3,21 +3,32 @@
   "parserOptions": {
     "sourceType": "module"
   },
-  "plugins": ["jest-formatting", "jest"],
+  "plugins": ["jest-formatting", "jest", "@typescript-eslint/eslint-plugin"],
   "env": {
     "jest/globals": true
   },
   "extends": [
     "airbnb-base",
+    "plugin:@typescript-eslint/recommended",
     "plugin:prettier/recommended",
-    "plugin:jest-formatting/recommended"
+    "plugin:jest-formatting/recommended",
+    "plugin:import/typescript"
   ],
   "overrides": [
     {
       "files": ["**.*"],
       "rules": {
-        "camelcase": "off"
+        "camelcase": "off",
+        "no-plusplus": "off",
+        "import/extensions": "off"
       }
     }
-  ]
+  ],
+  "settings": {
+    "import/resolver": {
+      "typescript": {
+        "alwaysTryTypes": true // Without this `@types/estree` `estree` isn't actually in our node_modules.
+      }
+    }
+  }
 }

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## v3.0.0 - May 4, 2021
+
+### Breaking Changes
+
+- Padding is no longer enforced between statements and `await`ed statements of the same kind.
+
 ## v1.1.0 - August 14, 2019
 
 ### Changed

package/README.md

@@ -1,14 +1,16 @@
 [![CircleCI](https://circleci.com/gh/dangreenisrael/eslint-plugin-jest-formatting/tree/master.svg?style=svg)](https://circleci.com/gh/dangreenisrael/eslint-plugin-jest-formatting/tree/master)
 ![npm monthly downloads](https://img.shields.io/npm/dm/eslint-plugin-jest-formatting.svg)
 
-**_Note: The master version may not be the version deployed to npm. Please treat https://www.npmjs.com/package/eslint-plugin-jest-formatting as the cannonical source for docs._**
-
 # eslint-plugin-jest-formatting
 
+This package provides ESLint rules for jest test suites.
+
 This project aims to provide formatting rules (auto-fixable where possible) to ensure consistency and readability in jest test suites.
 
 Like this plugin? [Say thanks with a ⭐️](https://github.com/dangreenisrael/eslint-plugin-jest-formatting/stargazers)
 
+**_Note: The master version may not be the version deployed to npm. Please treat https://www.npmjs.com/package/eslint-plugin-jest-formatting as the cannonical source for docs._**
+
 ## Installation
 
 You'll first need to install [ESLint](http://eslint.org):
@@ -73,14 +75,12 @@ We also support a "strict" settings which enabled all of the rules for you
 - [padding-around-expect-groups](docs/rules/padding-around-expect-groups.md)
 - [padding-around-describe-blocks](docs/rules/padding-around-describe-blocks.md)
 - [padding-around-test-blocks](docs/rules/padding-around-test-blocks.md)
+- [padding-around-all](docs/rules/padding-around-all.md)
+
+## Related Projects
+
+### eslint-plugin-jest
 
-### Deprecated
+This provides an extensive set of jest eslint rules
 
-- [padding-before-all](docs/rules/padding-before-all.md)
-- [padding-before-before-each-blocks](docs/rules/padding-before-before-each-blocks.md)
-- [padding-before-after-each-blocks](docs/rules/padding-before-after-each-blocks.md)
-- [padding-before-before-all-blocks](docs/rules/padding-before-before-all-blocks.md)
-- [padding-before-after-all-blocks](docs/rules/padding-before-after-all-blocks.md)
-- [padding-before-describe-blocks](docs/rules/padding-before-describe-blocks.md)
-- [padding-before-expect-statements](docs/rules/padding-before-expect-statements.md)
-- [padding-before-test-blocks](docs/rules/padding-before-test-blocks.md)
+https://github.com/jest-community/eslint-plugin-jest

package/docs/rules/padding-around-all.md

@@ -0,0 +1,13 @@
+# padding-around-all
+
+## Rule Details
+
+This is a meta rule that simply enables all of the following rules:
+
+- [padding-around-after-all-blocks](padding-around-after-all-blocks.md)
+- [padding-around-after-each-blocks](padding-around-after-each-blocks.md)
+- [padding-around-before-all-blocks](padding-around-before-all-blocks.md)
+- [padding-around-before-each-blocks](padding-around-before-each-blocks.md)
+- [padding-around-expect-groups](padding-around-expect-groups.md)
+- [padding-around-describe-blocks](padding-around-describe-blocks.md)
+- [padding-around-test-blocks](padding-around-test-blocks.md)

package/lib/ast-utils.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.getPaddingLineSequences = exports.getActualLastToken = exports.isValidParent = exports.areTokensOnSameLine = exports.isTokenASemicolon = void 0;
 exports.isTokenASemicolon = (token) => token.value === ';' && token.type === 'Punctuator';
 exports.areTokensOnSameLine = (left, right) => left.loc.end.line === right.loc.start.line;
 const STATEMENT_LIST_PARENTS = new Set([

package/lib/index.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.configs = exports.rules = void 0;
 const padding_1 = require("./rules/padding");
 const paddingConfigs = {
     afterAll: [
@@ -120,121 +121,50 @@ exports.rules = {
     'padding-around-describe-blocks': padding_1.createRule(paddingConfigs.describe),
     'padding-around-expect-groups': padding_1.createRule(paddingConfigs.expect),
     'padding-around-test-blocks': padding_1.createRule(paddingConfigs.test),
-    'padding-around-all': padding_1.createRule([].concat(...Object.keys(paddingConfigs).map(k => paddingConfigs[k]))),
-    'padding-before-after-all-blocks': padding_1.createRule([
-        {
-            paddingType: 1,
-            prevStatementType: 0,
-            nextStatementType: 1,
-        },
-    ], true),
-    'padding-before-after-each-blocks': padding_1.createRule([
-        {
-            paddingType: 1,
-            prevStatementType: 0,
-            nextStatementType: 2,
-        },
-    ], true),
-    'padding-before-before-all-blocks': padding_1.createRule([
-        {
-            paddingType: 1,
-            prevStatementType: 0,
-            nextStatementType: 3,
-        },
-    ], true),
-    'padding-before-before-each-blocks': padding_1.createRule([
-        {
-            paddingType: 1,
-            prevStatementType: 0,
-            nextStatementType: 4,
-        },
-    ], true),
-    'padding-before-describe-blocks': padding_1.createRule([
-        {
-            paddingType: 1,
-            prevStatementType: 0,
-            nextStatementType: 5,
-        },
-    ], true),
-    'padding-before-expect-statements': padding_1.createRule([
-        {
-            paddingType: 1,
-            prevStatementType: 0,
-            nextStatementType: 6,
-        },
-        {
-            paddingType: 0,
-            prevStatementType: 6,
-            nextStatementType: 6,
-        },
-    ], true),
-    'padding-before-test-blocks': padding_1.createRule([
-        {
-            paddingType: 1,
-            prevStatementType: 0,
-            nextStatementType: [10, 9],
-        },
-    ], true),
-    'padding-before-all': padding_1.createRule([
-        {
-            paddingType: 1,
-            prevStatementType: 0,
-            nextStatementType: [
-                1,
-                2,
-                3,
-                4,
-                5,
-                6,
-                9,
-                10,
-            ],
-        },
-        {
-            paddingType: 0,
-            prevStatementType: 6,
-            nextStatementType: 6,
-        },
-    ], true),
+    'padding-around-all': padding_1.createRule([].concat(...Object.keys(paddingConfigs).map((k) => paddingConfigs[k]))),
 };
 exports.configs = {
     recommended: {
         plugins: ['jest-formatting'],
-        overrides: {
-            files: [
-                '**/*.test.*',
-                '**/*_test.*',
-                '**/*Test.*',
-                '**/*.spec.*',
-                '**/*_spec.*',
-                '**/*Spec.*',
-                '**/__tests__/*',
-            ],
-            rules: {
-                'jest-formatting/padding-around-after-all-blocks': 2,
-                'jest-formatting/padding-around-after-each-blocks': 2,
-                'jest-formatting/padding-around-before-all-blocks': 2,
-                'jest-formatting/padding-around-before-each-blocks': 2,
-                'jest-formatting/padding-around-describe-blocks': 2,
-                'jest-formatting/padding-around-test-blocks': 2,
+        overrides: [
+            {
+                files: [
+                    '**/*.test.*',
+                    '**/*_test.*',
+                    '**/*Test.*',
+                    '**/*.spec.*',
+                    '**/*_spec.*',
+                    '**/*Spec.*',
+                    '**/__tests__/*',
+                ],
+                rules: {
+                    'jest-formatting/padding-around-after-all-blocks': 2,
+                    'jest-formatting/padding-around-after-each-blocks': 2,
+                    'jest-formatting/padding-around-before-all-blocks': 2,
+                    'jest-formatting/padding-around-before-each-blocks': 2,
+                    'jest-formatting/padding-around-describe-blocks': 2,
+                    'jest-formatting/padding-around-test-blocks': 2,
+                },
             },
-        },
+        ],
     },
     strict: {
         plugins: ['jest-formatting'],
-        overrides: {
-            files: [
-                '**/*.test.*',
-                '**/*_test.*',
-                '**/*Test.*',
-                '**/*.spec.*',
-                '**/*_spec.*',
-                '**/*Spec.*',
-                '**/__tests__/*',
-            ],
-            rules: {
-                'jest-formatting/padding-around-all': 2,
+        overrides: [
+            {
+                files: [
+                    '**/*.test.*',
+                    '**/*_test.*',
+                    '**/*Test.*',
+                    '**/*.spec.*',
+                    '**/*_spec.*',
+                    '**/*Spec.*',
+                    '**/__tests__/*',
+                ],
+                rules: {
+                    'jest-formatting/padding-around-all': 2,
+                },
             },
-        },
+        ],
     },
 };

package/lib/rules/padding.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.createRule = exports.PaddingType = exports.StatementType = void 0;
 const astUtils = require("../ast-utils");
 var StatementType;
 (function (StatementType) {
@@ -25,10 +26,15 @@ var PaddingType;
 })(PaddingType = exports.PaddingType || (exports.PaddingType = {}));
 const createTokenTester = (tokenName) => {
     return (node, sourceCode) => {
-        const token = sourceCode.getFirstToken(node);
-        return (node.type === 'ExpressionStatement' &&
-            token.type === 'Identifier' &&
-            token.value === tokenName);
+        let activeNode = node;
+        if (activeNode.type === 'ExpressionStatement') {
+            if (activeNode.expression.type === 'AwaitExpression') {
+                activeNode = activeNode.expression.argument;
+            }
+            const token = sourceCode.getFirstToken(activeNode);
+            return token.type === 'Identifier' && token.value === tokenName;
+        }
+        return false;
     };
 };
 const statementTesters = {
@@ -105,7 +111,7 @@ const nodeMatchesType = (node, statementType, paddingContext) => {
         innerStatementNode = innerStatementNode.body;
     }
     if (Array.isArray(statementType)) {
-        return statementType.some(type => nodeMatchesType(innerStatementNode, type, paddingContext));
+        return statementType.some((type) => nodeMatchesType(innerStatementNode, type, paddingContext));
     }
     return statementTesters[statementType](innerStatementNode, sourceCode);
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "eslint-plugin-jest-formatting",
-  "version": "1.1.1",
-  "description": "Formatting rules for jest tests",
+  "version": "3.0.0",
+  "description": "ESLint rules for formatting jest tests",
   "keywords": [
     "eslint",
     "eslintplugin",
@@ -20,8 +20,8 @@
   "module": "src/index.ts",
   "scripts": {
     "pretty": "yarn prettier '**/*.*'",
-    "lint": "yarn build && yarn link-plugin && yarn pretty --check && yarn eslint .",
-    "format": "yarn build && yarn link-plugin && yarn pretty --write && yarn eslint --fix .",
+    "lint": "yarn build && yarn link-plugin && yarn pretty --check && yarn eslint --ext .ts,.js .",
+    "format": "yarn build && yarn link-plugin && yarn pretty --write && yarn eslint --fix --ext .ts,.js .",
     "build": "tsc",
     "test": "yarn build && jest",
     "link-plugin": "yarn link && yarn link eslint-plugin-jest-formatting"
@@ -30,25 +30,26 @@
     "eslint": ">=0.8.0"
   },
   "devDependencies": {
-    "@types/eslint": "4.16.6",
-    "@types/estree": "0.0.39",
-    "@types/jest": "24.0.11",
-    "@types/node": "8.10.0",
-    "@typescript-eslint/parser": "1.10.2",
-    "eslint": "5.16.0",
-    "eslint-config-airbnb-base": "13.1.0",
-    "eslint-config-prettier": "5.0.0",
-    "eslint-plugin-import": "2.14.0",
-    "eslint-plugin-jest": "22.7.0",
+    "@types/eslint": "^7.2.0",
+    "@types/jest": "^26.0.0",
+    "@types/node": "^14.0.13",
+    "@typescript-eslint/eslint-plugin": "^3.4.0",
+    "@typescript-eslint/parser": "^3.4.0",
+    "eslint": "^7.3.1",
+    "eslint-config-airbnb-base": "^14.2.0",
+    "eslint-config-prettier": "^6.11.0",
+    "eslint-import-resolver-typescript": "^2.0.0",
+    "eslint-plugin-import": "^2.21.2",
+    "eslint-plugin-jest": "^23.17.1",
     "eslint-plugin-jest-formatting": "file:.",
-    "eslint-plugin-prettier": "3.1.0",
-    "jest": "24.8.0",
-    "prettier": "1.18.2",
-    "typescript": "3.4.1",
-    "ts-jest": "24.0.2"
+    "eslint-plugin-prettier": "^3.1.4",
+    "jest": "^26.1.0",
+    "prettier": "2.0.5",
+    "typescript": "^3.9.5",
+    "ts-jest": "^26.1.1"
   },
   "engines": {
-    "node": ">=8.10.0"
+    "node": "^10.12.0 || >=12.0.0"
   },
   "license": "MIT"
 }

package/src/ast-utils.ts

@@ -1,4 +1,6 @@
 import { AST, SourceCode } from 'eslint';
+// This is because we are using @types/estree that are brought in with eslint
+// eslint-disable-next-line import/no-extraneous-dependencies
 import { Node } from 'estree';
 
 export const isTokenASemicolon = (token: AST.Token): boolean =>

package/src/index.ts

@@ -131,157 +131,52 @@ export const rules = {
   'padding-around-expect-groups': createRule(paddingConfigs.expect),
   'padding-around-test-blocks': createRule(paddingConfigs.test),
   'padding-around-all': createRule(
-    [].concat(...Object.keys(paddingConfigs).map(k => paddingConfigs[k])),
-  ),
-
-  // ===========================================================================
-  // DEPRECATED
-  'padding-before-after-all-blocks': createRule(
-    [
-      {
-        paddingType: PaddingType.Always,
-        prevStatementType: StatementType.Any,
-        nextStatementType: StatementType.AfterAllToken,
-      },
-    ],
-    true,
-  ),
-  // DEPRECATED
-  'padding-before-after-each-blocks': createRule(
-    [
-      {
-        paddingType: PaddingType.Always,
-        prevStatementType: StatementType.Any,
-        nextStatementType: StatementType.AfterEachToken,
-      },
-    ],
-    true,
-  ),
-  // DEPRECATED
-  'padding-before-before-all-blocks': createRule(
-    [
-      {
-        paddingType: PaddingType.Always,
-        prevStatementType: StatementType.Any,
-        nextStatementType: StatementType.BeforeAllToken,
-      },
-    ],
-    true,
-  ),
-  // DEPRECATED
-  'padding-before-before-each-blocks': createRule(
-    [
-      {
-        paddingType: PaddingType.Always,
-        prevStatementType: StatementType.Any,
-        nextStatementType: StatementType.BeforeEachToken,
-      },
-    ],
-    true,
-  ),
-  // DEPRECATED
-  'padding-before-describe-blocks': createRule(
-    [
-      {
-        paddingType: PaddingType.Always,
-        prevStatementType: StatementType.Any,
-        nextStatementType: StatementType.DescribeToken,
-      },
-    ],
-    true,
-  ),
-  // DEPRECATED
-  'padding-before-expect-statements': createRule(
-    [
-      {
-        paddingType: PaddingType.Always,
-        prevStatementType: StatementType.Any,
-        nextStatementType: StatementType.ExpectToken,
-      },
-      {
-        paddingType: PaddingType.Any,
-        prevStatementType: StatementType.ExpectToken,
-        nextStatementType: StatementType.ExpectToken,
-      },
-    ],
-    true,
-  ),
-  // DEPRECATED
-  'padding-before-test-blocks': createRule(
-    [
-      {
-        paddingType: PaddingType.Always,
-        prevStatementType: StatementType.Any,
-        nextStatementType: [StatementType.TestToken, StatementType.ItToken],
-      },
-    ],
-    true,
-  ),
-  // DEPRECATED
-  'padding-before-all': createRule(
-    [
-      {
-        paddingType: PaddingType.Always,
-        prevStatementType: StatementType.Any,
-        nextStatementType: [
-          StatementType.AfterAllToken,
-          StatementType.AfterEachToken,
-          StatementType.BeforeAllToken,
-          StatementType.BeforeEachToken,
-          StatementType.DescribeToken,
-          StatementType.ExpectToken,
-          StatementType.ItToken,
-          StatementType.TestToken,
-        ],
-      },
-      {
-        paddingType: PaddingType.Any,
-        prevStatementType: StatementType.ExpectToken,
-        nextStatementType: StatementType.ExpectToken,
-      },
-    ],
-    true,
+    [].concat(...Object.keys(paddingConfigs).map((k) => paddingConfigs[k])),
   ),
 };
 
 export const configs = {
   recommended: {
     plugins: ['jest-formatting'],
-    overrides: {
-      files: [
-        '**/*.test.*',
-        '**/*_test.*',
-        '**/*Test.*',
-        '**/*.spec.*',
-        '**/*_spec.*',
-        '**/*Spec.*',
-        '**/__tests__/*',
-      ],
-      rules: {
-        'jest-formatting/padding-around-after-all-blocks': 2,
-        'jest-formatting/padding-around-after-each-blocks': 2,
-        'jest-formatting/padding-around-before-all-blocks': 2,
-        'jest-formatting/padding-around-before-each-blocks': 2,
-        'jest-formatting/padding-around-describe-blocks': 2,
-        'jest-formatting/padding-around-test-blocks': 2,
+    overrides: [
+      {
+        files: [
+          '**/*.test.*',
+          '**/*_test.*',
+          '**/*Test.*',
+          '**/*.spec.*',
+          '**/*_spec.*',
+          '**/*Spec.*',
+          '**/__tests__/*',
+        ],
+        rules: {
+          'jest-formatting/padding-around-after-all-blocks': 2,
+          'jest-formatting/padding-around-after-each-blocks': 2,
+          'jest-formatting/padding-around-before-all-blocks': 2,
+          'jest-formatting/padding-around-before-each-blocks': 2,
+          'jest-formatting/padding-around-describe-blocks': 2,
+          'jest-formatting/padding-around-test-blocks': 2,
+        },
       },
-    },
+    ],
   },
   strict: {
     plugins: ['jest-formatting'],
-    overrides: {
-      files: [
-        '**/*.test.*',
-        '**/*_test.*',
-        '**/*Test.*',
-        '**/*.spec.*',
-        '**/*_spec.*',
-        '**/*Spec.*',
-        '**/__tests__/*',
-      ],
-      rules: {
-        'jest-formatting/padding-around-all': 2,
+    overrides: [
+      {
+        files: [
+          '**/*.test.*',
+          '**/*_test.*',
+          '**/*Test.*',
+          '**/*.spec.*',
+          '**/*_spec.*',
+          '**/*Spec.*',
+          '**/__tests__/*',
+        ],
+        rules: {
+          'jest-formatting/padding-around-all': 2,
+        },
       },
-    },
+    ],
   },
 };

package/src/rules/padding.ts

@@ -9,6 +9,8 @@
  */
 
 import { AST, Rule, SourceCode } from 'eslint';
+// This is because we are using @types/estree that are brought in with eslint
+// eslint-disable-next-line import/no-extraneous-dependencies
 import { Node } from 'estree';
 import * as astUtils from '../ast-utils';
 
@@ -77,13 +79,20 @@ interface PaddingContext {
 // Creates a StatementTester to test an ExpressionStatement's first token name
 const createTokenTester = (tokenName: string): StatementTester => {
   return (node: Node, sourceCode: SourceCode): boolean => {
-    const token = sourceCode.getFirstToken(node);
+    let activeNode = node;
 
-    return (
-      node.type === 'ExpressionStatement' &&
-      token.type === 'Identifier' &&
-      token.value === tokenName
-    );
+    if (activeNode.type === 'ExpressionStatement') {
+      // In the case of `await`, we actually care about its argument
+      if (activeNode.expression.type === 'AwaitExpression') {
+        activeNode = activeNode.expression.argument;
+      }
+
+      const token = sourceCode.getFirstToken(activeNode);
+
+      return token.type === 'Identifier' && token.value === tokenName;
+    }
+
+    return false;
   };
 };
 
@@ -219,7 +228,7 @@ const nodeMatchesType = (
   // If it's an array recursively check if any of the statement types match
   // the node
   if (Array.isArray(statementType)) {
-    return statementType.some(type =>
+    return statementType.some((type) =>
       nodeMatchesType(innerStatementNode, type, paddingContext),
     );
   }
@@ -271,8 +280,8 @@ const verifyNode = (node: Node, paddingContext: PaddingContext): void => {
   //  ESTree.Node doesn't support the parent property which is added by
   //  ESLint during traversal. Our best bet is to ignore the property access
   //  here as it's the only place that it's checked.
-  // @ts-ignore
-  if (!astUtils.isValidParent(node.parent.type)) {
+  //  eslint-disable-next-line @typescript-eslint/no-explicit-any
+  if (!astUtils.isValidParent((node as any).parent.type)) {
     return;
   }
 
@@ -314,7 +323,7 @@ const verifyNode = (node: Node, paddingContext: PaddingContext): void => {
  */
 export const createRule = (
   configs: Config[],
-  deprecated: boolean = false,
+  deprecated = false,
 ): Rule.RuleModule => ({
   meta: {
     fixable: 'whitespace',