Add eslint-plugin-newline-destructuring

lolgab · lolgab · commit d08e15b415c2 · 2026-05-20T16:37:41.000+02:00
Register the plugin and add a multiple-test that verifies the
newline-destructuring/newline rule via a project .eslintrc.json.
diff --git a/docs/description/description.json b/docs/description/description.json
diff --git a/docs/multiple-tests/all-patterns-typescript/patterns.xml b/docs/multiple-tests/all-patterns-typescript/patterns.xml
@@ -1724,6 +1724,7 @@
   <module name="n_hashbang" />
   <module name="n_no-hide-core-modules" />
   <module name="n_shebang" />
+  <module name="newline-destructuring_newline" />
   <module name="no-only-tests_no-only-tests" />
   <module name="no-unsanitized_property" />
   <module name="no-unsanitized_method" />
diff --git a/docs/multiple-tests/all-patterns/patterns.xml b/docs/multiple-tests/all-patterns/patterns.xml
@@ -1724,6 +1724,7 @@
   <module name="n_hashbang" />
   <module name="n_no-hide-core-modules" />
   <module name="n_shebang" />
+  <module name="newline-destructuring_newline" />
   <module name="no-only-tests_no-only-tests" />
   <module name="no-unsanitized_property" />
   <module name="no-unsanitized_method" />
diff --git a/docs/multiple-tests/newline-destructuring/patterns.xml b/docs/multiple-tests/newline-destructuring/patterns.xml
@@ -0,0 +1,5 @@
+<module name="root">
+    <module name="BeforeExecutionExclusionFileFilter">
+        <property name="fileNamePattern" value=".*\.json" />
+    </module>
+</module>
diff --git a/docs/multiple-tests/newline-destructuring/results.xml b/docs/multiple-tests/newline-destructuring/results.xml
@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="utf-8"?>
+<checkstyle version="4.3">
+    <file name="newline-destructuring.js">
+        <error source="newline-destructuring_newline" line="2" message="Object desctructuring lines must be broken into multiple lines if there are more than 2 properties" severity="error" />
+    </file>
+</checkstyle>
diff --git a/docs/multiple-tests/newline-destructuring/src/.eslintrc.json b/docs/multiple-tests/newline-destructuring/src/.eslintrc.json
@@ -0,0 +1,9 @@
+{
+  "parserOptions": {
+    "ecmaVersion": 2020
+  },
+  "plugins": ["newline-destructuring"],
+  "rules": {
+    "newline-destructuring/newline": ["error", { "items": 2 }]
+  }
+}
diff --git a/docs/multiple-tests/newline-destructuring/src/newline-destructuring.js b/docs/multiple-tests/newline-destructuring/src/newline-destructuring.js
@@ -0,0 +1,2 @@
+const obj = { a: 1, b: 2, c: 3 };
+const { a, b, c } = obj;
diff --git a/docs/patterns.json b/docs/patterns.json
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -290,6 +290,7 @@
     "eslint-plugin-mocha": "^10.4.3",
     "eslint-plugin-monorepo": "^0.3.2",
     "eslint-plugin-n": "^17.7.0",
+    "eslint-plugin-newline-destructuring": "^1.2.2",
     "eslint-plugin-no-only-tests": "^3.1.0",
     "eslint-plugin-no-unsanitized": "^4.0.2",
     "eslint-plugin-nuxt": "^4.0.0",
diff --git a/src/eslintPlugins.ts b/src/eslintPlugins.ts
@@ -72,6 +72,7 @@ const packageNames: string[] = [
   "eslint-plugin-mocha",
   "eslint-plugin-monorepo",
   "eslint-plugin-n",
+  "eslint-plugin-newline-destructuring",
   "eslint-plugin-no-only-tests",
   "eslint-plugin-no-unsanitized",
   "eslint-plugin-nuxt",

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+const obj = { a: 1, b: 2, c: 3 };`
	`2`	`+const { a, b, c } = obj;`