eslint-plugin-lube 0.3.5 → 0.4.1

package/rules/pretty-imports.js

@@ -12,47 +12,34 @@ module.exports = {
 			exports: "This exports is not pretty",
 			imports: "This imports is not pretty"
 		},
-		schema: [
+		schema: [
 			{
 				properties: {
-					checkExports: {
-						type: "boolean",
-						default: true
-					},
-					checkImports: {
-						type: "boolean",
-						default: true
-					},
-					indent: {
-						type: "string",
-						default: "\t"
-					},
-					maxLength: {
-						type: "number",
-						default: 30
-					},
-					semicolon: {
-						type: "boolean",
-						default: false
-					}
+					checkExports: { type: "boolean", default: true },
+					checkImports: { type: "boolean", default: true },
+					indent: { type: "string", default: "\t" },
+					maxLength: { type: "number", default: 30 },
+					semicolon: { type: "boolean", default: false }
 				},
 				type: "object"
-			}
+			}
 		],
 		type: "layout"
 	},
 	create(context) {
-		const check_exports = /** @type {boolean} */(context.options[0]?.checkExports)/**/ ?? true
-		const check_imports = /** @type {boolean} */(context.options[0]?.checkImports)/**/ ?? true
-		const indent = /** @type {string} */(context.options[0]?.indent)/**/ ?? "\t"
-		const max_length = /** @type {number} */(context.options[0]?.maxLength)/**/ ?? 30
-		const semicolon = /** @type {number} */(context.options[0]?.semicolon)/**/ ?? false
+		/** @type {import("../private").RuleOptions["pretty-imports"]} */
+		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
 
 		const source_code = context.sourceCode
 		const text = source_code.text
-
 		const indent_regex = /[ \t]*(?=[^\n]*$)/
 		const _r_regex = /\r/g
+
 		/**
 		 * @param {number} index
 		 * @returns {string}
@@ -60,7 +47,6 @@ module.exports = {
 		function get_indent(index) {
 			return text.slice(0, index).match(indent_regex)?.[0] || ""
 		}
-
 		/**
 		 * @overload
 		 * @param {number} start
@@ -78,10 +64,12 @@ module.exports = {
 		function get_text(node_or_start, end) {
 			const substr = typeof node_or_start == "number"
 				? text.slice(node_or_start, end)
-				: text.slice(node_or_start.range[0], node_or_start.range[1])
+				: text.slice(
+					node_or_start.range[0],
+					node_or_start.range[1]
+				)
 			return substr.replace(_r_regex, "")
 		}
-
 		/**
 		 * @param {import("../private").AstNode} node
 		 * @param {string} corrected_text
@@ -89,13 +77,15 @@ module.exports = {
 		 * @returns {void}
 		 */
 		function report(node, corrected_text, message_id) {
-			context.report({
-				fix(fixer) {
-					return fixer.replaceText(node, corrected_text)
-				},
-				messageId: message_id,
-				node: /** @type {import("estree").Node} */(node)/**/
-			})
+			context.report(
+				{
+					fix(fixer) {
+						return fixer.replaceText(node, corrected_text)
+					},
+					messageId: message_id,
+					node: /** @type {import("estree").Node} */(node)/**/
+				}
+			)
 		}
 
 		return {
@@ -112,12 +102,10 @@ module.exports = {
 					}
 					let corrected_text = length > max_length
 						? `export {\n${line_indent + indent}${
-
 							/** @type {import("../private").AstNode[]} */(node.specifiers)/**/.map(get_text)
 								.join(",\n" + line_indent + indent)
 						}\n${line_indent}}`
 						: `export { ${
-
 							/** @type {import("../private").AstNode[]} */(node.specifiers)/**/.map(get_text).join(", ")
 						} }`
 					if (node.source) {
@@ -142,12 +130,10 @@ module.exports = {
 					}
 					let corrected_text = length > max_length
 						? `import {\n${line_indent + indent}${
-
 							/** @type {import("../private").AstNode[]} */(node.specifiers)/**/.map(get_text)
 								.join(",\n" + line_indent + indent)
 						}\n${line_indent}} from ${node.source.raw}`
 						: `import { ${
-
 							/** @type {import("../private").AstNode[]} */(node.specifiers)/**/.map(get_text).join(", ")
 						} } from ${node.source.raw}`
 					if (semicolon) {

package/rules/pretty-jsdoc-casting.js

@@ -1,5 +1,9 @@
 "use strict"
 
+const left_space_regex = /\s+$/
+const right_space_regex = /^\s+/
+const type_regex = /(?<=(?:^|.*\s*)@type\s*\{).+(?=\}.*?$)/
+
 /**
  * @param {number} length
  * @returns {number[]}
@@ -30,15 +34,11 @@ module.exports = {
 		let fixed_text = origin_text
 		const text_length = fixed_text.length + 1
 		const text_indexes = get_indexed_array(text_length)
-		const left_space_regex = /\s+$/
-		const right_space_regex = /^\s+/
-		const type_regex = /(?<=(?:^|.*\s*)@type\s*\{).+(?=\}.*?$)/
 		/** @type {import("../private").Comment[]} */
 		const comments = []
-		for (const comment of /** @type {import("../private").Comment[]} */(source_code.getAllComments().reverse())/**/) {
-			const [start, end] = comment.range
-			comments[start] = comment
-			comments[end - 1] = comment
+		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[]} */
 		const expressions = []
@@ -51,7 +51,7 @@ module.exports = {
 		 */
 		function verify_correct(node) {
 			let temp_text = fixed_text
-			const temp_indexes = [...text_indexes]
+			const temp_indexes = [ ...text_indexes ]
 			/** @type {(string | undefined)[]} */
 			const types = []
 			/** @type {true[]} */
@@ -75,7 +75,7 @@ module.exports = {
 			let close = 0
 			let prev_open = 0
 			let prev_close = 0
-			let [left, right] = node.range
+			let [ left, right ] = node.range
 			W: while (left > 0) {
 				if (comments[left - 1]) {
 					const comment = comments[left - 1]
@@ -106,7 +106,10 @@ module.exports = {
 										prev_close = right
 										temp_text_changes(left, left + 1)
 										close++
-										if (temp_text.slice(temp_indexes[right + 1], temp_indexes[right + 5]) == "/**/") {
+										if (temp_text.slice(
+											temp_indexes[right + 1],
+											temp_indexes[right + 5]
+										) == "/**/") {
 											extras[right] = true
 											temp_text_changes(right, right += 5)
 										} else {
@@ -143,7 +146,10 @@ module.exports = {
 			corrected_text = temp_text.slice(temp_indexes[left], start)
 				+ corrected_text
 				+ temp_text.slice(end, temp_indexes[right])
-			if (fixed_text.slice(text_indexes[left], text_indexes[right]) != corrected_text) {
+			if (fixed_text.slice(
+				text_indexes[left],
+				text_indexes[right]
+			) != corrected_text) {
 				report(node, left, right, corrected_text)
 			}
 		}
@@ -162,17 +168,19 @@ module.exports = {
 					text_indexes[i] += gap
 				}
 			}
-			context.report({
-				fix(fixer) {
-					return fixer.replaceTextRange([start, end], corrected_text)
-				},
-				loc: {
-					start: source_code.getLocFromIndex(start),
-					end: source_code.getLocFromIndex(end)
-				},
-				messageId: "not_match",
-				node
-			})
+			context.report(
+				{
+					fix(fixer) {
+						return fixer.replaceTextRange([ start, end ], corrected_text)
+					},
+					loc: {
+						start: source_code.getLocFromIndex(start),
+						end: source_code.getLocFromIndex(end)
+					},
+					messageId: "not_match",
+					node
+				}
+			)
 		}
 		/**
 		 * @param {import("../private").AstNode} node

package/rules/pretty-sequence.js

@@ -0,0 +1,430 @@
+"use strict"
+
+const indent_regex = /[ \t]*(?=[^\n]*$)/
+const left_space_regex = /\s+$/
+const right_space_regex = /^\s+/
+const __n_regex = /(?<=\n)/g
+const _r_regex = /\r/g
+
+/**
+ * @param {number} length
+ * @returns {number[]}
+ */
+function get_indexed_array(length) {
+	const array = []
+	while (length) array[--length] = length
+	return array
+}
+
+/** @type {import("eslint").Rule.RuleModule} */
+module.exports = {
+	meta: {
+		docs: {
+			description: "Enforces additional empty comment when type casting in JSDoc.",
+			recommended: true,
+			url: "https://github.com/Artxe2/lube-series/blob/master/packages/eslint-plugin-lube/docs/pretty-sequence.md"
+		},
+		fixable: "code",
+		messages: {
+			not_match: "This sequence is not pretty"
+		},
+		schema: [
+			{
+				properties: {
+					arrayBracketSpacing: { type: "boolean", default: true },
+					checkArray: { type: "boolean", default: true },
+					checkCall: { type: "boolean", default: true },
+					checkObject: { type: "boolean", default: true },
+					checkSequence: { type: "boolean", default: true },
+					funcCallSpacing: { type: "boolean", default: false },
+					ignoreTemplateLiteral: { type: "boolean", default: true },
+					indent: { type: "string", default: "\t" },
+					maxLength: { type: "number", default: 30 },
+					objectCurlySpacing: { type: "boolean", default: true }
+				},
+				type: "object"
+			}
+		],
+		type: "layout"
+	},
+	create(context) {
+		/** @type {import("../private").RuleOptions["pretty-sequence"]} */
+		const option = context.options[0]
+		const array_bracket_spacing = option?.arrayBracketSpacing ?? true
+		const check_array = option?.checkArray ?? true
+		const check_call = option?.checkCall ?? true
+		const check_object = option?.checkObject ?? true
+		const check_sequence = option?.checkSequence ?? true
+		const func_call_spacing = option?.funcCallSpacing ?? false
+		const ignore_template_literal = option?.ignoreTemplateLiteral ?? true
+		const indent = option?.indent ?? "\t"
+		const max_length = option?.maxLength ?? 30
+		const object_curly_spacing = option?.objectCurlySpacing ?? true
+
+		const source_code = context.sourceCode
+		const origin_text = source_code.text
+		let fixed_text = origin_text
+		const text_length = fixed_text.length + 1
+		const text_indexes = get_indexed_array(text_length)
+		/** @type {import("../private").Comment[]} */
+		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 {true[]} */
+		const ignored_indexes = []
+		/** @type {import("../private").AstNode[] & import("estree").Expression[]} */
+		const nodes = []
+
+		/**
+		 * @param {import("../private").AstNode} node
+		 * @param {number} start
+		 * @param {number} end
+		 * @param {boolean=} add_indentation
+		 * @returns {string}
+		 */
+		function get_text(node, start, end, add_indentation) {
+			let open_paren = false
+			let [ left, right ] = node.range
+			W: while (left > start) {
+				if (comments[left - 1]) {
+					left = comments[left - 1].range[0]
+				} else {
+					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] == "(") {
+						open_paren = true
+						while (right < end) {
+							if (comments[right]) {
+								const comment = comments[right]
+								right = comment.range[1]
+							} else {
+								const right_space = right_space_regex.exec(origin_text.slice(right))?.[0].length
+								if (right_space) {
+									right += right_space
+								} else {
+									if (origin_text[right] == ")") {
+										left--
+										right++
+										open_paren = false
+									}
+									break
+								}
+							}
+						}
+						if (open_paren) break W
+					} else {
+						break
+					}
+				}
+			}
+			while (right < end) {
+				if (comments[right]) {
+					const comment = comments[right]
+					right = comment.range[1]
+				} else {
+					const right_space = right_space_regex.exec(origin_text.slice(right))?.[0].length
+					if (right_space) {
+						right += right_space
+					} else {
+						break
+					}
+				}
+			}
+			const substr = fixed_text.slice(
+				text_indexes[left],
+				text_indexes[right]
+			)
+				.replace(_r_regex, "")
+				.trim()
+			return add_indentation
+				? substr.replace(__n_regex, indent)
+				: substr
+		}
+		/**
+		 * @param {import("../private").AstNode} node
+		 * @returns {void}
+		 */
+		function push_to_reverse(node) {
+			if (
+				ignore_template_literal
+				&& ignored_indexes[node.range[0]]
+			) return
+			nodes.push(node)
+		}
+		/**
+		 * @param {import("../private").AstNode} node
+		 * @param {number} start
+		 * @param {number} end
+		 * @param {string} corrected_text
+		 * @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])
+			const gap = corrected_text.length + text_indexes[start] - text_indexes[end]
+			if (gap) {
+				for (let i = end; i < text_length; i++) {
+					text_indexes[i] += gap
+				}
+			}
+			context.report(
+				{
+					fix(fixer) {
+						return fixer.replaceTextRange([ start, end ], corrected_text)
+					},
+					loc: {
+						start: source_code.getLocFromIndex(start),
+						end: source_code.getLocFromIndex(end)
+					},
+					messageId: "not_match",
+					node
+				}
+			)
+		}
+		/**
+		 * @param {import("../private").AstNode} node
+		 * @returns {void}
+		 */
+		function verify_correct(node) {
+			/**
+			 * @param {number} index
+			 * @returns {string}
+			 */
+			function get_indent(index) {
+				return fixed_text.slice(0, text_indexes[index]).match(indent_regex)?.[0] || ""
+			}
+			let length = 0
+			let start = 0
+			let end = 0
+			let corrected_text = ""
+			let line_indent = get_indent(node.range[0])
+			switch (node.type) {
+			case "ArrayExpression":
+			case "ArrayPattern":
+				start = node.range[0] + 1
+				end = node.range[1] - 1
+				let null_anchor = start
+				const elements = node.elements.map(
+					v => {
+						const n = v ?? {
+							range: [ null_anchor, null_anchor ]
+						}
+						const text = get_text(n, start, end)
+						null_anchor += text.length + 1
+						return n
+					}
+				)
+				for (const text of elements.map(v => get_text(v, start, end))) {
+					if (text.includes("\n")) {
+						length = max_length + 1
+						break
+					}
+					length += text.length
+				}
+				corrected_text = length > max_length
+					? `\n${line_indent + indent}${
+						elements.map(
+							v => get_text(
+								v,
+								start,
+								end,
+								line_indent == get_indent(v.range[0])
+							)
+						)
+							.join(",\n" + line_indent + indent)
+					}\n${line_indent}`
+					: `${length && array_bracket_spacing ? " " : ""}${
+						elements.map(v => get_text(v, start, end)).join(", ")
+					}${length && array_bracket_spacing ? " " : ""}`
+				break
+			case "ArrowFunctionExpression":
+			case "FunctionDeclaration":
+			case "FunctionExpression":
+				if (node.type == "ArrowFunctionExpression") {
+					if (
+						node.params.length != 1
+						|| origin_text.slice(
+							node.range[0],
+							node.params[0].range[0]
+						).includes("(")
+					) {
+						start = origin_text.indexOf("(", node.range[0]) + 1
+						end = origin_text.indexOf(
+							")",
+							node.params.length
+								? node.params[node.params.length - 1].range[1]
+								: start
+						)
+					} else {
+						[ start, end ] = node.params[0].range
+					}
+				} else {
+					start = node.type == "FunctionDeclaration"
+						? origin_text.indexOf("(", node.id.range[1]) + 1
+						: node.id
+							? origin_text.indexOf("(", node.id.range[1]) + 1
+							: origin_text.indexOf("(", node.range[0]) + 1
+					end = origin_text.indexOf(
+						")",
+						node.params.length
+							? node.params[node.params.length - 1].range[1]
+							: start
+					)
+				}
+				for (const text of node.params.map(v => get_text(v, start, end))) {
+					if (text.includes("\n")) {
+						length = max_length + 1
+						break
+					}
+					length += text.length
+				}
+				corrected_text = length > max_length
+					? `\n${line_indent + indent}${
+						node.params.map(
+							v => get_text(
+								v,
+								start,
+								end,
+								line_indent == get_indent(v.range[0])
+							)
+						)
+							.join(",\n" + line_indent + indent)
+					}\n${line_indent}`
+					: `${length && func_call_spacing ? " " : ""}${
+						node.params.map(v => get_text(v, start, end)).join(", ")
+					}${length && func_call_spacing ? " " : ""}`
+				break
+			case "CallExpression":
+			case "NewExpression":
+				if (node.range[1] == node.callee.range[1]) return
+				line_indent = get_indent(node.callee.range[1])
+				start = origin_text.indexOf("(", node.callee.range[1]) + 1
+				end = node.range[1] - 1
+				for (const text of node.arguments.map(v => get_text(v, start, end))) {
+					if (text.includes("\n")) {
+						length = max_length + 1
+						break
+					}
+					length += text.length
+				}
+				corrected_text = length > max_length
+					? `\n${line_indent + indent}${
+						node.arguments.map(
+							v => get_text(
+								v,
+								start,
+								end,
+								line_indent == get_indent(v.range[0])
+							)
+						)
+							.join(",\n" + line_indent + indent)
+					}\n${line_indent}`
+					: `${length && func_call_spacing ? " " : ""}${
+						node.arguments.map(v => get_text(v, start, end)).join(", ")
+					}${length && func_call_spacing ? " " : ""}`
+				break
+			case "ObjectExpression":
+			case "ObjectPattern":
+				start = node.range[0] + 1
+				end = node.range[1] - 1
+				for (const text of node.properties.map(v => get_text(v, start, end))) {
+					if (text.includes("\n")) {
+						length = max_length + 1
+						break
+					}
+					length += text.length
+				}
+				corrected_text = length > max_length
+					? `\n${line_indent + indent}${
+						node.properties.map(
+							v => get_text(
+								v,
+								start,
+								end,
+								line_indent == get_indent(v.range[0])
+							)
+						)
+							.join(",\n" + line_indent + indent)
+					}\n${line_indent}`
+					: `${length && object_curly_spacing ? " " : ""}${
+						node.properties.map(v => get_text(v, start, end))
+							.join(", ")
+					}${length && object_curly_spacing ? " " : ""}`
+				break
+			case "SequenceExpression":
+				start = node.range[0]
+				end = node.range[1]
+				for (const text of node.expressions.map(v => get_text(v, start, end))) {
+					if (text.includes("\n")) {
+						length = max_length + 1
+						break
+					}
+					length += text.length
+				}
+				corrected_text = length > max_length
+					? `${node.expressions
+						.map(v => get_text(v, start, end))
+						.join(",\n" + line_indent)}`
+					: `${node.expressions
+						.map(v => get_text(v, start, end))
+						.join(", ")}`
+				break
+			}
+
+			if (
+				fixed_text.slice(
+					text_indexes[start],
+					text_indexes[end]
+				)
+					.replace(_r_regex, "")
+				!= corrected_text
+			) {
+				report(node, start, end, corrected_text)
+			}
+		}
+		return /** @type {import("../private").RuleListener} */({
+			"Program:exit": () => {
+				for (const node of nodes.reverse()) {
+					verify_correct(node)
+				}
+			},
+			ArrayExpression: node => {
+				if (check_array) push_to_reverse(node)
+			},
+			ArrayPattern: node => {
+				if (check_array) push_to_reverse(node)
+			},
+			ArrowFunctionExpression: node => {
+				if (check_call) push_to_reverse(node)
+			},
+			CallExpression: node => {
+				if (check_call) push_to_reverse(node)
+			},
+			FunctionExpression: node => {
+				if (check_call) push_to_reverse(node)
+			},
+			FunctionDeclaration: node => {
+				if (check_call) push_to_reverse(node)
+			},
+			NewExpression: node => {
+				if (check_call) push_to_reverse(node)
+			},
+			ObjectExpression: node => {
+				if (check_object) push_to_reverse(node)
+			},
+			ObjectPattern: node => {
+				if (check_object) push_to_reverse(node)
+			},
+			SequenceExpression: node => {
+				if (check_sequence) push_to_reverse(node)
+			},
+			TemplateLiteral: ({ range: [ start, end ] }) => {
+				if (ignore_template_literal) {
+					while (start < end) ignored_indexes[start++] = true
+				}
+			}
+		})/**/
+	}
+}