projen 0.101.8 → 0.101.9

package/.jsii

@@ -720,6 +720,29 @@
           },
           "static": true
         },
+        {
+          "docs": {
+            "remarks": "It does not run on later `projen` invocations. It only fires for `projen new` (or `Projects.createProject`).\nIt is also skipped when post-synthesis steps are disabled, e.g. `--no-post` or `PROJEN_DISABLE_POST`.\nUse it for one-off setup that can be turned off by the user, like running a task to give the user immediate\nfeedback on their new project. Order across components is not guaranteed.",
+            "stability": "experimental",
+            "summary": "Called once, right after `postSynthesize()`, only when the project is created for the first time."
+          },
+          "locationInModule": {
+            "filename": "src/component.ts",
+            "line": 79
+          },
+          "name": "postProjectCreation",
+          "parameters": [
+            {
+              "docs": {
+                "summary": "Details about how the project was created, e.g. its type and the original CLI args."
+              },
+              "name": "initProject",
+              "type": {
+                "fqn": "projen.InitProject"
+              }
+            }
+          ]
+        },
         {
           "docs": {
             "remarks": "Order is *not* guaranteed.",
@@ -743,6 +766,29 @@
           },
           "name": "preSynthesize"
         },
+        {
+          "docs": {
+            "remarks": "It does not run on later `projen` invocations. It only fires for `projen new` (or `Projects.createProject`).\nUse it for deterministic, one-off file generation. Order across components is not guaranteed.",
+            "stability": "experimental",
+            "summary": "Called once, right after `synthesize()`, only when the project is created for the first time."
+          },
+          "locationInModule": {
+            "filename": "src/component.ts",
+            "line": 65
+          },
+          "name": "projectCreation",
+          "parameters": [
+            {
+              "docs": {
+                "summary": "Details about how the project was created, e.g. its type and the original CLI args."
+              },
+              "name": "initProject",
+              "type": {
+                "fqn": "projen.InitProject"
+              }
+            }
+          ]
+        },
         {
           "docs": {
             "stability": "experimental",
@@ -3970,13 +4016,13 @@
         },
         "locationInModule": {
           "filename": "src/component.ts",
-          "line": 183
+          "line": 209
         }
       },
       "kind": "class",
       "locationInModule": {
         "filename": "src/component.ts",
-        "line": 179
+        "line": 205
       },
       "methods": [
         {
@@ -3987,7 +4033,7 @@
           },
           "locationInModule": {
             "filename": "src/component.ts",
-            "line": 222
+            "line": 248
           },
           "name": "attach",
           "parameters": [
@@ -4019,7 +4065,7 @@
           },
           "locationInModule": {
             "filename": "src/component.ts",
-            "line": 212
+            "line": 238
           },
           "name": "init",
           "protected": true
@@ -4032,7 +4078,7 @@
           },
           "locationInModule": {
             "filename": "src/component.ts",
-            "line": 268
+            "line": 294
           },
           "name": "tryAttach",
           "parameters": [
@@ -4068,7 +4114,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/component.ts",
-            "line": 204
+            "line": 230
           },
           "name": "attached",
           "type": {
@@ -6138,7 +6184,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/project.ts",
-        "line": 686
+        "line": 712
       },
       "name": "InitProject",
       "properties": [
@@ -6151,7 +6197,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/project.ts",
-            "line": 695
+            "line": 721
           },
           "name": "args",
           "type": {
@@ -6174,7 +6220,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/project.ts",
-            "line": 706
+            "line": 732
           },
           "name": "comments",
           "type": {
@@ -6190,13 +6236,47 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/project.ts",
-            "line": 690
+            "line": 716
           },
           "name": "fqn",
           "type": {
             "primitive": "string"
           }
         },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "true",
