eslint-plugin-lube 0.3.4 → 0.4.0

package/README.md

@@ -1,6 +1,8 @@
 # Eslint plugin lube
+## Full fixable rules for auto-formatting with ESLint only without Prettier
 
 | Rule | Docs | Code | Test |
 |---|---|---|---|
-| 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) |
-| 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-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) |
+| 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-imports.md

@@ -3,31 +3,18 @@ Enforces proper indentation for import and export statements.
 
 ## options
 ```js
-schema: [{
-    properties: {
-        checkExports: {
-            type: "boolean",
-            default: true
+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 }
         },
-        checkImports: {
-            type: "boolean",
-            default: true
-        },
-        indent: {
-            type: "string",
-            default: "\t"
-        },
-        maxLength: {
-            type: "number",
-            default: 30
-        },
-        semicolon: {
-            type: "boolean",
-            default: false
-        }
-    },
-    type: "object"
-}]
+        type: "object"
+    }
+]
 ```
 ### checkExports
 If it is `true`, it checks the export statement.

package/docs/pretty-jsdoc-casting.md

@@ -1,5 +1,5 @@
-# pretty-imports
-Enforces proper indentation for import and export statements.
+# pretty-jsdoc-casting
+Enforces additional empty comment when type casting in JSDoc.
 
 ## options
 ```js

package/docs/pretty-sequence.md

@@ -0,0 +1,113 @@
+# pretty-imports
+Enforces arrays, objects, and functions to have a pretty format by enforcing proper indentation in sequences.
+
+## options
+```js
+schema: [
+    {
+        properties: {
+            arrayBracketSpacing: { type: "boolean", default: true },
+            checkCall: { type: "boolean", default: true },
+            checkArray: { type: "boolean", default: true },
+            checkObject: { type: "boolean", default: true },
+            checkSequence: { type: "boolean", default: true },
+            funcCallSpacing: { type: "boolean", default: false },
+            indent: { type: "string", default: "\t" },
+            maxLength: { type: "number", default: 30 },
+            objectCurlySpacing: { type: "boolean", default: true }
+        },
+        type: "object"
+    }
+]
+```
+### arrayBracketSpacing
+If it is `true`, it inserts spaces inside array brackets.
+### checkArray
+If it is `true`, it checks the array statement.
+### checkCall
+If it is `true`, it checks the function statement.
+### checkObject
+If it is `true`, it checks the object statement.
+### checkSequence
+If it is `true`, it checks the sequence statement.
+### funcCallSpacing
+If it is `true`, it inserts spaces inside function parenthesis.
+### indent
+This is the character to be used for indentation.
+### maxLength
+If the sum of the characters in the Sequences is greater than the set value, apply line breaks.
+```js
+// If maxLength is less than or equal to 20, an error occurs.
+var value = { fff, ggg, hhh, iii, jjj, kkk, lll }
+```
+### objectCurlySpacing
+If it is `true`, it inserts spaces inside object braces.
+
+## Valid
+```js
+var value = [ a, b, c ]
+var value = [
+    aaaaaaaaaa,
+    bbbbbbbbbb,
+    cccccccccc,
+    dddddddddd
+]
+var value = { a, b, c, d, e }
+var value = {
+    aaaaaaaaaa,
+    bbbbbbbbbb,
+    cccccccccc,
+    dddddddddd
+}
+function func(a, b, c) {
+
+}
+function func(
+    aaaaaaaaaa,
+    bbbbbbbbbb,
+    cccccccccc,
+    dddddddddd
+) {
+
+}
+func(
+    aaaaaaaaaa_bbbbbbbbbb_cccccccccc
+)
+    .a(
+        aaaaaaaaaa_bbbbbbbbbb_cccccccccc
+    )
+    .b(
+        aaaaaaaaaa_bbbbbbbbbb_cccccccccc
+    )
+    .c(
+        aaaaaaaaaa_bbbbbbbbbb_cccccccccc
+    )
+
+var value = {
+    a: [ a, b, c ],
+    b: true,
+    c: {
+        aaaaaaaaaa: a,
+        bbbbbbbbbb: b,
+        c: [
+            aaaaaaaaaa,
+            bbbbbbbbbbb,
+            ccccccccccc
+        ],
+        d: {
+            aaaaaaaaaa,
+            bbbbbbbbbbb,
+            ccccccccccc
+        }
+    }
+}
+```
+
+## Invalid
+```js
+var value = [a,b,c]
+var value = { aaaaaaaaaa, bbbbbbbbbb, cccccccccc, dddddddddd }
+new Obj(
+
+)
+```

package/docs/svelte-naming-convention.md

@@ -4,15 +4,14 @@ Enforces snake_case with some symbols for variable declaration.
 
 ## options
 ```js
