eslint-plugin-lube 0.2.5 → 0.3.1

package/README.md

@@ -1,6 +1,6 @@
 # Eslint plugin lube
 
-| Rule | Code | Test |
-|---|---|---|
-| svelte-naming-convention | [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 | [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) |
+| 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) |

package/docs/pretty-imports.md

@@ -0,0 +1,73 @@
+# pretty-imports
+Enforces proper indentation for import and export statements.
+
+## options
+```js
+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
+        }
+    },
+    type: "object"
+}]
+```
+### checkExports
+If it is `true`, it checks the export statement.
+### checkImports
+If it is `true`, it checks the import statement.
+### indent
+This is the character to be used for indentation.
+### maxLength
+If the sum of the characters in the Specifier is greater than the set value, apply line breaks.
+```js
+// If maxLength is less than or equal to 20, an error occurs.
+export { fff, ggg, hhh, iii, jjj, kkk, lll } from 'module/2'
+```
+### semicolon
+If it is `true`, insert a semicolon explicitly.
+
+## Valid
+```js
+export { a, b as c, d } from 'module'
+export { fff, ggg, hhh, iii, jjj, kkk, lll } from 'module/2'
+import {
+    aaaaa_bbbbb,
+    aaaaa_ccccc,
+	aaaaa_ddddd
+} from "module"
+```
+
+## Invalid
+```js
+export { a, b as c, d } from 'module';
+export {a, b as c, d} from 'module'
+export {
+    a,
+    b as c,
+    d
+} from 'module'
+import { aaaaa_bbbbb, aaaaa_ccccc, aaaaa_ddddd } from "module"
+import {
+    aaaaa_bbbbb,
+    aaaaa_ccccc,
+    aaaaa_ddddd
+    } from "module"
+```

package/docs/pretty-jsdoc-casting.md

@@ -0,0 +1,24 @@
+# pretty-imports
+Enforces proper indentation for import and export statements.
+
+## options
+```js
+schema: undefined
+```
+
+## Valid
+```js
+var v = func(
+    a
+)
+var v = /** @type {A} */(/** @type {B} */(/** @type {C} */(a)/**/)/**/)/**/
+var v = /** @type {A} */(a)/**/()
+var v = { b: /** @type {A} */(a)/**/ }
+```
+
+## Invalid
+```js
+var v = /** @type {A} */(  /** @type {B} */(/** @type {C} */((a))))
+var v = { b: /** @type {A} */(a) }
+var v = { b: /**@type {A}*/(a)/**/ }
+```

package/docs/svelte-naming-convention.md

@@ -0,0 +1,48 @@
+# svelte-naming-convention
+Enforces snake_case with some symbols for variable declaration.  
+[svelte#code-conventions](https://github.com/sveltejs/svelte/blob/master/CONTRIBUTING.md#code-conventions)
+
+## options
+```js
+schema: [{
+    properties: {
+        fixSameNames: {
+            type: "boolean",
+            default: true
+        },
+    },
+    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`.
+```js
+myFunction() // Only in the case that fixSameNames is true, an error occurs.
+
+// Identifier 'myFunction' does not match for svelte's naming conventions.
+function myFunction() {
+
+}
+```
+
+## Valid
+```js
+var snake_case = 'Hello'
+var snake1_2_3case_4 = 'Hello'
+var SNAKE_CASE = 'Hello'
+var SNAKE1_2_3CASE_4 = 'Hello'
+var PascalCase = 'Hello'
+var P1ascal2Case345 = 'Hello'
+var __ = 'Hello'
+var $$ = 'Hello'
+var __snake_case$$ = 'Hello'
+var $$snake_case$$ = 'Hello'
+```
+
+## Invalid
+```js
+var camelCase = 'Hello'
+var NO_SNAKE__CASE = 'Hello'
+var NO_SNAKE_CASE_ = 'Hello'
+var __camelCase$$ = 'Hello'
+```

package/index.js

@@ -19,8 +19,6 @@ module.exports = {
 					"after": true,
 					"before": true
 				}],
-				"lube/svelte-naming-convention": "error",
-				"lube/pretty-imports": "error",
 				"max-len": ["warn", 120],
 				"max-nested-callbacks": ["error", 3],
 				"no-console": "warn",
@@ -42,12 +40,16 @@ module.exports = {
 				}],
 				"space-in-parens": ["error", "never"],
 				"space-infix-ops": "error",
-				"space-unary-ops": "error"
+				"space-unary-ops": "error",
+				"lube/pretty-imports": "error",
+				"lube/pretty-jsdoc-casting": "error",
+				"lube/svelte-naming-convention": "error",
 			}
 		}
 	},
 	rules: {
 		"pretty-imports": require("./rules/pretty-imports"),
+		"pretty-jsdoc-casting": require("./rules/pretty-jsdoc-casting"),
 		"svelte-naming-convention": require("./rules/svelte-naming-convention")
 	}
 }