+            "stability": "experimental",
+            "summary": "Whether `projen new` should run post-synthesis steps (e.g. package manager install)."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/project.ts",
+            "line": 744
+          },
+          "name": "post",
+          "type": {
+            "primitive": "boolean"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "true",
+            "stability": "experimental",
+            "summary": "Whether `projen new` should call `project.synth()` after construction."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/project.ts",
+            "line": 738
+          },
+          "name": "synth",
+          "type": {
+            "primitive": "boolean"
+          }
+        },
         {
           "abstract": true,
           "docs": {
@@ -6206,7 +6286,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/project.ts",
-            "line": 700
+            "line": 726
           },
           "name": "type",
           "type": {
@@ -7677,7 +7757,7 @@
         },
         "locationInModule": {
           "filename": "src/project.ts",
-          "line": 277
+          "line": 281
         },
         "parameters": [
           {
@@ -7756,7 +7836,7 @@
           },
           "locationInModule": {
             "filename": "src/project.ts",
-            "line": 549
+            "line": 553
           },
           "name": "addExcludeFromCleanup",
           "parameters": [
@@ -7780,7 +7860,7 @@
           },
           "locationInModule": {
             "filename": "src/project.ts",
-            "line": 579
+            "line": 583
           },
           "name": "addGitIgnore",
           "parameters": [
@@ -7803,7 +7883,7 @@
           },
           "locationInModule": {
             "filename": "src/project.ts",
-            "line": 571
+            "line": 575
           },
           "name": "addPackageIgnore",
           "parameters": [
@@ -7826,7 +7906,7 @@
           },
           "locationInModule": {
             "filename": "src/project.ts",
-            "line": 447
+            "line": 451
           },
           "name": "addTask",
           "parameters": [
@@ -7864,7 +7944,7 @@
           },
           "locationInModule": {
             "filename": "src/project.ts",
-            "line": 590
+            "line": 594
           },
           "name": "annotateGenerated",
           "parameters": [
@@ -7887,7 +7967,7 @@
           },
           "locationInModule": {
             "filename": "src/project.ts",
-            "line": 679
+            "line": 705
           },
           "name": "postSynthesize"
         },
@@ -7898,7 +7978,7 @@
           },
           "locationInModule": {
             "filename": "src/project.ts",
-            "line": 674
+            "line": 700
           },
           "name": "preSynthesize"
         },
@@ -7910,7 +7990,7 @@
           },
           "locationInModule": {
             "filename": "src/project.ts",
-            "line": 458
+            "line": 462
           },
           "name": "removeTask",
           "parameters": [
@@ -7939,7 +8019,7 @@
           },
           "locationInModule": {
             "filename": "src/project.ts",
-            "line": 560
+            "line": 564
           },
           "name": "runTaskCommand",
           "parameters": [
@@ -7961,13 +8041,13 @@
         },
         {
           "docs": {
-            "remarks": "1. Call \"this.preSynthesize()\"\n2. Delete all generated files\n3. Synthesize all subprojects\n4. Synthesize all components of this project\n5. Call \"postSynthesize()\" for all components of this project\n6. Call \"this.postSynthesize()\"",
+            "remarks": "1. Call \"this.preSynthesize()\"\n2. Delete all generated files\n3. Synthesize all subprojects\n4. Synthesize all components of this project\n5. Call \"projectCreation()\" for all components, only if the project is being created for the first time\n6. Call \"postSynthesize()\" for all components of this project\n7. Call \"this.postSynthesize()\"\n8. Call \"postProjectCreation()\" for all components, only if the project is being created for the first time",
             "stability": "experimental",
             "summary": "Synthesize all project files into `outdir`."
           },
           "locationInModule": {
             "filename": "src/project.ts",
-            "line": 604
+            "line": 610
           },
           "name": "synth"
         },
