eslint-plugin-lube 0.4.3 → 0.5.1

package/index.js

@@ -1,125 +1,126 @@
-/**
- * @type {import("eslint").ESLint.Plugin & {
- *   configs: Record<string, import("eslint").ESLint.ConfigData|{}>
- * }}
- */
-module.exports = {
-	configs: {
-		recommended: {
-			extends: [ "eslint:recommended" ],
-			plugins: [ "lube" ],
-			rules: {
-				"array-bracket-newline": [ "error", "consistent" ],
-				"array-element-newline": [ "error", "consistent" ],
-				"arrow-parens": [ "error", "as-needed" ],
-				"arrow-spacing": [
-					"error",
-					{ "before": true, "after": true }
-				],
-				"block-spacing": [ "error", "always" ],
-				"brace-style": [ "error", "1tbs" ],
-				"comma-dangle": [ "error", "never" ],
-				"comma-spacing": [
-					"error",
-					{ "before": false, "after": true }
-				],
-				"comma-style": [ "error", "last" ],
-				"computed-property-spacing": [ "error", "never" ],
-				"dot-location": [ "error", "property" ],
-				"eol-last": [ "error", "never" ],
-				"func-call-spacing": [ "error", "never" ],
-				"function-call-argument-newline": [ "error", "consistent" ],
-				"generator-star-spacing": [ "error", "after" ],
-				"indent": [ "error", "tab" ],
-				"jsx-quotes": [ "error", "prefer-double" ],
-				"key-spacing": [
-					"error",
-					{
-						"afterColon": true,
-						"beforeColon": false
-					}
-				],
-				"keyword-spacing": [
-					"error",
-					{ "after": true, "before": true }
-				],
-				"max-len": [ "warn", 120 ],
-				"max-statements-per-line": [ "error", { "max": 1 } ],
-				"multiline-ternary": [ "error", "always-multiline" ],
-				"newline-per-chained-call": [
-					"error",
-					{ "ignoreChainWithDepth": 2 }
-				],
-				"no-await-in-loop": "warn",
-				"no-case-declarations": "off",
-				"no-console": "warn",
-				"no-duplicate-imports": "error",
-				"no-lonely-if": "error",
-				"no-multi-spaces": "error",
-				"no-new-native-nonconstructor": "error",
-				"no-self-compare": "error",
-				"no-shadow": "error",
-				"no-shadow-restricted-names": "error",
-				"no-trailing-spaces": [
-					"error",
-					{
-						"ignoreComments": false,
-						"skipBlankLines": false
-					}
-				],
-				"object-curly-newline": [ "error", { "consistent": true } ],
-				"object-curly-spacing": [ "error", "always" ],
-				"operator-linebreak": [ "error", "before" ],
-				"prefer-const": [
-					"warn",
-					{
-						"destructuring": "all",
-						"ignoreReadBeforeAssign": false
-					}
-				],
-				"quotes": [ "error", "double" ],
-				"rest-spread-spacing": [ "error", "never" ],
-				"semi": [ "error", "never" ],
-				"semi-spacing": [
-					"error",
-					{ "after": true, "before": false }
-				],
-				"semi-style": [ "error", "first" ],
-				"space-before-blocks": [ "error", "always" ],
-				"space-before-function-paren": [
-					"error",
-					{
-						"anonymous": "never",
-						"asyncArrow": "always",
-						"named": "never"
-					}
-				],
-				"space-in-parens": [ "error", "never" ],
-				"space-infix-ops": [ "error", { "int32Hint": true } ],
-				"space-unary-ops": [
-					"error",
-					{ "words": true, "nonwords": false }
-				],
-				"switch-colon-spacing": [
-					"error",
-					{ "after": true, "before": false }
-				],
-				"template-curly-spacing": [ "error", "never" ],
-				"template-tag-spacing": [ "error", "never" ],
-				"yield-star-spacing": [ "error", "after" ],
-				"lube/pretty-imports": "error",
-				"lube/pretty-jsdoc-casting": "error",
-				"lube/pretty-sequence": "error",
-				"lube/svelte-naming-convention": "error"
-			}
-		}
-	},
-	rules: {
-		"pretty-imports": require("./rules/pretty-imports"),
-		"pretty-jsdoc-casting": require("./rules/pretty-jsdoc-casting"),
-		"pretty-sequence": require("./rules/pretty-sequence"),
-		"svelte-naming-convention": require(
-			"./rules/svelte-naming-convention"
-		)
-	}
-}
+const plugin = {
+	configs: { plugins: {}, rules: {} },
+	meta: { name: "eslint-plugin-lube" },
+	rules: {
+		"pretty-imports": require("./rules/pretty-imports"),
+		"pretty-jsdoc-casting": require("./rules/pretty-jsdoc-casting"),
+		"pretty-sequence": require("./rules/pretty-sequence"),
+		"svelte-naming-convention": require(
+			"./rules/svelte-naming-convention"
+		)
+	}
+}
+
+Object.assign(
+	plugin.configs,
+	{
+		plugins: { lube: plugin },
+		rules: {
+			"array-bracket-newline": [ "error", "consistent" ],
+			"array-element-newline": [ "error", "consistent" ],
+			"arrow-parens": [ "error", "as-needed" ],
+			"arrow-spacing": [
+				"error",
+				{ "after": true, "before": true }
+			],
+			"block-spacing": [ "error", "always" ],
+			"brace-style": [ "error", "1tbs" ],
+			"comma-dangle": [ "error", "never" ],
+			"comma-spacing": [
+				"error",
+				{ "after": true, "before": false }
+			],
+			"comma-style": [ "error", "last" ],
+			"computed-property-spacing": [ "error", "never" ],
+			"dot-location": [ "error", "property" ],
+			"eol-last": [ "error", "never" ],
+			"func-call-spacing": [ "error", "never" ],
+			"function-call-argument-newline": [ "error", "consistent" ],
+			"generator-star-spacing": [ "error", "after" ],
+			"indent": [ "error", "tab" ],
+			"jsx-quotes": [ "error", "prefer-double" ],
+			"key-spacing": [
+				"error",
+				{
+					"afterColon": true,
+					"beforeColon": false
+				}
+			],
+			"keyword-spacing": [
+				"error",
+				{ "after": true, "before": true }
+			],
+			"lube/pretty-imports": "error",
+			"lube/pretty-jsdoc-casting": "error",
+			"lube/pretty-sequence": "error",
+			"lube/svelte-naming-convention": "error",
+			"max-len": [ "warn", 120 ],
+			"max-statements-per-line": [ "error", { "max": 1 } ],
+			"multiline-ternary": [ "error", "always-multiline" ],
+			"newline-per-chained-call": [
+				"error",
+				{ "ignoreChainWithDepth": 2 }
+			],
+			"no-await-in-loop": "warn",
+			"no-case-declarations": "off",
+			"no-console": "warn",
+			"no-duplicate-imports": "error",
+			"no-lonely-if": "error",
+			"no-multi-spaces": "error",
+			"no-new-native-nonconstructor": "error",
+			"no-self-compare": "error",
+			"no-shadow": "error",
+			"no-shadow-restricted-names": "error",
+			"no-trailing-spaces": [
+				"error",
+				{
+					"ignoreComments": false,
+					"skipBlankLines": false
+				}
+			],
+			"object-curly-newline": [ "error", { "consistent": true } ],
+			"object-curly-spacing": [ "error", "always" ],
+			"one-var": [ "error", "never" ],
+			"operator-linebreak": [ "error", "before" ],
+			"prefer-const": [
+				"warn",
+				{
+					"destructuring": "all",
+					"ignoreReadBeforeAssign": false
+				}
+			],
+			"quotes": [ "error", "double" ],
+			"rest-spread-spacing": [ "error", "never" ],
+			"semi": [ "error", "never" ],
+			"semi-spacing": [
+				"error",
+				{ "after": true, "before": false }
+			],
+			"semi-style": [ "error", "first" ],
+			"space-before-blocks": [ "error", "always" ],
+			"space-before-function-paren": [
+				"error",
+				{
+					"anonymous": "never",
+					"asyncArrow": "always",
+					"named": "never"
+				}
+			],
+			"space-in-parens": [ "error", "never" ],
+			"space-infix-ops": [ "error", { "int32Hint": true } ],
+			"space-unary-ops": [
+				"error",
+				{ "nonwords": false, "words": true }
+			],
+			"switch-colon-spacing": [
+				"error",
+				{ "after": true, "before": false }
+			],
+			"template-curly-spacing": [ "error", "never" ],
+			"template-tag-spacing": [ "error", "never" ],
+			"yield-star-spacing": [ "error", "after" ]
+		}
+	}
+)
+
+module.exports = plugin

