projen 0.76.5 → 0.76.7

package/docs/typescript.md

@@ -1,119 +0,0 @@
-# TypeScript Projects
-
-To create a new TypeScript project, use `projen new typescript`:
-
-```shell
-npx projen new typescript
-```
-
-This will create a `.projenrc.js` file which defines your project. If you
-instead would like to define your project in TypeScript, use the
-`--projenrc-ts` flag to create a `.projenrc.ts` file:
-
-```shell
-npx projen new typescript --projenrc-ts
-```
-
-`projen new` will synthesize a standard project directory structure with some sample
-code.
-
-```shell
-├── src
-│   ├── index.ts
-├── test
-│   ├── hello.test.ts
-├── node_modules
-├── package.json
-└── tsconfig.json
-```
-
-The default options will set up your `tsconfig` root directory as `src` and your
-out directory as `lib`. By default the `test` directory is not compiled to
-JavaScript and instead compiled when `npx projen test` is executed.
-
-The `projen new` command will also generate a `.projenrc.js` file which includes
-the definition of your project with any options you specified in the command
-line:
-
-```js
-const { typescript } = require('projen');
-const project = new typescript.TypeScriptProject({
-  defaultReleaseBranch: 'main',
-  name: 'my-project',
-});
-project.synth();
-```
-
-To modify your project definitions, edit `.projenrc.js` and run `projen` again
-to re-synthesize your project. The following sections describe the various
-features of your TypeScript project.
-
-## Dependencies
-
-You can specify dependencies in your project via the `deps`, `devDeps`, and
-`peerDeps` options similar to what you might expect in a `package.json` file.
-
-The recommendation is to only specify the module name here (e.g. `express`).
-This will behave similar to yarn add or npm install in the sense that it will
-add the module as a dependency to your package.json file with the latest version
-(`^`). You can specify semver requirements in the same syntax passed to npm i or
-yarn add (e.g. `express@^2`) and this will be what your `package.json` will
-eventually include.
-
-## Migrating your TypeScript Project to Projen
-
-Projen provides some opinionated defaults that may be different than the defaults
-you rely on in your existing TypeScript Project. This section attempts to document
-some of the common themes to look out for when migrating an existing TypeScript
-project to Projen.
-
-## Migrating .projenrc.js to .projenrc.ts
-
-If you'd like to upgrade an existing project that was creating using a JS-based 
-projen RC file (.projenrc.js) to a TS-based projen RC file (.projenrc.ts):
-
-1. Add `projenrcTs: true` to your project.
-2. Run `npx projen`.
-3. Rename `.projenrc.js` to `.projenrc.ts`.
-4. Update `require`s to `import`s.
-5. Run `npx projen`.
-
-### Default Directory Structure
-
-The most important is the default project structure. Projen expects all source code
-to be in the `src` directory and will write compiled `.js` and `.d.ts` files to the
-`lib` directory. Test files are expected in the `test` directory and not compiled
-to javascript. Instead, Projen configures `Jest` to compile `.ts` files when testing.
-
-As this is only one of many structures for valid TypeScript projects, your migrated
-project may not work out-of-the-box with Projen. We recommend that you take the
-time to fully migrate to the expected project structure so that you can take full
-advantage of Projen management on your repository.
-
-However, you can also configure your `.projenrc.js` file to reflect your current
-project structure. A `TypeScriptProject` exposes all options in a `tsConfig` file
-so you can manually set the structure you want. Here is an example for specifying a
-structure where the TypeScript compiler finds all TypeScript files recursively in your
-repository:
-
-```js
-const { typescript } = require('projen');
-const project = new typescript.TypeScriptProject({
-  ...
-  tsConfig: {
-    compilerOptions: {
-      rootDir: '.',
-      outDir: '.',
-    },
-    include: ['**/*.ts'], // all typescript files recursively
-  },
-});
-```
-
-### Dependency Versions
-
-As described in the section above, Projen recommends that you list your dependencies
-only by module name and have Projen install the latest version of the package. A
-consequence of this recommendation is that when migrating, you may unknowingly update
-your dependencies to incompatible versions. You can always specify specific semvar
-requirements (e.g. `express@^2`) if necessary.

package/logo/projen.svg