@@ -7979,7 +8059,7 @@
           },
           "locationInModule": {
             "filename": "src/project.ts",
-            "line": 489
+            "line": 493
           },
           "name": "tryFindFile",
           "parameters": [
@@ -8008,7 +8088,7 @@
           },
           "locationInModule": {
             "filename": "src/project.ts",
-            "line": 508
+            "line": 512
           },
           "name": "tryFindObjectFile",
           "parameters": [
@@ -8037,7 +8117,7 @@
           },
           "locationInModule": {
             "filename": "src/project.ts",
-            "line": 532
+            "line": 536
           },
           "name": "tryRemoveFile",
           "parameters": [
@@ -8087,7 +8167,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/project.ts",
-            "line": 462
+            "line": 466
           },
           "name": "buildTask",
           "type": {
@@ -8102,7 +8182,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/project.ts",
-            "line": 270
+            "line": 274
           },
           "name": "commitGenerated",
           "type": {
@@ -8116,7 +8196,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/project.ts",
-            "line": 465
+            "line": 469
           },
           "name": "compileTask",
           "type": {
@@ -8131,7 +8211,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/project.ts",
-            "line": 416
+            "line": 420
           },
           "name": "components",
           "type": {
@@ -8166,7 +8246,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/project.ts",
-            "line": 667
+            "line": 693
           },
           "name": "ejected",
           "type": {
@@ -8181,7 +8261,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/project.ts",
-            "line": 434
+            "line": 438
           },
           "name": "files",
           "type": {
@@ -8275,7 +8355,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/project.ts",
-            "line": 477
+            "line": 481
           },
           "name": "packageTask",
           "type": {
@@ -8289,7 +8369,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/project.ts",
-            "line": 474
+            "line": 478
           },
           "name": "postCompileTask",
           "type": {
@@ -8303,7 +8383,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/project.ts",
-            "line": 471
+            "line": 475
           },
           "name": "preCompileTask",
           "type": {
@@ -8318,7 +8398,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/project.ts",
-            "line": 265
+            "line": 269
           },
           "name": "projectBuild",
           "type": {
@@ -8333,7 +8413,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/project.ts",
-            "line": 244
+            "line": 248
           },
           "name": "projenCommand",
           "type": {
@@ -8348,7 +8428,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/project.ts",
-            "line": 409
+            "line": 413
           },
           "name": "root",
           "type": {
@@ -8363,7 +8443,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/project.ts",
-            "line": 427
+            "line": 431
           },
           "name": "subprojects",
           "type": {
@@ -8397,7 +8477,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/project.ts",
-            "line": 468
+            "line": 472
           },
           "name": "testTask",
           "type": {
@@ -8413,7 +8493,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/project.ts",
-            "line": 252
+            "line": 256
           },
           "name": "defaultTask",
           "optional": true,
@@ -8423,14 +8503,15 @@
         },
         {
           "docs": {
+            "deprecated": "use the `initProject` argument passed to `Component.projectCreation()` instead.",
             "remarks": "It\nincludes the original set of options passed to the CLI and also the JSII\nFQN of the project type.",
-            "stability": "experimental",
+            "stability": "deprecated",
             "summary": "The options used when this project is bootstrapped via `projen new`."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/project.ts",
-            "line": 239
+            "line": 241
           },
           "name": "initProject",
           "optional": true,
@@ -9352,6 +9433,29 @@
         "filename": "src/projenrc-json.ts",
         "line": 17
       },
+      "methods": [
+        {
+          "docs": {
+            "remarks": "It does not run on later `projen` invocations. It only fires for `projen new` (or `Projects.createProject`).\nUse it for deterministic, one-off file generation. Order across components is not guaranteed.",
+            "stability": "experimental",
+            "summary": "Called once, right after `synthesize()`, only when the project is created for the first time."
+          },
+          "locationInModule": {
+            "filename": "src/projenrc-json.ts",
+            "line": 30
+          },
+          "name": "projectCreation",
+          "overrides": "projen.Component",
+          "parameters": [
+            {
+              "name": "initProject",
+              "type": {
+                "fqn": "projen.InitProject"
+              }
+            }
+          ]
+        }
+      ],
       "name": "ProjenrcJson",
       "properties": [
         {
@@ -10497,7 +10601,7 @@
         },
         "locationInModule": {
           "filename": "src/component.ts",
-          "line": 183
+          "line": 209
         }
       },
       "interfaces": [
@@ -44070,6 +44174,29 @@
         "filename": "src/java/projenrc.ts",
         "line": 50
       },
+      "methods": [
+        {
+          "docs": {
+            "remarks": "It does not run on later `projen` invocations. It only fires for `projen new` (or `Projects.createProject`).\nUse it for deterministic, one-off file generation. Order across components is not guaranteed.",
+            "stability": "experimental",
+            "summary": "Called once, right after `synthesize()`, only when the project is created for the first time."
+          },
+          "locationInModule": {
+            "filename": "src/java/projenrc.ts",
+            "line": 89
+          },
+          "name": "projectCreation",
+          "overrides": "projen.Component",
+          "parameters": [
+            {
+              "name": "initProject",
+              "type": {
+                "fqn": "projen.InitProject"
+              }
+            }
+          ]
+        }
+      ],
       "name": "Projenrc",
       "namespace": "java",
       "properties": [
@@ -44096,7 +44223,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/java/projenrc.ts",
-            "line": 111
+            "line": 112
           },
           "name": "filePath",
           "overrides": "projen.ProjenrcFile",
