feat: Add option in block-sequence-hyphen-indicator-newline (#259)

* feat: Add an option to block-sequence-hyphen-indicator-newline

* test: Rename test suite `block-mapping-only` to `nested-hyphen-and-block-mapping-newline`

* test: new test suite for `block-sequence-hyphen-indicator-newline`

* docs: Update for new option in `block-sequence-hyphen-indicator-newline`

* test: add test case for block mapping

* Create thick-eyes-march.md

---------

Co-authored-by: Yosuke Ota <otameshiyo23@gmail.com>

.changeset/thick-eyes-march.md

@@ -0,0 +1,5 @@
+---
+"eslint-plugin-yml": minor
+---
+
+feat: add `blockMapping` option in `block-sequence-hyphen-indicator-newline`

docs/rules/block-sequence-hyphen-indicator-newline.md

@@ -41,6 +41,7 @@ yml/block-sequence-hyphen-indicator-newline:
   - error
   - never # or "always" 
   - nestedHyphen: always # or "never"
+  - blockMapping: never # or "always"
 ```
 
 - Styles
@@ -49,6 +50,27 @@ yml/block-sequence-hyphen-indicator-newline:
 
 - Properties
   - `nestedHyphen` ... Specifies the style to apply to nested hyphens. default `"always"`
+  - `blockMapping` ... Specifies the style to apply to block mapping. If unspecified, the value of `Styles` is used.
+
+### `"blockMapping": "always"`
+
+<eslint-code-block fix>
+
+<!-- eslint-skip -->
+
+```yaml
+# eslint yml/block-sequence-hyphen-indicator-newline: ['error', 'never', { blockMapping: 'always' }]
+
+# ✓ GOOD
+-
+  keyA: "GOOD"
+- { keyB: "GOOD" }
+
+# ✗ BAD
+- key: "BAD"
+```
+
+</eslint-code-block>
 
 ## :couple: Related rules
 

src/rules/block-sequence-hyphen-indicator-newline.ts

@@ -17,6 +17,7 @@ export default createRule("block-sequence-hyphen-indicator-newline", {
         type: "object",
         properties: {
           nestedHyphen: { enum: ["always", "never"] },
+          blockMapping: { enum: ["always", "never"] },
         },
         additionalProperties: false,
       },
@@ -37,16 +38,25 @@ export default createRule("block-sequence-hyphen-indicator-newline", {
     const style: "never" | "always" = context.options[0] || "never";
     const nestedHyphenStyle: "never" | "always" =
       context.options[1]?.nestedHyphen || "always";
+    const blockMappingStyle: "never" | "always" =
+      context.options[1]?.blockMapping || style;
 
     /**
      * Get style from given hyphen
      */
-    function getStyleOption(hyphen: AST.Token): "never" | "always" {
+    function getStyleOption(
+      hyphen: AST.Token,
+      entry: AST.YAMLContent | AST.YAMLWithMeta,
+    ): "never" | "always" {
       const next = sourceCode.getTokenAfter(hyphen);
       if (next && isHyphen(next)) {
         return nestedHyphenStyle;
       }
 
+      if (entry.type === "YAMLMapping" && entry.style === "block") {
+        return blockMappingStyle;
+      }
+
       return style;
     }
 
@@ -66,7 +76,7 @@ export default createRule("block-sequence-hyphen-indicator-newline", {
 
           const hasNewline = hyphen.loc.end.line < entry.loc.start.line;
           if (hasNewline) {
-            if (getStyleOption(hyphen) === "never") {
+            if (getStyleOption(hyphen, entry) === "never") {
               context.report({
                 loc: hyphen.loc,
                 messageId: "unexpectedLinebreakAfterIndicator",
@@ -89,7 +99,7 @@ export default createRule("block-sequence-hyphen-indicator-newline", {
               });
             }
           } else {
-            if (getStyleOption(hyphen) === "always") {
+            if (getStyleOption(hyphen, entry) === "always") {
               context.report({
                 loc: hyphen.loc,
                 messageId: "expectedLinebreakAfterIndicator",

tests/fixtures/rules/block-sequence-hyphen-indicator-newline/invalid/yaml-test-suite-for-always/_config.json

@@ -2,7 +2,8 @@
   "options": [
     "always",
     {
-      "nestedHyphen": "always"
+      "nestedHyphen": "always",
+      "blockMapping": "always"
     }
   ],
   "settings": {

tests/fixtures/rules/block-sequence-hyphen-indicator-newline/invalid/yaml-test-suite-for-always/mapping-errors.json

@@ -0,0 +1,22 @@
+[
+  {
+    "message": "Expected a line break after this `-` indicator.",
+    "line": 2,
+    "column": 1
+  },
+  {
+    "message": "Expected a line break after this `-` indicator.",
+    "line": 3,
+    "column": 1
+  },
+  {
+    "message": "Expected a line break after this `-` indicator.",
+    "line": 3,
+    "column": 3
+  },
+  {
+    "message": "Expected a line break after this `-` indicator.",
+    "line": 4,
+    "column": 1
+  }
+]

tests/fixtures/rules/block-sequence-hyphen-indicator-newline/invalid/yaml-test-suite-for-always/mapping-input.yaml

@@ -0,0 +1,3 @@
+- a: a
+- - b: b
+- {c: c}

tests/fixtures/rules/block-sequence-hyphen-indicator-newline/invalid/yaml-test-suite-for-always/mapping-output.yml

@@ -0,0 +1,8 @@
+# block-sequence-hyphen-indicator-newline/invalid/yaml-test-suite-for-always/mapping-input.yaml
+-
+  a: a
+-
+  -
+    b: b
+-
+  {c: c}

tests/fixtures/rules/block-sequence-hyphen-indicator-newline/invalid/yaml-test-suite-for-block-mapping-only-newline/6BCT-errors.json

@@ -0,0 +1,7 @@
+[
+  {
+    "message": "Expected a line break after this `-` indicator.",
+    "line": 2,
+    "column": 1
+  }
+]

tests/fixtures/rules/block-sequence-hyphen-indicator-newline/invalid/yaml-test-suite-for-block-mapping-only-newline/6BCT-input.yaml

@@ -0,0 +1,3 @@
+- foo:	 bar
+- - baz
+  -	baz

tests/fixtures/rules/block-sequence-hyphen-indicator-newline/invalid/yaml-test-suite-for-block-mapping-only-newline/6BCT-output.yml

@@ -0,0 +1,5 @@
+# block-sequence-hyphen-indicator-newline/invalid/yaml-test-suite-for-block-mapping-only-newline/6BCT-input.yaml
+-
+  foo:	 bar
+- - baz
+  -	baz

tests/fixtures/rules/block-sequence-hyphen-indicator-newline/invalid/yaml-test-suite-for-block-mapping-only-newline/735Y-errors.json

@@ -0,0 +1,7 @@
+[
+  {
+    "message": "Unexpected line break after this `-` indicator.",
+    "line": 2,
+    "column": 1
+  }
+]

tests/fixtures/rules/block-sequence-hyphen-indicator-newline/invalid/yaml-test-suite-for-block-mapping-only-newline/735Y-input.yaml

@@ -0,0 +1,6 @@
+-
+  "flow in block"
+- >
+ Block scalar
+- !!map # Block collection
+  foo : bar

tests/fixtures/rules/block-sequence-hyphen-indicator-newline/invalid/yaml-test-suite-for-block-mapping-only-newline/735Y-output.yml

@@ -0,0 +1,6 @@
+# block-sequence-hyphen-indicator-newline/invalid/yaml-test-suite-for-block-mapping-only-newline/735Y-input.yaml
+- "flow in block"
+- >
+ Block scalar
+- !!map # Block collection
+  foo : bar

tests/fixtures/rules/block-sequence-hyphen-indicator-newline/invalid/yaml-test-suite-for-block-mapping-only-newline/93JH-errors.json

@@ -0,0 +1,7 @@
+[
+  {
+    "message": "Expected a line break after this `-` indicator.",
+    "line": 2,
+    "column": 2
+  }
+]

tests/fixtures/rules/block-sequence-hyphen-indicator-newline/invalid/yaml-test-suite-for-block-mapping-only-newline/93JH-input.yaml

@@ -0,0 +1,4 @@
+ - key: value
+   key2: value2
+ -
+   key3: value3

tests/fixtures/rules/block-sequence-hyphen-indicator-newline/invalid/yaml-test-suite-for-block-mapping-only-newline/93JH-output.yml

@@ -0,0 +1,6 @@
+# block-sequence-hyphen-indicator-newline/invalid/yaml-test-suite-for-block-mapping-only-newline/93JH-input.yaml
+ -
+   key: value
+   key2: value2
+ -
+   key3: value3

tests/fixtures/rules/block-sequence-hyphen-indicator-newline/invalid/yaml-test-suite-for-block-mapping-only-newline/9U5K-errors.json

@@ -0,0 +1,17 @@
+[
+  {
+    "message": "Expected a line break after this `-` indicator.",
+    "line": 4,
+    "column": 1
+  },
+  {
+    "message": "Expected a line break after this `-` indicator.",
+    "line": 6,
+    "column": 1
+  },
+  {
+    "message": "Expected a line break after this `-` indicator.",
+    "line": 8,
+    "column": 1
+  }
+]

tests/fixtures/rules/block-sequence-hyphen-indicator-newline/invalid/yaml-test-suite-for-block-mapping-only-newline/9U5K-input.yaml

@@ -0,0 +1,8 @@
+---
+# Products purchased
+- item    : Super Hoop
+  quantity: 1
+- item    : Basketball
+  quantity: 4
+- item    : Big Shoes
+  quantity: 1

tests/fixtures/rules/block-sequence-hyphen-indicator-newline/invalid/yaml-test-suite-for-block-mapping-only-newline/9U5K-output.yml

@@ -0,0 +1,12 @@
+# block-sequence-hyphen-indicator-newline/invalid/yaml-test-suite-for-block-mapping-only-newline/9U5K-input.yaml
+---
+# Products purchased
+-
+  item    : Super Hoop
+  quantity: 1
+-
+  item    : Basketball
+  quantity: 4
+-
+  item    : Big Shoes
+  quantity: 1

tests/fixtures/rules/block-sequence-hyphen-indicator-newline/invalid/yaml-test-suite-for-block-mapping-only-newline/AZW3-errors.json

@@ -0,0 +1,12 @@
+[
+  {
+    "message": "Expected a line break after this `-` indicator.",
+    "line": 2,
+    "column": 1
+  },
+  {
+    "message": "Expected a line break after this `-` indicator.",
+    "line": 3,
+    "column": 1
+  }
+]

tests/fixtures/rules/block-sequence-hyphen-indicator-newline/invalid/yaml-test-suite-for-block-mapping-only-newline/AZW3-input.yaml

@@ -0,0 +1,2 @@
+- bla"keks: foo
+- bla]keks: foo

tests/fixtures/rules/block-sequence-hyphen-indicator-newline/invalid/yaml-test-suite-for-block-mapping-only-newline/AZW3-output.yml

@@ -0,0 +1,5 @@
+# block-sequence-hyphen-indicator-newline/invalid/yaml-test-suite-for-block-mapping-only-newline/AZW3-input.yaml
+-
+  bla"keks: foo
+-
+  bla]keks: foo

tests/fixtures/rules/block-sequence-hyphen-indicator-newline/invalid/yaml-test-suite-for-block-mapping-only-newline/FH7J-errors.json

@@ -0,0 +1,7 @@
+[
+  {
+    "message": "Expected a line break after this `-` indicator.",
+    "line": 6,
+    "column": 1
+  }
+]

tests/fixtures/rules/block-sequence-hyphen-indicator-newline/invalid/yaml-test-suite-for-block-mapping-only-newline/FH7J-input.yaml

@@ -0,0 +1,5 @@
+- !!str
+-
+  !!null : a
+  b: !!str
+- !!str : !!null

tests/fixtures/rules/block-sequence-hyphen-indicator-newline/invalid/yaml-test-suite-for-block-mapping-only-newline/FH7J-output.yml

@@ -0,0 +1,7 @@
+# block-sequence-hyphen-indicator-newline/invalid/yaml-test-suite-for-block-mapping-only-newline/FH7J-input.yaml
+- !!str
+-
+  !!null : a
+  b: !!str
+-
+  !!str : !!null

tests/fixtures/rules/block-sequence-hyphen-indicator-newline/invalid/yaml-test-suite-for-block-mapping-only-newline/J7PZ-errors.json

@@ -0,0 +1,17 @@
+[
+  {
+    "message": "Expected a line break after this `-` indicator.",
+    "line": 6,
+    "column": 1
+  },
+  {
+    "message": "Expected a line break after this `-` indicator.",
+    "line": 7,
+    "column": 1
+  },
+  {
+    "message": "Expected a line break after this `-` indicator.",
+    "line": 8,
+    "column": 1
+  }
+]

tests/fixtures/rules/block-sequence-hyphen-indicator-newline/invalid/yaml-test-suite-for-block-mapping-only-newline/J7PZ-input.yaml

@@ -0,0 +1,7 @@
+# Ordered maps are represented as
+# A sequence of mappings, with
+# each mapping having one key
+--- !!omap
+- Mark McGwire: 65
+- Sammy Sosa: 63
+- Ken Griffy: 58

tests/fixtures/rules/block-sequence-hyphen-indicator-newline/invalid/yaml-test-suite-for-block-mapping-only-newline/J7PZ-output.yml

@@ -0,0 +1,11 @@
+# block-sequence-hyphen-indicator-newline/invalid/yaml-test-suite-for-block-mapping-only-newline/J7PZ-input.yaml
+# Ordered maps are represented as
+# A sequence of mappings, with
+# each mapping having one key
+--- !!omap
+-
+  Mark McGwire: 65
+-
+  Sammy Sosa: 63
+-
+  Ken Griffy: 58

tests/fixtures/rules/block-sequence-hyphen-indicator-newline/invalid/yaml-test-suite-for-block-mapping-only-newline/JQ4R-errors.json

@@ -0,0 +1,7 @@
+[
+  {
+    "message": "Expected a line break after this `-` indicator.",
+    "line": 4,
+    "column": 3
+  }
+]

tests/fixtures/rules/block-sequence-hyphen-indicator-newline/invalid/yaml-test-suite-for-block-mapping-only-newline/JQ4R-input.yaml

@@ -0,0 +1,3 @@
+block sequence:
+  - one
+  - two : three

tests/fixtures/rules/block-sequence-hyphen-indicator-newline/invalid/yaml-test-suite-for-block-mapping-only-newline/JQ4R-output.yml

@@ -0,0 +1,5 @@
+# block-sequence-hyphen-indicator-newline/invalid/yaml-test-suite-for-block-mapping-only-newline/JQ4R-input.yaml
+block sequence:
+  - one
+  -
+    two : three

tests/fixtures/rules/block-sequence-hyphen-indicator-newline/invalid/yaml-test-suite-for-block-mapping-only-newline/RZP5-errors.json

@@ -0,0 +1,12 @@
+[
+  {
+    "message": "Unexpected line break after this `-` indicator.",
+    "line": 11,
+    "column": 2
+  },
+  {
+    "message": "Expected a line break after this `-` indicator.",
+    "line": 14,
+    "column": 2
+  }
+]

tests/fixtures/rules/block-sequence-hyphen-indicator-newline/invalid/yaml-test-suite-for-block-mapping-only-newline/RZP5-input.yaml

@@ -0,0 +1,15 @@
+a: "double
+  quotes" # lala
+b: plain
+ value  # lala
+c  : #lala
+  d
+? # lala
+ - seq1
+: # lala
+ - #lala
+  seq2
+e: &node # lala
+ - x: y
+block: > # lala
+  abcde

tests/fixtures/rules/block-sequence-hyphen-indicator-newline/invalid/yaml-test-suite-for-block-mapping-only-newline/RZP5-output.yml

@@ -0,0 +1,16 @@
+# block-sequence-hyphen-indicator-newline/invalid/yaml-test-suite-for-block-mapping-only-newline/RZP5-input.yaml
+a: "double
+  quotes" # lala
+b: plain
+ value  # lala
+c  : #lala
+  d
+? # lala
+ - seq1
+: # lala
+ - seq2
+e: &node # lala
+ -
+   x: y
+block: > # lala
+  abcde

tests/fixtures/rules/block-sequence-hyphen-indicator-newline/invalid/yaml-test-suite-for-block-mapping-only-newline/RZT7-errors.json

@@ -0,0 +1,12 @@
+[
+  {
+    "message": "Expected a line break after this `-` indicator.",
+    "line": 20,
+    "column": 3
+  },
+  {
+    "message": "Expected a line break after this `-` indicator.",
+    "line": 24,
+    "column": 3
+  }
+]