package/package.json

@@ -1,26 +1,26 @@
-{
-	"author": "artxe2",
-	"bugs": {
-		"url": "https://github.com/Artxe2/lube-series/issues"
-	},
-	"description": "Eslint rules expand options",
-	"devDependencies": {
-		"@types/eslint": "^8.44.2",
-		"@types/estree": "^1.0.1",
-		"@typescript-eslint/parser": "^6.3.0",
-		"eslint": "^8.47.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.2.5"
-}
+{
+	"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.1"
+}

package/private.d.ts

@@ -1,26 +1,34 @@
 import * as estree from "estree"
 
-export type ASTNode = {
-	parent: ASTNode
+export type BaseAstNode = {
+	parent: AstNode
 	range: [number, number]
-} & (
+}
+
+export type AstNode = BaseAstNode & (
 	estree.ArrayExpression & {
-		elements: ASTNode[]
+		elements: AstNode[]
 	}
 	| estree.ArrayPattern & {
-		elements: ASTNode[]
+		elements: AstNode[]
 	}
 	| estree.ArrowFunctionExpression & {
-		body: ASTNode
-		params: ASTNode[]
+		body: AstNode
+		params: AstNode[]
+	}
+	| estree.AssignmentExpression & {
+		left: AstNode
+		right: AstNode
 	}
-	| estree.AssignmentExpression
 	| estree.AssignmentPattern
 	| estree.AwaitExpression
 	| estree.BinaryExpression
 	| estree.BlockStatement
 	| estree.BreakStatement
-	| estree.CallExpression
+	| estree.CallExpression & {
+		callee: AstNode
+		arguments: AstNode[]
+	}
 	| estree.CatchClause
 	| estree.ChainExpression
 	| estree.ClassBody
@@ -39,7 +47,7 @@ export type ASTNode = {
 			raw: string
 			value: string
 		}
-		specifiers: ASTNode[]
+		specifiers: AstNode[]
 	}
 	| estree.ExportSpecifier
 	| estree.ExpressionStatement
@@ -47,12 +55,12 @@ export type ASTNode = {
 	| estree.ForOfStatement
 	| estree.ForStatement
 	| estree.FunctionDeclaration & {
-		body: ASTNode
-		params: ASTNode[]
+		body: AstNode
+		params: AstNode[]
 	}
 	| estree.FunctionExpression & {
-		body: ASTNode
-		params: ASTNode[]
+		body: AstNode
+		params: AstNode[]
 	}
 	| estree.Identifier
 	| estree.IfStatement
@@ -62,7 +70,7 @@ export type ASTNode = {
 			raw: string
 			value: string
 		}
-		specifiers: ASTNode[]
+		specifiers: AstNode[]
 	}
 	| estree.ImportDefaultSpecifier
 	| estree.ImportExpression
@@ -74,21 +82,29 @@ export type ASTNode = {
 	| estree.MemberExpression
 	| estree.MetaProperty
 	| estree.MethodDefinition
-	| estree.NewExpression
+	| estree.NewExpression & {
+		callee: AstNode
+		arguments: AstNode[]
+	}
 	| estree.ObjectExpression & {
-		properties: ASTNode[]
+		properties: AstNode[]
 	}
 	| estree.ObjectPattern & {
-		properties: ASTNode[]
+		properties: AstNode[]
 	}
 	| estree.PrivateIdentifier
 	| estree.Program
-	| estree.Property & { key: estree.Identifier }
+	| estree.Property & {
+		key: AstNode & estree.Identifier
+		value: AstNode
+	}
 	| estree.PropertyDefinition
 	| estree.RestElement
 	| estree.ReturnStatement
 	| estree.SequenceExpression
-	| estree.SpreadElement
+	| estree.SpreadElement & {
+		argument: AstNode
+	}
 	| estree.StaticBlock
 	| estree.Super
 	| estree.SwitchCase
@@ -102,8 +118,13 @@ export type ASTNode = {
 	| estree.UnaryExpression
 	| estree.UpdateExpression
 	| estree.VariableDeclaration
-	| estree.VariableDeclarator
+	| estree.VariableDeclarator & {
+		id: AstNode
+		init: AstNode
+	}
 	| estree.WhileStatement
 	| estree.WithStatement
 	| estree.YieldExpression
-)
+)
+
+export type Comment = BaseAstNode & estree.Comment

package/rules/pretty-imports.js

@@ -3,13 +3,14 @@
 module.exports = {
 	meta: {
 		docs: {
-			description: "Enforces pretty imports.",
+			description: "Enforces proper indentation for import and export statements.",
 			recommended: true,
-			url: "https://github.com/Artxe2/lube-series/blob/master/packages/eslint-plugin-lube/rules/pretty-imports.js"
+			url: "https://github.com/Artxe2/lube-series/blob/master/packages/eslint-plugin-lube/docs/pretty-imports.md"
 		},
 		fixable: "code",
 		messages: {
-			not_match: "This imports is not pretty"
+			exports: "This exports is not pretty",
+			imports: "This imports is not pretty"
 		},
 		schema: [{
 			properties: {
@@ -36,21 +37,24 @@ module.exports = {
 			},
 			type: "object"
 		}],
-		type: "suggestion"
+		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
+		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
 
 		const source_code = context.sourceCode
 		const text = source_code.text
 
 		const indent_regex = /[ \t]*(?=[^\n]*$)/
 		const _r_regex = /\r/g
-		/** @param {number} index */
+		/**
+		 * @param {number} index
+		 * @returns {string}
+		 */
 		function get_indent(index) {
 			return text.slice(0, index).match(indent_regex)?.[0] || ""
 		}
@@ -62,11 +66,11 @@ module.exports = {
 		 * @returns {string}
 		 *//**
 		 * @overload
-		 * @param {import("../private").ASTNode} node
+		 * @param {import("../private").AstNode} node
 		 * @returns {string}
 		 *//**
-		 * @param {import("../private").ASTNode|number} node_or_start
-		 * @param {number} [end]
+		 * @param {import("../private").AstNode | number} node_or_start
+		 * @param {number=} end
 		 * @returns {string}
 		 */
 		function get_text(node_or_start, end) {
@@ -77,21 +81,26 @@ module.exports = {
 		}
 
 		/**
-		 * @param {import("../private").ASTNode} node
+		 * @param {import("../private").AstNode} node
 		 * @param {string} corrected_text
+		 * @param {"exports" | "imports"} message_id
+		 * @returns {void}
 		 */
-		function report(node, corrected_text) {
+		function report(node, corrected_text, message_id) {
 			context.report({
 				fix(fixer) {
 					return fixer.replaceText(node, corrected_text)
 				},
-				messageId: "not_match",
-				node: /** @type {import("estree").Node} */(node)
+				messageId: message_id,
+				node: /** @type {import("estree").Node} */(node)/**/
 			})
 		}
 
 		return {
-			/** @param {import("../private").ASTNode & import("estree").ExportNamedDeclaration} node */
+			/**
+			 * @param {import("../private").AstNode & import("estree").ExportNamedDeclaration} node
+			 * @returns {void}
+			 */
 			ExportNamedDeclaration(node) {
 				if (check_exports && node.specifiers[0]?.type == "ExportSpecifier") {
 					const line_indent = get_indent(node.range[0])
@@ -101,13 +110,13 @@ module.exports = {
 					}
 					let corrected_text = length > max_length
 						? `export {\n${line_indent + indent}${
-							/** @type {import("../private").ASTNode[]} v */
-							(node.specifiers).map(get_text)
+							
+							/** @type {import("../private").AstNode[]} */(node.specifiers)/**/.map(get_text)
 								.join(",\n" + line_indent + indent)
 						}\n${line_indent}}`
 						: `export { ${
-							/** @type {import("../private").ASTNode[]} v */
-							(node.specifiers).map(get_text).join(", ")
+							
+							/** @type {import("../private").AstNode[]} */(node.specifiers)/**/.map(get_text).join(", ")
 						} }`
 					if (node.source) {
 						corrected_text += " from " + node.source.raw
@@ -115,10 +124,13 @@ module.exports = {
 					if (semicolon) {
 						corrected_text += ";"
 					}
-					if (corrected_text != get_text(node)) report(node, corrected_text)
+					if (corrected_text != get_text(node)) report(node, corrected_text, "exports")
 				}
 			},
-			/** @param {import("../private").ASTNode & import("estree").ImportDeclaration} node */
+			/**
+			 * @param {import("../private").AstNode & import("estree").ImportDeclaration} node
+			 * @returns {void}
+			 */
 			ImportDeclaration(node) {
 				if (check_imports && node.specifiers[0]?.type == "ImportSpecifier") {
 					const line_indent = get_indent(node.range[0])
@@ -128,18 +140,18 @@ module.exports = {
 					}
 					let corrected_text = length > max_length
 						? `import {\n${line_indent + indent}${
-							/** @type {import("../private").ASTNode[]} v */
-							(node.specifiers).map(get_text)
+							
+							/** @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[]} v */
-							(node.specifiers).map(get_text).join(", ")
+							
+							/** @type {import("../private").AstNode[]} */(node.specifiers)/**/.map(get_text).join(", ")
 						} } from ${node.source.raw}`
 					if (semicolon) {
 						corrected_text += ";"
 					}
-					if (corrected_text != get_text(node)) report(node, corrected_text)
+					if (corrected_text != get_text(node)) report(node, corrected_text, "imports")
 				}
 			}
 		}