From 746e486c1bce4dc8897a1a66f190aaaff1d4ba09 Mon Sep 17 00:00:00 2001 From: armin Date: Tue, 2 Feb 2021 21:21:22 +0330 Subject: [PATCH 1/3] Docs: Clarify line breaks in object-curly-newline (refs #14024) --- docs/rules/object-curly-newline.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/rules/object-curly-newline.md b/docs/rules/object-curly-newline.md index 302c81c33b5..da30baf2d6e 100644 --- a/docs/rules/object-curly-newline.md +++ b/docs/rules/object-curly-newline.md @@ -1,10 +1,10 @@ -# enforce consistent line breaks inside braces (object-curly-newline) +# enforce consistent line breaks after opening and before closing braces (object-curly-newline) A number of style guides require or disallow line breaks inside of object braces and other tokens. ## Rule Details -This rule enforces consistent line breaks inside braces of object literals or destructuring assignments. +This rule enforces consistent line breaks after opening and before closing braces of object literals or destructuring assignments. ## Options @@ -538,7 +538,7 @@ export { foo as f, bar } from 'foo-bar'; ## When Not To Use It -If you don't want to enforce consistent line breaks inside braces, then it's safe to disable this rule. +If you don't want to enforce consistent line breaks after opening and before closing braces, then it's safe to disable this rule. ## Related Rules From 083373dcb36f14d37535906ce525e00fa683a658 Mon Sep 17 00:00:00 2001 From: armin Date: Fri, 12 Mar 2021 15:34:22 +0330 Subject: [PATCH 2/3] Docs: Clarify line breaks in object-curly-newline (refs #14024) --- docs/rules/object-curly-newline.md | 6 +++--- lib/rules/object-curly-newline.js | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/rules/object-curly-newline.md b/docs/rules/object-curly-newline.md index da30baf2d6e..bab4661e47f 100644 --- a/docs/rules/object-curly-newline.md +++ b/docs/rules/object-curly-newline.md @@ -4,14 +4,14 @@ A number of style guides require or disallow line breaks inside of object braces ## Rule Details -This rule enforces consistent line breaks after opening and before closing braces of object literals or destructuring assignments. +More precisely, the rule requires or disallows a line break between { and its following token, and between } and its preceding token of object literals or destructuring assignments. ## Options This rule has either a string option: -* `"always"` requires line breaks inside braces -* `"never"` disallows line breaks inside braces +* `"always"` requires line breaks after opening and before closing braces +* `"never"` disallows line breaks after opening and before closing braces Or an object option: diff --git a/lib/rules/object-curly-newline.js b/lib/rules/object-curly-newline.js index c5c098e1301..9b64a1b5c6a 100644 --- a/lib/rules/object-curly-newline.js +++ b/lib/rules/object-curly-newline.js @@ -134,7 +134,7 @@ module.exports = { type: "layout", docs: { - description: "enforce consistent line breaks inside braces", + description: "enforce consistent line breaks after opening and before closing braces", category: "Stylistic Issues", recommended: false, url: "https://eslint.org/docs/rules/object-curly-newline" From d6aa4a795935fb4383606d3a2b0589ea2d4ae44f Mon Sep 17 00:00:00 2001 From: armin Date: Sat, 13 Mar 2021 06:38:13 +0330 Subject: [PATCH 3/3] Fix: Clarify line breaks in object-curly-newline (fixes #14024) --- docs/rules/object-curly-newline.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/rules/object-curly-newline.md b/docs/rules/object-curly-newline.md index bab4661e47f..cc98b4293c0 100644 --- a/docs/rules/object-curly-newline.md +++ b/docs/rules/object-curly-newline.md @@ -4,7 +4,7 @@ A number of style guides require or disallow line breaks inside of object braces ## Rule Details -More precisely, the rule requires or disallows a line break between { and its following token, and between } and its preceding token of object literals or destructuring assignments. +This rule requires or disallows a line break between `{` and its following token, and between `}` and its preceding token of object literals or destructuring assignments. ## Options