eslint-plugin-jest-formatting 1.2.0 → 3.1.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:12
 
 jobs:
   test:
@@ -28,7 +28,7 @@ jobs:
           command: yarn test
 
       - run: yarn lint
-      
+
       - save_cache:
           paths:
             - node_modules

package/.eslintrc

@@ -3,21 +3,34 @@
   "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",
+        "no-shadow": "off",
+        "@typescript-eslint/no-shadow": "error"
       }
     }
-  ]
+  ],
+  "settings": {
+    "import/resolver": {
+      "typescript": {
+        "alwaysTryTypes": true // Without this `@types/estree` `estree` isn't actually in our node_modules.
+      }
+    }
+  }
 }

package/.github/workflows/codeql-analysis.yml

@@ -0,0 +1,71 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ master ]
+  schedule:
+    - cron: '42 12 * * 5'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'javascript' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ]
+        # Learn more:
+        # https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v1
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        # queries: ./path/to/local/query, your-org/your-repo/queries@main
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v1
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 https://git.io/JvXDl
+
+    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+    #    and modify them (or add more) to build your code if your project
+    #    uses a compiled language
+
+    #- run: |
+    #   make bootstrap
+    #   make release
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v1

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):
@@ -75,13 +77,10 @@ We also support a "strict" settings which enabled all of the rules for you
 - [padding-around-test-blocks](docs/rules/padding-around-test-blocks.md)
 - [padding-around-all](docs/rules/padding-around-all.md)
 
-### Deprecated
+## Related Projects
+
+### eslint-plugin-jest
+
+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/lib/ast-utils.js

@@ -1,35 +1,42 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isTokenASemicolon = (token) => token.value === ';' && token.type === 'Punctuator';
-exports.areTokensOnSameLine = (left, right) => left.loc.end.line === right.loc.start.line;
+exports.getPaddingLineSequences = exports.getActualLastToken = exports.isValidParent = exports.areTokensOnSameLine = exports.isTokenASemicolon = void 0;
+const isTokenASemicolon = (token) => token.value === ';' && token.type === 'Punctuator';
+exports.isTokenASemicolon = isTokenASemicolon;
+const areTokensOnSameLine = (left, right) => left.loc.end.line === right.loc.start.line;
+exports.areTokensOnSameLine = areTokensOnSameLine;
 const STATEMENT_LIST_PARENTS = new Set([
     'Program',
     'BlockStatement',
     'SwitchCase',
     'SwitchStatement',
 ]);
