Skip to content

chore: bring in updates for create's interactive CLI #1781

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 28 commits into from
Dec 24, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
249c5b7
chore: bring in updates for create's interactive CLI
JoshuaKGoldberg Dec 19, 2024
7e3aab4
delete main, not just comment
JoshuaKGoldberg Dec 19, 2024
fb6693c
[email protected], with suggestions
JoshuaKGoldberg Dec 20, 2024
dba9bb3
Apply suggestions from code review
JoshuaKGoldberg Dec 20, 2024
3d3b465
bring in alpha.4s
JoshuaKGoldberg Dec 20, 2024
409adf8
pnpm dedupe
JoshuaKGoldberg Dec 20, 2024
cfc7719
Started fixing tests
JoshuaKGoldberg Dec 20, 2024
e16639a
Merge branch 'main'
JoshuaKGoldberg Dec 21, 2024
901af8d
Merge branch 'main'
JoshuaKGoldberg Dec 21, 2024
bfb8588
Factor directory . in tests
JoshuaKGoldberg Dec 21, 2024
9b72b67
Merge branch 'main'
JoshuaKGoldberg Dec 21, 2024
4cc4aba
Oops, no vitest in creation/index.ts
JoshuaKGoldberg Dec 21, 2024
d891999
Merge branch 'main' into create-cli
JoshuaKGoldberg Dec 21, 2024
1028831
fix create index.test.ts
JoshuaKGoldberg Dec 21, 2024
b12fb57
fix create index.test.ts fetchers again
JoshuaKGoldberg Dec 22, 2024
ea33115
Merge branch 'main'
JoshuaKGoldberg Dec 22, 2024
885787b
Remove --offline :(
JoshuaKGoldberg Dec 22, 2024
122c785
Update tests
JoshuaKGoldberg Dec 22, 2024
a27f12a
Update package.json snapshot
JoshuaKGoldberg Dec 22, 2024
5d3685e
Fixups for relativity
JoshuaKGoldberg Dec 22, 2024
93b70df
Reset directory changes, since chdir already happened
JoshuaKGoldberg Dec 23, 2024
7c68ea6
A bit of linting
JoshuaKGoldberg Dec 23, 2024
7b52362
A bit more reverting
JoshuaKGoldberg Dec 23, 2024
ca07d3b
Persistent chdir/cwd change maybe
JoshuaKGoldberg Dec 24, 2024
1dbe38e
More aggressively keep the updated cwd
JoshuaKGoldberg Dec 24, 2024
a01c09b
Fix up linting and testing
JoshuaKGoldberg Dec 24, 2024
0948e21
Merge branch 'main' into create-cli
JoshuaKGoldberg Dec 24, 2024
3941867
Merge branch 'main' into create-cli
JoshuaKGoldberg Dec 24, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/Options.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ These required options determine the options that will be substituted into the t
- `--description` _(`string`)_: Sentence case description of the repository (e.g. `Quickstart-friendly TypeScript package with lots of great repository tooling. ✨`)
- `--owner` _(`string`)_: GitHub organization or user the repository is underneath (e.g. `JoshuaKGoldberg`)
- `--repository` _(`string`)_: The kebab-case name of the repository (e.g. `create-typescript-app`)
- `--title` _(`string`)_: Title Case title for the repository to be used in documentation (e.g. `Create TypeScript App`)
- `--title` _(`string`)_: Title Case title for the repository (e.g. `Create TypeScript App`)

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

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

- `--access` _(`"public" | "restricted"`)_: Which [`npm publish --access`](https://docs.npmjs.com/cli/commands/npm-publish#access) to release npm packages with (by default, `"public"`)
- `--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()`)
- `--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)
- `--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)
- `--directory` _(`string`)_: Directory to create the repository in (by default, the same name as the repository)
- `--email` _(`string`)_: Email address to be listed as the point of contact in docs and packages (e.g. `[email protected]`)
- Optionally, `--email-github` _(`string`)_ and/or `--email-npm` _(`string`)_ may be provided to use different emails in `.md` files and `package.json`, respectively
- `--funding` _(`string`)_: GitHub organization or username to mention in `funding.yml` (by default, `owner`)
- `--guide` _(`string`)_: Link to a contribution guide to place at the top of the development docs
- `--guide` _(`string`)_: Link to a contribution guide to place at the top of development docs
- `--guide-title` _(`string`)_: If `--guide` is provided or detected from an existing DEVELOPMENT.md, the text title to place in the guide link
- `--keywords` _(`string[]`)_: Any number of keywords to include in `package.json` (by default, none)
- This can be specified any number of times, like `--keywords apple --keywords "banana cherry"`
- `--logo` _(`string`)_: Local image file in the repository to display near the top of the README.md as a logo
- `--logo` _(`string`)_: Local image file in the repository to display near the top of the README.md
- `--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)
- `--preserve-generated-from` _(`boolean`)_: Whether to keep the GitHub repository _generated from_ notice (by default, `false`)

Expand Down
9 changes: 5 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -44,13 +44,14 @@
"@clack/prompts": "^0.9.0",
"@prettier/sync": "^0.5.2",
"chalk": "^5.4.1",
"create": "0.1.0-alpha.7",
"create": "0.1.0-alpha.8",
"cspell-populate-words": "^0.3.0",
"execa": "^9.5.2",
"git-remote-origin-url": "^4.0.0",
"git-url-parse": "^16.0.0",
"input-from-file": "0.1.0-alpha.2",
"input-from-file-json": "0.1.0-alpha.2",
"input-from-file": "0.1.0-alpha.4",
"input-from-file-json": "0.1.0-alpha.4",
"input-from-script": "0.1.0-alpha.4",
"js-yaml": "^4.1.0",
"lazy-value": "^3.0.0",
"npm-user": "^6.1.1",
Expand Down Expand Up @@ -84,7 +85,7 @@
"all-contributors-cli": "6.26.1",
"c8": "10.1.3",
"console-fail-test": "0.5.0",
"create-testers": "0.1.0-alpha.7",
"create-testers": "0.1.0-alpha.8",
"cspell": "8.17.1",
"eslint": "9.17.0",
"eslint-plugin-jsdoc": "50.6.1",
Expand Down
Loading
Loading