eslint-plugin-lube 0.8.0 → 0.9.0

package/src/index.js

@@ -1,21 +1,32 @@
 import ascii_order from "./rules/ascii-order.js"
+import closures_last from "./rules/closures-last.js"
+import indent from "./rules/indent.js"
+import no_ambiguous_start from "./rules/no-ambiguous-start.js"
+import no_loose_types from "./rules/no-loose-types.js"
+import no_typedef from "./rules/no-typedef.js"
 import prefer_param_tag from "./rules/prefer-param-tag.js"
 import prefer_type_tag from "./rules/prefer-type-tag.js"
 import pretty_imports from "./rules/pretty-imports.js"
 import pretty_jsdoc_casting from "./rules/pretty-jsdoc-casting.js"
+import pretty_jsdoc_lines from "./rules/pretty-jsdoc-lines.js"
+import pretty_parens from "./rules/pretty-parens.js"
 import pretty_sequence from "./rules/pretty-sequence.js"
 import pretty_ternary from "./rules/pretty-ternary.js"
+import require_returns from "./rules/require-returns.js"
 import svelte_naming_convention from "./rules/svelte-naming-convention.js"
+import { accept_cr_eol } from "./utils/accept_cr_eol.js"
 import { keep_body_comments } from "./utils/keep_body_comments.js"
 import {
 	keep_comment_order,
 	keep_comments
 } from "./utils/keep_comments.js"
 import { keep_line_breaks } from "./utils/keep_line_breaks.js"
+import { record_options } from "./utils/rule_options.js"
 import { skip_hole_commas } from "./utils/skip_hole_commas.js"
 import { skip_optional_patterns } from "./utils/skip_optional_patterns.js"
 import { skip_unchanged_fixes } from "./utils/skip_unchanged_fixes.js"
 import { split_declarations } from "./utils/split_declarations.js"
+import { trim_fixes } from "./utils/trim_fixes.js"
 import stylistic_plugin from "@stylistic/eslint-plugin"
 import { builtinRules } from "eslint/use-at-your-own-risk"
 import { readFileSync } from "node:fs"
@@ -31,6 +42,12 @@ const manifest = JSON.parse(
 		"utf8"
 	)
 )
