eslint-plugin-yenz 1.1.0 → 1.2.0

package/index.js

@@ -2,5 +2,6 @@ module.exports = {
   rules: {
     'type-ordering': require('./lib/rules/type-ordering.js'),
     'no-loops': require('./lib/rules/no-loops.js'),
+    'it-newline': require('./lib/rules/it-newline.js'),
   },
 };

package/lib/rules/it-newline.js

@@ -0,0 +1,68 @@
+module.exports = {
+  meta: {
+    type: 'layout', // Since we're dealing with code formatting
+    docs: {
+      description: 'Ensure that `it()` calls in tests are preceded by a newline',
+      category: 'Stylistic Issues',
+      recommended: false, // Set to true if you want to enforce it by default
+    },
+    fixable: 'whitespace', // The rule can fix issues by modifying whitespace
+    schema: [], // No options
+    messages: {
+      missingNewline: 'There should be a blank line before `it()`.',
+    },
+  },
+  create(context) {
+    const sourceCode = context.getSourceCode();
+
+    return {
+      CallExpression(node) {
+        const callee = node.callee;
+
+        // Check if the callee is `it`
+        const isIt =
+          (callee.type === 'Identifier' && callee.name === 'it') ||
+          // Also handle cases like `global.it` or `describe.it`
+          (callee.type === 'MemberExpression' &&
+            callee.property.type === 'Identifier' &&
+            callee.property.name === 'it');
+
+        if (!isIt) {
+          return;
+        }
+
+        // Get the token before the `it` call
+        const prevToken = sourceCode.getTokenBefore(node, {
+          includeComments: true,
+        });
+
+        if (!prevToken) {
+          // If there's no previous token, it's likely the first statement; no need for a newline
+          return;
+        }
+
+        const prevTokenEndLine = prevToken.loc.end.line;
+        const currentTokenStartLine = node.loc.start.line;
+
+        // Calculate the number of newlines between the previous token and the current `it` call
+        const newlineCount = currentTokenStartLine - prevTokenEndLine - 1;
+
+        if (newlineCount < 1) {
+          // Report if there's no blank line before `it()`
+          context.report({
+            node,
+            messageId: 'missingNewline',
+            fix(fixer) {
+              // Insert a newline before the `it` call
+              const insertionPoint = prevToken.range[1];
+              return fixer.insertTextAfterRange(
+                [insertionPoint, insertionPoint],
+                '\n'
+              );
+            },
+          });
+        }
+      },
+    };
+  },
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-yenz",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "Adds custom rules that Jens likes",
   "repository": "https://github.com/JensAstrup/eslint-plugin-yenz",
   "main": "index.js",