eslint-plugin-jest-formatting 3.0.0 → 4.0.0

package/lib/rules/padding.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createRule = exports.PaddingType = exports.StatementType = void 0;
+exports.createRule = exports.DOCS_BASE_URL = exports.messages = exports.getStatementToken = exports.PaddingType = exports.StatementType = void 0;
 const astUtils = require("../ast-utils");
 var StatementType;
 (function (StatementType) {
@@ -24,19 +24,29 @@ var PaddingType;
     PaddingType[PaddingType["Any"] = 0] = "Any";
     PaddingType[PaddingType["Always"] = 1] = "Always";
 })(PaddingType = exports.PaddingType || (exports.PaddingType = {}));
+const getStatementToken = (node, sourceCode) => {
+    let activeNode = node;
+    while (activeNode.type === 'LabeledStatement') {
+        activeNode = activeNode.body;
+    }
+    if (activeNode.type === 'ExpressionStatement') {
+        const expression = activeNode.expression.type === 'AwaitExpression'
+            ? activeNode.expression.argument
+            : activeNode;
+        const token = sourceCode.getFirstToken(expression);
+        return token.type === 'Identifier' ? token.value : null;
+    }
+    return null;
+};
+exports.getStatementToken = getStatementToken;
 const createTokenTester = (tokenName) => {
-    return (node, sourceCode) => {
-        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;
-    };
+    return (node, sourceCode) => (0, exports.getStatementToken)(node, sourceCode) === tokenName;
 };
+exports.messages = {
+    missingPaddingBefore: 'Missing blank line before `{{token}}`. Expected at least one blank line between the previous statement and this `{{token}}` call. Fix: insert an empty line between the statements, before any comments leading the next statement (autofixable with --fix).',
+    missingPaddingAfter: 'Missing blank line after `{{token}}`. Expected at least one blank line between the `{{token}}` call above and this statement. Fix: insert an empty line between the statements, before any comments leading the next statement (autofixable with --fix).',
+};
+exports.DOCS_BASE_URL = 'https://github.com/dangreenisrael/eslint-plugin-jest-formatting/blob/master/docs/rules';
 const statementTesters = {
     [0]: () => true,
     [1]: createTokenTester('afterAll'),
@@ -53,18 +63,23 @@ const statementTesters = {
     [12]: createTokenTester('xit'),
     [13]: createTokenTester('xtest'),
 };
-const paddingAlwaysTester = (prevNode, nextNode, paddingContext) => {
+const paddingAlwaysTester = (prevNode, nextNode, paddingContext, config) => {
     const { sourceCode, ruleContext } = paddingContext;
     const paddingLines = astUtils.getPaddingLineSequences(prevNode, nextNode, sourceCode);
     if (paddingLines.length > 0) {
         return;
     }
+    const nextIsJestCall = config !== undefined && config.nextStatementType !== 0;
+    const tokenNode = nextIsJestCall ? nextNode : prevNode;
     ruleContext.report({
         node: nextNode,
-        message: 'Expected blank line before this statement.',
+        messageId: nextIsJestCall ? 'missingPaddingBefore' : 'missingPaddingAfter',
+        data: {
+            token: (0, exports.getStatementToken)(tokenNode, sourceCode) || '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)) {
@@ -73,7 +88,7 @@ const paddingAlwaysTester = (prevNode, nextNode, paddingContext) => {
                     }
                     return true;
                 },
-            }) || nextNode;
+            }) || nextNode);
             const insertText = astUtils.areTokensOnSameLine(prevToken, nextToken)
                 ? '\n\n'
                 : '\n';
@@ -117,12 +132,13 @@ const nodeMatchesType = (node, statementType, paddingContext) => {
 };
 const testPadding = (prevNode, nextNode, paddingContext) => {
     const { configs } = paddingContext;
-    const testType = (type) => paddingTesters[type](prevNode, nextNode, paddingContext);
+    const testType = (type, config) => paddingTesters[type](prevNode, nextNode, paddingContext, config);
     for (let i = configs.length - 1; i >= 0; --i) {
-        const { prevStatementType: prevType, nextStatementType: nextType, paddingType, } = configs[i];
+        const config = configs[i];
+        const { prevStatementType: prevType, nextStatementType: nextType, paddingType, } = config;
         if (nodeMatchesType(prevNode, prevType, paddingContext) &&
             nodeMatchesType(nextNode, nextType, paddingContext)) {
-            return testType(paddingType);
+            return testType(paddingType, config);
         }
     }
     return testType(0);
@@ -137,15 +153,24 @@ const verifyNode = (node, paddingContext) => {
     }
     scopeInfo.prevNode = node;
 };