@@ -1,211 +0,0 @@
-<?xml version="1.0" encoding="UTF-8" standalone="no"?>
-<svg
-   xmlns:dc="http://purl.org/dc/elements/1.1/"
-   xmlns:cc="http://creativecommons.org/ns#"
-   xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
-   xmlns:svg="http://www.w3.org/2000/svg"
-   xmlns="http://www.w3.org/2000/svg"
-   id="svg8"
-   version="1.1"
-   viewBox="0 0 57.296654 52.39449"
-   height="52.394489mm"
-   width="57.296654mm">
-  <defs
-     id="defs2" />
-  <metadata
-     id="metadata5">
-    <rdf:RDF>
-      <cc:Work
-         rdf:about="">
-        <dc:format>image/svg+xml</dc:format>
-        <dc:type
-           rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
-        <dc:title></dc:title>
-      </cc:Work>
-    </rdf:RDF>
-  </metadata>
-  <g
-     transform="translate(-75.785746,-87.205383)"
-     id="layer1">
-    <a
-       id="a4574" />
-    <g
-       id="g1004">
-      <g
-         id="g1323">
-        <g
-           id="g1345">
-          <g
-             transform="translate(46.26548,27.572157)"
-             id="g1046-6">
-            <g
-               transform="translate(55.907187,-58.285812)"
-               id="g908-3">
-              <g
-                 transform="translate(-122.4408,-65.271444)"
-                 id="g4623-0">
-                <g
-                   id="g902-0"
-                   transform="translate(0.01909553)">
-                  <path
-                     id="path888-7"
-                     d="m 96.48484,212.0709 v 23.06401 h 28.19827 V 212.0709 l -4.16132,-5.39635 -20.40541,0.0343 z"
-                     style="fill:#fa983c;fill-opacity:1;stroke:#66200b;stroke-width:0.90011251;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" />
-                </g>
-                <path
-                   style="fill:#fcc161;fill-opacity:1;stroke:none;stroke-width:0.26458332px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
-                   d="m 97.33592,211.61954 26.43699,0.002 -3.45765,-4.49827 -19.95968,0.0365 z"
-                   id="path906-9" />
-                <g
-                   id="g928-9"
-                   transform="translate(-0.14519447,-25.082386)">
-                  <path
-                     style="fill:#cbdada;fill-opacity:1;stroke:#66200b;stroke-width:0.90011251;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
-                     d="m 107.25435,237.15231 v 5.6589 l 3.55655,-2.17491 3.43128,2.17491 v -5.6589 l -1.43039,-5.39389 -3.84281,0.0206 z"
-                     id="path930-0" />
-                </g>
-              </g>
-            </g>
-            <g
-               id="g1015-6">
-              <g
-                 id="g1009-3">
-                <path
-                   style="fill:none;stroke:#66200b;stroke-width:0.90011251;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
-                   d="m 96.48484,212.0709 h 28.19827"
-                   id="path890-7"
-                   transform="translate(-66.514517,-123.55726)" />
-                <path
-                   id="path4561-7-1"
-                   d="m 53.781647,83.566014 3.45765,4.49827 -2.19301,0.001 -3.27537,-4.49 z"
-                   style="fill:#f9a63c;fill-opacity:1;stroke:none;stroke-width:0.26458332px;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" />
-                <path
-                   style="fill:#ed862f;fill-opacity:1;stroke:none;stroke-width:0.96445072;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
-                   d="m 55.275299,88.963797 0.04122,22.153023 2.379277,-0.007 0.01451,-22.130415 z"
-                   id="path4565-5-5" />
-              </g>
-            </g>
-          </g>
-          <g
-             id="g908-6"
-             transform="translate(130.37094,-30.713651)">
-            <g
-               id="g4623-4"
-               transform="translate(-122.4408,-65.271444)">
-              <g
-                 transform="translate(0.01909553)"
-                 id="g902-5">
-                <path
-                   style="fill:#fa983c;fill-opacity:1;stroke:#66200b;stroke-width:0.90011251;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
-                   d="m 96.48484,212.0709 v 23.06401 h 28.19827 V 212.0709 l -4.16132,-5.39635 -20.40541,0.0343 z"
-                   id="path888-3" />
-              </g>
-              <path
-                 id="path906-7"
-                 d="m 97.33592,211.61954 26.43699,0.002 -3.45765,-4.49827 -19.95968,0.0365 z"
-                 style="fill:#fcc161;fill-opacity:1;stroke:none;stroke-width:0.26458332px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" />
-              <g
-                 transform="translate(-0.14519447,-25.082386)"
-                 id="g928-1">
-                <path
-                   id="path930-6"
-                   d="m 107.25435,237.15231 v 5.6589 l 3.55655,-2.17491 3.43128,2.17491 v -5.6589 l -1.43039,-5.39389 -3.84281,0.0206 z"
-                   style="fill:#cbdada;fill-opacity:1;stroke:#66200b;stroke-width:0.90011251;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" />
-              </g>
-            </g>
-          </g>
-        </g>
-        <g
-           id="g1009-5"
-           transform="translate(74.46375,27.572161)">
-          <path
-             transform="translate(-66.514517,-123.55726)"
-             id="path890-9"
-             d="m 96.48484,212.0709 h 28.19827"
-             style="fill:none;stroke:#66200b;stroke-width:0.90011251;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" />
-          <path
-             style="fill:#f9a63c;fill-opacity:1;stroke:none;stroke-width:0.26458332px;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
-             d="m 53.781647,83.566014 3.45765,4.49827 -2.19301,0.001 -3.27537,-4.49 z"
-             id="path4561-7-2" />
-          <path
-             id="path4565-5-6"
-             d="m 55.275299,88.963797 0.04122,22.153023 2.379277,-0.007 0.01451,-22.130415 z"
-             style="fill:#ed862f;fill-opacity:1;stroke:none;stroke-width:0.96445072;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" />
-        </g>
-        <g
-           id="g1046"
-           transform="translate(60.364616,4.504308)">
-          <g
-             id="g908"
-             transform="translate(55.907187,-58.285812)">
-            <g
-               id="g4623"
-               transform="translate(-122.4408,-65.271444)">
-              <g
-                 transform="translate(0.01909553)"
-                 id="g902">
-                <path
-                   style="fill:#fa983c;fill-opacity:1;stroke:#66200b;stroke-width:0.90011251;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
-                   d="m 96.48484,212.0709 v 23.06401 h 28.19827 V 212.0709 l -4.16132,-5.39635 -20.40541,0.0343 z"
-                   id="path888" />
-              </g>
-              <path
-                 id="path906"
-                 d="m 97.33592,211.61954 26.43699,0.002 -3.45765,-4.49827 -19.95968,0.0365 z"
-                 style="fill:#fcc161;fill-opacity:1;stroke:none;stroke-width:0.26458332px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" />
-              <g
-                 transform="translate(-0.14519447,-25.082386)"
-                 id="g928">
-                <path
-                   id="path930"
-                   d="m 107.25435,237.15231 v 5.6589 l 3.55655,-2.17491 3.43128,2.17491 v -5.6589 l -1.43039,-5.39389 -3.84281,0.0206 z"
-                   style="fill:#cbdada;fill-opacity:1;stroke:#66200b;stroke-width:0.90011251;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" />
-              </g>
-            </g>
-          </g>
-          <g
-             id="g1015">
-            <g
-               id="g1009">
-              <path
-                 transform="translate(-66.514517,-123.55726)"
-                 id="path890"
-                 d="m 96.48484,212.0709 h 28.19827"
-                 style="fill:none;stroke:#66200b;stroke-width:0.90011251;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" />
-              <path
-                 style="fill:#f9a63c;fill-opacity:1;stroke:none;stroke-width:0.26458332px;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
-                 d="m 53.781647,83.566014 3.45765,4.49827 -2.19301,0.001 -3.27537,-4.49 z"
-                 id="path4561-7" />
-              <path
-                 id="path4565-5"
-                 d="m 55.275299,88.963797 0.04122,22.153023 2.379277,-0.007 0.01451,-22.130415 z"
-                 style="fill:#ed862f;fill-opacity:1;stroke:none;stroke-width:0.96445072;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" />
-            </g>
-          </g>
-        </g>
-        <g
-           transform="translate(125.02229,-75.78176)"
-           id="g4861">
-          <g
-             style="stroke-width:0.90011251;stroke-miterlimit:4;stroke-dasharray:none"
-             id="g4623-5"
-             transform="translate(-135.69803,-31.076619)" />
-          <g
-             id="g894"
-             transform="translate(1.458479,-0.00413411)">
-            <text
-               id="text4787"
-               y="209.54585"
-               x="-14.349669"
-               style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:2.82222223px;line-height:1.25;font-family:Arial;-inkscape-font-specification:Arial;letter-spacing:0px;word-spacing:0px;fill:#66200b;fill-opacity:1;stroke:none;stroke-width:0.26458332"
-               xml:space="preserve"><tspan
-                 style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:14.46388912px;font-family:Arial;-inkscape-font-specification:'Arial Bold';fill:#66200b;fill-opacity:1;stroke:none;stroke-width:0.26458332;stroke-opacity:1"
-                 y="209.54585"
-                 x="-14.349669"
-                 id="tspan4785">pj</tspan></text>
-          </g>
-        </g>
-      </g>
-    </g>
-  </g>
-</svg>

