chore: minor tidy up of code (#603)

* test: ensure `cwd` is restored after each test

* chore: add `eslint-plugin-eslint-config`

* chore: replace `ban-ts-ignore` with `ban-ts-comment` rule

* chore: enable `padding-line-between-statements` rule

* chore: remove some unneeded conditional checks

* chore: use correct jsdoc syntax for optional params

Author: G-Rath

.eslintignore

@@ -1,2 +1,3 @@
 coverage/
 lib/
+!.eslintrc.js

.eslintrc.js

@@ -5,6 +5,7 @@ const globals = require('./src/globals.json');
 module.exports = {
   parser: require.resolve('@typescript-eslint/parser'),
   extends: [
+    'plugin:eslint-config/rc',
     'plugin:eslint-plugin/recommended',
     'plugin:eslint-comments/recommended',
     'plugin:node/recommended',
@@ -13,6 +14,7 @@ module.exports = {
     'prettier/@typescript-eslint',
   ],
   plugins: [
+    'eslint-config',
     'eslint-plugin',
     'eslint-comments',
     'node',
@@ -30,7 +32,7 @@ module.exports = {
   rules: {
     '@typescript-eslint/array-type': ['error', { default: 'array-simple' }],
     '@typescript-eslint/no-require-imports': 'error',
-    '@typescript-eslint/ban-ts-ignore': 'warn',
+    '@typescript-eslint/ban-ts-comment': 'warn',
     '@typescript-eslint/ban-types': 'error',
     '@typescript-eslint/no-unused-vars': 'error',
     'eslint-comments/no-unused-disable': 'error',
@@ -58,6 +60,18 @@ module.exports = {
       'error',
       { alphabetize: { order: 'asc' }, 'newlines-between': 'never' },
     ],
+    'padding-line-between-statements': [
+      'error',
+      { blankLine: 'always', prev: '*', next: 'return' },
+      { blankLine: 'always', prev: ['const', 'let', 'var'], next: '*' },
+      {
+        blankLine: 'any',
+        prev: ['const', 'let', 'var'],
+        next: ['const', 'let', 'var'],
+      },
+      { blankLine: 'always', prev: 'directive', next: '*' },
+      { blankLine: 'any', prev: 'directive', next: 'directive' },
+    ],
   },
   overrides: [
     {

package.json

@@ -109,6 +109,7 @@
     "eslint": "^5.1.0 || ^6.0.0",
     "eslint-config-prettier": "^6.5.0",
     "eslint-plugin-eslint-comments": "^3.1.2",
+    "eslint-plugin-eslint-config": "^1.0.2",
     "eslint-plugin-eslint-plugin": "^2.0.0",
     "eslint-plugin-import": "^2.20.2",
     "eslint-plugin-node": "^11.0.0",

src/__tests__/rules.test.ts

@@ -36,6 +36,7 @@ describe('rules', () => {
 
   it('should have the correct amount of rules', () => {
     const { length } = ruleNames;
+
     if (length !== numberOfRules) {
       throw new Error(
         `There should be exactly ${numberOfRules} rules, but there are ${length}. If you've added a new rule, please update this number.`,
@@ -65,6 +66,7 @@ describe('rules', () => {
     allConfigRules.forEach(rule => {
       const ruleNamePrefix = 'jest/';
       const ruleName = rule.slice(ruleNamePrefix.length);
+
       expect(rule.startsWith(ruleNamePrefix)).toBe(true);
       expect(ruleNames).toContain(ruleName);
       // eslint-disable-next-line @typescript-eslint/no-require-imports

src/rules/expect-expect.ts

@@ -31,6 +31,7 @@ function matchesAssertFunctionName(
         .split('.')
         .map(x => {
           if (x === '**') return '[a-z\\.]*';
+
           return x.replace(/\*/gu, '[a-z]*');
         })
         .join('\\.')}(\\.|$)`,
@@ -97,6 +98,7 @@ export default createRule<
     return {
       CallExpression(node) {
         const name = getNodeName(node.callee);
+
         if (name === TestCaseName.it || name === TestCaseName.test) {
           unchecked.push(node);
         } else if (

src/rules/lowercase-name.ts

@@ -43,6 +43,7 @@ const jestFunctionName = (
   allowedPrefixes: readonly string[],
 ) => {
   const description = getStringValue(node.arguments[0]);
+
   if (allowedPrefixes.some(name => description.startsWith(name))) {
     return null;
   }

src/rules/no-alias-methods.ts

@@ -45,6 +45,7 @@ export default createRule({
         }
 
         const alias = matcher.name;
+
         if (alias in methodNames) {
           const canonical = methodNames[alias];
 

src/rules/no-duplicate-hooks.ts

@@ -24,6 +24,7 @@ export default createRule({
   defaultOptions: [],
   create(context) {
     const hookContexts = [newHookContext()];
+
     return {
       CallExpression(node) {
         if (isDescribe(node)) {
@@ -32,6 +33,7 @@ export default createRule({
 
         if (isHook(node)) {
           const currentLayer = hookContexts[hookContexts.length - 1];
+
           currentLayer[node.callee.name] += 1;
           if (currentLayer[node.callee.name] > 1) {
             context.report({

src/rules/no-focused-tests.ts

@@ -24,7 +24,6 @@ interface ConcurrentExpression extends TSESTree.MemberExpressionComputedName {
 const isConcurrentExpression = (
   expression: TSESTree.MemberExpression,
 ): expression is ConcurrentExpression =>
-  expression.type === AST_NODE_TYPES.MemberExpression &&
   isSupportedAccessor(expression.property, TestCaseProperty.concurrent) &&
   !!expression.parent &&
   expression.parent.type === AST_NODE_TYPES.MemberExpression;
@@ -72,6 +71,7 @@ export default createRule({
           isCallToFocusedTestFunction(callee.object)
         ) {
           context.report({ messageId: 'focusedTest', node: callee.object });
+
           return;
         }
 
@@ -83,11 +83,13 @@ export default createRule({
             messageId: 'focusedTest',
             node: callee.object.property,
           });
+
           return;
         }
 
         if (isCallToTestOnlyFunction(callee)) {
           context.report({ messageId: 'focusedTest', node: callee.property });
+
           return;
         }
       }

src/rules/no-identical-title.ts

@@ -36,13 +36,16 @@ export default createRule({
   defaultOptions: [],
   create(context) {
     const contexts = [newDescribeContext()];
+
     return {
       CallExpression(node) {
         const currentLayer = contexts[contexts.length - 1];
+
         if (isDescribe(node)) {
           contexts.push(newDescribeContext());
         }
         const [argument] = node.arguments;
+
         if (!argument || !isStringNode(argument)) {
           return;
         }