-schema: [{
-    properties: {
-        fixSameNames: {
-            type: "boolean",
-            default: true
+schema: [
+    {
+        properties: {
+            fixSameNames: { type: "boolean", default: true }
         },
-    },
-    type: "object"
-}]
+        type: "object"
+    }
+]
 ```
 ### fixSameNames
 If set to `true`, an error will be returned if the variable name is the same, even in the case of function calls that are the target of `defer`.

package/index.js

@@ -6,66 +6,52 @@
 module.exports = {
 	configs: {
 		recommended: {
-			extends: ["eslint:recommended"],
-			plugins: ["lube"],
+			extends: [ "eslint:recommended" ],
+			plugins: [ "lube" ],
 			rules: {
-				"array-bracket-newline": [
-					"error", {
-						"multiline": true
-					}
-				],
-				"array-element-newline": ["error", "consistent"],
-				"arrow-parens": ["error", "as-needed"],
+				"array-bracket-newline": [ "error", "consistent" ],
+				"array-element-newline": [ "error", "consistent" ],
+				"arrow-parens": [ "error", "as-needed" ],
 				"arrow-spacing": [
-					"error", {
-						"before": true,
-						"after": true
-					}
+					"error",
+					{ "before": true, "after": true }
 				],
-				"block-spacing": ["error", "always"],
-				"brace-style": ["error", "1tbs"],
-				"comma-dangle": ["error", "never"],
+				"block-spacing": [ "error", "always" ],
+				"brace-style": [ "error", "1tbs" ],
+				"comma-dangle": [ "error", "never" ],
 				"comma-spacing": [
-					"error", {
-						"before": false,
-						"after": true
-					}
+					"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"],
+				"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", {
+					"error",
+					{
 						"afterColon": true,
 						"beforeColon": false
 					}
 				],
 				"keyword-spacing": [
-					"error", {
-						"after": true,
-						"before": true
-					}
-				],
-				"max-len": ["warn", 120],
-				"max-nested-callbacks": ["error", 3],
-				"max-statements-per-line": [
-					"error", {
-						"max": 1
-					}
+					"error",
+					{ "after": true, "before": true }
 				],
-				"multiline-ternary": ["error", "always-multiline"],
+				"max-len": [ "warn", 120 ],
+				"max-statements-per-line": [ "error", { "max": 1 } ],
+				"multiline-ternary": [ "error", "always-multiline" ],
 				"newline-per-chained-call": [
-					"error", {
-						"ignoreChainWithDepth": 2
-					}
+					"error",
+					{ "ignoreChainWithDepth": 2 }
 				],
-				"no-await-in-loop": "error",
+				"no-await-in-loop": "warn",
+				"no-case-declarations": "off",
 				"no-console": "warn",
 				"no-duplicate-imports": "error",
 				"no-lonely-if": "error",
@@ -75,65 +61,55 @@ module.exports = {
 				"no-shadow": "error",
 				"no-shadow-restricted-names": "error",
 				"no-trailing-spaces": [
-					"error", {
+					"error",
+					{
 						"ignoreComments": false,
 						"skipBlankLines": false
 					}
 				],
-				"object-curly-newline": [
-					"error", {
-						"consistent": true
-					}
-				],
-				"object-curly-spacing": ["error", "always"],
-				"operator-linebreak": ["error", "before"],
+				"object-curly-newline": [ "error", { "consistent": true } ],
+				"object-curly-spacing": [ "error", "always" ],
+				"operator-linebreak": [ "error", "before" ],
 				"prefer-const": [
-					"warn", {
+					"warn",
+					{
 						"destructuring": "all",
 						"ignoreReadBeforeAssign": false
 					}
 				],
-				"quotes": ["error", "double"],
-				"rest-spread-spacing": ["error", "never"],
-				"semi": ["error", "never"],
+				"quotes": [ "error", "double" ],
+				"rest-spread-spacing": [ "error", "never" ],
+				"semi": [ "error", "never" ],
 				"semi-spacing": [
-					"error", {
-						"after": true,
-						"before": false
-					}
+					"error",
+					{ "after": true, "before": false }
 				],
-				"semi-style": ["error", "first"],
-				"space-before-blocks": ["error", "always"],
+				"semi-style": [ "error", "first" ],
+				"space-before-blocks": [ "error", "always" ],
 				"space-before-function-paren": [
-					"error", {
+					"error",
+					{
 						"anonymous": "never",
 						"asyncArrow": "always",
 						"named": "never"
 					}
 				],
-				"space-in-parens": ["error", "never"],
-				"space-infix-ops": [
-					"error", {
-						"int32Hint": true
-					}
-				],
+				"space-in-parens": [ "error", "never" ],
+				"space-infix-ops": [ "error", { "int32Hint": true } ],
 				"space-unary-ops": [
-					"error", {
-						"words": true,
-						"nonwords": false
-					}
+					"error",
+					{ "words": true, "nonwords": false }
 				],
 				"switch-colon-spacing": [
-					"error", {
-						"after": true,
-						"before": false
-					}
+					"error",
+					{ "after": true, "before": false }
 				],
-				"template-curly-spacing": ["error", "never"],
-				"template-tag-spacing": ["error", "never"],
-				"yield-star-spacing": ["error", "after"],
+				"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"
 			}
 		}
@@ -141,6 +117,9 @@ module.exports = {
 	rules: {
 		"pretty-imports": require("./rules/pretty-imports"),
 		"pretty-jsdoc-casting": require("./rules/pretty-jsdoc-casting"),
-		"svelte-naming-convention": require("./rules/svelte-naming-convention")
+		"pretty-sequence": require("./rules/pretty-sequence"),
+		"svelte-naming-convention": require(
+			"./rules/svelte-naming-convention"
+		)
 	}
 }

package/package.json

@@ -1,26 +1,34 @@
-{
-	"author": "artxe2",
-	"bugs": {
-		"url": "https://github.com/Artxe2/lube-series/issues"
-	},
-	"description": "Eslint rules expand options",
-	"devDependencies": {
-		"@types/eslint": "^8.44.6",
-		"@types/estree": "^1.0.3",
-		"@typescript-eslint/parser": "^6.8.0",
-		"eslint": "^8.52.0",
-		"mocha": "^10.2.0"
-	},
-	"license": "MIT",
-	"name": "eslint-plugin-lube",
-	"repository": {
-		"type": "git",
-		"url": "https://github.com/Artxe2/lube-series",
-		"directory": "packages/eslint-plugin-lube"
-	},
-	"scripts": {
-		"test": "mocha"
-	},
-	"type": "commonjs",
-	"version": "0.3.4"
+{
+	"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"
+	},
+	"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.0"
 }

package/private.d.ts

@@ -1,34 +1,30 @@
+import * as eslint from "eslint"
 import * as estree from "estree"
 
-export type BaseAstNode = {
-	parent: AstNode
-	range: [number, number]
-}
-
 export type AstNode = BaseAstNode & (
-	estree.ArrayExpression & {
+	{
 		elements: AstNode[]
-	}
-	| estree.ArrayPattern & {
+	} & estree.ArrayExpression
+	| {
 		elements: AstNode[]
-	}
-	| estree.ArrowFunctionExpression & {
+	} & estree.ArrayPattern
+	| {
 		body: AstNode
 		params: AstNode[]
-	}
-	| estree.AssignmentExpression & {
+	} & estree.ArrowFunctionExpression
+	| {
 		left: AstNode
 		right: AstNode
-	}
+	} & estree.AssignmentExpression
 	| estree.AssignmentPattern
 	| estree.AwaitExpression
 	| estree.BinaryExpression
 	| estree.BlockStatement
 	| estree.BreakStatement
-	| estree.CallExpression & {
+	| {
 		callee: AstNode
 		arguments: AstNode[]
-	}
+	} & estree.CallExpression
 	| estree.CatchClause
 	| estree.ChainExpression
 	| estree.ClassBody
@@ -41,37 +37,39 @@ export type AstNode = BaseAstNode & (
 	| estree.EmptyStatement
 	| estree.ExportAllDeclaration
 	| estree.ExportDefaultDeclaration
-	| estree.ExportNamedDeclaration & {
-		source?: estree.SimpleLiteral & {
+	| {
+		source?: {
 			range: [number, number]
 			raw: string
 			value: string
-		}
+		} & estree.SimpleLiteral
 		specifiers: AstNode[]
-	}
+	} & estree.ExportNamedDeclaration
 	| estree.ExportSpecifier
 	| estree.ExpressionStatement
 	| estree.ForInStatement
 	| estree.ForOfStatement
 	| estree.ForStatement
-	| estree.FunctionDeclaration & {
+	| {
 		body: AstNode
+		id: AstNode
 		params: AstNode[]
-	}
-	| estree.FunctionExpression & {
+	} & estree.FunctionDeclaration
+	| {
 		body: AstNode
+		id?: AstNode
 		params: AstNode[]
-	}
+	} & estree.FunctionExpression
 	| estree.Identifier
 	| estree.IfStatement
-	| estree.ImportDeclaration & {
-		source: estree.SimpleLiteral & {
+	| {
+		source: {
 			range: [number, number]
 			raw: string
 			value: string
-		}
+		} & estree.SimpleLiteral
 		specifiers: AstNode[]
-	}
+	} & estree.ImportDeclaration
 	| estree.ImportDefaultSpecifier
 	| estree.ImportExpression
 	| estree.ImportNamespaceSpecifier
@@ -82,29 +80,34 @@ export type AstNode = BaseAstNode & (
 	| estree.MemberExpression
 	| estree.MetaProperty
 	| estree.MethodDefinition
-	| estree.NewExpression & {
+	| {
 		callee: AstNode
 		arguments: AstNode[]
-	}
-	| estree.ObjectExpression & {
+	} & estree.NewExpression
+	| {
 		properties: AstNode[]
-	}
-	| estree.ObjectPattern & {
+	} & estree.ObjectExpression
+	| {
 		properties: AstNode[]
-	}
+	} & estree.ObjectPattern
 	| estree.PrivateIdentifier
 	| estree.Program
-	| estree.Property & {
-		key: AstNode & estree.Identifier
+	| {
+		key: AstNode & (
+			estree.Identifier
+			| estree.Literal
+		)
 		value: AstNode
-	}
+	} & estree.Property
 	| estree.PropertyDefinition
 	| estree.RestElement
 	| estree.ReturnStatement
-	| estree.SequenceExpression
-	| estree.SpreadElement & {
+	| {
+		expressions: AstNode[]
+	} & estree.SequenceExpression
+	| {
 		argument: AstNode
-	}
+	} & estree.SpreadElement
 	| estree.StaticBlock
 	| estree.Super
 	| estree.SwitchCase
@@ -118,13 +121,47 @@ export type AstNode = BaseAstNode & (
 	| estree.UnaryExpression
 	| estree.UpdateExpression
 	| estree.VariableDeclaration
-	| estree.VariableDeclarator & {
+	| {
 		id: AstNode
 		init: AstNode
-	}
+	} & estree.VariableDeclarator
 	| estree.WhileStatement
 	| estree.WithStatement
 	| estree.YieldExpression
 )
 
-export type Comment = BaseAstNode & estree.Comment
+export type BaseAstNode = {
+	parent: AstNode
+	range: [number, number]
+}
+
+export type Comment = BaseAstNode & estree.Comment
+
+export type RuleListener = {
+	[K in keyof eslint.Rule.NodeListener]: (node: import("../private").AstNode) => void
+}
+
+export type RuleOptions = {
+	"pretty-imports"?: {
+		checkExports?: boolean
+		checkImports?: boolean
+		indent?: string
+		maxLength?: number
+		semicolon?: boolean
+	}
+	"pretty-jsdoc-casting": never
+	"pretty-sequence"?: {
+		arrayBracketSpacing?: boolean
+		checkArray?: boolean
+		checkCall?: boolean
+		checkObject?: boolean
+		checkSequence?: boolean
+		funcCallSpacing?: boolean
+		indent?: string
+		maxLength?: number
+		objectCurlySpacing?: boolean
+	}
+	"svelte-naming-convention"?: {
+		fixSameNames?: boolean
+	}
+}