@@ -44920,7 +45047,7 @@
           },
           "locationInModule": {
             "filename": "src/javascript/biome/biome.ts",
-            "line": 248
+            "line": 255
           },
           "name": "addFilePattern",
           "parameters": [
@@ -44943,7 +45070,7 @@
           },
           "locationInModule": {
             "filename": "src/javascript/biome/biome.ts",
-            "line": 257
+            "line": 264
           },
           "name": "addOverride",
           "parameters": [
@@ -44968,7 +45095,7 @@
           },
           "locationInModule": {
             "filename": "src/javascript/biome/biome.ts",
-            "line": 281
+            "line": 288
           },
           "name": "expandLinterRules",
           "parameters": [
@@ -44982,6 +45109,26 @@
               }
             }
           ]
+        },
+        {
+          "docs": {
+            "stability": "experimental",
+            "summary": "Runs biome once, right after the project is first created, so the generated code is linted and formatted immediately."
+          },
+          "locationInModule": {
+            "filename": "src/javascript/biome/biome.ts",
+            "line": 244
+          },
+          "name": "postProjectCreation",
+          "overrides": "projen.Component",
+          "parameters": [
+            {
+              "name": "_initProject",
+              "type": {
+                "fqn": "projen.InitProject"
+              }
+            }
+          ]
         }
       ],
       "name": "Biome",
@@ -46559,6 +46706,26 @@
               }
             }
           ]
+        },
+        {
+          "docs": {
+            "stability": "experimental",
+            "summary": "Runs eslint once, right after the project is first created, so the generated code is linted (and auto-fixed) immediately."
+          },
+          "locationInModule": {
+            "filename": "src/javascript/eslint.ts",
+            "line": 592
+          },
+          "name": "postProjectCreation",
+          "overrides": "projen.Component",
+          "parameters": [
+            {
+              "name": "_initProject",
+              "type": {
+                "fqn": "projen.InitProject"
+              }
+            }
+          ]
         }
       ],
       "name": "Eslint",
@@ -59003,10 +59170,31 @@
           },
           "locationInModule": {
             "filename": "src/javascript/projenrc.ts",
-            "line": 39
+            "line": 37
           },
           "name": "preSynthesize",
           "overrides": "projen.ProjenrcFile"
+        },
+        {
+          "docs": {
+            "remarks": "It does not run on later `projen` invocations. It only fires for `projen new` (or `Projects.createProject`).\nUse it for deterministic, one-off file generation. Order across components is not guaranteed.",
+            "stability": "experimental",
+            "summary": "Called once, right after `synthesize()`, only when the project is created for the first time."
+          },
+          "locationInModule": {
+            "filename": "src/javascript/projenrc.ts",
+            "line": 55
+          },
+          "name": "projectCreation",
+          "overrides": "projen.Component",
+          "parameters": [
+            {
+              "name": "initProject",
+              "type": {
+                "fqn": "projen.InitProject"
+              }
+            }
+          ]
         }
       ],
       "name": "Projenrc",
@@ -72563,6 +72751,29 @@
         "filename": "src/python/projenrc.ts",
         "line": 39
       },
