eslint-plugin-jest-formatting 3.0.0 → 3.1.0

package/.circleci/config.yml

@@ -7,7 +7,7 @@ version: 2
 defaults: &defaults
   working_directory: ~/repo
   docker:
-    - image: circleci/node:10
+    - image: circleci/node:12
 
 jobs:
   test:

package/.eslintrc

@@ -20,7 +20,9 @@
       "rules": {
         "camelcase": "off",
         "no-plusplus": "off",
-        "import/extensions": "off"
+        "import/extensions": "off",
+        "no-shadow": "off",
+        "@typescript-eslint/no-shadow": "error"
       }
     }
   ],

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/lib/ast-utils.js

@@ -1,36 +1,42 @@
 "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 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]);
             }
@@ -39,3 +45,4 @@ exports.getPaddingLineSequences = (prevNode, nextNode, sourceCode) => {
     }
     return pairs;
 };
+exports.getPaddingLineSequences = getPaddingLineSequences;

package/lib/index.js

@@ -114,14 +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-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

@@ -64,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)) {
@@ -73,7 +73,7 @@ const paddingAlwaysTester = (prevNode, nextNode, paddingContext) => {
                     }
                     return true;
                 },
-            }) || nextNode;
+            }) || nextNode);
             const insertText = astUtils.areTokensOnSameLine(prevToken, nextToken)
                 ? '\n\n'
                 : '\n';
@@ -137,7 +137,7 @@ const verifyNode = (node, paddingContext) => {
     }
     scopeInfo.prevNode = node;
 };
-exports.createRule = (configs, deprecated = false) => ({
+const createRule = (configs, deprecated = false) => ({
     meta: {
         fixable: 'whitespace',
         deprecated,
@@ -166,3 +166,4 @@ exports.createRule = (configs, deprecated = false) => ({
         };
     },
 });
+exports.createRule = createRule;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-jest-formatting",
-  "version": "3.0.0",
+  "version": "3.1.0",
   "description": "ESLint rules for formatting jest tests",
   "keywords": [
     "eslint",
@@ -30,26 +30,26 @@
     "eslint": ">=0.8.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.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.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": "^12.22.0 || ^14.17.0 || >=16.0.0"
   },
   "license": "MIT"
 }

package/src/ast-utils.ts

@@ -66,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/rules/padding.ts

@@ -42,12 +42,6 @@ export const enum PaddingType {
   Always,
 }
 
-type PaddingTester = (
-  prevNode: Node,
-  nextNode: Node,
-  paddingContext: PaddingContext,
-) => void;
-
 // A configuration object for padding type and the two statement types
 export interface Config {
   paddingType: PaddingType;
@@ -55,14 +49,6 @@ export interface Config {
   nextStatementType: StatementTypes;
 }
 
-// Tracks position in scope and prevNode. Used to compare current and prev node
-// and then to walk back up to the parent scope or down into the next one.
-// And so on...
-interface Scope {
-  upper: Scope | null;
-  prevNode: Node | null;
-}
-
 interface ScopeInfo {
   prevNode: Node | null;
   enter: () => void;
@@ -76,6 +62,20 @@ interface PaddingContext {
   configs: Config[];
 }
 
+type PaddingTester = (
+  prevNode: Node,
+  nextNode: Node,
+  paddingContext: PaddingContext,
+) => void;
+
+// Tracks position in scope and prevNode. Used to compare current and prev node
+// and then to walk back up to the parent scope or down into the next one.
+// And so on...
+interface Scope {
+  upper: Scope | null;
+  prevNode: Node | null;
+}
+
 // Creates a StatementTester to test an ExpressionStatement's first token name
 const createTokenTester = (tokenName: string): StatementTester => {
   return (node: Node, sourceCode: SourceCode): boolean => {
@@ -143,35 +143,34 @@ const paddingAlwaysTester = (
     message: 'Expected blank line before this statement.',
     fix(fixer: Rule.RuleFixer): Rule.Fix {
       let prevToken = astUtils.getActualLastToken(sourceCode, prevNode);
-      const nextToken =
-        sourceCode.getFirstTokenBetween(prevToken, nextNode, {
-          includeComments: true,
-          /**
-           * Skip the trailing comments of the previous node.
-           * This inserts a blank line after the last trailing comment.
-           *
-           * For example:
-           *
-           *     foo(); // trailing comment.
-           *     // comment.
-           *     bar();
-           *
-           * Get fixed to:
-           *
-           *     foo(); // trailing comment.
-           *
-           *     // comment.
-           *     bar();
-           */
-          filter(token: AST.Token): boolean {
-            if (astUtils.areTokensOnSameLine(prevToken, token)) {
-              prevToken = token;
-              return false;
-            }
-
-            return true;
-          },
-        }) || nextNode;
+      const nextToken = (sourceCode.getFirstTokenBetween(prevToken, nextNode, {
+        includeComments: true,
+        /**
+         * Skip the trailing comments of the previous node.
+         * This inserts a blank line after the last trailing comment.
+         *
+         * For example:
+         *
+         *     foo(); // trailing comment.
+         *     // comment.
+         *     bar();
+         *
+         * Get fixed to:
+         *
+         *     foo(); // trailing comment.
+         *
+         *     // comment.
+         *     bar();
+         */
+        filter(token: AST.Token): boolean {
+          if (astUtils.areTokensOnSameLine(prevToken, token)) {
+            prevToken = token;
+            return false;
+          }
+
+          return true;
+        },
+      }) || nextNode) as AST.Token;
 
       const insertText = astUtils.areTokensOnSameLine(prevToken, nextToken)
         ? '\n\n'