feat(create-waku): `--example` option #581

ojj1123 · 2024-03-08T05:00:32Z

related #315

I wrote the prototype for --example option. I've referred to create-next-app
I will be adding automatically installing dependencies in next PR.

What features were added

pnpm create waku --example 14_react-tweet // will download https://github.com/dai-shi/waku/tree/main/examples/14_react-tweet

pnpm create waku --example https://github.com/dai-shi/waku/tree/main/examples/14_react-tweet

pnpm create waku --example https://github.com/himself65/waku-vercel-template

also in this PR, i've drop --choose-example as @dai-shi said
#315 (reply in thread)

What I want to discuss

In create-next-app, they are dealing with the branch name or file path containing the slash. But I've thought this case is a bit rare one so I didn't implement this feature in create-waku. How about this case?

vercel · 2024-03-08T05:00:36Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated (UTC)
waku	✅ Ready (Inspect)	Visit Preview	Mar 12, 2024 4:49am

codesandbox-ci · 2024-03-08T05:00:55Z

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

dai-shi

https://github.com/dai-shi/waku/pull/581/files#diff-995f71dd25297bc098cf21c18a6770843422edd5863adc74f7b181ca7c803bcfR25
We would like to copy only examples/01_template.

@himself65 Can you review please?

(Maybe, it's time for us to add some unit tests.)

packages/create-waku/src/helpers/examples.ts

packages/create-waku/src/index.ts

dai-shi · 2024-03-08T06:19:42Z

they are dealing with the branch name or file path containing the slash.

Branch name or tag name is actually important because examples in main branch will be breaking with older versions.

packages/create-waku/src/helpers/examples.ts

packages/create-waku/src/index.ts

ojj1123 · 2024-03-09T07:32:56Z

packages/create-waku/src/helpers/examples.ts

+/**
+ * this is a part of the response type for github "Get a repository" API
+ * @see {@link https://docs.github.com/en/rest/repos/repos?apiVersion=2022-11-28#get-a-repository|GitHub REST API}
+ */
+interface GetRepoInfo {
+  /** A default branch of the repository */
+  default_branch: string;
+}


I take a part of the response type from github docs here

cc. @himself65

ojj1123 · 2024-03-09T09:39:27Z

they are dealing with the branch name or file path containing the slash.

Branch name or tag name is actually important because examples in main branch will be breaking with older versions.

@dai-shi
what you mean?
you mean create-waku support the features below?

pnpm create waku --example 01_template // by default, download example from default branch

pnpm create waku --example 01_template --branch with-middleware // download example from with-middleware

This PR's implementation is only to download example from default branch by default

because examples in main branch will be breaking with older versions.

I didn't understand this situation

dai-shi · 2024-03-09T12:04:51Z

I didn't understand this situation

Let's say, we release v0.20.0. At that point, we can use npm create --example 01_template, and it works fine.

Meanwhile, we will start merging PRs for v0.21.0, and examples will only work with the new (unreleased) version. If we run npm create --example 01_template at that point, the template won't work with v0.20.0.

ojj1123 · 2024-03-10T02:31:43Z

I got that situation.
but each example have package.json. I think that new example for working only with new (unreleased) version is added during or after merging new release.
Wouldn't it be safe if the examples aren't modified before new release or new example is added after new waku release?

Still if you think it is nessasary to get the branch or tag option, i will make it next PR

dai-shi · 2024-03-10T03:37:07Z

is added during or after merging new release.

No, that's not the case.
Well, package.json lies in the examples folder (it only works with the monorepo setup.)

Still if you think it is nessasary to get the branch or tag option, i will make it next PR

Yes, it's necessary, but can be a follow-up PR.

ojj1123 · 2024-03-11T09:44:24Z

Please review this PR.
I will do the works next PR below:

branch option for downloading the examples feat(create-waku): --example option #581 (comment)
Automatically installing dependencies
writing e2e test code or refactoring

dai-shi

I didn't check the behavior though.

dai-shi · 2024-03-11T13:42:20Z

packages/create-waku/package.json

@@ -25,16 +25,18 @@
    "start": "node ./dist/index.js",
    "dev": "ncc build ./src/index.ts -w -o ./dist/",
    "compile": "rm -rf template dist *.tsbuildinfo && pnpm run template && pnpm run build",
-    "template": "cp -r ../../examples template/ && rm -rf template/*/dist && rm -rf template/*/node_modules && mv template/01_template/.gitignore template/01_template/gitignore",
+    "template": "mkdir template && cp -r ../../examples/01_template template/01_template && rm -rf template/*/dist && rm -rf template/*/node_modules && mv template/01_template/.gitignore template/01_template/gitignore",


Maybe we can just cp -r ../../examples/01_template template. You can consider it in the follow-up PRs.

yeah i've tried to do that. but i've got it like below:

/template /src package.json ...

but i want to do this below:

/template /01_template

because i consider that it will be added the extra templates 👍

okay, i thought the former is fine (single template). We don't know the future, but for now we have only one template.

dai-shi · 2024-03-11T13:44:04Z

packages/create-waku/src/index.ts

+  return (
+    typeof err === 'object' &&
+    err !== null &&
+    typeof (err as { message?: unknown }).message === 'string'


Maybe this works?

Suggested change

typeof (err as { message?: unknown }).message === 'string'

typeof err.message === 'string'

okay i will try that next PR

Aslemammad · 2024-03-11T14:15:46Z

packages/create-waku/src/index.ts

+
+    // TODO automatically installing dependencies
+    // 1. check packageManager
+    // 2. and then install dependencies


can we use this? https://github.com/antfu/ni

Oh thanks.
My plan is just below:

exec(`${packageManager} install`)

i don't know ni but if it is useful, let's use it.

Yes that can work too. just wanted to drop a possibility.

Pay special attention when choosing a dependency. we generally avoid adding new dependencies especially if they are new.

Aslemammad · 2024-03-11T14:19:54Z

packages/create-waku/src/helpers/example-option.ts

+) {
+  await pipeline(
+    await downloadTarStream(
+      `https://codeload.github.com/${username}/${name}/tar.gz/${branch}`,


is this downloading the whole waku repo for users?

Yes, the only way to get examples of waku is to download the whole waku repository.
Do you have any concerns or suggestions?
if you do, i would like to consider it

Yea, it might be too much size to download for the user. If there's no other way then let's go with this. but it's better to find a way.

ojj1123 · 2024-03-12T05:20:02Z

@dai-shi
I have no write access to this repository.
I was wondering if you could merge it 👍

dai-shi · 2024-03-12T05:41:23Z

I was wondering if you could merge it

Basically, it feels like we are still in the middle of review.
We are not confident if there are no bugs, or if it's well designed / coded.
But, I guess you take the responsibility, so let's merge it this time.

okay i will try that next PR

out of curiosity, why do you prefer separating PRs?

ojj1123 · 2024-03-12T05:56:11Z

Basically, it feels like we are still in the middle of review.
We are not confident if there are no bugs, or if it's well designed / coded.

yeah i also agree with you. If you have any feedback, please let me know !

out of curiosity, why do you prefer separating PRs?

i prefer separating the works such as refactoring and other features. I just want to focus on the interests of this PR and i tend to separate the task into smaller tasks and prioritize them.
if you have the other opinion, i could follow your one :)

dai-shi · 2024-03-12T07:07:58Z

if you have the other opinion, i could follow your one :)

Maybe we can create a branch, and send PRs there. Will let you know when it's appropriate.

Meanwhile, send follow-up PRs to main.

ojj1123 added 8 commits March 7, 2024 23:53

add tar package

b948db8

wip create waku <url>

8529ec7

drop --choose-template option

60e20e9

feat: install template if no example option

f4dbdfe

check example's name

b468f67

refactor: only make gitignore if no example

6d3f3d9

chore

5856c34

refactor

ea90d93

Merge branch 'main' into feat/example-option

ccf6c41

vercel bot deployed to Preview March 8, 2024 05:03 View deployment

dai-shi reviewed Mar 8, 2024

View reviewed changes

packages/create-waku/src/helpers/examples.ts Outdated Show resolved Hide resolved

packages/create-waku/src/index.ts Outdated Show resolved Hide resolved

packages/create-waku/src/index.ts Outdated Show resolved Hide resolved

himself65 reviewed Mar 8, 2024

View reviewed changes

packages/create-waku/src/helpers/examples.ts Outdated Show resolved Hide resolved

packages/create-waku/src/helpers/examples.ts Outdated Show resolved Hide resolved

packages/create-waku/src/index.ts Outdated Show resolved Hide resolved

refactor: review

83bfe4f

ojj1123 commented Mar 9, 2024

View reviewed changes

Merge branch 'main' into feat/example-option

ca7b3d5

vercel bot had a problem deploying to Preview March 9, 2024 07:33 Failure

ojj1123 marked this pull request as draft March 9, 2024 07:37

fix copy only 01_template

73036a2

Merge branch 'main' into feat/example-option

b45e664

vercel bot had a problem deploying to Preview March 11, 2024 09:30 Failure

ojj1123 added 2 commits March 11, 2024 18:32

refactor rename examples.ts to example-option.ts

594ecbb

resolve ci fail

ff84784

ojj1123 marked this pull request as ready for review March 11, 2024 09:38

ojj1123 requested a review from dai-shi March 11, 2024 09:39

dai-shi approved these changes Mar 11, 2024

View reviewed changes

Aslemammad reviewed Mar 11, 2024

View reviewed changes

Merge branch 'main' into feat/example-option

b1cddbe

vercel bot deployed to Preview March 12, 2024 04:49 View deployment

dai-shi merged commit 64e883c into dai-shi:main Mar 12, 2024
28 checks passed

ojj1123 deleted the feat/example-option branch March 12, 2024 05:57

dai-shi mentioned this pull request Mar 13, 2024

fix(create-waku): do not download from main #599

Merged

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(create-waku): `--example` option #581

feat(create-waku): `--example` option #581

ojj1123 commented Mar 8, 2024 •

edited

Loading

vercel bot commented Mar 8, 2024 •

edited

Loading

codesandbox-ci bot commented Mar 8, 2024 •

edited

Loading

dai-shi left a comment

dai-shi commented Mar 8, 2024

ojj1123 Mar 9, 2024

ojj1123 commented Mar 9, 2024 •

edited

Loading

dai-shi commented Mar 9, 2024

ojj1123 commented Mar 10, 2024 •

edited

Loading

dai-shi commented Mar 10, 2024

ojj1123 commented Mar 11, 2024

dai-shi left a comment

dai-shi Mar 11, 2024

ojj1123 Mar 12, 2024 •

edited

Loading

dai-shi Mar 12, 2024

dai-shi Mar 11, 2024

ojj1123 Mar 12, 2024

Aslemammad Mar 11, 2024

ojj1123 Mar 12, 2024

Aslemammad Mar 12, 2024

dai-shi Mar 12, 2024

Aslemammad Mar 11, 2024

ojj1123 Mar 12, 2024 •

edited

Loading

Aslemammad Mar 12, 2024

ojj1123 commented Mar 12, 2024

dai-shi commented Mar 12, 2024

ojj1123 commented Mar 12, 2024

dai-shi commented Mar 12, 2024

	typeof (err as { message?: unknown }).message === 'string'
	typeof err.message === 'string'

feat(create-waku): --example option #581

feat(create-waku): --example option #581

Conversation

ojj1123 commented Mar 8, 2024 • edited Loading

What features were added

What I want to discuss

vercel bot commented Mar 8, 2024 • edited Loading

codesandbox-ci bot commented Mar 8, 2024 • edited Loading

dai-shi left a comment

Choose a reason for hiding this comment

dai-shi commented Mar 8, 2024

Choose a reason for hiding this comment

ojj1123 commented Mar 9, 2024 • edited Loading

dai-shi commented Mar 9, 2024

ojj1123 commented Mar 10, 2024 • edited Loading

dai-shi commented Mar 10, 2024

ojj1123 commented Mar 11, 2024

dai-shi left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ojj1123 Mar 12, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ojj1123 Mar 12, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ojj1123 commented Mar 12, 2024

dai-shi commented Mar 12, 2024

ojj1123 commented Mar 12, 2024

dai-shi commented Mar 12, 2024

feat(create-waku): `--example` option #581

feat(create-waku): `--example` option #581

ojj1123 commented Mar 8, 2024 •

edited

Loading

vercel bot commented Mar 8, 2024 •

edited

Loading

codesandbox-ci bot commented Mar 8, 2024 •

edited

Loading

ojj1123 commented Mar 9, 2024 •

edited

Loading

ojj1123 commented Mar 10, 2024 •

edited

Loading

ojj1123 Mar 12, 2024 •

edited

Loading

ojj1123 Mar 12, 2024 •

edited

Loading