projen 0.61.17 → 0.61.20

package/.jsii

@@ -31,7 +31,7 @@
     "stability": "experimental"
   },
   "homepage": "https://github.com/projen/projen.git",
-  "jsiiVersion": "1.64.0 (build 4c1eae8)",
+  "jsiiVersion": "1.65.0 (build 7a02b7f)",
   "keywords": [
     "cdk",
     "cicd",
@@ -4191,7 +4191,7 @@
         },
         "locationInModule": {
           "filename": "src/json.ts",
-          "line": 23
+          "line": 29
         },
         "parameters": [
           {
@@ -4217,7 +4217,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/json.ts",
-        "line": 19
+        "line": 25
       },
       "methods": [
         {
@@ -4227,7 +4227,7 @@
           },
           "locationInModule": {
             "filename": "src/json.ts",
-            "line": 34
+            "line": 43
           },
           "name": "synthesizeContent",
           "overrides": "projen.ObjectFile",
@@ -4269,6 +4269,24 @@
       },
       "name": "JsonFileOptions",
       "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- false for .json files, true for .json5 and .jsonc files",
+            "stability": "experimental",
+            "summary": "Allow the use of comments in this file."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/json.ts",
+            "line": 19
+          },
+          "name": "allowComments",
+          "optional": true,
+          "type": {
+            "primitive": "boolean"
+          }
+        },
         {
           "abstract": true,
           "docs": {
@@ -7689,6 +7707,42 @@
       ],
       "symbolId": "src/semver:Semver"
     },
+    "projen.SnapshotOptions": {
+      "assembly": "projen",
+      "datatype": true,
+      "docs": {
+        "stability": "experimental",
+        "summary": "Options for the Snapshot synthesis."
+      },
+      "fqn": "projen.SnapshotOptions",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/util/synth.ts",
+        "line": 10
+      },
+      "name": "SnapshotOptions",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "default": "true parse .json files into an object",
+            "stability": "experimental",
+            "summary": "Parse .json files as a JS object for improved inspection. This will fail if the contents are invalid JSON."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/util/synth.ts",
+            "line": 17
+          },
+          "name": "parseJson",
+          "optional": true,
+          "type": {
+            "primitive": "boolean"
+          }
+        }
+      ],
+      "symbolId": "src/util/synth:SnapshotOptions"
+    },
     "projen.SourceCode": {
       "assembly": "projen",
       "base": "projen.Component",
@@ -9169,6 +9223,13 @@
               "type": {
                 "fqn": "projen.Project"
               }
+            },
+            {
+              "name": "options",
+              "optional": true,
+              "type": {
+                "fqn": "projen.SnapshotOptions"
+              }
             }
           ],
           "returns": {
@@ -47433,6 +47494,42 @@
       "namespace": "typescript",
       "symbolId": "src/typescript/typescript-typedoc:TypedocDocgen"
     },
