Skip to content

Commit 3b082a9

Browse files
chore: bring in updates for create's interactive CLI (#1781)
## PR Checklist - [x] Addresses an existing open issue: fixes #1780 - [x] That issue was marked as [`status: accepting prs`](https://github.com/JoshuaKGoldberg/create-typescript-app/issues?q=is%3Aopen+is%3Aissue+label%3A%22status%3A+accepting+prs%22) - [x] Steps in [CONTRIBUTING.md](https://github.com/JoshuaKGoldberg/create-typescript-app/blob/main/.github/CONTRIBUTING.md) were taken ## Overview Applies three main areas of change: * Factors in a `directory` string for option defaults so they can work outside of the cwd * Adds a fallback of `gh config get user -h github.com` for `options.owner`, finally removing the need to manually re-type your own owner always 🥳 * Adds `.describe("...")` to their Zod schemas so they can be nicely described in prompts (and, eventually, auto-generated docs) * Brings in the new `suggestions` Indirect Creations to generate the nice _"be sure to..."_ notice upon completion Also removes the `--offline` from `finalizeDependencies`. 💖
1 parent cc7ac99 commit 3b082a9

26 files changed

+612
-218
lines changed

Diff for: docs/Options.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ These required options determine the options that will be substituted into the t
3737
- `--description` _(`string`)_: Sentence case description of the repository (e.g. `Quickstart-friendly TypeScript package with lots of great repository tooling. ✨`)
3838
- `--owner` _(`string`)_: GitHub organization or user the repository is underneath (e.g. `JoshuaKGoldberg`)
3939
- `--repository` _(`string`)_: The kebab-case name of the repository (e.g. `create-typescript-app`)
40-
- `--title` _(`string`)_: Title Case title for the repository to be used in documentation (e.g. `Create TypeScript App`)
40+
- `--title` _(`string`)_: Title Case title for the repository (e.g. `Create TypeScript App`)
4141

4242
For example, pre-populating all core required options and also creating a new repository:
4343

@@ -53,16 +53,16 @@ The setup scripts also allow for optional overrides of the following inputs whos
5353

5454
- `--access` _(`"public" | "restricted"`)_: Which [`npm publish --access`](https://docs.npmjs.com/cli/commands/npm-publish#access) to release npm packages with (by default, `"public"`)
5555
- `--author` _(`string`)_: Username on npm to publish packages under (by default, an existing npm author, or the currently logged in npm user, or `owner.toLowerCase()`)
56-
- `--bin` _(`string`)_: value to set in `package.json`'s `"bin"` property, per [FAQs > How can I use `bin`?](./FAQs.md#how-can-i-use-bin)
56+
- `--bin` _(`string`)_: Value to set in `package.json`'s `"bin"` property, per [FAQs > How can I use `bin`?](./FAQs.md#how-can-i-use-bin)
5757
- `--directory` _(`string`)_: Directory to create the repository in (by default, the same name as the repository)
5858
- `--email` _(`string`)_: Email address to be listed as the point of contact in docs and packages (e.g. `[email protected]`)
5959
- Optionally, `--email-github` _(`string`)_ and/or `--email-npm` _(`string`)_ may be provided to use different emails in `.md` files and `package.json`, respectively
6060
- `--funding` _(`string`)_: GitHub organization or username to mention in `funding.yml` (by default, `owner`)
61-
- `--guide` _(`string`)_: Link to a contribution guide to place at the top of the development docs
61+
- `--guide` _(`string`)_: Link to a contribution guide to place at the top of development docs
6262
- `--guide-title` _(`string`)_: If `--guide` is provided or detected from an existing DEVELOPMENT.md, the text title to place in the guide link
6363
- `--keywords` _(`string[]`)_: Any number of keywords to include in `package.json` (by default, none)
6464
- This can be specified any number of times, like `--keywords apple --keywords "banana cherry"`
65-
- `--logo` _(`string`)_: Local image file in the repository to display near the top of the README.md as a logo
65+
- `--logo` _(`string`)_: Local image file in the repository to display near the top of the README.md
6666
- `--logo-alt` _(`string`)_: If `--logo` is provided or detected from an existing README.md, alt text that describes the image (will be prompted for if not provided)
6767
- `--preserve-generated-from` _(`boolean`)_: Whether to keep the GitHub repository _generated from_ notice (by default, `false`)
6868

Diff for: package.json

+5-4
Original file line numberDiff line numberDiff line change
@@ -44,13 +44,14 @@
4444
"@clack/prompts": "^0.9.0",
4545
"@prettier/sync": "^0.5.2",
4646
"chalk": "^5.4.1",
47-
"create": "0.1.0-alpha.7",
47+
"create": "0.1.0-alpha.8",
4848
"cspell-populate-words": "^0.3.0",
4949
"execa": "^9.5.2",
5050
"git-remote-origin-url": "^4.0.0",
5151
"git-url-parse": "^16.0.0",
52-
"input-from-file": "0.1.0-alpha.2",
53-
"input-from-file-json": "0.1.0-alpha.2",
52+
"input-from-file": "0.1.0-alpha.4",
53+
"input-from-file-json": "0.1.0-alpha.4",
54+
"input-from-script": "0.1.0-alpha.4",
5455
"js-yaml": "^4.1.0",
5556
"lazy-value": "^3.0.0",
5657
"npm-user": "^6.1.1",
@@ -84,7 +85,7 @@
8485
"all-contributors-cli": "6.26.1",
8586
"c8": "10.1.3",
8687
"console-fail-test": "0.5.0",
87-
"create-testers": "0.1.0-alpha.7",
88+
"create-testers": "0.1.0-alpha.8",
8889
"cspell": "8.17.1",
8990
"eslint": "9.17.0",
9091
"eslint-plugin-jsdoc": "50.6.1",

0 commit comments

Comments
 (0)