+const whole_comment_rules = new Set(
+	[
+		"pretty-jsdoc-lines",
+		"require-returns"
+	]
+)
 const brace_rules = /** @type {const} */([
 	"object-curly-newline",
 	"object-curly-spacing"
@@ -66,11 +83,6 @@ const strict_rules = {
 	"@stylistic/function-call-argument-newline": [ "error", "consistent" ],
 	"@stylistic/function-call-spacing": [ "error", "never" ],
 	"@stylistic/generator-star-spacing": [ "error", "after" ],
-	"@stylistic/indent": [
-		"error",
-		"tab",
-		{ "SwitchCase": 0 }
-	],
 	"@stylistic/jsx-quotes": [ "error", "prefer-double" ],
 	"@stylistic/key-spacing": [
 		"error",
@@ -152,13 +164,28 @@ const strict_rules = {
 			checkTests: true
 		}
 	],
+	"lube/closures-last": "error",
 	"lube/curly": [ "error", "all" ],
+	"lube/indent": [
+		"error",
+		"tab",
+		{
+			"SwitchCase": 0,
+			"binaryOperator": 1
+		}
+	],
+	"lube/no-ambiguous-start": "error",
+	"lube/no-loose-types": "error",
+	"lube/no-typedef": "error",
 	"lube/prefer-param-tag": "error",
 	"lube/prefer-type-tag": "error",
 	"lube/pretty-imports": "error",
 	"lube/pretty-jsdoc-casting": "error",
+	"lube/pretty-jsdoc-lines": "error",
+	"lube/pretty-parens": "error",
 	"lube/pretty-sequence": "error",
 	"lube/pretty-ternary": "error",
+	"lube/require-returns": "error",
 	"lube/svelte-naming-convention": "error",
 	"no-case-declarations": "off",
 	"no-console": "warn",
@@ -212,8 +239,15 @@ const recommended_rules = {
 			checkTests: false
 		}
 	],
+	"lube/indent": [
+		"error",
+		"tab",
+		{ "SwitchCase": 0 }
+	],
 	"lube/pretty-imports": [ "error", { maxLength: 80 } ],
 	"lube/pretty-jsdoc-casting": "error",
+	"lube/pretty-jsdoc-lines": "error",
+	"lube/pretty-parens": "error",
 	"lube/pretty-sequence": [ "error", { maxLength: 80 } ],
 	"lube/pretty-ternary": "error"
 }
@@ -243,19 +277,39 @@ const plugin = {
 		name: "eslint-plugin-lube",
 		version: manifest.version
 	},
-	rules: {
-		"ascii-order": ascii_order,
-		"curly": keep_body_comments(
-			/** @type {import("eslint").Rule.RuleModule} */(builtinRules.get("curly"))/**/
-		),
-		"prefer-param-tag": prefer_param_tag,
-		"prefer-type-tag": prefer_type_tag,
-		"pretty-imports": pretty_imports,
-		"pretty-jsdoc-casting": pretty_jsdoc_casting,
-		"pretty-sequence": pretty_sequence,
-		"pretty-ternary": pretty_ternary,
-		"svelte-naming-convention": svelte_naming_convention
-	}
+	rules: Object.fromEntries(
+		Object.entries(
+			/** @type {Record<string, import("eslint").Rule.RuleModule>} */({
+				"ascii-order": ascii_order,
+				"closures-last": closures_last,
+				"curly": keep_body_comments(
+					/** @type {import("eslint").Rule.RuleModule} */(builtinRules.get("curly"))/**/
+				),
+				"indent": indent,
+				"no-ambiguous-start": no_ambiguous_start,
+				"no-loose-types": no_loose_types,
+				"no-typedef": no_typedef,
+				"prefer-param-tag": prefer_param_tag,
+				"prefer-type-tag": prefer_type_tag,
+				"pretty-imports": pretty_imports,
+				"pretty-jsdoc-casting": pretty_jsdoc_casting,
+				"pretty-jsdoc-lines": pretty_jsdoc_lines,
+				"pretty-parens": pretty_parens,
+				"pretty-sequence": pretty_sequence,
+				"pretty-ternary": pretty_ternary,
+				"require-returns": require_returns,
+				"svelte-naming-convention": svelte_naming_convention
+			})/**/
+		).map(
+			([ name, rule ]) => [
+				name,
+				record_options(
+					name,
+					rule.meta?.fixable && !whole_comment_rules.has(name) ? trim_fixes(rule) : rule
+				)
+			]
+		)
+	)
 }
 /** @type {Record<string, import("eslint").Rule.RuleModule>} */
 const stylistic_rules = {
@@ -263,6 +317,9 @@ const stylistic_rules = {
 	"comma-style": skip_hole_commas(
 		/** @type {import("eslint").Rule.RuleModule} */(stylistic.rules?.["comma-style"])/**/
 	),
+	"eol-last": accept_cr_eol(
+		/** @type {import("eslint").Rule.RuleModule} */(stylistic.rules?.["eol-last"])/**/
+	),
 	"max-statements-per-line": split_declarations(
 		/** @type {import("eslint").Rule.RuleModule} */(stylistic.rules?.["max-statements-per-line"])/**/
 	),
@@ -298,7 +355,9 @@ const plugins = {
 			Object.entries(stylistic_rules).map(
 				([ name, rule ]) => [
 					name,
-					skip_unchanged_fixes(keep_line_breaks(rule))
+					trim_fixes(
+						skip_unchanged_fixes(keep_line_breaks(rule))
+					)
 				]
 			)
 		)

package/src/rules/ascii-order.js

@@ -1,3 +1,4 @@
+import { compare } from "../utils/order_compare.js"
 import { create_source_text } from "../utils/source_text.js"
 const not_static = Symbol("not static")
 const portable_flags_regex = /^[gimsuy]*$/
@@ -59,22 +60,6 @@ const safe_constructors = new Set(
 const closers = new Set([ ")", "]", "}" ])
 const member_separators = new Set([ ",", ";" ])
 const shebang_types = new Set([ "Hashbang", "Shebang" ])
-/**
- * @param {import("../../private.js").OrderEntry} a
- * @param {import("../../private.js").OrderEntry} b
- * @returns {number}
- */
-function compare(a, b) {
-	const rank = (a.rank ?? 1) - (b.rank ?? 1)
-	if (rank) {
-		return rank
-	}
-	return a.name < b.name
-		? -1
-		: a.name > b.name
-			? 1
-			: 0
-}
 /**
  * @param {import("../../private.js").Comment[]} comments
  * @param {number} line
@@ -93,11 +78,13 @@ function count_same_line(comments, line) {
 }
 /**
  * @param {import("eslint").Rule.RuleContext} context
+ * @returns {{ verify: (entries: import("../../private.js").OrderEntry[], message_id: string, layout: import("../../private.js").OrderLayout, get_level?: ((node: import("../../private.js").OrderNode) => number) | undefined) => void; }}
  */
 function create_reorder(context) {
 	const source_code = context.sourceCode
 	const source = create_source_text(source_code)
 	const text = source.text
+	return { verify }
 	/**
 	 * @param {import("../../private.js").OrderEntry} entry
 	 * @param {import("../../private.js").OrderLayout} layout
@@ -216,11 +203,11 @@ function create_reorder(context) {
 			const has_tail = item.tail_start < item.after
 			if (
 				item.leading && !slot.break_before
-				|| i == 0 && slot.head && !slot.break_before
-				|| slot.header && item != slot
-				|| slot.tail_start < slot.after && !slot.break_after && (i < last_index || !slot.closes)
-				|| has_tail && !slot.break_after && (i < last_index || item.tail_line)
-				|| layout == "statement" && i < last_index && !item.terminated && !slot.break_after
+					|| i == 0 && slot.head && !slot.break_before
+					|| slot.header && item != slot
+					|| slot.tail_start < slot.after && !slot.break_after && (i < last_index || !slot.closes)
+					|| has_tail && !slot.break_after && (i < last_index || item.tail_line)
+					|| layout == "statement" && i < last_index && !item.terminated && !slot.break_after
 			) {
 				return null
 			}
@@ -302,7 +289,6 @@ function create_reorder(context) {
 			}
 		)
 	}
-	return { verify }
 }
 /**
  * @param {import("../../private.js").OrderItem[]} items
@@ -409,6 +395,107 @@ export default {
 		const default_exports = new Set()
 		/** @type {Parameters<typeof verify>[]} */
 		const pending = []
+		/** @type {import("../../private.js").OrderRuleListener} */
+		const listener = {
+			BlockStatement: verify_statements,
+			ExportNamedDeclaration: node => {
+				if (check_names) {
+					verify_nodes(
+						node.specifiers,
+						get_specifier_name,
+						"names",
+						"sequence"
+					)
+				}
+			},
+			ImportDeclaration: node => {
+				if (check_names) {
+					verify_nodes(
+						node.specifiers,
+						get_specifier_name,
+						"names",
+						"sequence"
+					)
+				}
+			},
+			ObjectExpression: node => {
+				if (!check_keys) {
+					return
+				}
+				const condition = is_package_condition(node)
+				verify_nodes(
+					node.properties,
+					get_key_name,
+					condition ? "conditions" : "keys",
+					"sequence",
+					classify,
+					condition ? get_condition_rank : undefined
+				)
+			},
+			ObjectPattern: node => {
+				if (check_keys) {
+					/** @type {Map<import("../../private.js").OrderNode, string[]>} */
+					const targets = new Map()
+					/** @type {Set<string>} */
+					const seen = new Set()
+					/** @type {Set<string>} */
+					const repeated = new Set()
+					for (const property of node.properties) {
+						const names = collect_targets(property, [])
+						for (const name of new Set(names)) {
+							if (seen.has(name)) {
+								repeated.add(name)
+							}
+							seen.add(name)
+						}
+						targets.set(property, names)
+					}
+					verify_nodes(
+						node.properties,
+						get_key_name,
+						"keys",
+						"sequence",
+						property => targets.get(property)?.some(name => repeated.has(name))
+							? 2
+							: classify_pattern(property)
+					)
+				}
+			},
+			Program: node => {
+				collect_default_exports(node)
+				verify_statements(node)
+			},
+			"Program:exit": () => {
+				for (let i = pending.length - 1; i >= 0; i--) {
+					verify(
+						.../** @type {Parameters<typeof verify>} */(pending[i])/**/
+					)
+				}
+			},
+			StaticBlock: verify_statements,
+			TSInterfaceBody: node => {
+				if (check_keys) {
+					verify_nodes(
+						node.body,
+						get_key_name,
+						"keys",
+						"member"
+					)
+				}
+			},
+			TSModuleBlock: verify_statements,
+			TSTypeLiteral: node => {
+				if (check_keys) {
+					verify_nodes(
+						node.members,
+						get_key_name,
+						"keys",
+						"member"
+					)
+				}
+			}
+		}
+		return /** @type {import("eslint").Rule.RuleListener} */(/** @type {unknown} */(listener))/**/
 		/**
 		 * @param {import("../../private.js").OrderNode} node
 		 * @returns {number}
@@ -534,8 +621,8 @@ export default {
 			const args = node.arguments.map(static_value)
 			if (
 				args.includes(not_static)
-				|| (callee.name.includes("Array") || callee.name == "DataView") && args.some(is_large)
-				|| callee.name == "RegExp" && !is_portable_regexp(args)
+					|| (callee.name.includes("Array") || callee.name == "DataView") && args.some(is_large)
+					|| callee.name == "RegExp" && !is_portable_regexp(args)
 			) {
 				return not_static
 			}
@@ -694,8 +781,8 @@ export default {
 			const parent = /** @type {import("eslint").Rule.Node} */(declaration)/**/.parent
 			if (
 				parent?.type == "SwitchCase"
-				|| parent?.parent?.type == "SwitchCase"
-				|| /** @type {[number, number]} */(node.range)/**/[0] < /** @type {[number, number]} */(declaration.range)/**/[1]
+					|| parent?.parent?.type == "SwitchCase"
+					|| /** @type {[number, number]} */(node.range)/**/[0] < /** @type {[number, number]} */(declaration.range)/**/[1]
 			) {
 				return false
 			}
@@ -892,107 +979,6 @@ export default {
 				}
 			}
 		}
-		/** @type {import("../../private.js").OrderRuleListener} */
-		const listener = {
-			BlockStatement: verify_statements,
-			ExportNamedDeclaration: node => {
-				if (check_names) {
-					verify_nodes(
-						node.specifiers,
-						get_specifier_name,
-						"names",
-						"sequence"
-					)
-				}
-			},
-			ImportDeclaration: node => {
-				if (check_names) {
-					verify_nodes(
-						node.specifiers,
-						get_specifier_name,
-						"names",
-						"sequence"
-					)
-				}
-			},
-			ObjectExpression: node => {
-				if (!check_keys) {
-					return
-				}
-				const condition = is_package_condition(node)
-				verify_nodes(
-					node.properties,
-					get_key_name,
-					condition ? "conditions" : "keys",
-					"sequence",
-					classify,
-					condition ? get_condition_rank : undefined
-				)
-			},
-			ObjectPattern: node => {
-				if (check_keys) {
-					/** @type {Map<import("../../private.js").OrderNode, string[]>} */
-					const targets = new Map()
-					/** @type {Set<string>} */
-					const seen = new Set()
-					/** @type {Set<string>} */
-					const repeated = new Set()
-					for (const property of node.properties) {
-						const names = collect_targets(property, [])
-						for (const name of new Set(names)) {
-							if (seen.has(name)) {
-								repeated.add(name)
-							}
-							seen.add(name)
-						}
-						targets.set(property, names)
-					}
-					verify_nodes(
-						node.properties,
-						get_key_name,
-						"keys",
-						"sequence",
-						property => targets.get(property)?.some(name => repeated.has(name))
-							? 2
-							: classify_pattern(property)
-					)
-				}
-			},
-			Program: node => {
-				collect_default_exports(node)
-				verify_statements(node)
-			},
-			"Program:exit": () => {
-				for (let i = pending.length - 1; i >= 0; i--) {
-					verify(
-						.../** @type {Parameters<typeof verify>} */(pending[i])/**/
-					)
-				}
-			},
-			StaticBlock: verify_statements,
-			TSInterfaceBody: node => {
-				if (check_keys) {
-					verify_nodes(
-						node.body,
-						get_key_name,
-						"keys",
-						"member"
-					)
-				}
-			},
-			TSModuleBlock: verify_statements,
-			TSTypeLiteral: node => {
-				if (check_keys) {
-					verify_nodes(
-						node.members,
-						get_key_name,
-						"keys",
-						"member"
-					)
-				}
-			}
-		}
-		return /** @type {import("eslint").Rule.RuleListener} */(/** @type {unknown} */(listener))/**/
 	},
 	meta: {
 		docs: {