package/rfcs/github-project-settings.md

@@ -1,95 +0,0 @@
-# External GitHub Repository Settings (RFC #1014)
-
-> **Author**: [@eladb](https://github.com/eladb), **Status**: Draft
-
-Projen is great for managing project-related configuration that is modeled in
-files within the git repository. Much of GitHub's configuration (such as issue
-templates, workflows, etc) is managed through files under `.github` and to that
-extend, projen lends itself well to maintain these files.
-
-However, there are some GitHub repository settings that are not managed through
-files in the repos. These include things like branch protection rules,
-auto-merge options, and most noteable are repository secrets. Projen heavily
-relies on repository secrets for things like publishing tokens.
-
-When maintaining many projects, manaing publishing secrets becomes a major
-burden. It is also error prone and has potential security implications. Ideally
-these secrets should be managed by tooling and not by humans.
-
-GitHub offers some support for centrally managing secrets but these require
-organization-level permissions which are not always available.
-
-## README (working backwards)
-
-Let’s say we have a JSII project. By default, it does not publish to PyPI. Let's
-add Python publishing to our project.
-
-First, we need edit your `projenrc.js` file and add the `publishToPyPi` setting.
-Additionally, set the `secrets` option to tell Projen to retrieve secrets from
-AWS Secrets Manager (in the future other secret sources will be supported):
-
-```js
-const projen = require('projen');
-
-const project = new projen.JsiiProject({
-  // ...
-  
-  secrets: projen.Secrets.fromAwsSecretsManager('arn:aws:secretsmanager:us-east-1:111111111111:secret:projen-publishing-tokens'),
-  publishToPyPi: {
-    distName: 'foo-bar',
-    module: 'foo_bar',
-  },
-});
-```
-
-> NOTE: not sure I like the union-like API, but we can debate that later.
-
-Now, as usual, execute `npx projen`.
-
-Under the hood, projen uses `gh secret list` to check if your repo has the
-desired secrets. If not, it will retrieve them from AWS Secrets Manager and
-store them in your repository via the GitHub API.
-
-```shell
-$ npx projen
-Synthesizing project...
-Storing TWINE_USERNAME from arn:aws:secretsmanager:us-east-1:111111111111:secret:projen-publishing-tokens
-Storing TWINE_PASSWORD from arn:aws:secretsmanager:us-east-1:111111111111:secret:projen-publishing-tokens
-Done
-```
-
-_not sure that’s feasible:_ You will also notice that your
-`.github/workflows/release.yml` workflow was updated and now includes a check
-that verifeis that your repository has the desired secrets. This is sort of an
-"anti-tamper check" for external settings. If your repository does not have the
-needed secerts, an error will be displayed with instructions on how to store
-them.
-
-A similar approach can be taken to configure other non-source-code repository
-settings such as branch protection rules:
-
-```js
-# this should be the default probably
-project.addBranchProtection(project.defaultBranch);
-```
-
-Similarly, during synth, given the proper credentials, projen can actually setup
-the project to align with the definition and a workflow on the default branch
-can be used to ensure that the project is compliant.
-
-**Prerequisites:** For this to work, you'll need your development box to have
-GitHub CLI installed and logged in, as well as default AWS credentials with
-access to a secret called `projen-publishing-token` secret in `us-east-1` (as
-defined by the ARN specified under `secrets`). Projen expects to find a field by
-the same name as the secret name (e.g. `TWINE_USERNAME` and `TWINE_PASSWORD`)
-stored in JSON format in the secret. Secrets can be stored using the AWS CLI or
-via the AWS Console.
-
-In the future we can offer a CLI command to store secrets:
-
-```shell
-$ projen secrets store TWINE_USERNAME "Boom"
-$ projen secrets store TWINE_PASSWORD "Bam"
-```
-
-Something like that.

