@utilfirst/eslint-plugin 0.1.0 → 0.1.1

package/README.md

@@ -37,9 +37,9 @@ export default [
 
 ## Rules
 
-| Rule                                                               | Description                                                                          | Fixable |
-| ------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------- |
-| [`consistent-blank-lines`](./docs/rules/consistent-blank-lines.md) | Insert blank lines between statement-list and JSXChild items that start new thoughts | yes     |
+| Rule                                                               | Description                                                                           | Fixable |
+| ------------------------------------------------------------------ | ------------------------------------------------------------------------------------- | ------- |
+| [`consistent-blank-lines`](./docs/rules/consistent-blank-lines.md) | Insert blank lines between statement-list and JSXChild items that start a new thought | yes     |
 
 ## Develop
 

package/dist/index.d.ts

@@ -4,7 +4,7 @@ import { TSESLint } from "@typescript-eslint/utils";
 declare const plugin: {
   meta: {
     readonly name: "@utilfirst/eslint-plugin";
-    readonly version: "0.1.0";
+    readonly version: string;
   };
   rules: {
     "consistent-blank-lines": TSESLint.RuleModule<"extra" | "missing", [], unknown, TSESLint.RuleListener>;

package/dist/index.js

@@ -1,5 +1,9 @@
 import { AST_NODE_TYPES } from "@typescript-eslint/utils";
 
+//#region package.json
+var version = "0.1.1";
+
+//#endregion
 //#region src/rules/consistent-blank-lines.ts
 const SKIP_KEYS = new Set([
 	"parent",
@@ -59,8 +63,8 @@ const consistentBlankLines = {
 		fixable: "whitespace",
 		schema: [],
 		messages: {
-			extra: "Unexpected blank line between statements that continue the same paragraph.",
-			missing: "Expected a blank line between statements that start new paragraphs."
+			extra: "Unexpected blank line between items that continue the same paragraph.",
+			missing: "Expected a blank line between items that start a new paragraph."
 		}
 	},
 	defaultOptions: [],
@@ -70,7 +74,7 @@ const consistentBlankLines = {
 			for (let i = 0; i < statements.length - 1; i++) {
 				const prev = statements[i];
 				const next = statements[i + 1];
-				if (prev && next) checkPair(prev, next, sourceCode.getCommentsBefore(next)[0] ?? next, () => sameParagraph(prev, next, sourceCode), () => isImportPair(prev, next) || isReExport(prev) && isReExport(next));
+				if (prev && next) checkPair(prev, next, sourceCode.getCommentsBefore(next)[0] ?? next, () => sameParagraph(prev, next, sourceCode), () => isImportPair(prev, next) || isReExport(prev) && isReExport(next) || isExpressionStatementPair(prev, next));
 			}
 		}
 		function checkJsxChildren(children) {
@@ -189,23 +193,26 @@ function sameShape(prev, next) {
 function isImportPair(prev, next) {
 	return prev.type === AST_NODE_TYPES.ImportDeclaration && next.type === AST_NODE_TYPES.ImportDeclaration;
 }
+function isExpressionStatementPair(prev, next) {
+	return prev.type === AST_NODE_TYPES.ExpressionStatement && next.type === AST_NODE_TYPES.ExpressionStatement;
+}
 function isReExport(stmt) {
 	return stmt.type === AST_NODE_TYPES.ExportNamedDeclaration && stmt.source !== null || stmt.type === AST_NODE_TYPES.ExportAllDeclaration;
 }
 function isMatchingVarDeclPair(prev, next) {
-	const p = unwrapExport(prev);
-	const n = unwrapExport(next);
-	if (p.type !== AST_NODE_TYPES.VariableDeclaration || n.type !== AST_NODE_TYPES.VariableDeclaration) return false;
-	if (!isConstOrLet(p) || !isConstOrLet(n)) return false;
+	const previousDeclaration = unwrapExport(prev);
+	const nextDeclaration = unwrapExport(next);
+	if (previousDeclaration.type !== AST_NODE_TYPES.VariableDeclaration || nextDeclaration.type !== AST_NODE_TYPES.VariableDeclaration) return false;
+	if (!isConstOrLet(previousDeclaration) || !isConstOrLet(nextDeclaration)) return false;
 	if (isMultiLine(prev) || isMultiLine(next)) return false;
-	if (p.declarations.length !== 1 || n.declarations.length !== 1) return false;
-	if (!initsMatchByShape(p.declarations[0].init, n.declarations[0].init)) return false;
+	if (previousDeclaration.declarations.length !== 1 || nextDeclaration.declarations.length !== 1) return false;
+	if (!initsMatchByShape(previousDeclaration.declarations[0].init, nextDeclaration.declarations[0].init)) return false;
 	return prev.type === AST_NODE_TYPES.ExportNamedDeclaration === (next.type === AST_NODE_TYPES.ExportNamedDeclaration);
 }
 function isMatchingTypeAliasPair(prev, next) {
-	const p = unwrapExport(prev);
-	const n = unwrapExport(next);
-	if (p.type !== AST_NODE_TYPES.TSTypeAliasDeclaration || n.type !== AST_NODE_TYPES.TSTypeAliasDeclaration) return false;
+	const previousDeclaration = unwrapExport(prev);
+	const nextDeclaration = unwrapExport(next);
+	if (previousDeclaration.type !== AST_NODE_TYPES.TSTypeAliasDeclaration || nextDeclaration.type !== AST_NODE_TYPES.TSTypeAliasDeclaration) return false;
 	if (isMultiLine(prev) || isMultiLine(next)) return false;
 	return prev.type === AST_NODE_TYPES.ExportNamedDeclaration === (next.type === AST_NODE_TYPES.ExportNamedDeclaration);
 }
@@ -248,13 +255,15 @@ function isGuardIf(stmt) {
 	return stmt.type === AST_NODE_TYPES.IfStatement && blockAlwaysTerminates(stmt.consequent);
 }
 function blockAlwaysTerminates(node) {
-	if (!node) return false;
 	if (TERMINATING_STATEMENT_TYPES.has(node.type)) return true;
 	if (node.type === AST_NODE_TYPES.BlockStatement) {
 		const last = node.body[node.body.length - 1];
 		return last ? blockAlwaysTerminates(last) : false;
 	}
-	if (node.type === AST_NODE_TYPES.IfStatement) return Boolean(node.alternate) && blockAlwaysTerminates(node.consequent) && blockAlwaysTerminates(node.alternate);
+	if (node.type === AST_NODE_TYPES.IfStatement) {
+		if (!node.alternate) return false;
+		return blockAlwaysTerminates(node.consequent) && blockAlwaysTerminates(node.alternate);
+	}
 	if (node.type === AST_NODE_TYPES.TryStatement) {
 		if (node.finalizer && blockAlwaysTerminates(node.finalizer)) return true;
 		if (!blockAlwaysTerminates(node.block)) return false;
@@ -278,7 +287,6 @@ function collectIntroducedOrAssignedNames(stmt) {
 	return set;
 }
 function collectBindingNames(node, set) {
-	if (!node) return;
 	switch (node.type) {
 		case AST_NODE_TYPES.Identifier:
 			set.add(node.name);
@@ -333,10 +341,10 @@ function resolvesOutsideRoot(idNode, root, sourceCode) {
 	return true;
 }
 function thisResolvesOutsideRoot(thisNode, root) {
-	let p = parentOf(thisNode);
-	while (p) {
-		if (p.type === AST_NODE_TYPES.FunctionDeclaration || p.type === AST_NODE_TYPES.FunctionExpression) return !isInSubtree(p, root);
-		p = parentOf(p);
+	let parent = parentOf(thisNode);
+	while (parent) {
+		if (parent.type === AST_NODE_TYPES.FunctionDeclaration || parent.type === AST_NODE_TYPES.FunctionExpression) return !isInSubtree(parent, root);
+		parent = parentOf(parent);
 	}
 	return true;
 }
@@ -362,8 +370,6 @@ function isDeclarationOrPropertyKey(idNode) {
 	if (FN_DECL_TYPES.has(parent.type) && "id" in parent && parent.id === idNode) return true;
 	if ((parent.type === AST_NODE_TYPES.ClassDeclaration || parent.type === AST_NODE_TYPES.ClassExpression) && parent.id === idNode) return true;
 	if (parent.type === AST_NODE_TYPES.MemberExpression && parent.property === idNode && !parent.computed) return true;
-	if (parent.type === AST_NODE_TYPES.MethodDefinition && parent.key === idNode && !parent.computed) return true;
-	if (parent.type === AST_NODE_TYPES.PropertyDefinition && parent.key === idNode && !parent.computed) return true;
 	if (IMPORT_SPECIFIER_TYPES.has(parent.type) && "local" in parent && parent.local === idNode) return true;
 	if (parent.type === AST_NODE_TYPES.Property && parent.key === idNode && !parent.computed && !parent.shorthand) return true;
 	if (isInBindingPosition(idNode)) return true;
@@ -371,26 +377,25 @@ function isDeclarationOrPropertyKey(idNode) {
 }
 function isInBindingPosition(idNode) {
 	let cur = idNode;
-	let p = parentOf(cur);
-	while (p) {
-		if (FN_DECL_TYPES.has(p.type) && "params" in p && Array.isArray(p.params) && p.params.includes(cur)) return true;
-		if (p.type === AST_NODE_TYPES.ObjectPattern || p.type === AST_NODE_TYPES.ArrayPattern) return true;
-		if (p.type === AST_NODE_TYPES.Property) {
-			if (p.computed && p.key === cur) return false;
-			if (!p.shorthand && p.value !== cur) return false;
-			cur = p;
-			p = parentOf(p);
+	let parent = parentOf(cur);
+	while (parent) {
+		if (FN_DECL_TYPES.has(parent.type) && "params" in parent && Array.isArray(parent.params) && parent.params.includes(cur)) return true;
+		if (parent.type === AST_NODE_TYPES.ObjectPattern || parent.type === AST_NODE_TYPES.ArrayPattern) return true;
+		if (parent.type === AST_NODE_TYPES.Property) {
+			if (parent.computed && parent.key === cur) return false;
+			cur = parent;
+			parent = parentOf(parent);
 			continue;
 		}
-		if (p.type === AST_NODE_TYPES.AssignmentPattern) {
-			if (p.right === cur) return false;
-			cur = p;
-			p = parentOf(p);
+		if (parent.type === AST_NODE_TYPES.AssignmentPattern) {
+			if (parent.right === cur) return false;
+			cur = parent;
+			parent = parentOf(parent);
 			continue;
 		}
-		if (p.type === AST_NODE_TYPES.RestElement) {
-			cur = p;
-			p = parentOf(p);
+		if (parent.type === AST_NODE_TYPES.RestElement) {
+			cur = parent;
+			parent = parentOf(parent);
 			continue;
 		}
 		return false;
@@ -426,11 +431,11 @@ function expressionYieldsStringLiteral(expr) {
 function walk(node, fn) {
 	if (!node || typeof node !== "object" || typeof node.type !== "string") return;
 	fn(node);
-	const obj = node;
-	for (const key of Object.keys(obj)) {
+	const nodeFields = node;
+	for (const key of Object.keys(nodeFields)) {
 		if (SKIP_KEYS.has(key)) continue;
 		if (key === "body" && OPAQUE_BODY_TYPES.has(node.type)) continue;
-		const child = obj[key];
+		const child = nodeFields[key];
 		if (Array.isArray(child)) for (const c of child) walk(c, fn);
 		else walk(child, fn);
 	}
@@ -451,7 +456,7 @@ function hasMultiLineLeadingComment(node, sourceCode) {
 const plugin = {
 	meta: {
 		name: "@utilfirst/eslint-plugin",
-		version: "0.1.0"
+		version
 	},
 	rules: { "consistent-blank-lines": consistentBlankLines },
 	configs: {}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@utilfirst/eslint-plugin",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Shared ESLint rules for utilfirst projects",
   "keywords": [
     "eslint",
@@ -28,20 +28,6 @@
   "files": [
     "dist"
   ],
-  "scripts": {
-    "build": "tsdown",
-    "fix": "pnpm run --sequential '/^fix:[^:]+$/'",
-    "fix:eslint": "pnpm run lint:eslint --fix",
-    "fix:prettier": "pnpm run lint:prettier --write",
-    "lint": "pnpm run --sequential '/^lint:[^:]+$/'",
-    "lint:eslint": "eslint .",
-    "lint:prettier": "prettier --check .",
-    "lint:publint": "publint",
-    "lint:typecheck": "tsc --pretty --noEmit",
-    "prepack": "pnpm run build",
-    "setup-hooks": "simple-git-hooks",
-    "test": "vitest run"
-  },
   "simple-git-hooks": {
     "pre-commit": "pnpm exec lint-staged && pnpm run lint:typecheck"
   },
@@ -56,6 +42,8 @@
     "@eslint/js": "^10.0.1",
     "@types/node": "^25.9.1",
     "@typescript-eslint/rule-tester": "^8.59.3",
+    "@utilfirst/prettier-plugin": "^0.1.0",
+    "@vitest/coverage-v8": "^4.1.7",
     "eslint": "^10.3.0",
     "lint-staged": "^17.0.4",
     "prettier": "^3.8.3",
@@ -73,12 +61,24 @@
   "peerDependencies": {
     "eslint": "^9.0.0 || ^10.0.0"
   },
-  "packageManager": "pnpm@11.0.9",
   "engines": {
     "node": ">=20.19.0"
   },
   "publishConfig": {
     "access": "public",
     "provenance": true
+  },
+  "scripts": {
+    "build": "tsdown",
+    "fix": "pnpm run --sequential '/^fix:[^:]+$/'",
+    "fix:eslint": "pnpm run lint:eslint --fix",
+    "fix:prettier": "pnpm run lint:prettier --write",
+    "lint": "pnpm run --sequential '/^lint:[^:]+$/'",
+    "lint:eslint": "eslint .",
+    "lint:prettier": "prettier --check .",
+    "lint:publint": "publint",
+    "lint:typecheck": "tsc --pretty --noEmit",
+    "setup-hooks": "simple-git-hooks",
+    "test": "vitest run"
   }
-}
+}