+    "projen.vscode.Console": {
+      "assembly": "projen",
+      "docs": {
+        "stability": "experimental",
+        "summary": "Controls where to launch the debug target Source: https://code.visualstudio.com/docs/editor/debugging#_launchjson-attributes."
+      },
+      "fqn": "projen.vscode.Console",
+      "kind": "enum",
+      "locationInModule": {
+        "filename": "src/vscode/launch-config.ts",
+        "line": 9
+      },
+      "members": [
+        {
+          "docs": {
+            "stability": "experimental"
+          },
+          "name": "INTERNAL_CONSOLE"
+        },
+        {
+          "docs": {
+            "stability": "experimental"
+          },
+          "name": "INTEGRATED_TERMINAL"
+        },
+        {
+          "docs": {
+            "stability": "experimental"
+          },
+          "name": "EXTERNAL_TERMINAL"
+        }
+      ],
+      "name": "Console",
+      "namespace": "vscode",
+      "symbolId": "src/vscode/launch-config:Console"
+    },
     "projen.vscode.DevContainer": {
       "assembly": "projen",
       "base": "projen.Component",
@@ -47625,7 +47722,7 @@
       "kind": "enum",
       "locationInModule": {
         "filename": "src/vscode/launch-config.ts",
-        "line": 9
+        "line": 19
       },
       "members": [
         {
@@ -47662,7 +47759,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/vscode/launch-config.ts",
-        "line": 22
+        "line": 32
       },
       "name": "Presentation",
       "namespace": "vscode",
@@ -47675,7 +47772,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/vscode/launch-config.ts",
-            "line": 24
+            "line": 34
           },
           "name": "group",
           "type": {
@@ -47690,7 +47787,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/vscode/launch-config.ts",
-            "line": 23
+            "line": 33
           },
           "name": "hidden",
           "type": {
@@ -47705,7 +47802,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/vscode/launch-config.ts",
-            "line": 25
+            "line": 35
           },
           "name": "order",
           "type": {
@@ -47726,7 +47823,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/vscode/launch-config.ts",
-        "line": 33
+        "line": 43
       },
       "name": "ServerReadyAction",
       "namespace": "vscode",
@@ -47739,7 +47836,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/vscode/launch-config.ts",
-            "line": 34
+            "line": 44
           },
           "name": "action",
           "type": {
@@ -47754,7 +47851,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/vscode/launch-config.ts",
-            "line": 35
+            "line": 45
           },
           "name": "pattern",
           "optional": true,
@@ -47770,7 +47867,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/vscode/launch-config.ts",
-            "line": 36
+            "line": 46
           },
           "name": "uriFormat",
           "optional": true,
@@ -47844,7 +47941,7 @@
         },
         "locationInModule": {
           "filename": "src/vscode/launch-config.ts",
-          "line": 68
+          "line": 104
         },
         "parameters": [
           {
@@ -47858,7 +47955,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/vscode/launch-config.ts",
-        "line": 65
+        "line": 85
       },
       "methods": [
         {
@@ -47868,7 +47965,7 @@
           },
           "locationInModule": {
             "filename": "src/vscode/launch-config.ts",
-            "line": 87
+            "line": 128
           },
           "name": "addConfiguration",
           "parameters": [
@@ -47899,7 +47996,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/vscode/launch-config.ts",
-        "line": 43
+        "line": 53
       },
       "name": "VsCodeLaunchConfigurationEntry",
       "namespace": "vscode",
@@ -47912,7 +48009,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/vscode/launch-config.ts",
-            "line": 46
+            "line": 56
           },
           "name": "name",
           "type": {
@@ -47927,7 +48024,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/vscode/launch-config.ts",
-            "line": 45
+            "line": 55
           },
           "name": "request",
           "type": {
@@ -47942,7 +48039,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/vscode/launch-config.ts",
-            "line": 44
+            "line": 54
           },
           "name": "type",
           "type": {
@@ -47957,7 +48054,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/vscode/launch-config.ts",
-            "line": 47
+            "line": 57
           },
           "name": "args",
           "optional": true,
@@ -47978,7 +48075,39 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/vscode/launch-config.ts",
-            "line": 48
+            "line": 78
+          },
+          "name": "console",
+          "optional": true,
+          "type": {
+            "fqn": "projen.vscode.Console"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/vscode/launch-config.ts",
+            "line": 75
+          },
+          "name": "cwd",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/vscode/launch-config.ts",
+            "line": 58
           },
           "name": "debugServer",
           "optional": true,
@@ -47994,7 +48123,70 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/vscode/launch-config.ts",
-            "line": 49
+            "line": 79
+          },
+          "name": "disableOptimisticBPs",
+          "optional": true,
+          "type": {
+            "primitive": "boolean"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental",
+            "summary": "Set value to `false` to unset an existing environment variable."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/vscode/launch-config.ts",
+            "line": 73
+          },
+          "name": "env",
+          "optional": true,
+          "type": {
+            "collection": {
+              "elementtype": {
+                "union": {
+                  "types": [
+                    {
+                      "primitive": "string"
+                    },
+                    {
+                      "primitive": "boolean"
+                    }
+                  ]
+                }
+              },
+              "kind": "map"
+            }
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/vscode/launch-config.ts",
+            "line": 74
+          },
+          "name": "envFile",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/vscode/launch-config.ts",
+            "line": 59
           },
           "name": "internalConsoleOptions",
           "optional": true,