package/rfcs/project-creation-prompt.md

@@ -1,95 +0,0 @@
-# Project Creation Prompts (RFC #1365)
-
-> **Author**: [@MarkMcCulloh](https://github.com/MarkMcCulloh), **Status**: Draft
-
-When hearing about projen for the first time, the typical comparisons one may think of are tools such as `yeoman` or the various projects making use of `npm init`.
-Obviously the underlying methodology of projen is quite different, but there is a great UX feature these other tools typically employ that projen can make use of: Guided prompts. This allows users to create a project from an opinionated set of options with friendly guidance. This is especially useful in scenarios where the project requires a value that has no reasonable default (and thus could not be created with projen as it is now without it being provided as a CLI arg).
-
-## Example user flows
-
-Note: All prompts are assuming to be run from a TTY. We should check if in a TTY before a prompt is presented and error otherwise.
-
-`$ npx projen new`
-1. User is shown a list of base projen project types
-1. User selects the `typescript` project
-1. Project is synthesized
-
-`$ npx projen new typescript`
-1. No prompts are shown because a project is selected and the `typescript` project type has no `@featured` required options that do not also have a default
-1. Project is synthesized
-
-`$ npx projen new typescript --prompt`
-1. Prompts are shown for (currently) `packageName` and `description`, as those options are `@featured` and have no default value
-1. Project is synthesized
-
-`$ npx projen new typescript --prompt --package-name cool-name --description 'Terse but useful'`
-1. No prompts are shown because all `@featured` options have been given supplied values already
-1. Project is synthesized
-
-## Details
-
-### Prompt library to use
-
-[Prompts](https://github.com/terkelg/prompts) is an extremely common library for CLI-based prompts. It's relatively small and has very few dependencies.
-
-### Project type prompt
-
-A user should be prompted to select a project type to create. This should be prompted during `projen new` when:
-
-- A project id has not been specified
-- There is more than one project type available
-
-Currently projen will exit and show the user the help menu. Instead, it should show the user a list of available projects to choose from in the current context. After choosing a project, projen can continue is it normally would have if the user has provided it during the original invocation.
-
-[autocomplete](https://github.com/terkelg/prompts#autocompletemessage-choices-initial-suggest-limit-style) would be a good input type for this as it has a filtering feature.
-
-### Project option prompts
-
-After a project type has been selected, the user can be shown a list of featured options to set interactively. For a project option to be available as a prompt during `projen new`:
-
-- `@featured` tag in property docstring
-- Must be able to be set via CLI arg (is a primitive or enum)
-- Must not have already been provided as a CLI arg
-
-By default, `projen new <project>` will not show prompts unless the `--prompt` flag is provided.
-There is one exception: If a project option meets the above criteria but is also:
-
-- Non-nullable
-- Not already provided as a CLI arg
-
-### Prompt format
-
-By default, values sent to the `prompts` library will be derived by the information in the JSII. For example, enums should have their choices populated automatically.
-
-In case the default logic is insufficient,  `@prompt...` doc tags can be added to override the default. See below for reference.
-
-#### Docstring tag reference
-
-<https://github.com/terkelg/prompts#multiselectmessage-choices-initial-max-hint-warn>
-
-- `@featured` - Functions as it did before, but now also signifies that this option is prompt-able
-- `@promptType` - The type of prompt (text, toggle, etc.). See <https://github.com/terkelg/prompts#-types>.
-  - **Example:** An array type would have a default prompt type of [list](https://github.com/terkelg/prompts#listmessage-initial).  
-  `@promptType multiselect` would allow you to provide a set of distinct options instead.
-- `@promptMessage` - The actual prompt, derived from the docstring summary. See <https://github.com/terkelg/prompts#message>.
-  - Can be used when the type documentation insufficient for use as a prompt.
-- `@promptChoices` - Comma-separated list of choices for this prompt.
-  - Important for types that can't have their available choices automatically derived.  
-  - **Example:** `@promptChoices choice1,choice2` would limit a plain text field into only have those two choices.
-
-## Testing
-
-`prompts` [provides a utility](https://github.com/terkelg/prompts#injectvalues) for injecting responses to prompts. This can be used for testing this functionality without any interaction.
-
-## Documentation
-
-Usage of `--prompt` should be mentioned in the README. Documentation on specifics of this feature should be added into `/docs`.
-
-## Proposed implementation phases
-
-To keep the implementation PRs small-ish:
-
-1. Add `--prompt` flag to `projen new` that shows basic `text` prompts for `@featured` options
-1. Show certain option prompts even when `--prompt` is not supplied (see above)
-1. Add project type prompts
-1. Derive specific option prompts (text, number, select, etc.) from JSII type info and `@prompt...` overrides

package/version.json

@@ -1,3 +0,0 @@
-{
-  "version": "0.17.52"
-}