eslint-plugin-lube 0.4.0 → 0.4.2

package/README.md

@@ -5,4 +5,5 @@
 |---|---|---|---|
 | pretty-imports | [docs](https://github.com/Artxe2/lube-series/blob/master/packages/eslint-plugin-lube/docs/pretty-imports.md) | [code](https://github.com/Artxe2/lube-series/blob/master/packages/eslint-plugin-lube/rules/pretty-imports.js) | [test](https://github.com/Artxe2/lube-series/blob/master/packages/eslint-plugin-lube/test/pretty-imports) |
 | pretty-jsdoc-casting | [docs](https://github.com/Artxe2/lube-series/blob/master/packages/eslint-plugin-lube/docs/pretty-jsdoc-casting.md) | [code](https://github.com/Artxe2/lube-series/blob/master/packages/eslint-plugin-lube/rules/pretty-jsdoc-casting.js) | [test](https://github.com/Artxe2/lube-series/blob/master/packages/eslint-plugin-lube/test/pretty-jsdoc-casting) |
+| pretty-sequence | [docs](https://github.com/Artxe2/lube-series/blob/master/packages/eslint-plugin-lube/docs/pretty-sequence.md) | [code](https://github.com/Artxe2/lube-series/blob/master/packages/eslint-plugin-lube/rules/pretty-sequence.js) | [test](https://github.com/Artxe2/lube-series/blob/master/packages/eslint-plugin-lube/test/pretty-sequence) |
 | svelte-naming-convention | [docs](https://github.com/Artxe2/lube-series/blob/master/packages/eslint-plugin-lube/docs/svelte-naming-convention.md) | [code](https://github.com/Artxe2/lube-series/blob/master/packages/eslint-plugin-lube/rules/svelte-naming-convention.js) | [test](https://github.com/Artxe2/lube-series/blob/master/packages/eslint-plugin-lube/test/svelte-naming-convention) |

package/docs/pretty-sequence.md

@@ -1,4 +1,4 @@
-# pretty-imports
+# pretty-sequence
 Enforces arrays, objects, and functions to have a pretty format by enforcing proper indentation in sequences.
 
 ## options
@@ -12,6 +12,7 @@ schema: [
             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 }
@@ -32,6 +33,8 @@ If it is `true`, it checks the object statement.
 If it is `true`, it checks the sequence statement.
 ### funcCallSpacing
 If it is `true`, it inserts spaces inside function parenthesis.
+### ignoreTemplateLiteral
+If it is `true`, it ignores the template literal syntax.
 ### indent
 This is the character to be used for indentation.
 ### maxLength
@@ -70,6 +73,8 @@ function func(
 ) {
 
 }
+var value = `${[a,b,c]}`
+
 func(
     aaaaaaaaaa_bbbbbbbbbb_cccccccccc
 )

package/package.json

@@ -30,5 +30,5 @@
 		"test": "mocha"
 	},
 	"type": "commonjs",
-	"version": "0.4.0"
+	"version": "0.4.2"
 }

package/private.d.ts

@@ -157,6 +157,7 @@ export type RuleOptions = {
 		checkObject?: boolean
 		checkSequence?: boolean
 		funcCallSpacing?: boolean
+		ignoreTemplateLiteral?: boolean
 		indent?: string
 		maxLength?: number
 		objectCurlySpacing?: boolean

package/rules/pretty-sequence.js

@@ -37,6 +37,7 @@ module.exports = {
 					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 }
@@ -55,6 +56,7 @@ module.exports = {
 		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
@@ -70,6 +72,8 @@ module.exports = {
 			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 = []
 
@@ -144,6 +148,10 @@ module.exports = {
 		 * @returns {void}
 		 */
 		function push_to_reverse(node) {
+			if (
+				ignore_template_literal
+				&& ignored_indexes[node.range[0]]
+			) return
 			nodes.push(node)
 		}
 		/**
@@ -411,6 +419,11 @@ module.exports = {
 			},
 			SequenceExpression: node => {
 				if (check_sequence) push_to_reverse(node)
+			},
+			TemplateLiteral: ({ range: [ start, end ] }) => {
+				if (ignore_template_literal) {
+					while (start < end) ignored_indexes[start++] = true
+				}
 			}
 		})/**/
 	}

package/test/pretty-sequence/case_by_option.js

@@ -108,4 +108,19 @@ exports.module = (valid, invalid) => {
 			parserOptions: { ecmaVersion: "latest" }
 		}
 	)
+	invalid.push(
+		{
+			code: `
+			var value = \`\${[a,b,c]}\`
+			`,
+			errors: [ {} ],
+			options: [
+				{ ignoreTemplateLiteral: false }
+			],
+			output: `
+			var value = \`\${[ a, b, c ]}\`
+			`,
+			parserOptions: { ecmaVersion: "latest" }
+		}
+	)
 }