+      "methods": [
+        {
+          "docs": {
+            "remarks": "It does not run on later `projen` invocations. It only fires for `projen new` (or `Projects.createProject`).\nUse it for deterministic, one-off file generation. Order across components is not guaranteed.",
+            "stability": "experimental",
+            "summary": "Called once, right after `synthesize()`, only when the project is created for the first time."
+          },
+          "locationInModule": {
+            "filename": "src/python/projenrc.ts",
+            "line": 65
+          },
+          "name": "projectCreation",
+          "overrides": "projen.Component",
+          "parameters": [
+            {
+              "name": "initProject",
+              "type": {
+                "fqn": "projen.InitProject"
+              }
+            }
+          ]
+        }
+      ],
       "name": "Projenrc",
       "namespace": "python",
       "properties": [
@@ -84454,7 +84665,7 @@
         },
         "locationInModule": {
           "filename": "src/typescript/projenrc.ts",
-          "line": 56
+          "line": 57
         },
         "parameters": [
           {
@@ -84475,7 +84686,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/typescript/projenrc.ts",
-        "line": 48
+        "line": 49
       },
       "methods": [
         {
@@ -84485,10 +84696,31 @@
           },
           "locationInModule": {
             "filename": "src/typescript/projenrc.ts",
-            "line": 122
+            "line": 125
           },
           "name": "preSynthesize",
           "overrides": "projen.ProjenrcFile"
+        },
+        {
+          "docs": {
+            "remarks": "It does not run on later `projen` invocations. It only fires for `projen new` (or `Projects.createProject`).\nUse it for deterministic, one-off file generation. Order across components is not guaranteed.",
+            "stability": "experimental",
+            "summary": "Called once, right after `synthesize()`, only when the project is created for the first time."
+          },
+          "locationInModule": {
+            "filename": "src/typescript/projenrc.ts",
+            "line": 86
+          },
+          "name": "projectCreation",
+          "overrides": "projen.Component",
+          "parameters": [
+            {
+              "name": "initProject",
+              "type": {
+                "fqn": "projen.InitProject"
+              }
+            }
+          ]
         }
       ],
       "name": "Projenrc",
@@ -84502,7 +84734,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/typescript/projenrc.ts",
-            "line": 49
+            "line": 50
           },
           "name": "filePath",
           "overrides": "projen.ProjenrcFile",
@@ -84517,7 +84749,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/typescript/projenrc.ts",
-            "line": 50
+            "line": 51
           },
           "name": "tsconfig",
           "type": {
@@ -84537,7 +84769,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/typescript/projenrc.ts",
-        "line": 10
+        "line": 11
       },
       "name": "ProjenrcOptions",
       "namespace": "typescript",
@@ -84552,7 +84784,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/typescript/projenrc.ts",
-            "line": 15
+            "line": 16
           },
           "name": "filename",
           "optional": true,
@@ -84570,7 +84802,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/typescript/projenrc.ts",
-            "line": 23
+            "line": 24
           },
           "name": "projenCodeDir",
           "optional": true,
@@ -84588,7 +84820,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/typescript/projenrc.ts",
-            "line": 38
+            "line": 39
           },
           "name": "runner",
           "optional": true,
@@ -84607,7 +84839,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/typescript/projenrc.ts",
-            "line": 31
+            "line": 32
           },
           "name": "swc",
           "optional": true,
@@ -84664,10 +84896,31 @@
           },
           "locationInModule": {
             "filename": "src/typescript/projenrc-ts.ts",
-            "line": 115
+            "line": 117
           },
           "name": "preSynthesize",
           "overrides": "projen.ProjenrcFile"
+        },
+        {
+          "docs": {
+            "remarks": "It does not run on later `projen` invocations. It only fires for `projen new` (or `Projects.createProject`).\nUse it for deterministic, one-off file generation. Order across components is not guaranteed.",
+            "stability": "experimental",
+            "summary": "Called once, right after `synthesize()`, only when the project is created for the first time."
+          },
+          "locationInModule": {
+            "filename": "src/typescript/projenrc-ts.ts",
+            "line": 100
+          },
+          "name": "projectCreation",
+          "overrides": "projen.Component",
+          "parameters": [
+            {
+              "name": "initProject",
+              "type": {
+                "fqn": "projen.InitProject"
+              }
+            }
+          ]
         }
       ],
       "name": "ProjenrcTs",
@@ -88951,6 +89204,6 @@
   "usedFeatures": [
     "class-covariant-overrides"
   ],
-  "version": "0.101.8",
-  "fingerprint": "UA00xf0po+vJ/40ExC6cKS6TypKwrCK2EjYfmb9ARlw="
+  "version": "0.101.9",
+  "fingerprint": "IuYX/PgmjFwjEGWW0c9MKz7MPEEm1PhsLZtkD3zYxo8="
 }