chore: disable yaml folding (projen#1546)

Upgrade the bundled `yaml` dependency to `yaml@2` and disable line folding by default (can be changed through `YamlFile.lineWidth`. --- By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
FitX · Jan 20, 2022 · e7d7a5c · e7d7a5c
1 parent 7b5d5fc
commit e7d7a5c
Show file tree

Hide file tree

Showing 27 changed files with 364 additions and 1,127 deletions.
diff --git a/.github/workflows/auto-approve.yml b/.github/workflows/auto-approve.yml
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
diff --git a/.github/workflows/stale.yml b/.github/workflows/stale.yml
diff --git a/.github/workflows/upgrade-main.yml b/.github/workflows/upgrade-main.yml
diff --git a/.projen/deps.json b/.projen/deps.json
diff --git a/.projenrc.js b/.projenrc.js
@@ -27,7 +27,7 @@ const project = new cdk.JsiiProject({
 
   bundledDeps: [
     "conventional-changelog-config-spec",
-    "yaml",
+    "yaml@next",
     "fs-extra",
     "yargs",
     "case",

diff --git a/API.md b/API.md
@@ -2888,8 +2888,17 @@ new YamlFile(project: Project, filePath: string, options: YamlFileOptions)
   * **marker** (<code>boolean</code>)  Adds the projen marker to the file. __*Default*__: true
   * **obj** (<code>any</code>)  The object that will be serialized. __*Default*__: {} an empty object (use `file.obj` to mutate).
   * **omitEmpty** (<code>boolean</code>)  Omits empty objects and arrays. __*Default*__: false
+  * **lineWidth** (<code>number</code>)  Maximum line width (set to 0 to disable folding). __*Default*__: 0
 
 
+
+### Properties
+
+
+Name | Type | Description 
+-----|------|-------------
+**lineWidth**🔹 | <code>number</code> | Maximum line width (set to 0 to disable folding).
+
 ### Methods
 
 
@@ -11005,6 +11014,7 @@ Name | Type | Description
 **committed**?🔹 | <code>boolean</code> | Indicates whether this file should be committed to git or ignored.<br/>__*Default*__: true
 **editGitignore**?🔹 | <code>boolean</code> | Update the project's .gitignore file.<br/>__*Default*__: true
 **executable**?🔹 | <code>boolean</code> | Whether the generated file should be marked as executable.<br/>__*Default*__: false
+**lineWidth**?🔹 | <code>number</code> | Maximum line width (set to 0 to disable folding).<br/>__*Default*__: 0
 **marker**?🔹 | <code>boolean</code> | Adds the projen marker to the file.<br/>__*Default*__: true
 **obj**?🔹 | <code>any</code> | The object that will be serialized.<br/>__*Default*__: {} an empty object (use `file.obj` to mutate).
 **omitEmpty**?🔹 | <code>boolean</code> | Omits empty objects and arrays.<br/>__*Default*__: false

diff --git a/package.json b/package.json
diff --git a/src/yaml.ts b/src/yaml.ts
@@ -6,14 +6,27 @@ import { Project } from "./project";
 /**
  * Options for `JsonFile`.
  */
-export interface YamlFileOptions extends ObjectFileOptions {}
+export interface YamlFileOptions extends ObjectFileOptions {
+  /**
+   * Maximum line width (set to 0 to disable folding).
+   *
+   * @default - 0
+   */
+  readonly lineWidth?: number;
+}
 
 /**
  * Represents a YAML file.
  */
 export class YamlFile extends ObjectFile {
+  /**
+   * Maximum line width (set to 0 to disable folding).
+   */
+  public lineWidth: number;
+
   constructor(project: Project, filePath: string, options: YamlFileOptions) {
     super(project, filePath, options);
+    this.lineWidth = options.lineWidth ?? 0;
   }
 
   protected synthesizeContent(resolver: IResolver): string | undefined {
@@ -25,7 +38,10 @@ export class YamlFile extends ObjectFile {
     return [
       ...(this.marker ? [`# ${YamlFile.PROJEN_MARKER}`] : []),
       "",
-      YAML.stringify(JSON.parse(json), { indent: 2 }),
+      YAML.stringify(JSON.parse(json), {
+        indent: 2,
+        lineWidth: this.lineWidth,
+      }),
     ].join("\n");
   }
 }