projen 0.47.4 → 0.47.5

package/lib/yaml.js

@@ -36,5 +36,5 @@ class YamlFile extends object_file_1.ObjectFile {
 }
 exports.YamlFile = YamlFile;
 _a = JSII_RTTI_SYMBOL_1;
-YamlFile[_a] = { fqn: "projen.YamlFile", version: "0.47.4" };
+YamlFile[_a] = { fqn: "projen.YamlFile", version: "0.47.5" };
 //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoieWFtbC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3NyYy95YW1sLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7O0FBQUEsNkJBQTZCO0FBRTdCLCtDQUE4RDs7Ozs7O0FBTzlELE1BQWEsUUFBUyxTQUFRLHdCQUFVOzs7O0lBQ3RDLFlBQVksT0FBZ0IsRUFBRSxRQUFnQixFQUFFLE9BQXdCO1FBQ3RFLEtBQUssQ0FBQyxPQUFPLEVBQUUsUUFBUSxFQUFFLE9BQU8sQ0FBQyxDQUFDO0lBQ3BDLENBQUM7Ozs7OztJQUVTLGlCQUFpQixDQUFDLFFBQW1CO1FBQzdDLE1BQU0sSUFBSSxHQUFHLEtBQUssQ0FBQyxpQkFBaUIsQ0FBQyxRQUFRLENBQUMsQ0FBQztRQUMvQyxJQUFJLENBQUMsSUFBSSxFQUFFO1lBQ1QsT0FBTyxTQUFTLENBQUM7U0FDbEI7UUFFRCxPQUFPO1lBQ0wsR0FBSSxDQUFDLElBQUksQ0FBQyxNQUFNLENBQUMsQ0FBQyxDQUFDLENBQUMsS0FBSyxRQUFRLENBQUMsYUFBYSxFQUFFLENBQUMsQ0FBQyxDQUFDLENBQUMsRUFBRSxDQUFDO1lBQ3hELEVBQUU7WUFDRixJQUFJLENBQUMsU0FBUyxDQUFDLElBQUksQ0FBQyxLQUFLLENBQUMsSUFBSSxDQUFDLEVBQUUsRUFBRSxNQUFNLEVBQUUsQ0FBQyxFQUFFLENBQUM7U0FDaEQsQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLENBQUM7SUFDZixDQUFDOztBQWhCSCw0QkFpQkMiLCJzb3VyY2VzQ29udGVudCI6WyJpbXBvcnQgKiBhcyBZQU1MIGZyb20gJ3lhbWwnO1xuaW1wb3J0IHsgSVJlc29sdmVyIH0gZnJvbSAnLi9maWxlJztcbmltcG9ydCB7IE9iamVjdEZpbGUsIE9iamVjdEZpbGVPcHRpb25zIH0gZnJvbSAnLi9vYmplY3QtZmlsZSc7XG5pbXBvcnQgeyBQcm9qZWN0IH0gZnJvbSAnLi9wcm9qZWN0JztcblxuICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIFxuZXhwb3J0IGludGVyZmFjZSBZYW1sRmlsZU9wdGlvbnMgZXh0ZW5kcyBPYmplY3RGaWxlT3B0aW9ucyB7fVxuXG4gICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgXG5leHBvcnQgY2xhc3MgWWFtbEZpbGUgZXh0ZW5kcyBPYmplY3RGaWxlIHtcbiAgY29uc3RydWN0b3IocHJvamVjdDogUHJvamVjdCwgZmlsZVBhdGg6IHN0cmluZywgb3B0aW9uczogWWFtbEZpbGVPcHRpb25zKSB7XG4gICAgc3VwZXIocHJvamVjdCwgZmlsZVBhdGgsIG9wdGlvbnMpO1xuICB9XG5cbiAgcHJvdGVjdGVkIHN5bnRoZXNpemVDb250ZW50KHJlc29sdmVyOiBJUmVzb2x2ZXIpOiBzdHJpbmcgfCB1bmRlZmluZWQge1xuICAgIGNvbnN0IGpzb24gPSBzdXBlci5zeW50aGVzaXplQ29udGVudChyZXNvbHZlcik7XG4gICAgaWYgKCFqc29uKSB7XG4gICAgICByZXR1cm4gdW5kZWZpbmVkO1xuICAgIH1cblxuICAgIHJldHVybiBbXG4gICAgICAuLi4gKHRoaXMubWFya2VyID8gW2AjICR7WWFtbEZpbGUuUFJPSkVOX01BUktFUn1gXSA6IFtdKSxcbiAgICAgICcnLFxuICAgICAgWUFNTC5zdHJpbmdpZnkoSlNPTi5wYXJzZShqc29uKSwgeyBpbmRlbnQ6IDIgfSksXG4gICAgXS5qb2luKCdcXG4nKTtcbiAgfVxufSJdfQ==

package/package.json

@@ -113,7 +113,7 @@
   },
   "main": "lib/index.js",
   "license": "Apache-2.0",
-  "version": "0.47.4",
+  "version": "0.47.5",
   "jest": {
     "testMatch": [
       "**/__tests__/**/*.ts?(x)",

package/releasetag.txt

@@ -1 +1 @@
-v0.47.4
+v0.47.5

package/rfcs/project-creation-prompt.md

@@ -0,0 +1,95 @@
+# 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.txt

@@ -1 +1 @@
-0.47.4
+0.47.5