@@ -48010,7 +48202,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/vscode/launch-config.ts",
-            "line": 57
+            "line": 67
           },
           "name": "outFiles",
           "optional": true,
@@ -48031,7 +48223,23 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/vscode/launch-config.ts",
-            "line": 51
+            "line": 76
+          },
+          "name": "port",
+          "optional": true,
+          "type": {
+            "primitive": "number"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/vscode/launch-config.ts",
+            "line": 61
           },
           "name": "postDebugTask",
           "optional": true,
@@ -48047,7 +48255,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/vscode/launch-config.ts",
-            "line": 52
+            "line": 62
           },
           "name": "preLaunchTask",
           "optional": true,
@@ -48063,7 +48271,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/vscode/launch-config.ts",
-            "line": 53
+            "line": 63
           },
           "name": "presentation",
           "optional": true,
@@ -48079,7 +48287,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/vscode/launch-config.ts",
-            "line": 54
+            "line": 64
           },
           "name": "program",
           "optional": true,
@@ -48095,7 +48303,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/vscode/launch-config.ts",
-            "line": 50
+            "line": 60
           },
           "name": "runtimeArgs",
           "optional": true,
@@ -48116,7 +48324,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/vscode/launch-config.ts",
-            "line": 55
+            "line": 65
           },
           "name": "serverReadyAction",
           "optional": true,
@@ -48132,7 +48340,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/vscode/launch-config.ts",
-            "line": 56
+            "line": 66
           },
           "name": "skipFiles",
           "optional": true,
@@ -48153,7 +48361,23 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/vscode/launch-config.ts",
-            "line": 58
+            "line": 77
+          },
+          "name": "stopOnEntry",
+          "optional": true,
+          "type": {
+            "primitive": "boolean"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/vscode/launch-config.ts",
+            "line": 68
           },
           "name": "url",
           "optional": true,
@@ -48169,7 +48393,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/vscode/launch-config.ts",
-            "line": 59
+            "line": 69
           },
           "name": "webRoot",
           "optional": true,
@@ -49249,6 +49473,6 @@
       "symbolId": "src/web/tailwind:TailwindConfigOptions"
     }
   },
-  "version": "0.61.17",
-  "fingerprint": "7+ROaihlD4ylc/Lo0h37b3tFZfhUuOmR2Sm6Bx9zMiM="
+  "version": "0.61.20",
+  "fingerprint": "MxSaH3mz1qfW8cPR1fYzC+OfeIOZpO89AWpQwGAFe9Q="
 }

package/docs/api/API.md