package/package.json

@@ -1,32 +1,40 @@
-{
-	"author": "artxe2",
-	"bugs": {
-		"url": "https://github.com/Artxe2/lube-series/issues"
-	},
-	"description": "Full fixable rules for auto-formatting with ESLint only without Prettier",
-	"devDependencies": {
-		"@types/eslint": "^8.44.6",
-		"@types/estree": "^1.0.3",
-		"@typescript-eslint/parser": "^6.9.0",
-		"eslint": "^8.52.0",
-		"mocha": "^10.2.0",
-		"typescript": "^5.2.2"
-	},
-	"keywords": [
-		"eslint-plugin",
-		"lube",
-		"eslint-plugin-lube",
-		"prettier",
-		"jsdoc"
-	],
-	"license": "MIT",
-	"name": "eslint-plugin-lube",
-	"repository": {
-		"directory": "packages/eslint-plugin-lube",
-		"type": "git",
-		"url": "https://github.com/Artxe2/lube-series"
-	},
-	"scripts": { "dts": "tsc", "test": "mocha" },
-	"type": "commonjs",
-	"version": "0.4.3"
+{
+	"author": "artxe2",
+	"bugs": {
+		"url": "https://github.com/Artxe2/lube-series/issues"
+	},
+	"description": "Full fixable rules for auto-formatting with ESLint only without Prettier",
+	"devDependencies": {
+		"@types/eslint": "^9.6.1",
+		"@types/estree": "^1.0.8",
+		"@typescript-eslint/parser": "^8.35.0",
+		"eslint": "^9.29.0",
+		"mocha": "^11.7.0",
+		"typescript": "^5.8.3"
+	},
+	"keywords": [
+		"eslint-plugin",
+		"lube",
+		"eslint-plugin-lube",
+		"prettier",
+		"jsdoc"
+	],
+	"license": "MIT",
+	"main": "index.js",
+	"name": "eslint-plugin-lube",
+	"peerDependencies": {
+		"eslint": ">=9.0.0"
+	},
+	"repository": {
+		"directory": "packages/eslint-plugin-lube",
+		"type": "git",
+		"url": "https://github.com/Artxe2/lube-series"
+	},
+	"scripts": {
+		"dts": "node ../../scripts/tsc_with_clean.js eslint-plugin-lube",
+		"test": "mocha"
+	},
+	"type": "commonjs",
+	"types": "types/index.d.ts",
+	"version": "0.5.1"
 }

package/rules/pretty-imports.js

@@ -28,17 +28,17 @@ module.exports = {
 	},
 	create(context) {
 		/** @type {import("../private").RuleOptions["pretty-imports"]} */
-		let option = context.options[0]
-		let check_exports = option?.checkExports ?? true
-		let check_imports = option?.checkImports ?? true
-		let indent = option?.indent ?? "\t"
-		let max_length = option?.maxLength ?? 30
-		let semicolon = option?.semicolon ?? false
+		const option = context.options[0]
+		const check_exports = option?.checkExports ?? true
+		const check_imports = option?.checkImports ?? true
+		const indent = option?.indent ?? "\t"
+		const max_length = option?.maxLength ?? 30
+		const semicolon = option?.semicolon ?? false
 
-		let source_code = context.sourceCode
-		let text = source_code.text
-		let indent_regex = /[ \t]*(?=[^\n]*$)/
-		let _r_regex = /\r/g
+		const source_code = context.sourceCode
+		const text = source_code.text
+		const indent_regex = /[ \t]*(?=[^\n]*$)/
+		const _r_regex = /\r/g
 
 		/**
 		 * @param {number} index
@@ -62,7 +62,7 @@ module.exports = {
 		 * @returns {string}
 		 */
 		function get_text(node_or_start, end) {
-			let substr = typeof node_or_start == "number"
+			const substr = typeof node_or_start == "number"
 				? text.slice(node_or_start, end)
 				: text.slice(
 					node_or_start.range[0],
@@ -95,9 +95,9 @@ module.exports = {
 			 */
 			ExportNamedDeclaration(node) {
 				if (check_exports && node.specifiers[0]?.type == "ExportSpecifier") {
-					let line_indent = get_indent(node.range[0])
+					const line_indent = get_indent(node.range[0])
 					let length = 0
-					for (let s of node.specifiers) {
+					for (const s of node.specifiers) {
 						length += s.range[1] - s.range[0]
 					}
 					let corrected_text = length > max_length
@@ -123,9 +123,9 @@ module.exports = {
 			 */
 			ImportDeclaration(node) {
 				if (check_imports && node.specifiers[0]?.type == "ImportSpecifier") {
-					let line_indent = get_indent(node.range[0])
+					const line_indent = get_indent(node.range[0])
 					let length = 0
-					for (let s of node.specifiers) {
+					for (const s of node.specifiers) {
 						length += s.range[1] - s.range[0]
 					}
 					let corrected_text = length > max_length

package/rules/pretty-jsdoc-casting.js

@@ -1,15 +1,15 @@
 "use strict"
 
-let left_space_regex = /\s+$/
-let right_space_regex = /^\s+/
-let type_regex = /(?<=(?:^|.*\s*)@type\s*\{).+(?=\}.*?$)/
+const left_space_regex = /\s+$/
+const right_space_regex = /^\s+/
+const type_regex = /(?<=(?:^|.*\s*)@type\s*\{).+(?=\}.*?$)/
 
 /**
  * @param {number} length
  * @returns {number[]}
  */
 function get_indexed_array(length) {
-	let array = []
+	const array = []
 	while (length) array[--length] = length
 	return array
 }
@@ -29,21 +29,21 @@ module.exports = {
 		type: "layout"
 	},
 	create(context) {
-		let source_code = context.sourceCode
-		let origin_text = source_code.text
+		const source_code = context.sourceCode
+		const origin_text = source_code.text
 		let fixed_text = origin_text
-		let text_length = fixed_text.length + 1
-		let text_indexes = get_indexed_array(text_length)
+		const text_length = fixed_text.length + 1
+		const text_indexes = get_indexed_array(text_length)
 		/** @type {import("../private").Comment[]} */
-		let comments = []
-		for (let comment of /** @type {import("../private").Comment[]} */(source_code.getAllComments())/**/) {
+		const comments = []
+		for (const comment of /** @type {import("../private").Comment[]} */(source_code.getAllComments())/**/) {
 			let [ start, end ] = comment.range
 			while (start < end) comments[start++] = comment
 		}
 		/** @type {import("../private").AstNode[] & import("estree").Expression[]} */
-		let expressions = []
+		const expressions = []
 		/** @type {Set<string>} */
-		let node_ranges = new Set
+		const node_ranges = new Set
 
 		/**
 		 * @param {import("../private").AstNode} node
@@ -51,11 +51,11 @@ module.exports = {
 		 */
 		function verify_correct(node) {
 			let temp_text = fixed_text
-			let temp_indexes = [ ...text_indexes ]
+			const temp_indexes = [ ...text_indexes ]
 			/** @type {(string | undefined)[]} */
-			let types = []
+			const types = []
 			/** @type {true[]} */
-			let extras = []
+			const extras = []
 			/**
 			 * @param {number} start
 			 * @param {number} end
@@ -63,41 +63,45 @@ module.exports = {
 			 * @returns {void}
 			 */
 			function temp_text_changes(start, end, insert = "") {
-				let gap = insert.length + temp_indexes[start] - temp_indexes[end]
-				temp_text = temp_text.slice(0, temp_indexes[start]) + insert + temp_text.slice(temp_indexes[end])
+				const s = temp_indexes[start]
+				const e = temp_indexes[end]
+				if (s == null || e == null) return
+				const gap = insert.length + s - e
+				temp_text = temp_text.slice(0, s) + insert + temp_text.slice(e)
 				if (gap) {
 					while (end < text_length) {
 						temp_indexes[end++] += gap
 					}
 				}
 			}
+			let comment
 			let open = 0
 			let close = 0
 			let prev_open = 0
 			let prev_close = 0
 			let [ left, right ] = node.range
 			W: while (left > 0) {
-				if (comments[left - 1]) {
-					let comment = comments[left - 1]
+				comment = comments[left - 1]
+				if (comment) {
 					left = comment.range[0]
 					if (open && !types[open - 1]) {
-						let type = comment.type == "Block" && type_regex.exec(comment.value)?.[0]
+						const type = comment.type == "Block" && type_regex.exec(comment.value)?.[0]
 						if (type) {
 							types[open - 1] = type
 							temp_text_changes(...comment.range)
 						}
 					}
 				} else {
-					let left_space = left_space_regex.exec(origin_text.slice(0, left))?.[0].length
+					const left_space = left_space_regex.exec(origin_text.slice(0, left))?.[0].length
 					if (left_space) {
 						left -= left_space
 					} else if (origin_text[left - 1] == "(") {
 						while (right < text_length) {
-							if (comments[right]) {
-								let comment = comments[right]
+							comment = comments[right]
+							if (comment) {
 								right = comment.range[1]
 							} else {
-								let right_space = right_space_regex.exec(origin_text.slice(right))?.[0].length
+								const right_space = right_space_regex.exec(origin_text.slice(right))?.[0].length
 								if (right_space) {
 									right += right_space
 								} else {
@@ -132,8 +136,9 @@ module.exports = {
 				temp_text_changes(prev_open, prev_open, "(")
 				temp_text_changes(prev_close, prev_close, ")")
 			}
-			let start = temp_indexes[node.range[0]]
+			const start = temp_indexes[node.range[0]]
 			let end = temp_indexes[node.range[1]]
+			if (!end) return
 			if (extras[end] || open && temp_text.slice(end, end + 4) == "/**/") {
 				end += 4
 			}
@@ -161,8 +166,11 @@ module.exports = {
 		 * @returns {void}
 		 */
 		function report(node, start, end, corrected_text) {
-			fixed_text = fixed_text.slice(0, text_indexes[start]) + corrected_text + fixed_text.slice(text_indexes[end])
-			let gap = corrected_text.length + text_indexes[start] - text_indexes[end]
+			const s = text_indexes[start]
+			const e = text_indexes[end]
+			if (s == null || e == null) return
+			fixed_text = fixed_text.slice(0, s) + corrected_text + fixed_text.slice(e)
+			const gap = corrected_text.length + s - e
 			if (gap) {
 				for (let i = end; i < text_length; i++) {
 					text_indexes[i] += gap
@@ -187,14 +195,14 @@ module.exports = {
 		 * @returns {void}
 		 */
 		function push_to_reverse(node) {
-			let range = `${node.range[0]} ${node.range[1]}`
+			const range = `${node.range[0]} ${node.range[1]}`
 			if (node_ranges.has(range)) return
 			node_ranges.add(range)
 			expressions.push(node)
 		}
 		return {
 			"Program:exit": () => {
-				for (let node of expressions.reverse()) {
+				for (const node of expressions.reverse()) {
 					verify_correct(node)
 				}
 			},