@hallcor/pulumi-projen-project-types 0.0.16 → 0.0.18

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/.jsii CHANGED
@@ -1468,25 +1468,6 @@
1468
1468
  "primitive": "string"
1469
1469
  }
1470
1470
  },
1471
- {
1472
- "abstract": true,
1473
- "docs": {
1474
- "default": "package.json",
1475
- "remarks": "Must be a commit-and-tag-version compatible bump file",
1476
- "stability": "stable",
1477
- "summary": "The file to bump the version in."
1478
- },
1479
- "immutable": true,
1480
- "locationInModule": {
1481
- "filename": "src/TagReleaseOptions.ts",
1482
- "line": 263
1483
- },
1484
- "name": "bumpFile",
1485
- "optional": true,
1486
- "type": {
1487
- "primitive": "string"
1488
- }
1489
- },
1490
1471
  {
1491
1472
  "abstract": true,
1492
1473
  "docs": {
@@ -2056,39 +2037,2569 @@
2056
2037
  ],
2057
2038
  "symbolId": "src/TagReleaseOptions:TagReleaseOptions"
2058
2039
  },
2059
- "@hallcor/pulumi-projen-project-types.TypeScriptProject": {
2040
+ "@hallcor/pulumi-projen-project-types.TypeScriptComponent": {
2060
2041
  "assembly": "@hallcor/pulumi-projen-project-types",
2061
- "base": "projen.typescript.TypeScriptProject",
2042
+ "base": "@hallcor/pulumi-projen-project-types.TypeScriptProject",
2062
2043
  "docs": {
2063
2044
  "stability": "stable"
2064
2045
  },
2065
- "fqn": "@hallcor/pulumi-projen-project-types.TypeScriptProject",
2046
+ "fqn": "@hallcor/pulumi-projen-project-types.TypeScriptComponent",
2066
2047
  "initializer": {
2067
2048
  "docs": {
2068
2049
  "stability": "stable"
2069
2050
  },
2070
2051
  "locationInModule": {
2071
- "filename": "src/typescript-base.ts",
2072
- "line": 13
2052
+ "filename": "src/typescript.ts",
2053
+ "line": 7
2073
2054
  },
2074
2055
  "parameters": [
2075
2056
  {
2076
2057
  "name": "options",
2077
2058
  "type": {
2078
- "fqn": "projen.typescript.TypeScriptProjectOptions"
2059
+ "fqn": "@hallcor/pulumi-projen-project-types.TypeScriptComponentOptions"
2079
2060
  }
2080
2061
  }
2081
2062
  ]
2082
2063
  },
2083
2064
  "kind": "class",
2084
2065
  "locationInModule": {
2085
- "filename": "src/typescript-base.ts",
2086
- "line": 12
2066
+ "filename": "src/typescript.ts",
2067
+ "line": 6
2068
+ },
2069
+ "name": "TypeScriptComponent",
2070
+ "symbolId": "src/typescript:TypeScriptComponent"
2071
+ },
2072
+ "@hallcor/pulumi-projen-project-types.TypeScriptComponentOptions": {
2073
+ "assembly": "@hallcor/pulumi-projen-project-types",
2074
+ "datatype": true,
2075
+ "docs": {
2076
+ "stability": "stable",
2077
+ "summary": "TypeScriptComponentOptions."
2078
+ },
2079
+ "fqn": "@hallcor/pulumi-projen-project-types.TypeScriptComponentOptions",
2080
+ "kind": "interface",
2081
+ "locationInModule": {
2082
+ "filename": "src/TypeScriptComponentOptions.ts",
2083
+ "line": 7
2084
+ },
2085
+ "name": "TypeScriptComponentOptions",
2086
+ "properties": [
2087
+ {
2088
+ "abstract": true,
2089
+ "docs": {
2090
+ "default": "\"main\"",
2091
+ "stability": "experimental",
2092
+ "summary": "The name of the main release branch."
2093
+ },
2094
+ "immutable": true,
2095
+ "locationInModule": {
2096
+ "filename": "src/TypeScriptComponentOptions.ts",
2097
+ "line": 313
2098
+ },
2099
+ "name": "defaultReleaseBranch",
2100
+ "type": {
2101
+ "primitive": "string"
2102
+ }
2103
+ },
2104
+ {
2105
+ "abstract": true,
2106
+ "docs": {
2107
+ "custom": {
2108
+ "featured": "true"
2109
+ },
2110
+ "default": "$BASEDIR",
2111
+ "stability": "experimental",
2112
+ "summary": "This is the name of your project."
2113
+ },
2114
+ "immutable": true,
2115
+ "locationInModule": {
2116
+ "filename": "src/TypeScriptComponentOptions.ts",
2117
+ "line": 894
2118
+ },
2119
+ "name": "name",
2120
+ "type": {
2121
+ "primitive": "string"
2122
+ }
2123
+ },
2124
+ {
2125
+ "abstract": true,
2126
+ "docs": {
2127
+ "default": "true",
2128
+ "remarks": "This is normally only allowed for libraries. For apps, there's no meaning\nfor specifying these.",
2129
+ "stability": "experimental",
2130
+ "summary": "Allow the project to include `peerDependencies` and `bundledDependencies`."
2131
+ },
2132
+ "immutable": true,
2133
+ "locationInModule": {
2134
+ "filename": "src/TypeScriptComponentOptions.ts",
2135
+ "line": 739
2136
+ },
2137
+ "name": "allowLibraryDependencies",
2138
+ "optional": true,
2139
+ "type": {
2140
+ "primitive": "boolean"
2141
+ }
2142
+ },
2143
+ {
2144
+ "abstract": true,
2145
+ "docs": {
2146
+ "default": "\"dist\"",
2147
+ "stability": "experimental",
2148
+ "summary": "A directory which will contain build artifacts."
2149
+ },
2150
+ "immutable": true,
2151
+ "locationInModule": {
2152
+ "filename": "src/TypeScriptComponentOptions.ts",
2153
+ "line": 307
2154
+ },
2155
+ "name": "artifactsDirectory",
2156
+ "optional": true,
2157
+ "type": {
2158
+ "primitive": "string"
2159
+ }
2160
+ },
2161
+ {
2162
+ "abstract": true,
2163
+ "docs": {
2164
+ "stability": "experimental",
2165
+ "summary": "Author's e-mail."
2166
+ },
2167
+ "immutable": true,
2168
+ "locationInModule": {
2169
+ "filename": "src/TypeScriptComponentOptions.ts",
2170
+ "line": 731
2171
+ },
2172
+ "name": "authorEmail",
2173
+ "optional": true,
2174
+ "type": {
2175
+ "primitive": "string"
2176
+ }
2177
+ },
2178
+ {
2179
+ "abstract": true,
2180
+ "docs": {
2181
+ "stability": "experimental",
2182
+ "summary": "Author's name."
2183
+ },
2184
+ "immutable": true,
2185
+ "locationInModule": {
2186
+ "filename": "src/TypeScriptComponentOptions.ts",
2187
+ "line": 726
2188
+ },
2189
+ "name": "authorName",
2190
+ "optional": true,
2191
+ "type": {
2192
+ "primitive": "string"
2193
+ }
2194
+ },
2195
+ {
2196
+ "abstract": true,
2197
+ "docs": {
2198
+ "stability": "experimental",
2199
+ "summary": "Is the author an organization."
2200
+ },
2201
+ "immutable": true,
2202
+ "locationInModule": {
2203
+ "filename": "src/TypeScriptComponentOptions.ts",
2204
+ "line": 721
2205
+ },
2206
+ "name": "authorOrganization",
2207
+ "optional": true,
2208
+ "type": {
2209
+ "primitive": "boolean"
2210
+ }
2211
+ },
2212
+ {
2213
+ "abstract": true,
2214
+ "docs": {
2215
+ "stability": "experimental",
2216
+ "summary": "Author's URL / Website."
2217
+ },
2218
+ "immutable": true,
2219
+ "locationInModule": {
2220
+ "filename": "src/TypeScriptComponentOptions.ts",
2221
+ "line": 716
2222
+ },
2223
+ "name": "authorUrl",
2224
+ "optional": true,
2225
+ "type": {
2226
+ "primitive": "string"
2227
+ }
2228
+ },
2229
+ {
2230
+ "abstract": true,
2231
+ "docs": {
2232
+ "default": "- auto approve is disabled",
2233
+ "stability": "experimental",
2234
+ "summary": "Enable and configure the 'auto approve' workflow."
2235
+ },
2236
+ "immutable": true,
2237
+ "locationInModule": {
2238
+ "filename": "src/TypeScriptComponentOptions.ts",
2239
+ "line": 818
2240
+ },
2241
+ "name": "autoApproveOptions",
2242
+ "optional": true,
2243
+ "type": {
2244
+ "fqn": "projen.github.AutoApproveOptions"
2245
+ }
2246
+ },
2247
+ {
2248
+ "abstract": true,
2249
+ "docs": {
2250
+ "default": "- true",
2251
+ "remarks": "Throw if set to true but `autoApproveOptions` are not defined.",
2252
+ "stability": "experimental",
2253
+ "summary": "Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued)."
2254
+ },
2255
+ "immutable": true,
2256
+ "locationInModule": {
2257
+ "filename": "src/TypeScriptComponentOptions.ts",
2258
+ "line": 301
2259
+ },
2260
+ "name": "autoApproveUpgrades",
2261
+ "optional": true,
2262
+ "type": {
2263
+ "primitive": "boolean"
2264
+ }
2265
+ },
2266
+ {
2267
+ "abstract": true,
2268
+ "docs": {
2269
+ "default": "true",
2270
+ "stability": "experimental",
2271
+ "summary": "Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section."
2272
+ },
2273
+ "immutable": true,
2274
+ "locationInModule": {
2275
+ "filename": "src/TypeScriptComponentOptions.ts",
2276
+ "line": 711
2277
+ },
2278
+ "name": "autoDetectBin",
2279
+ "optional": true,
2280
+ "type": {
2281
+ "primitive": "boolean"
2282
+ }
2283
+ },
2284
+ {
2285
+ "abstract": true,
2286
+ "docs": {
2287
+ "default": "true",
2288
+ "remarks": "Has no effect if `github.mergify`\nis set to false.",
2289
+ "stability": "experimental",
2290
+ "summary": "Enable automatic merging on GitHub."
2291
+ },
2292
+ "immutable": true,
2293
+ "locationInModule": {
2294
+ "filename": "src/TypeScriptComponentOptions.ts",
2295
+ "line": 812
2296
+ },
2297
+ "name": "autoMerge",
2298
+ "optional": true,
2299
+ "type": {
2300
+ "primitive": "boolean"
2301
+ }
2302
+ },
2303
+ {
2304
+ "abstract": true,
2305
+ "docs": {
2306
+ "default": "- see defaults in `AutoMergeOptions`",
2307
+ "remarks": "Has no effect if\n`github.mergify` or `autoMerge` is set to false.",
2308
+ "stability": "experimental",
2309
+ "summary": "Configure options for automatic merging on GitHub."
2310
+ },
2311
+ "immutable": true,
2312
+ "locationInModule": {
2313
+ "filename": "src/TypeScriptComponentOptions.ts",
2314
+ "line": 804
2315
+ },
2316
+ "name": "autoMergeOptions",
2317
+ "optional": true,
2318
+ "type": {
2319
+ "fqn": "projen.github.AutoMergeOptions"
2320
+ }
2321
+ },
2322
+ {
2323
+ "abstract": true,
2324
+ "docs": {
2325
+ "remarks": "You can use this option to add/customize how binaries are represented in\nyour `package.json`, but unless `autoDetectBin` is `false`, every\nexecutable file under `bin` will automatically be added to this section.",
2326
+ "stability": "experimental",
2327
+ "summary": "Binary programs vended with your module."
2328
+ },
2329
+ "immutable": true,
2330
+ "locationInModule": {
2331
+ "filename": "src/TypeScriptComponentOptions.ts",
2332
+ "line": 705
2333
+ },
2334
+ "name": "bin",
2335
+ "optional": true,
2336
+ "type": {
2337
+ "collection": {
2338
+ "elementtype": {
2339
+ "primitive": "string"
2340
+ },
2341
+ "kind": "map"
2342
+ }
2343
+ }
2344
+ },
2345
+ {
2346
+ "abstract": true,
2347
+ "docs": {
2348
+ "stability": "experimental",
2349
+ "summary": "The email address to which issues should be reported."
2350
+ },
2351
+ "immutable": true,
2352
+ "locationInModule": {
2353
+ "filename": "src/TypeScriptComponentOptions.ts",
2354
+ "line": 697
2355
+ },
2356
+ "name": "bugsEmail",
2357
+ "optional": true,
2358
+ "type": {
2359
+ "primitive": "string"
2360
+ }
2361
+ },
2362
+ {
2363
+ "abstract": true,
2364
+ "docs": {
2365
+ "stability": "experimental",
2366
+ "summary": "The url to your project's issue tracker."
2367
+ },
2368
+ "immutable": true,
2369
+ "locationInModule": {
2370
+ "filename": "src/TypeScriptComponentOptions.ts",
2371
+ "line": 692
2372
+ },
2373
+ "name": "bugsUrl",
2374
+ "optional": true,
2375
+ "type": {
2376
+ "primitive": "string"
2377
+ }
2378
+ },
2379
+ {
2380
+ "abstract": true,
2381
+ "docs": {
2382
+ "default": "- true if not a subproject",
2383
+ "stability": "experimental",
2384
+ "summary": "Define a GitHub workflow for building PRs."
2385
+ },
2386
+ "immutable": true,
2387
+ "locationInModule": {
2388
+ "filename": "src/TypeScriptComponentOptions.ts",
2389
+ "line": 294
2390
+ },
2391
+ "name": "buildWorkflow",
2392
+ "optional": true,
2393
+ "type": {
2394
+ "primitive": "boolean"
2395
+ }
2396
+ },
2397
+ {
2398
+ "abstract": true,
2399
+ "docs": {
2400
+ "stability": "experimental",
2401
+ "summary": "Options for PR build workflow."
2402
+ },
2403
+ "immutable": true,
2404
+ "locationInModule": {
2405
+ "filename": "src/TypeScriptComponentOptions.ts",
2406
+ "line": 288
2407
+ },
2408
+ "name": "buildWorkflowOptions",
2409
+ "optional": true,
2410
+ "type": {
2411
+ "fqn": "projen.javascript.BuildWorkflowOptions"
2412
+ }
2413
+ },
2414
+ {
2415
+ "abstract": true,
2416
+ "docs": {
2417
+ "default": "- A recent version of \"commit-and-tag-version\"",
2418
+ "remarks": "This can be any compatible package version, including the deprecated `standard-version@9`.",
2419
+ "stability": "experimental",
2420
+ "summary": "The `commit-and-tag-version` compatible package used to bump the package version, as a dependency string."
2421
+ },
2422
+ "immutable": true,
2423
+ "locationInModule": {
2424
+ "filename": "src/TypeScriptComponentOptions.ts",
2425
+ "line": 461
2426
+ },
2427
+ "name": "bumpPackage",
2428
+ "optional": true,
2429
+ "type": {
2430
+ "primitive": "string"
2431
+ }
2432
+ },
2433
+ {
2434
+ "abstract": true,
2435
+ "docs": {
2436
+ "remarks": "These modules will be\nadded both to the `dependencies` section and `bundledDependencies` section of\nyour `package.json`.\n\nThe recommendation is to only specify the module name here (e.g.\n`express`). This will behave similar to `yarn add` or `npm install` in the\nsense that it will add the module as a dependency to your `package.json`\nfile with the latest version (`^`). You can specify semver requirements in\nthe same syntax passed to `npm i` or `yarn add` (e.g. `express@^2`) and\nthis will be what you `package.json` will eventually include.",
2437
+ "stability": "experimental",
2438
+ "summary": "List of dependencies to bundle into this module."
2439
+ },
2440
+ "immutable": true,
2441
+ "locationInModule": {
2442
+ "filename": "src/TypeScriptComponentOptions.ts",
2443
+ "line": 687
2444
+ },
2445
+ "name": "bundledDeps",
2446
+ "optional": true,
2447
+ "type": {
2448
+ "collection": {
2449
+ "elementtype": {
2450
+ "primitive": "string"
2451
+ },
2452
+ "kind": "array"
2453
+ }
2454
+ }
2455
+ },
2456
+ {
2457
+ "abstract": true,
2458
+ "docs": {
2459
+ "stability": "experimental",
2460
+ "summary": "Options for `Bundler`."
2461
+ },
2462
+ "immutable": true,
2463
+ "locationInModule": {
2464
+ "filename": "src/TypeScriptComponentOptions.ts",
2465
+ "line": 283
2466
+ },
2467
+ "name": "bundlerOptions",
2468
+ "optional": true,
2469
+ "type": {
2470
+ "fqn": "projen.javascript.BundlerOptions"
2471
+ }
2472
+ },
2473
+ {
2474
+ "abstract": true,
2475
+ "docs": {
2476
+ "default": "\"latest\"",
2477
+ "stability": "experimental",
2478
+ "summary": "The version of Bun to use if using Bun as a package manager."
2479
+ },
2480
+ "immutable": true,
2481
+ "locationInModule": {
2482
+ "filename": "src/TypeScriptComponentOptions.ts",
2483
+ "line": 672
2484
+ },
2485
+ "name": "bunVersion",
2486
+ "optional": true,
2487
+ "type": {
2488
+ "primitive": "string"
2489
+ }
2490
+ },
2491
+ {
2492
+ "abstract": true,
2493
+ "docs": {
2494
+ "default": "- no license checks are run during the build and all licenses will be accepted",
2495
+ "remarks": "This setting will cause the build to fail, if any prohibited or not allowed licenses ares encountered.",
2496
+ "stability": "experimental",
2497
+ "summary": "Configure which licenses should be deemed acceptable for use by dependencies."
2498
+ },
2499
+ "immutable": true,
2500
+ "locationInModule": {
2501
+ "filename": "src/TypeScriptComponentOptions.ts",
2502
+ "line": 278
2503
+ },
2504
+ "name": "checkLicenses",
2505
+ "optional": true,
2506
+ "type": {
2507
+ "fqn": "projen.javascript.LicenseCheckerOptions"
2508
+ }
2509
+ },
2510
+ {
2511
+ "abstract": true,
2512
+ "docs": {
2513
+ "default": "- true, but false for subprojects",
2514
+ "stability": "experimental",
2515
+ "summary": "Add a `clobber` task which resets the repo to origin."
2516
+ },
2517
+ "immutable": true,
2518
+ "locationInModule": {
2519
+ "filename": "src/TypeScriptComponentOptions.ts",
2520
+ "line": 796
2521
+ },
2522
+ "name": "clobber",
2523
+ "optional": true,
2524
+ "type": {
2525
+ "primitive": "boolean"
2526
+ }
2527
+ },
2528
+ {
2529
+ "abstract": true,
2530
+ "docs": {
2531
+ "default": "- undefined",
2532
+ "remarks": "This is required if publishing packages to, or installing scoped packages from AWS CodeArtifact",
2533
+ "stability": "experimental",
2534
+ "summary": "Options for npm packages using AWS CodeArtifact."
2535
+ },
2536
+ "immutable": true,
2537
+ "locationInModule": {
2538
+ "filename": "src/TypeScriptComponentOptions.ts",
2539
+ "line": 666
2540
+ },
2541
+ "name": "codeArtifactOptions",
2542
+ "optional": true,
2543
+ "type": {
2544
+ "fqn": "projen.javascript.CodeArtifactOptions"
2545
+ }
2546
+ },
2547
+ {
2548
+ "abstract": true,
2549
+ "docs": {
2550
+ "default": "false",
2551
+ "stability": "experimental",
2552
+ "summary": "Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v4 A secret is required for private repos. Configured with `@codeCovTokenSecret`."
2553
+ },
2554
+ "immutable": true,
2555
+ "locationInModule": {
2556
+ "filename": "src/TypeScriptComponentOptions.ts",
2557
+ "line": 271
2558
+ },
2559
+ "name": "codeCov",
2560
+ "optional": true,
2561
+ "type": {
2562
+ "primitive": "boolean"
2563
+ }
2564
+ },
2565
+ {
2566
+ "abstract": true,
2567
+ "docs": {
2568
+ "default": "- if this option is not specified, only public repositories are supported",
2569
+ "stability": "experimental",
2570
+ "summary": "Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories."
2571
+ },
2572
+ "immutable": true,
2573
+ "locationInModule": {
2574
+ "filename": "src/TypeScriptComponentOptions.ts",
2575
+ "line": 265
2576
+ },
2577
+ "name": "codeCovTokenSecret",
2578
+ "optional": true,
2579
+ "type": {
2580
+ "primitive": "string"
2581
+ }
2582
+ },
2583
+ {
2584
+ "abstract": true,
2585
+ "docs": {
2586
+ "default": "true",
2587
+ "stability": "experimental",
2588
+ "summary": "Whether to commit the managed files by default."
2589
+ },
2590
+ "immutable": true,
2591
+ "locationInModule": {
2592
+ "filename": "src/TypeScriptComponentOptions.ts",
2593
+ "line": 887
2594
+ },
2595
+ "name": "commitGenerated",
2596
+ "optional": true,
2597
+ "type": {
2598
+ "primitive": "boolean"
2599
+ }
2600
+ },
2601
+ {
2602
+ "abstract": true,
2603
+ "docs": {
2604
+ "default": "the `moduleName`",
2605
+ "stability": "stable",
2606
+ "summary": "The name of the pulumi component."
2607
+ },
2608
+ "immutable": true,
2609
+ "locationInModule": {
2610
+ "filename": "src/TypeScriptComponentOptions.ts",
2611
+ "line": 913
2612
+ },
2613
+ "name": "componentName",
2614
+ "optional": true,
2615
+ "type": {
2616
+ "primitive": "string"
2617
+ }
2618
+ },
2619
+ {
2620
+ "abstract": true,
2621
+ "docs": {
2622
+ "default": "- defaults to the value of authorName or \"\" if `authorName` is undefined.",
2623
+ "stability": "experimental",
2624
+ "summary": "License copyright owner."
2625
+ },
2626
+ "immutable": true,
2627
+ "locationInModule": {
2628
+ "filename": "src/TypeScriptComponentOptions.ts",
2629
+ "line": 259
2630
+ },
2631
+ "name": "copyrightOwner",
2632
+ "optional": true,
2633
+ "type": {
2634
+ "primitive": "string"
2635
+ }
2636
+ },
2637
+ {
2638
+ "abstract": true,
2639
+ "docs": {
2640
+ "default": "- current year",
2641
+ "stability": "experimental",
2642
+ "summary": "The copyright years to put in the LICENSE file."
2643
+ },
2644
+ "immutable": true,
2645
+ "locationInModule": {
2646
+ "filename": "src/TypeScriptComponentOptions.ts",
2647
+ "line": 253
2648
+ },
2649
+ "name": "copyrightPeriod",
2650
+ "optional": true,
2651
+ "type": {
2652
+ "primitive": "string"
2653
+ }
2654
+ },
2655
+ {
2656
+ "abstract": true,
2657
+ "docs": {
2658
+ "default": "false",
2659
+ "remarks": "Cannot be used in conjunction with `depsUpgrade`.",
2660
+ "stability": "experimental",
2661
+ "summary": "Use dependabot to handle dependency upgrades."
2662
+ },
2663
+ "immutable": true,
2664
+ "locationInModule": {
2665
+ "filename": "src/TypeScriptComponentOptions.ts",
2666
+ "line": 247
2667
+ },
2668
+ "name": "dependabot",
2669
+ "optional": true,
2670
+ "type": {
2671
+ "primitive": "boolean"
2672
+ }
2673
+ },
2674
+ {
2675
+ "abstract": true,
2676
+ "docs": {
2677
+ "default": "- default options",
2678
+ "stability": "experimental",
2679
+ "summary": "Options for dependabot."
2680
+ },
2681
+ "immutable": true,
2682
+ "locationInModule": {
2683
+ "filename": "src/TypeScriptComponentOptions.ts",
2684
+ "line": 240
2685
+ },
2686
+ "name": "dependabotOptions",
2687
+ "optional": true,
2688
+ "type": {
2689
+ "fqn": "projen.github.DependabotOptions"
2690
+ }
2691
+ },
2692
+ {
2693
+ "abstract": true,
2694
+ "docs": {
2695
+ "custom": {
2696
+ "featured": "true"
2697
+ },
2698
+ "default": "[]",
2699
+ "remarks": "The recommendation is to only specify the module name here (e.g.\n`express`). This will behave similar to `yarn add` or `npm install` in the\nsense that it will add the module as a dependency to your `package.json`\nfile with the latest version (`^`). You can specify semver requirements in\nthe same syntax passed to `npm i` or `yarn add` (e.g. `express@^2`) and\nthis will be what you `package.json` will eventually include.",
2700
+ "stability": "experimental",
2701
+ "summary": "Runtime dependencies of this module."
2702
+ },
2703
+ "immutable": true,
2704
+ "locationInModule": {
2705
+ "filename": "src/TypeScriptComponentOptions.ts",
2706
+ "line": 659
2707
+ },
2708
+ "name": "deps",
2709
+ "optional": true,
2710
+ "type": {
2711
+ "collection": {
2712
+ "elementtype": {
2713
+ "primitive": "string"
2714
+ },
2715
+ "kind": "array"
2716
+ }
2717
+ }
2718
+ },
2719
+ {
2720
+ "abstract": true,
2721
+ "docs": {
2722
+ "default": "true",
2723
+ "remarks": "Cannot be used in conjunction with `dependabot`.",
2724
+ "stability": "experimental",
2725
+ "summary": "Use tasks and github workflows to handle dependency upgrades."
2726
+ },
2727
+ "immutable": true,
2728
+ "locationInModule": {
2729
+ "filename": "src/TypeScriptComponentOptions.ts",
2730
+ "line": 234
2731
+ },
2732
+ "name": "depsUpgrade",
2733
+ "optional": true,
2734
+ "type": {
2735
+ "primitive": "boolean"
2736
+ }
2737
+ },
2738
+ {
2739
+ "abstract": true,
2740
+ "docs": {
2741
+ "default": "- default options",
2742
+ "stability": "experimental",
2743
+ "summary": "Options for `UpgradeDependencies`."
2744
+ },
2745
+ "immutable": true,
2746
+ "locationInModule": {
2747
+ "filename": "src/TypeScriptComponentOptions.ts",
2748
+ "line": 227
2749
+ },
2750
+ "name": "depsUpgradeOptions",
2751
+ "optional": true,
2752
+ "type": {
2753
+ "fqn": "projen.javascript.UpgradeDependenciesOptions"
2754
+ }
2755
+ },
2756
+ {
2757
+ "abstract": true,
2758
+ "docs": {
2759
+ "custom": {
2760
+ "featured": "true"
2761
+ },
2762
+ "remarks": "It can be used when searching for packages in a package manager as well.\nSee https://classic.yarnpkg.com/en/docs/package-json/#toc-description",
2763
+ "stability": "experimental",
2764
+ "summary": "The description is just a string that helps people understand the purpose of the package."
2765
+ },
2766
+ "immutable": true,
2767
+ "locationInModule": {
2768
+ "filename": "src/TypeScriptComponentOptions.ts",
2769
+ "line": 646
2770
+ },
2771
+ "name": "description",
2772
+ "optional": true,
2773
+ "type": {
2774
+ "primitive": "string"
2775
+ }
2776
+ },
2777
+ {
2778
+ "abstract": true,
2779
+ "docs": {
2780
+ "default": "false",
2781
+ "stability": "experimental",
2782
+ "summary": "Add a VSCode development environment (used for GitHub Codespaces)."
2783
+ },
2784
+ "immutable": true,
2785
+ "locationInModule": {
2786
+ "filename": "src/TypeScriptComponentOptions.ts",
2787
+ "line": 790
2788
+ },
2789
+ "name": "devContainer",
2790
+ "optional": true,
2791
+ "type": {
2792
+ "primitive": "boolean"
2793
+ }
2794
+ },
2795
+ {
2796
+ "abstract": true,
2797
+ "docs": {
2798
+ "custom": {
2799
+ "featured": "true"
2800
+ },
2801
+ "default": "[]",
2802
+ "remarks": "These dependencies will only be\navailable in your build environment but will not be fetched when this\nmodule is consumed.\n\nThe recommendation is to only specify the module name here (e.g.\n`express`). This will behave similar to `yarn add` or `npm install` in the\nsense that it will add the module as a dependency to your `package.json`\nfile with the latest version (`^`). You can specify semver requirements in\nthe same syntax passed to `npm i` or `yarn add` (e.g. `express@^2`) and\nthis will be what you `package.json` will eventually include.",
2803
+ "stability": "experimental",
2804
+ "summary": "Build dependencies for this module."
2805
+ },
2806
+ "immutable": true,
2807
+ "locationInModule": {
2808
+ "filename": "src/TypeScriptComponentOptions.ts",
2809
+ "line": 638
2810
+ },
2811
+ "name": "devDeps",
2812
+ "optional": true,
2813
+ "type": {
2814
+ "collection": {
2815
+ "elementtype": {
2816
+ "primitive": "string"
2817
+ },
2818
+ "kind": "array"
2819
+ }
2820
+ }
2821
+ },
2822
+ {
2823
+ "abstract": true,
2824
+ "docs": {
2825
+ "default": "false",
2826
+ "stability": "experimental",
2827
+ "summary": "Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler)."
2828
+ },
2829
+ "immutable": true,
2830
+ "locationInModule": {
2831
+ "filename": "src/TypeScriptComponentOptions.ts",
2832
+ "line": 120
2833
+ },
2834
+ "name": "disableTsconfig",
2835
+ "optional": true,
2836
+ "type": {
2837
+ "primitive": "boolean"
2838
+ }
2839
+ },
2840
+ {
2841
+ "abstract": true,
2842
+ "docs": {
2843
+ "default": "false",
2844
+ "stability": "experimental",
2845
+ "summary": "Do not generate a `tsconfig.dev.json` file."
2846
+ },
2847
+ "immutable": true,
2848
+ "locationInModule": {
2849
+ "filename": "src/TypeScriptComponentOptions.ts",
2850
+ "line": 114
2851
+ },
2852
+ "name": "disableTsconfigDev",
2853
+ "optional": true,
2854
+ "type": {
2855
+ "primitive": "boolean"
2856
+ }
2857
+ },
2858
+ {
2859
+ "abstract": true,
2860
+ "docs": {
2861
+ "default": "false",
2862
+ "stability": "experimental",
2863
+ "summary": "Docgen by Typedoc."
2864
+ },
2865
+ "immutable": true,
2866
+ "locationInModule": {
2867
+ "filename": "src/TypeScriptComponentOptions.ts",
2868
+ "line": 108
2869
+ },
2870
+ "name": "docgen",
2871
+ "optional": true,
2872
+ "type": {
2873
+ "primitive": "boolean"
2874
+ }
2875
+ },
2876
+ {
2877
+ "abstract": true,
2878
+ "docs": {
2879
+ "default": "\"docs\"",
2880
+ "stability": "experimental",
2881
+ "summary": "Docs directory."
2882
+ },
2883
+ "immutable": true,
2884
+ "locationInModule": {
2885
+ "filename": "src/TypeScriptComponentOptions.ts",
2886
+ "line": 102
2887
+ },
2888
+ "name": "docsDirectory",
2889
+ "optional": true,
2890
+ "type": {
2891
+ "primitive": "string"
2892
+ }
2893
+ },
2894
+ {
2895
+ "abstract": true,
2896
+ "docs": {
2897
+ "default": "src/index.ts",
2898
+ "stability": "experimental",
2899
+ "summary": "Module entrypoint (`main` in `package.json`). Set to an empty string to not include `main` in your package.json."
2900
+ },
2901
+ "immutable": true,
2902
+ "locationInModule": {
2903
+ "filename": "src/TypeScriptComponentOptions.ts",
2904
+ "line": 621
2905
+ },
2906
+ "name": "entrypoint",
2907
+ "optional": true,
2908
+ "type": {
2909
+ "primitive": "string"
2910
+ }
2911
+ },
2912
+ {
2913
+ "abstract": true,
2914
+ "docs": {
2915
+ "default": "- .d.ts file derived from the project's entrypoint (usually lib/index.d.ts)",
2916
+ "stability": "experimental",
2917
+ "summary": "The .d.ts file that includes the type declarations for this module."
2918
+ },
2919
+ "immutable": true,
2920
+ "locationInModule": {
2921
+ "filename": "src/TypeScriptComponentOptions.ts",
2922
+ "line": 96
2923
+ },
2924
+ "name": "entrypointTypes",
2925
+ "optional": true,
2926
+ "type": {
2927
+ "primitive": "string"
2928
+ }
2929
+ },
2930
+ {
2931
+ "abstract": true,
2932
+ "docs": {
2933
+ "default": "true",
2934
+ "stability": "experimental",
2935
+ "summary": "Setup eslint."
2936
+ },
2937
+ "immutable": true,
2938
+ "locationInModule": {
2939
+ "filename": "src/TypeScriptComponentOptions.ts",
2940
+ "line": 90
2941
+ },
2942
+ "name": "eslint",
2943
+ "optional": true,
2944
+ "type": {
2945
+ "primitive": "boolean"
2946
+ }
2947
+ },
2948
+ {
2949
+ "abstract": true,
2950
+ "docs": {
2951
+ "default": "- opinionated default options",
2952
+ "stability": "experimental",
2953
+ "summary": "Eslint options."
2954
+ },
2955
+ "immutable": true,
2956
+ "locationInModule": {
2957
+ "filename": "src/TypeScriptComponentOptions.ts",
2958
+ "line": 84
2959
+ },
2960
+ "name": "eslintOptions",
2961
+ "optional": true,
2962
+ "type": {
2963
+ "fqn": "projen.javascript.EslintOptions"
2964
+ }
2965
+ },
2966
+ {
2967
+ "abstract": true,
2968
+ "docs": {
2969
+ "default": "- see GitHubOptions",
2970
+ "stability": "experimental",
2971
+ "summary": "Options for GitHub integration."
2972
+ },
2973
+ "immutable": true,
2974
+ "locationInModule": {
2975
+ "filename": "src/TypeScriptComponentOptions.ts",
2976
+ "line": 784
2977
+ },
2978
+ "name": "githubOptions",
2979
+ "optional": true,
2980
+ "type": {
2981
+ "fqn": "projen.github.GitHubOptions"
2982
+ }
2983
+ },
2984
+ {
2985
+ "abstract": true,
2986
+ "docs": {
2987
+ "default": "${{ secrets.GITHUB_TOKEN }}",
2988
+ "stability": "stable",
2989
+ "summary": "The GitHub Token to use when pushing the tag commit Note: if you use the default `${{ secrets.GITHUB_TOKEN }}` then the Push/Tag will not trigger any other workflows."
2990
+ },
2991
+ "immutable": true,
2992
+ "locationInModule": {
2993
+ "filename": "src/TypeScriptComponentOptions.ts",
2994
+ "line": 901
2995
+ },
2996
+ "name": "githubReleaseToken",
2997
+ "optional": true,
2998
+ "type": {
2999
+ "primitive": "string"
3000
+ }
3001
+ },
3002
+ {
3003
+ "abstract": true,
3004
+ "docs": {
3005
+ "default": "github-actions user",
3006
+ "stability": "stable",
3007
+ "summary": "The git identity to use when pushing the release commit and tag Note: if you use the default github-actions user then the Push/Tag will not trigger any other workflows."
3008
+ },
3009
+ "immutable": true,
3010
+ "locationInModule": {
3011
+ "filename": "src/TypeScriptComponentOptions.ts",
3012
+ "line": 908
3013
+ },
3014
+ "name": "gitIdentity",
3015
+ "optional": true,
3016
+ "type": {
3017
+ "fqn": "projen.github.GitIdentity"
3018
+ }
3019
+ },
3020
+ {
3021
+ "abstract": true,
3022
+ "docs": {
3023
+ "stability": "experimental",
3024
+ "summary": "Additional entries to .gitignore."
3025
+ },
3026
+ "immutable": true,
3027
+ "locationInModule": {
3028
+ "filename": "src/TypeScriptComponentOptions.ts",
3029
+ "line": 221
3030
+ },
3031
+ "name": "gitignore",
3032
+ "optional": true,
3033
+ "type": {
3034
+ "collection": {
3035
+ "elementtype": {
3036
+ "primitive": "string"
3037
+ },
3038
+ "kind": "array"
3039
+ }
3040
+ }
3041
+ },
3042
+ {
3043
+ "abstract": true,
3044
+ "docs": {
3045
+ "stability": "experimental",
3046
+ "summary": "Configuration options for .gitignore file."
3047
+ },
3048
+ "immutable": true,
3049
+ "locationInModule": {
3050
+ "filename": "src/TypeScriptComponentOptions.ts",
3051
+ "line": 881
3052
+ },
3053
+ "name": "gitIgnoreOptions",
3054
+ "optional": true,
3055
+ "type": {
3056
+ "fqn": "projen.IgnoreFileOptions"
3057
+ }
3058
+ },
3059
+ {
3060
+ "abstract": true,
3061
+ "docs": {
3062
+ "stability": "experimental",
3063
+ "summary": "Configuration options for git."
3064
+ },
3065
+ "immutable": true,
3066
+ "locationInModule": {
3067
+ "filename": "src/TypeScriptComponentOptions.ts",
3068
+ "line": 876
3069
+ },
3070
+ "name": "gitOptions",
3071
+ "optional": true,
3072
+ "type": {
3073
+ "fqn": "projen.GitOptions"
3074
+ }
3075
+ },
3076
+ {
3077
+ "abstract": true,
3078
+ "docs": {
3079
+ "default": "false",
3080
+ "stability": "experimental",
3081
+ "summary": "Add a Gitpod development environment."
3082
+ },
3083
+ "immutable": true,
3084
+ "locationInModule": {
3085
+ "filename": "src/TypeScriptComponentOptions.ts",
3086
+ "line": 778
3087
+ },
3088
+ "name": "gitpod",
3089
+ "optional": true,
3090
+ "type": {
3091
+ "primitive": "boolean"
3092
+ }
3093
+ },
3094
+ {
3095
+ "abstract": true,
3096
+ "docs": {
3097
+ "stability": "experimental",
3098
+ "summary": "Package's Homepage / Website."
3099
+ },
3100
+ "immutable": true,
3101
+ "locationInModule": {
3102
+ "filename": "src/TypeScriptComponentOptions.ts",
3103
+ "line": 614
3104
+ },
3105
+ "name": "homepage",
3106
+ "optional": true,
3107
+ "type": {
3108
+ "primitive": "string"
3109
+ }
3110
+ },
3111
+ {
3112
+ "abstract": true,
3113
+ "docs": {
3114
+ "default": "true",
3115
+ "stability": "experimental",
3116
+ "summary": "Setup jest unit tests."
3117
+ },
3118
+ "immutable": true,
3119
+ "locationInModule": {
3120
+ "filename": "src/TypeScriptComponentOptions.ts",
3121
+ "line": 216
3122
+ },
3123
+ "name": "jest",
3124
+ "optional": true,
3125
+ "type": {
3126
+ "primitive": "boolean"
3127
+ }
3128
+ },
3129
+ {
3130
+ "abstract": true,
3131
+ "docs": {
3132
+ "default": "- default options",
3133
+ "stability": "experimental",
3134
+ "summary": "Jest options."
3135
+ },
3136
+ "immutable": true,
3137
+ "locationInModule": {
3138
+ "filename": "src/TypeScriptComponentOptions.ts",
3139
+ "line": 210
3140
+ },
3141
+ "name": "jestOptions",
3142
+ "optional": true,
3143
+ "type": {
3144
+ "fqn": "projen.javascript.JestOptions"
3145
+ }
3146
+ },
3147
+ {
3148
+ "abstract": true,
3149
+ "docs": {
3150
+ "stability": "experimental",
3151
+ "summary": "Keywords to include in `package.json`."
3152
+ },
3153
+ "immutable": true,
3154
+ "locationInModule": {
3155
+ "filename": "src/TypeScriptComponentOptions.ts",
3156
+ "line": 609
3157
+ },
3158
+ "name": "keywords",
3159
+ "optional": true,
3160
+ "type": {
3161
+ "collection": {
3162
+ "elementtype": {
3163
+ "primitive": "string"
3164
+ },
3165
+ "kind": "array"
3166
+ }
3167
+ }
3168
+ },
3169
+ {
3170
+ "abstract": true,
3171
+ "docs": {
3172
+ "default": "\"lib\"",
3173
+ "stability": "experimental",
3174
+ "summary": "Typescript artifacts output directory."
3175
+ },
3176
+ "immutable": true,
3177
+ "locationInModule": {
3178
+ "filename": "src/TypeScriptComponentOptions.ts",
3179
+ "line": 78
3180
+ },
3181
+ "name": "libdir",
3182
+ "optional": true,
3183
+ "type": {
3184
+ "primitive": "string"
3185
+ }
3186
+ },
3187
+ {
3188
+ "abstract": true,
3189
+ "docs": {
3190
+ "default": "\"Apache-2.0\"",
3191
+ "remarks": "See https://github.com/projen/projen/tree/main/license-text for a list of supported licenses.\nUse the `licensed` option if you want to no license to be specified.",
3192
+ "stability": "experimental",
3193
+ "summary": "License's SPDX identifier."
3194
+ },
3195
+ "immutable": true,
3196
+ "locationInModule": {
3197
+ "filename": "src/TypeScriptComponentOptions.ts",
3198
+ "line": 604
3199
+ },
3200
+ "name": "license",
3201
+ "optional": true,
3202
+ "type": {
3203
+ "primitive": "string"
3204
+ }
3205
+ },
3206
+ {
3207
+ "abstract": true,
3208
+ "docs": {
3209
+ "default": "true",
3210
+ "stability": "experimental",
3211
+ "summary": "Indicates if a license should be added."
3212
+ },
3213
+ "immutable": true,
3214
+ "locationInModule": {
3215
+ "filename": "src/TypeScriptComponentOptions.ts",
3216
+ "line": 596
3217
+ },
3218
+ "name": "licensed",
3219
+ "optional": true,
3220
+ "type": {
3221
+ "primitive": "boolean"
3222
+ }
3223
+ },
3224
+ {
3225
+ "abstract": true,
3226
+ "docs": {
3227
+ "default": "{}",
3228
+ "stability": "experimental",
3229
+ "summary": "Configure logging options such as verbosity."
3230
+ },
3231
+ "immutable": true,
3232
+ "locationInModule": {
3233
+ "filename": "src/TypeScriptComponentOptions.ts",
3234
+ "line": 871
3235
+ },
3236
+ "name": "logging",
3237
+ "optional": true,
3238
+ "type": {
3239
+ "fqn": "projen.LoggerOptions"
3240
+ }
3241
+ },
3242
+ {
3243
+ "abstract": true,
3244
+ "docs": {
3245
+ "default": "- Major version is not enforced.",
3246
+ "remarks": "If this is specified, we bump the latest version of this major version line.\nIf not specified, we bump the global latest version.",
3247
+ "stability": "experimental",
3248
+ "summary": "Major version to release from the default branch."
3249
+ },
3250
+ "immutable": true,
3251
+ "locationInModule": {
3252
+ "filename": "src/TypeScriptComponentOptions.ts",
3253
+ "line": 454
3254
+ },
3255
+ "name": "majorVersion",
3256
+ "optional": true,
3257
+ "type": {
3258
+ "primitive": "number"
3259
+ }
3260
+ },
3261
+ {
3262
+ "abstract": true,
3263
+ "docs": {
3264
+ "default": "- no maximum version is enforced",
3265
+ "remarks": "Most projects should not use this option.\nThe value indicates that the package is incompatible with any newer versions of node.\nThis requirement is enforced via the engines field.\n\nYou will normally not need to set this option.\nConsider this option only if your package is known to not function with newer versions of node.",
3266
+ "stability": "experimental",
3267
+ "summary": "The maximum node version supported by this package."
3268
+ },
3269
+ "immutable": true,
3270
+ "locationInModule": {
3271
+ "filename": "src/TypeScriptComponentOptions.ts",
3272
+ "line": 590
3273
+ },
3274
+ "name": "maxNodeVersion",
3275
+ "optional": true,
3276
+ "type": {
3277
+ "primitive": "string"
3278
+ }
3279
+ },
3280
+ {
3281
+ "abstract": true,
3282
+ "docs": {
3283
+ "default": "- No minimum version is being enforced",
3284
+ "remarks": "This can be useful to set to 1, as breaking changes before the 1.x major\nrelease are not incrementing the major version number.\n\nCan not be set together with `majorVersion`.",
3285
+ "stability": "experimental",
3286
+ "summary": "Minimal Major version to release."
3287
+ },
3288
+ "immutable": true,
3289
+ "locationInModule": {
3290
+ "filename": "src/TypeScriptComponentOptions.ts",
3291
+ "line": 446
3292
+ },
3293
+ "name": "minMajorVersion",
3294
+ "optional": true,
3295
+ "type": {
3296
+ "primitive": "number"
3297
+ }
3298
+ },
3299
+ {
3300
+ "abstract": true,
3301
+ "docs": {
3302
+ "default": "- no minimum version is enforced",
3303
+ "remarks": "Most projects should not use this option.\nThe value indicates that the package is incompatible with any older versions of node.\nThis requirement is enforced via the engines field.\n\nYou will normally not need to set this option, even if your package is incompatible with EOL versions of node.\nConsider this option only if your package depends on a specific feature, that is not available in other LTS versions.\nSetting this option has very high impact on the consumers of your package,\nas package managers will actively prevent usage with node versions you have marked as incompatible.\n\nTo change the node version of your CI/CD workflows, use `workflowNodeVersion`.",
3304
+ "stability": "experimental",
3305
+ "summary": "The minimum node version required by this package to function."
3306
+ },
3307
+ "immutable": true,
3308
+ "locationInModule": {
3309
+ "filename": "src/TypeScriptComponentOptions.ts",
3310
+ "line": 579
3311
+ },
3312
+ "name": "minNodeVersion",
3313
+ "optional": true,
3314
+ "type": {
3315
+ "primitive": "string"
3316
+ }
3317
+ },
3318
+ {
3319
+ "abstract": true,
3320
+ "docs": {
3321
+ "default": "- The next version will be determined based on the commit history and project settings.",
3322
+ "remarks": "If present, this shell command will be run before the bump is executed, and\nit determines what version to release. It will be executed in the following\nenvironment:\n\n- Working directory: the project directory.\n- `$VERSION`: the current version. Looks like `1.2.3`.\n- `$LATEST_TAG`: the most recent tag. Looks like `prefix-v1.2.3`, or may be unset.\n\nThe command should print one of the following to `stdout`:\n\n- Nothing: the next version number will be determined based on commit history.\n- `x.y.z`: the next version number will be `x.y.z`.\n- `major|minor|patch`: the next version number will be the current version number\n with the indicated component bumped.\n\nThis setting cannot be specified together with `minMajorVersion`; the invoked\nscript can be used to achieve the effects of `minMajorVersion`.",
3323
+ "stability": "experimental",
3324
+ "summary": "A shell command to control the next version to release."
3325
+ },
3326
+ "immutable": true,
3327
+ "locationInModule": {
3328
+ "filename": "src/TypeScriptComponentOptions.ts",
3329
+ "line": 436
3330
+ },
3331
+ "name": "nextVersionCommand",
3332
+ "optional": true,
3333
+ "type": {
3334
+ "primitive": "string"
3335
+ }
3336
+ },
3337
+ {
3338
+ "abstract": true,
3339
+ "docs": {
3340
+ "default": "- for scoped packages (e.g. `foo@bar`), the default is\n`NpmAccess.RESTRICTED`, for non-scoped packages, the default is\n`NpmAccess.PUBLIC`.",
3341
+ "stability": "experimental",
3342
+ "summary": "Access level of the npm package."
3343
+ },
3344
+ "immutable": true,
3345
+ "locationInModule": {
3346
+ "filename": "src/TypeScriptComponentOptions.ts",
3347
+ "line": 564
3348
+ },
3349
+ "name": "npmAccess",
3350
+ "optional": true,
3351
+ "type": {
3352
+ "fqn": "projen.javascript.NpmAccess"
3353
+ }
3354
+ },
3355
+ {
3356
+ "abstract": true,
3357
+ "docs": {
3358
+ "default": "true",
3359
+ "stability": "experimental",
3360
+ "summary": "Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs."
3361
+ },
3362
+ "immutable": true,
3363
+ "locationInModule": {
3364
+ "filename": "src/TypeScriptComponentOptions.ts",
3365
+ "line": 204
3366
+ },
3367
+ "name": "npmignoreEnabled",
3368
+ "optional": true,
3369
+ "type": {
3370
+ "primitive": "boolean"
3371
+ }
3372
+ },
3373
+ {
3374
+ "abstract": true,
3375
+ "docs": {
3376
+ "stability": "experimental",
3377
+ "summary": "Configuration options for .npmignore file."
3378
+ },
3379
+ "immutable": true,
3380
+ "locationInModule": {
3381
+ "filename": "src/TypeScriptComponentOptions.ts",
3382
+ "line": 198
3383
+ },
3384
+ "name": "npmIgnoreOptions",
3385
+ "optional": true,
3386
+ "type": {
3387
+ "fqn": "projen.IgnoreFileOptions"
3388
+ }
3389
+ },
3390
+ {
3391
+ "abstract": true,
3392
+ "docs": {
3393
+ "default": "- true for public packages, false otherwise",
3394
+ "remarks": "A supported package manager is required to publish a package with npm provenance statements and\nyou will need to use a supported CI/CD provider.\n\nNote that the projen `Release` and `Publisher` components are using `publib` to publish packages,\nwhich is using npm internally and supports provenance statements independently of the package manager used.",
3395
+ "stability": "experimental",
3396
+ "summary": "Should provenance statements be generated when the package is published."
3397
+ },
3398
+ "immutable": true,
3399
+ "locationInModule": {
3400
+ "filename": "src/TypeScriptComponentOptions.ts",
3401
+ "line": 556
3402
+ },
3403
+ "name": "npmProvenance",
3404
+ "optional": true,
3405
+ "type": {
3406
+ "primitive": "boolean"
3407
+ }
3408
+ },
3409
+ {
3410
+ "abstract": true,
3411
+ "docs": {
3412
+ "default": "\"https://registry.npmjs.org\"",
3413
+ "remarks": "Must be a URL (e.g. start with \"https://\" or \"http://\")",
3414
+ "stability": "experimental",
3415
+ "summary": "The base URL of the npm package registry."
3416
+ },
3417
+ "immutable": true,
3418
+ "locationInModule": {
3419
+ "filename": "src/TypeScriptComponentOptions.ts",
3420
+ "line": 545
3421
+ },
3422
+ "name": "npmRegistryUrl",
3423
+ "optional": true,
3424
+ "type": {
3425
+ "primitive": "string"
3426
+ }
3427
+ },
3428
+ {
3429
+ "abstract": true,
3430
+ "docs": {
3431
+ "default": "\"NPM_TOKEN\"",
3432
+ "stability": "experimental",
3433
+ "summary": "GitHub secret which contains the NPM token to use when publishing packages."
3434
+ },
3435
+ "immutable": true,
3436
+ "locationInModule": {
3437
+ "filename": "src/TypeScriptComponentOptions.ts",
3438
+ "line": 538
3439
+ },
3440
+ "name": "npmTokenSecret",
3441
+ "optional": true,
3442
+ "type": {
3443
+ "primitive": "string"
3444
+ }
3445
+ },
3446
+ {
3447
+ "abstract": true,
3448
+ "docs": {
3449
+ "default": "\".\"",
3450
+ "remarks": "If this project has a parent, this directory is relative to the parent\ndirectory and it cannot be the same as the parent or any of it's other\nsubprojects.",
3451
+ "stability": "experimental",
3452
+ "summary": "The root directory of the project. Relative to this directory, all files are synthesized."
3453
+ },
3454
+ "immutable": true,
3455
+ "locationInModule": {
3456
+ "filename": "src/TypeScriptComponentOptions.ts",
3457
+ "line": 865
3458
+ },
3459
+ "name": "outdir",
3460
+ "optional": true,
3461
+ "type": {
3462
+ "primitive": "string"
3463
+ }
3464
+ },
3465
+ {
3466
+ "abstract": true,
3467
+ "docs": {
3468
+ "default": "NodePackageManager.YARN_CLASSIC",
3469
+ "stability": "experimental",
3470
+ "summary": "The Node Package Manager used to execute scripts."
3471
+ },
3472
+ "immutable": true,
3473
+ "locationInModule": {
3474
+ "filename": "src/TypeScriptComponentOptions.ts",
3475
+ "line": 532
3476
+ },
3477
+ "name": "packageManager",
3478
+ "optional": true,
3479
+ "type": {
3480
+ "fqn": "projen.javascript.NodePackageManager"
3481
+ }
3482
+ },
3483
+ {
3484
+ "abstract": true,
3485
+ "docs": {
3486
+ "custom": {
3487
+ "featured": "true"
3488
+ },
3489
+ "default": "- defaults to project name",
3490
+ "stability": "experimental",
3491
+ "summary": "The \"name\" in package.json."
3492
+ },
3493
+ "immutable": true,
3494
+ "locationInModule": {
3495
+ "filename": "src/TypeScriptComponentOptions.ts",
3496
+ "line": 526
3497
+ },
3498
+ "name": "packageName",
3499
+ "optional": true,
3500
+ "type": {
3501
+ "primitive": "string"
3502
+ }
3503
+ },
3504
+ {
3505
+ "abstract": true,
3506
+ "docs": {
3507
+ "stability": "experimental",
3508
+ "summary": "The parent project, if this project is part of a bigger project."
3509
+ },
3510
+ "immutable": true,
3511
+ "locationInModule": {
3512
+ "filename": "src/TypeScriptComponentOptions.ts",
3513
+ "line": 854
3514
+ },
3515
+ "name": "parent",
3516
+ "optional": true,
3517
+ "type": {
3518
+ "fqn": "projen.Project"
3519
+ }
3520
+ },
3521
+ {
3522
+ "abstract": true,
3523
+ "docs": {
3524
+ "stability": "experimental",
3525
+ "summary": "Options for `peerDeps`."
3526
+ },
3527
+ "immutable": true,
3528
+ "locationInModule": {
3529
+ "filename": "src/TypeScriptComponentOptions.ts",
3530
+ "line": 519
3531
+ },
3532
+ "name": "peerDependencyOptions",
3533
+ "optional": true,
3534
+ "type": {
3535
+ "fqn": "projen.javascript.PeerDependencyOptions"
3536
+ }
3537
+ },
3538
+ {
3539
+ "abstract": true,
3540
+ "docs": {
3541
+ "default": "[]",
3542
+ "remarks": "Dependencies listed here are required to\nbe installed (and satisfied) by the _consumer_ of this library. Using peer\ndependencies allows you to ensure that only a single module of a certain\nlibrary exists in the `node_modules` tree of your consumers.\n\nNote that prior to npm@7, peer dependencies are _not_ automatically\ninstalled, which means that adding peer dependencies to a library will be a\nbreaking change for your customers.\n\nUnless `peerDependencyOptions.pinnedDevDependency` is disabled (it is\nenabled by default), projen will automatically add a dev dependency with a\npinned version for each peer dependency. This will ensure that you build &\ntest your module against the lowest peer version required.",
3543
+ "stability": "experimental",
3544
+ "summary": "Peer dependencies for this module."
3545
+ },
3546
+ "immutable": true,
3547
+ "locationInModule": {
3548
+ "filename": "src/TypeScriptComponentOptions.ts",
3549
+ "line": 514
3550
+ },
3551
+ "name": "peerDeps",
3552
+ "optional": true,
3553
+ "type": {
3554
+ "collection": {
3555
+ "elementtype": {
3556
+ "primitive": "string"
3557
+ },
3558
+ "kind": "array"
3559
+ }
3560
+ }
3561
+ },
3562
+ {
3563
+ "abstract": true,
3564
+ "docs": {
3565
+ "default": "\"9\"",
3566
+ "stability": "experimental",
3567
+ "summary": "The version of PNPM to use if using PNPM as a package manager."
3568
+ },
3569
+ "immutable": true,
3570
+ "locationInModule": {
3571
+ "filename": "src/TypeScriptComponentOptions.ts",
3572
+ "line": 495
3573
+ },
3574
+ "name": "pnpmVersion",
3575
+ "optional": true,
3576
+ "type": {
3577
+ "primitive": "string"
3578
+ }
3579
+ },
3580
+ {
3581
+ "abstract": true,
3582
+ "docs": {
3583
+ "default": "[]",
3584
+ "stability": "experimental",
3585
+ "summary": "Steps to execute after build as part of the release workflow."
3586
+ },
3587
+ "immutable": true,
3588
+ "locationInModule": {
3589
+ "filename": "src/TypeScriptComponentOptions.ts",
3590
+ "line": 413
3591
+ },
3592
+ "name": "postBuildSteps",
3593
+ "optional": true,
3594
+ "type": {
3595
+ "collection": {
3596
+ "elementtype": {
3597
+ "fqn": "projen.github.workflows.JobStep"
3598
+ },
3599
+ "kind": "array"
3600
+ }
3601
+ }
3602
+ },
3603
+ {
3604
+ "abstract": true,
3605
+ "docs": {
3606
+ "default": "- normal semantic versions",
3607
+ "stability": "experimental",
3608
+ "summary": "Bump versions from the default branch as pre-releases (e.g. \"beta\", \"alpha\", \"pre\")."
3609
+ },
3610
+ "immutable": true,
3611
+ "locationInModule": {
3612
+ "filename": "src/TypeScriptComponentOptions.ts",
3613
+ "line": 407
3614
+ },
3615
+ "name": "prerelease",
3616
+ "optional": true,
3617
+ "type": {
3618
+ "primitive": "string"
3619
+ }
3620
+ },
3621
+ {
3622
+ "abstract": true,
3623
+ "docs": {
3624
+ "default": "false",
3625
+ "stability": "experimental",
3626
+ "summary": "Setup prettier."
3627
+ },
3628
+ "immutable": true,
3629
+ "locationInModule": {
3630
+ "filename": "src/TypeScriptComponentOptions.ts",
3631
+ "line": 193
3632
+ },
3633
+ "name": "prettier",
3634
+ "optional": true,
3635
+ "type": {
3636
+ "primitive": "boolean"
3637
+ }
3638
+ },
3639
+ {
3640
+ "abstract": true,
3641
+ "docs": {
3642
+ "default": "- default options",
3643
+ "stability": "experimental",
3644
+ "summary": "Prettier options."
3645
+ },
3646
+ "immutable": true,
3647
+ "locationInModule": {
3648
+ "filename": "src/TypeScriptComponentOptions.ts",
3649
+ "line": 187
3650
+ },
3651
+ "name": "prettierOptions",
3652
+ "optional": true,
3653
+ "type": {
3654
+ "fqn": "projen.javascript.PrettierOptions"
3655
+ }
3656
+ },
3657
+ {
3658
+ "abstract": true,
3659
+ "docs": {
3660
+ "default": "\"npx projen\"",
3661
+ "remarks": "Can be used to customize in special environments.",
3662
+ "stability": "experimental",
3663
+ "summary": "The shell command to use in order to run the projen CLI."
3664
+ },
3665
+ "immutable": true,
3666
+ "locationInModule": {
3667
+ "filename": "src/TypeScriptComponentOptions.ts",
3668
+ "line": 849
3669
+ },
3670
+ "name": "projenCommand",
3671
+ "optional": true,
3672
+ "type": {
3673
+ "primitive": "string"
3674
+ }
3675
+ },
3676
+ {
3677
+ "abstract": true,
3678
+ "docs": {
3679
+ "default": "- use a personal access token named PROJEN_GITHUB_TOKEN",
3680
+ "stability": "experimental",
3681
+ "summary": "Choose a method of providing GitHub API access for projen workflows."
3682
+ },
3683
+ "immutable": true,
3684
+ "locationInModule": {
3685
+ "filename": "src/TypeScriptComponentOptions.ts",
3686
+ "line": 772
3687
+ },
3688
+ "name": "projenCredentials",
3689
+ "optional": true,
3690
+ "type": {
3691
+ "fqn": "projen.github.GithubCredentials"
3692
+ }
3693
+ },
3694
+ {
3695
+ "abstract": true,
3696
+ "docs": {
3697
+ "default": "- true if not a subproject",
3698
+ "stability": "experimental",
3699
+ "summary": "Indicates of \"projen\" should be installed as a devDependency."
3700
+ },
3701
+ "immutable": true,
3702
+ "locationInModule": {
3703
+ "filename": "src/TypeScriptComponentOptions.ts",
3704
+ "line": 181
3705
+ },
3706
+ "name": "projenDevDependency",
3707
+ "optional": true,
3708
+ "type": {
3709
+ "primitive": "boolean"
3710
+ }
3711
+ },
3712
+ {
3713
+ "abstract": true,
3714
+ "docs": {
3715
+ "default": "- true if projenrcJson is false",
3716
+ "stability": "experimental",
3717
+ "summary": "Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation."
3718
+ },
3719
+ "immutable": true,
3720
+ "locationInModule": {
3721
+ "filename": "src/TypeScriptComponentOptions.ts",
3722
+ "line": 175
3723
+ },
3724
+ "name": "projenrcJs",
3725
+ "optional": true,
3726
+ "type": {
3727
+ "primitive": "boolean"
3728
+ }
3729
+ },
3730
+ {
3731
+ "abstract": true,
3732
+ "docs": {
3733
+ "default": "false",
3734
+ "stability": "experimental",
3735
+ "summary": "Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation."
3736
+ },
3737
+ "immutable": true,
3738
+ "locationInModule": {
3739
+ "filename": "src/TypeScriptComponentOptions.ts",
3740
+ "line": 842
3741
+ },
3742
+ "name": "projenrcJson",
3743
+ "optional": true,
3744
+ "type": {
3745
+ "primitive": "boolean"
3746
+ }
3747
+ },
3748
+ {
3749
+ "abstract": true,
3750
+ "docs": {
3751
+ "default": "- default options",
3752
+ "stability": "experimental",
3753
+ "summary": "Options for .projenrc.json."
3754
+ },
3755
+ "immutable": true,
3756
+ "locationInModule": {
3757
+ "filename": "src/TypeScriptComponentOptions.ts",
3758
+ "line": 836
3759
+ },
3760
+ "name": "projenrcJsonOptions",
3761
+ "optional": true,
3762
+ "type": {
3763
+ "fqn": "projen.ProjenrcJsonOptions"
3764
+ }
3765
+ },
3766
+ {
3767
+ "abstract": true,
3768
+ "docs": {
3769
+ "default": "- default options",
3770
+ "stability": "experimental",
3771
+ "summary": "Options for .projenrc.js."
3772
+ },
3773
+ "immutable": true,
3774
+ "locationInModule": {
3775
+ "filename": "src/TypeScriptComponentOptions.ts",
3776
+ "line": 169
3777
+ },
3778
+ "name": "projenrcJsOptions",
3779
+ "optional": true,
3780
+ "type": {
3781
+ "fqn": "projen.javascript.ProjenrcOptions"
3782
+ }
3783
+ },
3784
+ {
3785
+ "abstract": true,
3786
+ "docs": {
3787
+ "custom": {
3788
+ "pjnew": "true"
3789
+ },
3790
+ "default": "false",
3791
+ "stability": "experimental",
3792
+ "summary": "Use TypeScript for your projenrc file (`.projenrc.ts`)."
3793
+ },
3794
+ "immutable": true,
3795
+ "locationInModule": {
3796
+ "filename": "src/TypeScriptComponentOptions.ts",
3797
+ "line": 72
3798
+ },
3799
+ "name": "projenrcTs",
3800
+ "optional": true,
3801
+ "type": {
3802
+ "primitive": "boolean"
3803
+ }
3804
+ },
3805
+ {
3806
+ "abstract": true,
3807
+ "docs": {
3808
+ "stability": "experimental",
3809
+ "summary": "Options for .projenrc.ts."
3810
+ },
3811
+ "immutable": true,
3812
+ "locationInModule": {
3813
+ "filename": "src/TypeScriptComponentOptions.ts",
3814
+ "line": 65
3815
+ },
3816
+ "name": "projenrcTsOptions",
3817
+ "optional": true,
3818
+ "type": {
3819
+ "fqn": "projen.typescript.ProjenrcOptions"
3820
+ }
3821
+ },
3822
+ {
3823
+ "abstract": true,
3824
+ "docs": {
3825
+ "default": "- Defaults to the latest version.",
3826
+ "stability": "experimental",
3827
+ "summary": "Version of projen to install."
3828
+ },
3829
+ "immutable": true,
3830
+ "locationInModule": {
3831
+ "filename": "src/TypeScriptComponentOptions.ts",
3832
+ "line": 163
3833
+ },
3834
+ "name": "projenVersion",
3835
+ "optional": true,
3836
+ "type": {
3837
+ "primitive": "string"
3838
+ }
3839
+ },
3840
+ {
3841
+ "abstract": true,
3842
+ "docs": {
3843
+ "default": "false",
3844
+ "stability": "experimental",
3845
+ "summary": "Instead of actually publishing to package managers, just print the publishing command."
3846
+ },
3847
+ "immutable": true,
3848
+ "locationInModule": {
3849
+ "filename": "src/TypeScriptComponentOptions.ts",
3850
+ "line": 401
3851
+ },
3852
+ "name": "publishDryRun",
3853
+ "optional": true,
3854
+ "type": {
3855
+ "primitive": "boolean"
3856
+ }
3857
+ },
3858
+ {
3859
+ "abstract": true,
3860
+ "docs": {
3861
+ "default": "false",
3862
+ "remarks": "Normally, publishing only happens within automated workflows. Enable this\nin order to create a publishing task for each publishing activity.",
3863
+ "stability": "experimental",
3864
+ "summary": "Define publishing tasks that can be executed manually as well as workflows."
3865
+ },
3866
+ "immutable": true,
3867
+ "locationInModule": {
3868
+ "filename": "src/TypeScriptComponentOptions.ts",
3869
+ "line": 395
3870
+ },
3871
+ "name": "publishTasks",
3872
+ "optional": true,
3873
+ "type": {
3874
+ "primitive": "boolean"
3875
+ }
3876
+ },
3877
+ {
3878
+ "abstract": true,
3879
+ "docs": {
3880
+ "default": "true",
3881
+ "stability": "experimental",
3882
+ "summary": "Include a GitHub pull request template."
3883
+ },
3884
+ "immutable": true,
3885
+ "locationInModule": {
3886
+ "filename": "src/TypeScriptComponentOptions.ts",
3887
+ "line": 157
3888
+ },
3889
+ "name": "pullRequestTemplate",
3890
+ "optional": true,
3891
+ "type": {
3892
+ "primitive": "boolean"
3893
+ }
3894
+ },
3895
+ {
3896
+ "abstract": true,
3897
+ "docs": {
3898
+ "default": "- default content",
3899
+ "stability": "experimental",
3900
+ "summary": "The contents of the pull request template."
3901
+ },
3902
+ "immutable": true,
3903
+ "locationInModule": {
3904
+ "filename": "src/TypeScriptComponentOptions.ts",
3905
+ "line": 151
3906
+ },
3907
+ "name": "pullRequestTemplateContents",
3908
+ "optional": true,
3909
+ "type": {
3910
+ "collection": {
3911
+ "elementtype": {
3912
+ "primitive": "string"
3913
+ },
3914
+ "kind": "array"
3915
+ }
3916
+ }
3917
+ },
3918
+ {
3919
+ "abstract": true,
3920
+ "docs": {
3921
+ "default": "- { filename: 'README.md', contents: '# replace this' }",
3922
+ "stability": "experimental",
3923
+ "summary": "The README setup."
3924
+ },
3925
+ "immutable": true,
3926
+ "locationInModule": {
3927
+ "filename": "src/TypeScriptComponentOptions.ts",
3928
+ "line": 766
3929
+ },
3930
+ "name": "readme",
3931
+ "optional": true,
3932
+ "type": {
3933
+ "fqn": "projen.SampleReadmeProps"
3934
+ }
3935
+ },
3936
+ {
3937
+ "abstract": true,
3938
+ "docs": {
3939
+ "default": "ReleasableCommits.everyCommit()",
3940
+ "stability": "experimental",
3941
+ "summary": "Find commits that should be considered releasable Used to decide if a release is required."
3942
+ },
3943
+ "immutable": true,
3944
+ "locationInModule": {
3945
+ "filename": "src/TypeScriptComponentOptions.ts",
3946
+ "line": 387
3947
+ },
3948
+ "name": "releasableCommits",
3949
+ "optional": true,
3950
+ "type": {
3951
+ "fqn": "projen.ReleasableCommits"
3952
+ }
3953
+ },
3954
+ {
3955
+ "abstract": true,
3956
+ "docs": {
3957
+ "default": "false",
3958
+ "stability": "experimental",
3959
+ "summary": "Create a github issue on every failed publishing task."
3960
+ },
3961
+ "immutable": true,
3962
+ "locationInModule": {
3963
+ "filename": "src/TypeScriptComponentOptions.ts",
3964
+ "line": 381
3965
+ },
3966
+ "name": "releaseFailureIssue",
3967
+ "optional": true,
3968
+ "type": {
3969
+ "primitive": "boolean"
3970
+ }
3971
+ },
3972
+ {
3973
+ "abstract": true,
3974
+ "docs": {
3975
+ "default": "\"failed-release\"",
3976
+ "remarks": "Only applies if `releaseFailureIssue` is true.",
3977
+ "stability": "experimental",
3978
+ "summary": "The label to apply to issues indicating publish failures."
3979
+ },
3980
+ "immutable": true,
3981
+ "locationInModule": {
3982
+ "filename": "src/TypeScriptComponentOptions.ts",
3983
+ "line": 375
3984
+ },
3985
+ "name": "releaseFailureIssueLabel",
3986
+ "optional": true,
3987
+ "type": {
3988
+ "primitive": "string"
3989
+ }
3990
+ },
3991
+ {
3992
+ "abstract": true,
3993
+ "docs": {
3994
+ "default": "\"v\"",
3995
+ "remarks": "Useful if you are releasing on multiple branches with overlapping version numbers.\nNote: this prefix is used to detect the latest tagged version\nwhen bumping, so if you change this on a project with an existing version\nhistory, you may need to manually tag your latest release\nwith the new prefix.",
3996
+ "stability": "experimental",
3997
+ "summary": "Automatically add the given prefix to release tags."
3998
+ },
3999
+ "immutable": true,
4000
+ "locationInModule": {
4001
+ "filename": "src/TypeScriptComponentOptions.ts",
4002
+ "line": 368
4003
+ },
4004
+ "name": "releaseTagPrefix",
4005
+ "optional": true,
4006
+ "type": {
4007
+ "primitive": "string"
4008
+ }
4009
+ },
4010
+ {
4011
+ "abstract": true,
4012
+ "docs": {
4013
+ "default": "- Continuous releases (`ReleaseTrigger.continuous()`)",
4014
+ "stability": "experimental",
4015
+ "summary": "The release trigger to use."
4016
+ },
4017
+ "immutable": true,
4018
+ "locationInModule": {
4019
+ "filename": "src/TypeScriptComponentOptions.ts",
4020
+ "line": 358
4021
+ },
4022
+ "name": "releaseTrigger",
4023
+ "optional": true,
4024
+ "type": {
4025
+ "fqn": "projen.release.ReleaseTrigger"
4026
+ }
4027
+ },
4028
+ {
4029
+ "abstract": true,
4030
+ "docs": {
4031
+ "default": "\"release\"",
4032
+ "stability": "experimental",
4033
+ "summary": "The name of the default release workflow."
4034
+ },
4035
+ "immutable": true,
4036
+ "locationInModule": {
4037
+ "filename": "src/TypeScriptComponentOptions.ts",
4038
+ "line": 352
4039
+ },
4040
+ "name": "releaseWorkflowName",
4041
+ "optional": true,
4042
+ "type": {
4043
+ "primitive": "string"
4044
+ }
4045
+ },
4046
+ {
4047
+ "abstract": true,
4048
+ "docs": {
4049
+ "stability": "experimental",
4050
+ "summary": "A set of workflow steps to execute in order to setup the workflow container."
4051
+ },
4052
+ "immutable": true,
4053
+ "locationInModule": {
4054
+ "filename": "src/TypeScriptComponentOptions.ts",
4055
+ "line": 346
4056
+ },
4057
+ "name": "releaseWorkflowSetupSteps",
4058
+ "optional": true,
4059
+ "type": {
4060
+ "collection": {
4061
+ "elementtype": {
4062
+ "fqn": "projen.github.workflows.JobStep"
4063
+ },
4064
+ "kind": "array"
4065
+ }
4066
+ }
4067
+ },
4068
+ {
4069
+ "abstract": true,
4070
+ "docs": {
4071
+ "default": "false",
4072
+ "stability": "experimental",
4073
+ "summary": "Use renovatebot to handle dependency upgrades."
4074
+ },
4075
+ "immutable": true,
4076
+ "locationInModule": {
4077
+ "filename": "src/TypeScriptComponentOptions.ts",
4078
+ "line": 830
4079
+ },
4080
+ "name": "renovatebot",
4081
+ "optional": true,
4082
+ "type": {
4083
+ "primitive": "boolean"
4084
+ }
4085
+ },
4086
+ {
4087
+ "abstract": true,
4088
+ "docs": {
4089
+ "default": "- default options",
4090
+ "stability": "experimental",
4091
+ "summary": "Options for renovatebot."
4092
+ },
4093
+ "immutable": true,
4094
+ "locationInModule": {
4095
+ "filename": "src/TypeScriptComponentOptions.ts",
4096
+ "line": 824
4097
+ },
4098
+ "name": "renovatebotOptions",
4099
+ "optional": true,
4100
+ "type": {
4101
+ "fqn": "projen.RenovatebotOptions"
4102
+ }
4103
+ },
4104
+ {
4105
+ "abstract": true,
4106
+ "docs": {
4107
+ "remarks": "See https://classic.yarnpkg.com/en/docs/package-json/#toc-repository",
4108
+ "stability": "experimental",
4109
+ "summary": "The repository is the location where the actual code for your package lives."
4110
+ },
4111
+ "immutable": true,
4112
+ "locationInModule": {
4113
+ "filename": "src/TypeScriptComponentOptions.ts",
4114
+ "line": 489
4115
+ },
4116
+ "name": "repository",
4117
+ "optional": true,
4118
+ "type": {
4119
+ "primitive": "string"
4120
+ }
4121
+ },
4122
+ {
4123
+ "abstract": true,
4124
+ "docs": {
4125
+ "stability": "experimental",
4126
+ "summary": "If the package.json for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives."
4127
+ },
4128
+ "immutable": true,
4129
+ "locationInModule": {
4130
+ "filename": "src/TypeScriptComponentOptions.ts",
4131
+ "line": 483
4132
+ },
4133
+ "name": "repositoryDirectory",
4134
+ "optional": true,
4135
+ "type": {
4136
+ "primitive": "string"
4137
+ }
4138
+ },
4139
+ {
4140
+ "abstract": true,
4141
+ "docs": {
4142
+ "default": "true",
4143
+ "stability": "experimental",
4144
+ "summary": "Generate one-time sample in `src/` and `test/` if there are no files there."
4145
+ },
4146
+ "immutable": true,
4147
+ "locationInModule": {
4148
+ "filename": "src/TypeScriptComponentOptions.ts",
4149
+ "line": 60
4150
+ },
4151
+ "name": "sampleCode",
4152
+ "optional": true,
4153
+ "type": {
4154
+ "primitive": "boolean"
4155
+ }
4156
+ },
4157
+ {
4158
+ "abstract": true,
4159
+ "docs": {
4160
+ "default": "- fetch all scoped packages from the public npm registry",
4161
+ "stability": "experimental",
4162
+ "summary": "Options for privately hosted scoped packages."
4163
+ },
4164
+ "immutable": true,
4165
+ "locationInModule": {
4166
+ "filename": "src/TypeScriptComponentOptions.ts",
4167
+ "line": 478
4168
+ },
4169
+ "name": "scopedPackagesOptions",
4170
+ "optional": true,
4171
+ "type": {
4172
+ "collection": {
4173
+ "elementtype": {
4174
+ "fqn": "projen.javascript.ScopedPackagesOptions"
4175
+ },
4176
+ "kind": "array"
4177
+ }
4178
+ }
4179
+ },
4180
+ {
4181
+ "abstract": true,
4182
+ "docs": {
4183
+ "default": "\"src\"",
4184
+ "stability": "experimental",
4185
+ "summary": "Typescript sources directory."
4186
+ },
4187
+ "immutable": true,
4188
+ "locationInModule": {
4189
+ "filename": "src/TypeScriptComponentOptions.ts",
4190
+ "line": 54
4191
+ },
4192
+ "name": "srcdir",
4193
+ "optional": true,
4194
+ "type": {
4195
+ "primitive": "string"
4196
+ }
4197
+ },
4198
+ {
4199
+ "abstract": true,
4200
+ "docs": {
4201
+ "stability": "experimental",
4202
+ "summary": "Package's Stability."
4203
+ },
4204
+ "immutable": true,
4205
+ "locationInModule": {
4206
+ "filename": "src/TypeScriptComponentOptions.ts",
4207
+ "line": 472
4208
+ },
4209
+ "name": "stability",
4210
+ "optional": true,
4211
+ "type": {
4212
+ "primitive": "string"
4213
+ }
4214
+ },
4215
+ {
4216
+ "abstract": true,
4217
+ "docs": {
4218
+ "default": "false",
4219
+ "remarks": "See `staleOptions` for options.",
4220
+ "stability": "experimental",
4221
+ "summary": "Auto-close of stale issues and pull request."
4222
+ },
4223
+ "immutable": true,
4224
+ "locationInModule": {
4225
+ "filename": "src/TypeScriptComponentOptions.ts",
4226
+ "line": 760
4227
+ },
4228
+ "name": "stale",
4229
+ "optional": true,
4230
+ "type": {
4231
+ "primitive": "boolean"
4232
+ }
4233
+ },
4234
+ {
4235
+ "abstract": true,
4236
+ "docs": {
4237
+ "default": "- see defaults in `StaleOptions`",
4238
+ "remarks": "To disable set `stale` to `false`.",
4239
+ "stability": "experimental",
4240
+ "summary": "Auto-close stale issues and pull requests."
4241
+ },
4242
+ "immutable": true,
4243
+ "locationInModule": {
4244
+ "filename": "src/TypeScriptComponentOptions.ts",
4245
+ "line": 753
4246
+ },
4247
+ "name": "staleOptions",
4248
+ "optional": true,
4249
+ "type": {
4250
+ "fqn": "projen.github.StaleOptions"
4251
+ }
4252
+ },
4253
+ {
4254
+ "abstract": true,
4255
+ "docs": {
4256
+ "default": "\"test\"",
4257
+ "remarks": "Tests files should be named `xxx.test.ts`.\nIf this directory is under `srcdir` (e.g. `src/test`, `src/__tests__`),\nthen tests are going to be compiled into `lib/` and executed as javascript.\nIf the test directory is outside of `src`, then we configure jest to\ncompile the code in-memory.",
4258
+ "stability": "experimental",
4259
+ "summary": "Jest tests directory."
4260
+ },
4261
+ "immutable": true,
4262
+ "locationInModule": {
4263
+ "filename": "src/TypeScriptComponentOptions.ts",
4264
+ "line": 48
4265
+ },
4266
+ "name": "testdir",
4267
+ "optional": true,
4268
+ "type": {
4269
+ "primitive": "string"
4270
+ }
4271
+ },
4272
+ {
4273
+ "abstract": true,
4274
+ "docs": {
4275
+ "default": "- default options",
4276
+ "stability": "experimental",
4277
+ "summary": "Custom TSConfig."
4278
+ },
4279
+ "immutable": true,
4280
+ "locationInModule": {
4281
+ "filename": "src/TypeScriptComponentOptions.ts",
4282
+ "line": 38
4283
+ },
4284
+ "name": "tsconfig",
4285
+ "optional": true,
4286
+ "type": {
4287
+ "fqn": "projen.javascript.TypescriptConfigOptions"
4288
+ }
4289
+ },
4290
+ {
4291
+ "abstract": true,
4292
+ "docs": {
4293
+ "default": "- use the production tsconfig options",
4294
+ "stability": "experimental",
4295
+ "summary": "Custom tsconfig options for the development tsconfig.json file (used for testing)."
4296
+ },
4297
+ "immutable": true,
4298
+ "locationInModule": {
4299
+ "filename": "src/TypeScriptComponentOptions.ts",
4300
+ "line": 32
4301
+ },
4302
+ "name": "tsconfigDev",
4303
+ "optional": true,
4304
+ "type": {
4305
+ "fqn": "projen.javascript.TypescriptConfigOptions"
4306
+ }
4307
+ },
4308
+ {
4309
+ "abstract": true,
4310
+ "docs": {
4311
+ "default": "\"tsconfig.dev.json\"",
4312
+ "stability": "experimental",
4313
+ "summary": "The name of the development tsconfig.json file."
4314
+ },
4315
+ "immutable": true,
4316
+ "locationInModule": {
4317
+ "filename": "src/TypeScriptComponentOptions.ts",
4318
+ "line": 26
4319
+ },
4320
+ "name": "tsconfigDevFile",
4321
+ "optional": true,
4322
+ "type": {
4323
+ "primitive": "string"
4324
+ }
4325
+ },
4326
+ {
4327
+ "abstract": true,
4328
+ "docs": {
4329
+ "stability": "experimental",
4330
+ "summary": "Options for ts-jest."
4331
+ },
4332
+ "immutable": true,
4333
+ "locationInModule": {
4334
+ "filename": "src/TypeScriptComponentOptions.ts",
4335
+ "line": 20
4336
+ },
4337
+ "name": "tsJestOptions",
4338
+ "optional": true,
4339
+ "type": {
4340
+ "fqn": "projen.typescript.TsJestOptions"
4341
+ }
4342
+ },
4343
+ {
4344
+ "abstract": true,
4345
+ "docs": {
4346
+ "default": "\"latest\"",
4347
+ "remarks": "NOTE: Typescript is not semantically versioned and should remain on the\nsame minor, so we recommend using a `~` dependency (e.g. `~1.2.3`).",
4348
+ "stability": "experimental",
4349
+ "summary": "TypeScript version to use."
4350
+ },
4351
+ "immutable": true,
4352
+ "locationInModule": {
4353
+ "filename": "src/TypeScriptComponentOptions.ts",
4354
+ "line": 15
4355
+ },
4356
+ "name": "typescriptVersion",
4357
+ "optional": true,
4358
+ "type": {
4359
+ "primitive": "string"
4360
+ }
4361
+ },
4362
+ {
4363
+ "abstract": true,
4364
+ "docs": {
4365
+ "default": "- standard configuration applicable for GitHub repositories",
4366
+ "remarks": "Given values either append to default configuration or overwrite values in it.",
4367
+ "stability": "experimental",
4368
+ "summary": "Custom configuration used when creating changelog with commit-and-tag-version package."
4369
+ },
4370
+ "immutable": true,
4371
+ "locationInModule": {
4372
+ "filename": "src/TypeScriptComponentOptions.ts",
4373
+ "line": 341
4374
+ },
4375
+ "name": "versionrcOptions",
4376
+ "optional": true,
4377
+ "type": {
4378
+ "collection": {
4379
+ "elementtype": {
4380
+ "primitive": "any"
4381
+ },
4382
+ "kind": "map"
4383
+ }
4384
+ }
4385
+ },
4386
+ {
4387
+ "abstract": true,
4388
+ "docs": {
4389
+ "default": "true",
4390
+ "remarks": "Enabled by default for root projects. Disabled for non-root projects.",
4391
+ "stability": "experimental",
4392
+ "summary": "Enable VSCode integration."
4393
+ },
4394
+ "immutable": true,
4395
+ "locationInModule": {
4396
+ "filename": "src/TypeScriptComponentOptions.ts",
4397
+ "line": 746
4398
+ },
4399
+ "name": "vscode",
4400
+ "optional": true,
4401
+ "type": {
4402
+ "primitive": "boolean"
4403
+ }
4404
+ },
4405
+ {
4406
+ "abstract": true,
4407
+ "docs": {
4408
+ "default": "\"yarn install --frozen-lockfile && yarn projen\"",
4409
+ "stability": "experimental",
4410
+ "summary": "Workflow steps to use in order to bootstrap this repo."
4411
+ },
4412
+ "immutable": true,
4413
+ "locationInModule": {
4414
+ "filename": "src/TypeScriptComponentOptions.ts",
4415
+ "line": 145
4416
+ },
4417
+ "name": "workflowBootstrapSteps",
4418
+ "optional": true,
4419
+ "type": {
4420
+ "collection": {
4421
+ "elementtype": {
4422
+ "fqn": "projen.github.workflows.JobStep"
4423
+ },
4424
+ "kind": "array"
4425
+ }
4426
+ }
4427
+ },
4428
+ {
4429
+ "abstract": true,
4430
+ "docs": {
4431
+ "default": "- default image",
4432
+ "stability": "experimental",
4433
+ "summary": "Container image to use for GitHub workflows."
4434
+ },
4435
+ "immutable": true,
4436
+ "locationInModule": {
4437
+ "filename": "src/TypeScriptComponentOptions.ts",
4438
+ "line": 334
4439
+ },
4440
+ "name": "workflowContainerImage",
4441
+ "optional": true,
4442
+ "type": {
4443
+ "primitive": "string"
4444
+ }
4445
+ },
4446
+ {
4447
+ "abstract": true,
4448
+ "docs": {
4449
+ "default": "- GitHub Actions",
4450
+ "stability": "experimental",
4451
+ "summary": "The git identity to use in workflows."
4452
+ },
4453
+ "immutable": true,
4454
+ "locationInModule": {
4455
+ "filename": "src/TypeScriptComponentOptions.ts",
4456
+ "line": 139
4457
+ },
4458
+ "name": "workflowGitIdentity",
4459
+ "optional": true,
4460
+ "type": {
4461
+ "fqn": "projen.github.GitIdentity"
4462
+ }
4463
+ },
4464
+ {
4465
+ "abstract": true,
4466
+ "docs": {
4467
+ "default": "- `minNodeVersion` if set, otherwise `lts/*`.",
4468
+ "remarks": "Always use this option if your GitHub Actions workflows require a specific to run.",
4469
+ "stability": "experimental",
4470
+ "summary": "The node version used in GitHub Actions workflows."
4471
+ },
4472
+ "immutable": true,
4473
+ "locationInModule": {
4474
+ "filename": "src/TypeScriptComponentOptions.ts",
4475
+ "line": 133
4476
+ },
4477
+ "name": "workflowNodeVersion",
4478
+ "optional": true,
4479
+ "type": {
4480
+ "primitive": "string"
4481
+ }
4482
+ },
4483
+ {
4484
+ "abstract": true,
4485
+ "docs": {
4486
+ "default": "false",
4487
+ "stability": "experimental",
4488
+ "summary": "Enable Node.js package cache in GitHub workflows."
4489
+ },
4490
+ "immutable": true,
4491
+ "locationInModule": {
4492
+ "filename": "src/TypeScriptComponentOptions.ts",
4493
+ "line": 126
4494
+ },
4495
+ "name": "workflowPackageCache",
4496
+ "optional": true,
4497
+ "type": {
4498
+ "primitive": "boolean"
4499
+ }
4500
+ },
4501
+ {
4502
+ "abstract": true,
4503
+ "docs": {
4504
+ "custom": {
4505
+ "description": "Defines a target Runner by labels",
4506
+ "throws": "{Error} if both `runsOn` and `runsOnGroup` are specified"
4507
+ },
4508
+ "default": "[\"ubuntu-latest\"]",
4509
+ "stability": "experimental",
4510
+ "summary": "Github Runner selection labels."
4511
+ },
4512
+ "immutable": true,
4513
+ "locationInModule": {
4514
+ "filename": "src/TypeScriptComponentOptions.ts",
4515
+ "line": 328
4516
+ },
4517
+ "name": "workflowRunsOn",
4518
+ "optional": true,
4519
+ "type": {
4520
+ "collection": {
4521
+ "elementtype": {
4522
+ "primitive": "string"
4523
+ },
4524
+ "kind": "array"
4525
+ }
4526
+ }
4527
+ },
4528
+ {
4529
+ "abstract": true,
4530
+ "docs": {
4531
+ "custom": {
4532
+ "description": "Defines a target Runner Group by name and/or labels",
4533
+ "throws": "{Error} if both `runsOn` and `runsOnGroup` are specified"
4534
+ },
4535
+ "stability": "experimental",
4536
+ "summary": "Github Runner Group selection options."
4537
+ },
4538
+ "immutable": true,
4539
+ "locationInModule": {
4540
+ "filename": "src/TypeScriptComponentOptions.ts",
4541
+ "line": 320
4542
+ },
4543
+ "name": "workflowRunsOnGroup",
4544
+ "optional": true,
4545
+ "type": {
4546
+ "fqn": "projen.GroupRunnerOptions"
4547
+ }
4548
+ },
4549
+ {
4550
+ "abstract": true,
4551
+ "docs": {
4552
+ "default": "- Yarn Berry v4 with all default options",
4553
+ "stability": "experimental",
4554
+ "summary": "Options for Yarn Berry."
4555
+ },
4556
+ "immutable": true,
4557
+ "locationInModule": {
4558
+ "filename": "src/TypeScriptComponentOptions.ts",
4559
+ "line": 467
4560
+ },
4561
+ "name": "yarnBerryOptions",
4562
+ "optional": true,
4563
+ "type": {
4564
+ "fqn": "projen.javascript.YarnBerryOptions"
4565
+ }
4566
+ }
4567
+ ],
4568
+ "symbolId": "src/TypeScriptComponentOptions:TypeScriptComponentOptions"
4569
+ },
4570
+ "@hallcor/pulumi-projen-project-types.TypeScriptProject": {
4571
+ "assembly": "@hallcor/pulumi-projen-project-types",
4572
+ "base": "projen.typescript.TypeScriptProject",
4573
+ "docs": {
4574
+ "stability": "stable"
4575
+ },
4576
+ "fqn": "@hallcor/pulumi-projen-project-types.TypeScriptProject",
4577
+ "initializer": {
4578
+ "docs": {
4579
+ "stability": "stable"
4580
+ },
4581
+ "locationInModule": {
4582
+ "filename": "src/typescript-base.ts",
4583
+ "line": 9
4584
+ },
4585
+ "parameters": [
4586
+ {
4587
+ "name": "options",
4588
+ "type": {
4589
+ "fqn": "projen.typescript.TypeScriptProjectOptions"
4590
+ }
4591
+ }
4592
+ ]
4593
+ },
4594
+ "kind": "class",
4595
+ "locationInModule": {
4596
+ "filename": "src/typescript-base.ts",
4597
+ "line": 8
2087
4598
  },
2088
4599
  "name": "TypeScriptProject",
2089
4600
  "symbolId": "src/typescript-base:TypeScriptProject"
2090
4601
  }
2091
4602
  },
2092
- "version": "0.0.16",
2093
- "fingerprint": "mID7bLCYIZV+S/jITrd19SbKFJrq3NpRZzUl+A0ck4s="
4603
+ "version": "0.0.18",
4604
+ "fingerprint": "PwYkeZFypNGT+ATeARDYqvZ8VOQyfyE/tAKsbr8CiCM="
2094
4605
  }