@@ -178,6 +178,7 @@ Name|Description
 [SampleDirOptions](#projen-samplediroptions)|SampleDir options.
 [SampleFileOptions](#projen-samplefileoptions)|Options for the SampleFile object.
 [SampleReadmeProps](#projen-samplereadmeprops)|SampleReadme Properties.
+[SnapshotOptions](#projen-snapshotoptions)|Options for the Snapshot synthesis.
 [SourceCodeOptions](#projen-sourcecodeoptions)|Options for `SourceCodeFile`.
 [TaskCommonOptions](#projen-taskcommonoptions)|*No description*
 [TaskOptions](#projen-taskoptions)|*No description*
@@ -453,6 +454,7 @@ Name|Description
 [javascript.TrailingComma](#projen-javascript-trailingcomma)|*No description*
 [javascript.TypeScriptJsxMode](#projen-javascript-typescriptjsxmode)|Determines how JSX should get transformed into valid JavaScript.
 [javascript.TypeScriptModuleResolution](#projen-javascript-typescriptmoduleresolution)|Determines how modules get resolved.
+[vscode.Console](#projen-vscode-console)|Controls where to launch the debug target Source: https://code.visualstudio.com/docs/editor/debugging#_launchjson-attributes.
 [vscode.InternalConsoleOptions](#projen-vscode-internalconsoleoptions)|Controls the visibility of the VSCode Debug Console panel during a debugging session Source: https://code.visualstudio.com/docs/editor/debugging#_launchjson-attributes.
 
 
@@ -1327,6 +1329,7 @@ new JsonFile(project: Project, filePath: string, options: JsonFileOptions)
   * **readonly** (<code>boolean</code>)  Whether the generated file should be readonly. __*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
+  * **allowComments** (<code>boolean</code>)  Allow the use of comments in this file. __*Default*__: false for .json files, true for .json5 and .jsonc files
   * **newline** (<code>boolean</code>)  Adds a newline at the end of the file. __*Default*__: true
 
 
@@ -3018,15 +3021,17 @@ A Testing static class with a .synth helper for getting a snapshots of construct
 ### Methods
 
 
-#### *static* synth(project)🔹 <a id="projen-testing-synth"></a>
+#### *static* synth(project, options?)🔹 <a id="projen-testing-synth"></a>
 
 Produces a simple JS object that represents the contents of the projects with field names being file paths.
 
 ```ts
-static synth(project: Project): Map<string, any>
+static synth(project: Project, options?: SnapshotOptions): Map<string, any>
 ```
 
 * **project** (<code>[Project](#projen-project)</code>)  the project to produce a snapshot for.
+* **options** (<code>[SnapshotOptions](#projen-snapshotoptions)</code>)  *No description*
+  * **parseJson** (<code>boolean</code>)  Parse .json files as a JS object for improved inspection. This will fail if the contents are invalid JSON. __*Default*__: true parse .json files into an object
 
 __Returns__:
 * <code>Map<string, any></code>
@@ -10666,9 +10671,15 @@ addConfiguration(cfg: VsCodeLaunchConfigurationEntry): void
   * **request** (<code>string</code>)  *No description* 
   * **type** (<code>string</code>)  *No description* 
   * **args** (<code>Array<string></code>)  *No description* __*Optional*__
+  * **console** (<code>[vscode.Console](#projen-vscode-console)</code>)  *No description* __*Optional*__
+  * **cwd** (<code>string</code>)  *No description* __*Optional*__
   * **debugServer** (<code>number</code>)  *No description* __*Optional*__
+  * **disableOptimisticBPs** (<code>boolean</code>)  *No description* __*Optional*__
+  * **env** (<code>Map<string, string &#124; boolean></code>)  Set value to `false` to unset an existing environment variable. __*Optional*__
+  * **envFile** (<code>string</code>)  *No description* __*Optional*__
   * **internalConsoleOptions** (<code>[vscode.InternalConsoleOptions](#projen-vscode-internalconsoleoptions)</code>)  *No description* __*Optional*__
   * **outFiles** (<code>Array<string></code>)  *No description* __*Optional*__
+  * **port** (<code>number</code>)  *No description* __*Optional*__
   * **postDebugTask** (<code>string</code>)  *No description* __*Optional*__
   * **preLaunchTask** (<code>string</code>)  *No description* __*Optional*__
   * **presentation** (<code>[vscode.Presentation](#projen-vscode-presentation)</code>)  *No description* __*Optional*__
@@ -10676,6 +10687,7 @@ addConfiguration(cfg: VsCodeLaunchConfigurationEntry): void
   * **runtimeArgs** (<code>Array<string></code>)  *No description* __*Optional*__
   * **serverReadyAction** (<code>[vscode.ServerReadyAction](#projen-vscode-serverreadyaction)</code>)  *No description* __*Optional*__
   * **skipFiles** (<code>Array<string></code>)  *No description* __*Optional*__
+  * **stopOnEntry** (<code>boolean</code>)  *No description* __*Optional*__
   * **url** (<code>string</code>)  *No description* __*Optional*__
   * **webRoot** (<code>string</code>)  *No description* __*Optional*__
 
@@ -11986,6 +11998,7 @@ Options for `JsonFile`.
 
 Name | Type | Description 
 -----|------|-------------
+**allowComments**?🔹 | <code>boolean</code> | Allow the use of comments in this file.<br/>__*Default*__: false for .json files, true for .json5 and .jsonc files
 **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
@@ -12187,6 +12200,19 @@ Name | Type | Description
 
 
 
+## struct SnapshotOptions 🔹 <a id="projen-snapshotoptions"></a>
+
+
+Options for the Snapshot synthesis.
+
+
+
+Name | Type | Description 
+-----|------|-------------
+**parseJson**?🔹 | <code>boolean</code> | Parse .json files as a JS object for improved inspection. This will fail if the contents are invalid JSON.<br/>__*Default*__: true parse .json files into an object
+
+
+
 ## struct SourceCodeOptions 🔹 <a id="projen-sourcecodeoptions"></a>
 
 
@@ -17803,9 +17829,15 @@ Name | Type | Description
 **request**🔹 | <code>string</code> | <span></span>
 **type**🔹 | <code>string</code> | <span></span>
 **args**?🔹 | <code>Array<string></code> | __*Optional*__
+**console**?🔹 | <code>[vscode.Console](#projen-vscode-console)</code> | __*Optional*__
+**cwd**?🔹 | <code>string</code> | __*Optional*__
 **debugServer**?🔹 | <code>number</code> | __*Optional*__
+**disableOptimisticBPs**?🔹 | <code>boolean</code> | __*Optional*__
+**env**?🔹 | <code>Map<string, string &#124; boolean></code> | Set value to `false` to unset an existing environment variable.<br/>__*Optional*__
+**envFile**?🔹 | <code>string</code> | __*Optional*__
 **internalConsoleOptions**?🔹 | <code>[vscode.InternalConsoleOptions](#projen-vscode-internalconsoleoptions)</code> | __*Optional*__
 **outFiles**?🔹 | <code>Array<string></code> | __*Optional*__
+**port**?🔹 | <code>number</code> | __*Optional*__
 **postDebugTask**?🔹 | <code>string</code> | __*Optional*__
 **preLaunchTask**?🔹 | <code>string</code> | __*Optional*__
 **presentation**?🔹 | <code>[vscode.Presentation](#projen-vscode-presentation)</code> | __*Optional*__
@@ -17813,6 +17845,7 @@ Name | Type | Description
 **runtimeArgs**?🔹 | <code>Array<string></code> | __*Optional*__
 **serverReadyAction**?🔹 | <code>[vscode.ServerReadyAction](#projen-vscode-serverreadyaction)</code> | __*Optional*__
 **skipFiles**?🔹 | <code>Array<string></code> | __*Optional*__
+**stopOnEntry**?🔹 | <code>boolean</code> | __*Optional*__
 **url**?🔹 | <code>string</code> | __*Optional*__
 **webRoot**?🔹 | <code>string</code> | __*Optional*__
 
@@ -18968,6 +19001,17 @@ Name | Description
 **NODE** 🔹|Resolution strategy which attempts to mimic the Node.js module resolution strategy at runtime.
 
 
+## enum Console 🔹 <a id="projen-vscode-console"></a>
+
+Controls where to launch the debug target Source: https://code.visualstudio.com/docs/editor/debugging#_launchjson-attributes.
+
+Name | Description
+-----|-----
+**INTERNAL_CONSOLE** 🔹|
+**INTEGRATED_TERMINAL** 🔹|
+**EXTERNAL_TERMINAL** 🔹|
+
+
 ## enum InternalConsoleOptions 🔹 <a id="projen-vscode-internalconsoleoptions"></a>
 
 Controls the visibility of the VSCode Debug Console panel during a debugging session Source: https://code.visualstudio.com/docs/editor/debugging#_launchjson-attributes.