-exports.createRule = (configs, deprecated = false) => ({
+const createRule = ({ name, description, configs, deprecated = false, }) => ({
     meta: {
+        type: 'layout',
+        docs: {
+            description,
+            url: `${exports.DOCS_BASE_URL}/${name}.md`,
+        },
         fixable: 'whitespace',
+        messages: exports.messages,
+        schema: [],
         deprecated,
     },
     create(context) {
+        const sourceCode = context.sourceCode ||
+            context.getSourceCode();
         const paddingContext = {
             ruleContext: context,
-            sourceCode: context.getSourceCode(),
+            sourceCode,
             scopeInfo: createScopeInfo(),
             configs,
         };
@@ -166,3 +191,4 @@ exports.createRule = (configs, deprecated = false) => ({
         };
     },
 });
+exports.createRule = createRule;

package/llms.txt

@@ -0,0 +1,29 @@
+# eslint-plugin-jest-formatting
+
+> ESLint rules that require a blank line before and after Jest blocks: `describe`, `test`/`it`, `beforeAll`, `beforeEach`, `afterAll`, `afterEach`, and groups of `expect` statements. Every rule is autofixable with `eslint --fix`, takes no options, and reports a message that states the problem and the fix. Works with ESLint 8, 9, and 10 in flat config and legacy `.eslintrc`.
+
+Install with `npm install --save-dev eslint-plugin-jest-formatting`. Enable `jestFormatting.configs['flat/recommended']` in `eslint.config.js`, or `"extends": ["plugin:jest-formatting/recommended"]` in `.eslintrc`. The `strict` variants enable `padding-around-all`, which also pads `expect` groups.
+
+## Start here
+
+- [AGENTS.md](https://raw.githubusercontent.com/dangreenisrael/eslint-plugin-jest-formatting/master/AGENTS.md): one-page briefing: purpose, every rule in one line, flat and legacy config snippets, how to build and test
+- [README](https://raw.githubusercontent.com/dangreenisrael/eslint-plugin-jest-formatting/master/README.md): installation and configuration
+
+## Rules
+
+Each page has the same sections in the same order: Rule summary, Why, Incorrect examples, Correct examples, Options, Fixability.
+
+- [padding-around-after-all-blocks](https://raw.githubusercontent.com/dangreenisrael/eslint-plugin-jest-formatting/master/docs/rules/padding-around-after-all-blocks.md): blank line before and after each `afterAll` call
+- [padding-around-after-each-blocks](https://raw.githubusercontent.com/dangreenisrael/eslint-plugin-jest-formatting/master/docs/rules/padding-around-after-each-blocks.md): blank line before and after each `afterEach` call
+- [padding-around-before-all-blocks](https://raw.githubusercontent.com/dangreenisrael/eslint-plugin-jest-formatting/master/docs/rules/padding-around-before-all-blocks.md): blank line before and after each `beforeAll` call
+- [padding-around-before-each-blocks](https://raw.githubusercontent.com/dangreenisrael/eslint-plugin-jest-formatting/master/docs/rules/padding-around-before-each-blocks.md): blank line before and after each `beforeEach` call
+- [padding-around-describe-blocks](https://raw.githubusercontent.com/dangreenisrael/eslint-plugin-jest-formatting/master/docs/rules/padding-around-describe-blocks.md): blank line before and after each `describe`, `fdescribe`, or `xdescribe` block
+- [padding-around-expect-groups](https://raw.githubusercontent.com/dangreenisrael/eslint-plugin-jest-formatting/master/docs/rules/padding-around-expect-groups.md): blank line before and after each run of consecutive `expect` statements, not between them
+- [padding-around-test-blocks](https://raw.githubusercontent.com/dangreenisrael/eslint-plugin-jest-formatting/master/docs/rules/padding-around-test-blocks.md): blank line before and after each `test`, `it`, `fit`, `xit`, or `xtest` block
+- [padding-around-all](https://raw.githubusercontent.com/dangreenisrael/eslint-plugin-jest-formatting/master/docs/rules/padding-around-all.md): all of the above as a single rule; used by the `strict` configs
+
+## Optional
+
+- [CHANGELOG](https://raw.githubusercontent.com/dangreenisrael/eslint-plugin-jest-formatting/master/CHANGELOG.md): release history
+- [Source repository](https://github.com/dangreenisrael/eslint-plugin-jest-formatting): issues and pull requests
+- [npm package](https://www.npmjs.com/package/eslint-plugin-jest-formatting): published releases

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-jest-formatting",
-  "version": "3.0.0",
+  "version": "4.0.0",
   "description": "ESLint rules for formatting jest tests",
   "keywords": [
     "eslint",
@@ -14,42 +14,49 @@
   "author": "Dan Green-Leipciger",
   "repository": {
     "type": "git",
-    "url": "https://github.com/dangreenisrael/eslint-plugin-jest-formatting"
+    "url": "git+https://github.com/dangreenisrael/eslint-plugin-jest-formatting.git"
   },
   "main": "lib/index.js",
-  "module": "src/index.ts",
+  "files": [
+    "lib",
+    "docs",
+    "AGENTS.md",
+    "llms.txt",
+    "CHANGELOG.md"
+  ],
   "scripts": {
     "pretty": "yarn prettier '**/*.*'",
     "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",
+    "prepack": "tsc",
     "test": "yarn build && jest",
     "link-plugin": "yarn link && yarn link eslint-plugin-jest-formatting"
   },
   "peerDependencies": {
-    "eslint": ">=0.8.0"
+    "eslint": "^8.0.0 || ^9.0.0 || ^10.0.0"
   },
   "devDependencies": {
-    "@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",
+    "@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.57.1",
+    "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.4",
-    "jest": "^26.1.0",
-    "prettier": "2.0.5",
-    "typescript": "^3.9.5",
-    "ts-jest": "^26.1.1"
+    "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": "^10.12.0 || >=12.0.0"
+    "node": ">=22.0.0"
   },
   "license": "MIT"
 }

package/.circleci/config.yml

@@ -1,67 +0,0 @@
-# Javascript Node CircleCI 2.0 configuration file
-#
-# Check https://circleci.com/docs/2.0/language-javascript/ for more details
-#
-version: 2
-
-defaults: &defaults
-  working_directory: ~/repo
-  docker:
-    - image: circleci/node:10
-
-jobs:
-  test:
-    <<: *defaults
-    steps:
-      - checkout
-
-      - restore_cache:
-          keys:
-            - v1-dependencies-{{ checksum "package.json" }}
-            # fallback to using the latest cache if no exact match is found
-            - v1-dependencies-
-
-      - run: yarn
-
-      - run:
-          name: Run tests
-          command: yarn test
-
-      - run: yarn lint
-
-      - save_cache:
-          paths:
-            - node_modules
-          key: v1-dependencies-{{ checksum "package.json" }}
-
-      - persist_to_workspace:
-          root: ~/repo
-          paths: .
-  deploy:
-    <<: *defaults
-    steps:
-      - attach_workspace:
-          at: ~/repo
-      - run:
-          name: Authenticate with registry
-          command: echo "//registry.npmjs.org/:_authToken=$NPM_TOKEN" > ~/repo/.npmrc
-      - run:
-          name: Publish package
-          command: npm publish
-
-workflows:
-  version: 2
-  test-deploy:
-    jobs:
-      - test:
-          filters:
-            tags:
-              only: /^v.*/
-      - deploy:
-          requires:
-            - test
-          filters:
-            tags:
-              only: /^v.*/
-            branches:
-              ignore: /.*/

package/.eslintignore

@@ -1,3 +0,0 @@
-lib
-node_modules
-*.log

package/.eslintrc

@@ -1,34 +0,0 @@
-{
-  "parser": "@typescript-eslint/parser",
-  "parserOptions": {
-    "sourceType": "module"
-  },
-  "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:import/typescript"
-  ],
-  "overrides": [
-    {
-      "files": ["**.*"],
-      "rules": {
-        "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/.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,31 +0,0 @@
----
-name: Bug report
-about: Create a report to help us improve
-title: '[BUG]'
-labels: bug
-assignees: dangreenisrael
----
-
-**Describe the bug**
-A clear and concise description of what the bug is.
-
-**To Reproduce**
-Steps to reproduce the behavior:
-
-1. Go to '...'
-2. Click on '....'
-3. Scroll down to '....'
-4. See error
-
-**Expected behavior**
-A clear and concise description of what you expected to happen.
-
-**Screenshots**
-If applicable, add screenshots to help explain your problem.
-
-**Desktop (please complete the following information):**
-
-- OS: [e.g. Mac, Linux Desktop, Linux CI, Windows]
-
-**Additional context**
-Add any other context about the problem here.

package/.github/ISSUE_TEMPLATE/rule-request.md

@@ -1,21 +0,0 @@
----
-name: Rule Request
-about: Request a new formatting rule
-title: '[Rule]'
-labels: Rule Request
-assignees: dangreenisrael
----
-
-_Explanation of the rule_
-
-_Valid code example_
-
-```JavaScript
-
-```
-
-_Invalid code example_
-
-```JavaScript
-
-```

package/.prettierignore

@@ -1,4 +0,0 @@
-*.lock
-.*
-*.log
-lib

package/.prettierrc

@@ -1,4 +0,0 @@
-{
-  "trailingComma": "all",
-  "singleQuote": true
-}

package/docs/rules/padding-before-after-all-blocks.md

@@ -1,24 +0,0 @@
-# padding-before-after-all-blocks
-
-## Rule Details
-
-This rule enforces a line of padding before afterAll blocks
-
-Examples of **incorrect** code for this rule:
-
-```js
-const something = 123;
-afterAll(() => {
-  // more stuff
-});
-```
-
-Examples of **correct** code for this rule:
-
-```js
-const something = 123;
-
-afterAll(() => {
-  // more stuff
-});
-```

package/docs/rules/padding-before-after-each-blocks.md

@@ -1,24 +0,0 @@
-# padding-before-after-each-blocks
-
-## Rule Details
-
-This rule enforces a line of padding before afterEach blocks
-
-Examples of **incorrect** code for this rule:
-
-```js
-const something = 123;
-afterEach(() => {
-  // more stuff
-});
-```
-
-Examples of **correct** code for this rule:
-
-```js
-const something = 123;
-
-afterEach(() => {
-  // more stuff
-});
-```

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

@@ -1,15 +0,0 @@
-# padding-before-after-all-blocks
-
-## Rule Details
-
-This rule enforces a line of padding before all Jest tokens.
-
-See each individual rules for examples.
-
-- [padding-before-after-all-blocks](docs/rules/padding-before-after-all-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-before-each-blocks](docs/rules/padding-before-before-each-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)

package/docs/rules/padding-before-before-all-blocks.md

@@ -1,24 +0,0 @@
-# padding-before-before-all-blocks
-
-## Rule Details
-
-This rule enforces a line of padding before beforeAll blocks
-
-Examples of **incorrect** code for this rule:
-
-```js
-const something = 123;
-beforeAll(() => {
-  // more stuff
-});
-```
-
-Examples of **correct** code for this rule:
-
-```js
-const something = 123;
-
-beforeAll(() => {
-  // more stuff
-});
-```

package/docs/rules/padding-before-before-each-blocks.md

@@ -1,24 +0,0 @@
-# padding-before-before-each-blocks
-
-## Rule Details
-
-This rule enforces a line of padding before beforeEach blocks
-
-Examples of **incorrect** code for this rule:
-
-```js
-const something = 123;
-beforeEach(() => {
-  // more stuff
-});
-```
-
-Examples of **correct** code for this rule:
-
-```js
-const something = 123;
-
-beforeEach(() => {
-  // more stuff
-});
-```

package/docs/rules/padding-before-describe-blocks.md

@@ -1,28 +0,0 @@
-# padding-before-describe-blocks
-
-## Rule Details
-
-This rule enforces a line of padding before describe blocks
-
-Examples of **incorrect** code for this rule:
-
-```js
-describe('foo', () => {
-  // stuff
-});
-describe('bar', () => {
-  // more stuff
-});
-```
-
-Examples of **correct** code for this rule:
-
-```js
-describe('foo', () => {
-  // stuff
-});
-
-describe('bar', () => {
-  // more stuff
-});
-```

package/docs/rules/padding-before-expect-statements.md

@@ -1,22 +0,0 @@
-# padding-before-expect-statements
-
-## Rule Details
-
-This rule enforces a line of padding before non-consecutive expect statements
-
-Examples of **incorrect** code for this rule:
-
-```js
-const something = 123;
-expect(something).toEqual(123);
-expect(something).toBeGreaterThan(0);
-```
-
-Examples of **correct** code for this rule:
-
-```js
-const something = 123;
-
-expect(something).toEqual(123);
-expect(something).toBeGreaterThan(0);
-```

package/docs/rules/padding-before-test-blocks.md

@@ -1,31 +0,0 @@
-# padding-before-test-blocks
-
-## Rule Details
-
-This rule enforces a line of padding before test/it blocks
-
-Examples of **incorrect** code for this rule:
-
-```js
-test('foo', () => {});
-test('bar', () => {});
-```
-
-```js
-it('foo', () => {});
-it('bar', () => {});
-```
-
-Examples of **correct** code for this rule:
-
-```js
-test('foo', () => {});
-
-test('bar', () => {});
-```
-
-```js
-it('foo', () => {});
-
-it('bar', () => {});
-```

package/jest.config.js

@@ -1,4 +0,0 @@
-module.exports = {
-  preset: 'ts-jest',
-  testEnvironment: 'node',
-};

package/renovate.json

@@ -1,3 +0,0 @@
-{
-  "extends": ["config:base"]
-}