-exports.isValidParent = (parentType) => {
+const isValidParent = (parentType) => {
     return STATEMENT_LIST_PARENTS.has(parentType);
 };
-exports.getActualLastToken = (sourceCode, node) => {
+exports.isValidParent = isValidParent;
+const getActualLastToken = (sourceCode, node) => {
     const semiToken = sourceCode.getLastToken(node);
     const prevToken = sourceCode.getTokenBefore(semiToken);
     const nextToken = sourceCode.getTokenAfter(semiToken);
     const isSemicolonLessStyle = Boolean(prevToken &&
         nextToken &&
         prevToken.range[0] >= node.range[0] &&
-        exports.isTokenASemicolon(semiToken) &&
+        (0, exports.isTokenASemicolon)(semiToken) &&
         semiToken.loc.start.line !== prevToken.loc.end.line &&
         semiToken.loc.end.line === nextToken.loc.start.line);
     return isSemicolonLessStyle ? prevToken : semiToken;
 };
-exports.getPaddingLineSequences = (prevNode, nextNode, sourceCode) => {
+exports.getActualLastToken = getActualLastToken;
+const getPaddingLineSequences = (prevNode, nextNode, sourceCode) => {
     const pairs = [];
     const includeComments = true;
-    let prevToken = exports.getActualLastToken(sourceCode, prevNode);
+    let prevToken = (0, exports.getActualLastToken)(sourceCode, prevNode);
     if (nextNode.loc.start.line - prevToken.loc.end.line >= 2) {
         do {
-            const token = sourceCode.getTokenAfter(prevToken, { includeComments });
+            const token = sourceCode.getTokenAfter(prevToken, {
+                includeComments,
+            });
             if (token.loc.start.line - prevToken.loc.end.line >= 2) {
                 pairs.push([prevToken, token]);
             }
@@ -38,3 +45,4 @@ exports.getPaddingLineSequences = (prevNode, nextNode, sourceCode) => {
     }
     return pairs;
 };
+exports.getPaddingLineSequences = getPaddingLineSequences;

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: [
@@ -113,89 +114,14 @@ const paddingConfigs = {
     ],
 };
 exports.rules = {
-    'padding-around-after-all-blocks': padding_1.createRule(paddingConfigs.afterAll),
-    'padding-around-after-each-blocks': padding_1.createRule(paddingConfigs.afterEach),
-    'padding-around-before-all-blocks': padding_1.createRule(paddingConfigs.beforeAll),
-    'padding-around-before-each-blocks': padding_1.createRule(paddingConfigs.beforeEach),
-    '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-after-all-blocks': (0, padding_1.createRule)(paddingConfigs.afterAll),
+    'padding-around-after-each-blocks': (0, padding_1.createRule)(paddingConfigs.afterEach),
+    'padding-around-before-all-blocks': (0, padding_1.createRule)(paddingConfigs.beforeAll),
+    'padding-around-before-each-blocks': (0, padding_1.createRule)(paddingConfigs.beforeEach),
+    'padding-around-describe-blocks': (0, padding_1.createRule)(paddingConfigs.describe),
+    'padding-around-expect-groups': (0, padding_1.createRule)(paddingConfigs.expect),
+    'padding-around-test-blocks': (0, padding_1.createRule)(paddingConfigs.test),
+    'padding-around-all': (0, padding_1.createRule)([].concat(...Object.keys(paddingConfigs).map((k) => paddingConfigs[k]))),
 };
 exports.configs = {
     recommended: {

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 = {
@@ -58,7 +64,7 @@ const paddingAlwaysTester = (prevNode, nextNode, paddingContext) => {
         message: 'Expected blank line before this statement.',
         fix(fixer) {
             let prevToken = astUtils.getActualLastToken(sourceCode, prevNode);
-            const nextToken = sourceCode.getFirstTokenBetween(prevToken, nextNode, {
+            const nextToken = (sourceCode.getFirstTokenBetween(prevToken, nextNode, {
                 includeComments: true,
                 filter(token) {
                     if (astUtils.areTokensOnSameLine(prevToken, token)) {
@@ -67,7 +73,7 @@ const paddingAlwaysTester = (prevNode, nextNode, paddingContext) => {
                     }
                     return true;
                 },
-            }) || nextNode;
+            }) || nextNode);
             const insertText = astUtils.areTokensOnSameLine(prevToken, nextToken)
                 ? '\n\n'
                 : '\n';
@@ -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);
 };
@@ -131,7 +137,7 @@ const verifyNode = (node, paddingContext) => {
     }
     scopeInfo.prevNode = node;
 };
-exports.createRule = (configs, deprecated = false) => ({
+const createRule = (configs, deprecated = false) => ({
     meta: {
         fixable: 'whitespace',
         deprecated,
@@ -160,3 +166,4 @@ exports.createRule = (configs, deprecated = false) => ({
         };
     },
 });
+exports.createRule = createRule;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "eslint-plugin-jest-formatting",
-  "version": "1.2.0",
-  "description": "Formatting rules for jest tests",
+  "version": "3.1.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.29.0",
+    "@types/jest": "^27.0.2",
+    "@types/node": "^16.11.7",
+    "@typescript-eslint/eslint-plugin": "^5.4.0",
+    "@typescript-eslint/parser": "^5.4.0",
+    "eslint": "^8.2.0",
+    "eslint-config-airbnb-base": "^15.0.0",
+    "eslint-config-prettier": "^8.3.0",
+    "eslint-import-resolver-typescript": "^2.5.0",
+    "eslint-plugin-import": "^2.25.3",
+    "eslint-plugin-jest": "^25.2.4",
     "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": "^4.0.0",
+    "jest": "^27.3.1",
+    "prettier": "2.4.1",
+    "typescript": "^4.4.4",
+    "ts-jest": "^27.0.7"
   },
   "engines": {
-    "node": ">=8.10.0"
+    "node": "^12.22.0 || ^14.17.0 || >=16.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 =>
@@ -64,7 +66,9 @@ export const getPaddingLineSequences = (
 
   if (nextNode.loc.start.line - prevToken.loc.end.line >= 2) {
     do {
-      const token = sourceCode.getTokenAfter(prevToken, { includeComments });
+      const token = sourceCode.getTokenAfter(prevToken, {
+        includeComments,
+      }) as AST.Token;
 
       if (token.loc.start.line - prevToken.loc.end.line >= 2) {
         pairs.push([prevToken, token]);

package/src/index.ts

@@ -131,116 +131,7 @@ 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])),
   ),
 };