eslint-plugin-jest-formatting 1.1.0 → 2.0.1

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/README.md

@@ -1,20 +1,22 @@
 [![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):
 
 ```
-$ yarn add eslint -dev
+$ yarn add eslint --dev
 ```
 
 Next, install `eslint-plugin-jest-formatting`:
@@ -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

@@ -0,0 +1,41 @@
+"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([
+    'Program',
+    'BlockStatement',
+    'SwitchCase',
+    'SwitchStatement',
+]);
+exports.isValidParent = (parentType) => {
+    return STATEMENT_LIST_PARENTS.has(parentType);
+};
+exports.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) &&
+        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) => {
+    const pairs = [];
+    const includeComments = true;
+    let prevToken = exports.getActualLastToken(sourceCode, prevNode);
+    if (nextNode.loc.start.line - prevToken.loc.end.line >= 2) {
+        do {
+            const token = sourceCode.getTokenAfter(prevToken, { includeComments });
+            if (token.loc.start.line - prevToken.loc.end.line >= 2) {
+                pairs.push([prevToken, token]);
+            }
+            prevToken = token;
+        } while (prevToken.range[0] < nextNode.range[0]);
+    }
+    return pairs;
+};

package/lib/index.js

@@ -1,98 +1,170 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const utils_1 = require("./utils");
-exports.rules = {
-    'padding-around-after-all-blocks': utils_1.makeRule([
-        { blankLine: 'always', prev: '*', next: 'afterAll' },
-        { blankLine: 'always', prev: 'afterAll', next: '*' },
-    ]),
-    'padding-around-after-each-blocks': utils_1.makeRule([
-        { blankLine: 'always', prev: '*', next: 'afterEach' },
-        { blankLine: 'always', prev: 'afterEach', next: '*' },
-    ]),
-    'padding-around-before-all-blocks': utils_1.makeRule([
-        { blankLine: 'always', prev: '*', next: 'beforeAll' },
-        { blankLine: 'always', prev: 'beforeAll', next: '*' },
-    ]),
-    'padding-around-before-each-blocks': utils_1.makeRule([
-        { blankLine: 'always', prev: '*', next: 'beforeEach' },
-        { blankLine: 'always', prev: 'beforeEach', next: '*' },
-    ]),
-    'padding-around-describe-blocks': utils_1.makeRule([
-        { blankLine: 'always', prev: '*', next: 'describe' },
-        { blankLine: 'always', prev: 'describe', next: '*' },
-    ]),
-    'padding-around-test-blocks': utils_1.makeRule([
-        { blankLine: 'always', prev: '*', next: ['test', 'it'] },
-        { blankLine: 'always', prev: ['test', 'it'], next: '*' },
-    ]),
-    'padding-before-after-all-blocks': utils_1.makeRule([
-        { blankLine: 'always', prev: '*', next: 'afterAll' },
-    ]),
-    'padding-before-after-each-blocks': utils_1.makeRule([
-        { blankLine: 'always', prev: '*', next: 'afterEach' },
-    ]),
-    'padding-before-before-all-blocks': utils_1.makeRule([
-        { blankLine: 'always', prev: '*', next: 'beforeAll' },
-    ]),
-    'padding-before-before-each-blocks': utils_1.makeRule([
-        { blankLine: 'always', prev: '*', next: 'beforeEach' },
-    ]),
-    'padding-before-describe-blocks': utils_1.makeRule([
-        { blankLine: 'always', prev: '*', next: 'describe' },
-    ]),
-    'padding-before-expect-statements': utils_1.makeRule([
-        { blankLine: 'always', prev: '*', next: 'expect' },
-        { blankLine: 'any', prev: 'expect', next: 'expect' },
-    ]),
-    'padding-around-expect-groups': utils_1.makeRule([
-        { blankLine: 'always', prev: '*', next: 'expect' },
-        { blankLine: 'always', prev: 'expect', next: '*' },
-        { blankLine: 'any', prev: 'expect', next: 'expect' },
-    ]),
-    'padding-before-test-blocks': utils_1.makeRule([
-        { blankLine: 'always', prev: '*', next: ['test', 'it'] },
-    ]),
-    'padding-before-all': utils_1.makeRule([
+exports.configs = exports.rules = void 0;
+const padding_1 = require("./rules/padding");
+const paddingConfigs = {
+    afterAll: [
+        {
+            paddingType: 1,
+            prevStatementType: 0,
+            nextStatementType: 1,
+        },
+        {
+            paddingType: 1,
+            prevStatementType: 1,
+            nextStatementType: 0,
+        },
+    ],
+    afterEach: [
+        {
+            paddingType: 1,
+            prevStatementType: 0,
+            nextStatementType: 2,
+        },
+        {
+            paddingType: 1,
+            prevStatementType: 2,
+            nextStatementType: 0,
+        },
+    ],
+    beforeAll: [
+        {
+            paddingType: 1,
+            prevStatementType: 0,
+            nextStatementType: 3,
+        },
+        {
+            paddingType: 1,
+            prevStatementType: 3,
+            nextStatementType: 0,
+        },
+    ],
+    beforeEach: [
+        {
+            paddingType: 1,
+            prevStatementType: 0,
+            nextStatementType: 4,
+        },
+        {
+            paddingType: 1,
+            prevStatementType: 4,
+            nextStatementType: 0,
+        },
+    ],
+    describe: [
+        {
+            paddingType: 1,
+            prevStatementType: 0,
+            nextStatementType: [
+                5,
+                7,
+                11,
+            ],
+        },
+        {
+            paddingType: 1,
+            prevStatementType: [
+                5,
+                7,
+                11,
+            ],
+            nextStatementType: 0,
+        },
+    ],
+    expect: [
+        {
+            paddingType: 1,
+            prevStatementType: 0,
+            nextStatementType: 6,
+        },
+        {
+            paddingType: 1,
+            prevStatementType: 6,
+            nextStatementType: 0,
+        },
         {
-            blankLine: 'always',
-            prev: '*',
-            next: [
-                'afterAll',
-                'afterEach',
-                'beforeAll',
-                'beforeEach',
-                'describe',
-                'expect',
-                'it',
-                'test',
+            paddingType: 0,
+            prevStatementType: 6,
+            nextStatementType: 6,
+        },
+    ],
+    test: [
+        {
+            paddingType: 1,
+            prevStatementType: 0,
+            nextStatementType: [
+                10,
+                9,
+                8,
+                12,
+                13,
+            ],
+        },
+        {
+            paddingType: 1,
+            prevStatementType: [
+                10,
+                9,
+                8,
+                12,
+                13,
             ],
+            nextStatementType: 0,
         },
-        { blankLine: 'any', prev: 'expect', next: 'expect' },
-    ]),
+    ],
+};
+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]))),
 };
 exports.configs = {
     recommended: {
         plugins: ['jest-formatting'],
-        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'],
-        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-expect-groups': 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-all': 2,
+                },
+            },
+        ],
     },
 };