Skip to content
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.

Sign up for GitHub

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

feat(create-waku): --project-name option #1232

Merged
merged 5 commits into from
Feb 17, 2025
+7 −3
Merged

feat(create-waku): --project-name option #1232

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
cf912b3
feat: --project-name option for create-waku
rmarscher Feb 16, 2025
1c43faf
revert onState change
rmarscher Feb 16, 2025
5826d06
Set defaultProjectName to targetDir
rmarscher Feb 17, 2025
03ba0a8
Merge branch 'main' into feat/waku-create-project-name
dai-shi Feb 17, 2025
68be762
Merge branch 'main' into feat/waku-create-project-name
dai-shi Feb 17, 2025
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
13 changes: 10 additions & 3 deletions packages/create-waku/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,9 @@ const { values } = parseArgs({
example: {
type: 'string',
},
'project-name': {
type: 'string',
},
help: {
type: 'boolean',
short: 'h',
Expand Down Expand Up @@ -98,17 +101,20 @@ async function doPrompts() {
const templateNames = await getTemplateNames(templateRoot);

const defaultProjectName = 'waku-project';
let targetDir = '';
let targetDir = values['project-name'] || '';
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
let targetDir = values['project-name'] || '';
let targetDir = values['project-name'] || defaultProjectName;

and the change L119

- message: `${targetDir || defaultProjectName} is not empty. Remove existing files and continue?`,
+ message: `${targetDir} is not empty. Remove existing files and continue?`,

work?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes. I made this update and tested it. Looks good.


try {
const result = await prompts(
[
{
name: 'projectName',
type: 'text',
type: values['project-name'] ? null : 'text',
message: 'Project Name',
initial: defaultProjectName,
onState: (state: any) => (targetDir = String(state.value).trim()),
onState: (state: any) =>
(targetDir =
String(values['project-name']).trim() ||
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This might be unnecessary... checking...

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, removed the change from there.

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we still need this?

let targetDir = values['project-name'] || '';

Or,

let targetDir = '';

works?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, we still need that. Otherwise, it prompts for package name because targetDir is empty.

String(state.value).trim()),
},
{
name: 'shouldOverwrite',
Expand Down Expand Up @@ -169,6 +175,7 @@ Usage: ${commands.create} [options]
Options:
--choose Choose from the template list
--example Specify an example use as a template
--project-name Specify a project name
-h, --help Display this help message
`);
}
Expand Down
Loading