feat: add better-yaml.documentOptions.version global option

You can set YAML version used by documents without a %YAML directive.

fix #25

CHANGELOG.md

@@ -4,6 +4,11 @@ All notable changes to the "kubernetes-yaml-formatter" extension will be documen
 
 Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file.
 
+## 2.3.0 (19 Nov 2024)
+
+- add `better-yaml.documentOptions.version` global option to set YAML version used by documents without a %YAML directive.
+- upgrade dependencies.
+
 ## 2.0.0 (03 Nov 2024)
 
 Rename to **Better YAML Formatter** since it works well with what you think about YAML :)

README.md

@@ -14,7 +14,7 @@ This extension is made for you :)
 
 Format **correct**, **consistent** and **customized** yaml text with **Better YAML Formatter**.
 
-Watch the demo video:
+### 🔥 Watch the demo video 👇
 
 https://github.com/user-attachments/assets/dfdec44b-221f-436d-9d90-413f0c0effe6
 
@@ -58,6 +58,7 @@ This extension contributes the following settings:
 * `better-yaml.directives`: Include directives in the output. If true, at least the document-start marker --- is always included. If false, no directives or marker is ever included. If null, directives and marker may be included if required.
 * `better-yaml.commentString`: Change the comment prefix string. By default, empty comment lines are left empty, lines consisting of a single space are replaced by `#`, and all other lines are prefixed with a `#`.
 * `better-yaml.lineWidth`: Maximum line width (set to 0 to disable folding). This is a soft limit, as only double-quoted semantics allow for inserting a line break in the middle of a word.
+* `better-yaml.documentOptions.version`: The YAML version used by documents without a %YAML directive. Must be '1.1' or '1.2'. Default to '1.2'.
 
 ## Thanks
 

package.json

@@ -77,6 +77,13 @@
           ],
           "default": 0,
           "description": "Maximum line width (set to 0 to disable folding). This is a soft limit, as only double-quoted semantics allow for inserting a line break in the middle of a word."
+        },
+        "better-yaml.documentOptions.version": {
+          "type": [
+            "string"
+          ],
+          "default": "1.2",
+          "description": "The YAML version used by documents without a %YAML directive. Must be '1.1' or '1.2'."
         }
       }
     },
@@ -124,6 +131,6 @@
     "process": "^0.11.10"
   },
   "dependencies": {
-    "yaml": "^2.6.0"
+    "yaml": "^2.6.1"
   }
 }