feature: better frameworks like cli #115

vasucp1207 · 2023-08-03T05:14:12Z

Method like other frameworks use(mainly vue).

Cli including,

Dynamically project name.
Choose from different default templates.
Overriding the directory if it exits after confirmation.
Validates package name.

Should try to commit in #52 but I messed up and also thought it's a completely new strategy so I raised this PR instead.

vercel · 2023-08-03T05:14:15Z

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

Name	Status	Preview	Comments	Updated (UTC)
waku	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Sep 5, 2023 10:59pm

codesandbox-ci · 2023-08-03T05:14:29Z

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.

Latest deployment of this branch, based on commit 4c549d9:

Sandbox	Source
Vanilla	Configuration
Vanilla Typescript	Configuration
React	Configuration
React Typescript	Configuration

dai-shi · 2023-08-03T09:29:06Z

Does this cover #81?
Can you also take #89 into account?

vasucp1207 · 2023-08-03T12:37:36Z

Regarding #89 , templates only contain necessary files it does not include folders like node_modules etc. Well if you run npm run build a resulted out.cjs file is generated, but I can't figure out now how to publish it to npm to actually check it. Do you have any idea about this.

dai-shi · 2023-08-04T00:00:21Z

Regarding #89 , templates only contain necessary files it does not include folders like node_modules etc.

As I understand, #89's request is just to put .gitignore file in those templates.
But, on second thought, I'm not sure what should be in there.
Does create-vue generate .gitignore file?

dai-shi

One big issue for me is now we have to maintain both examples and templates.
As we are adding the "build" process, we should copy files from examples folder, instead of copying them.

contrib/create-waku/cli.js

contrib/create-waku/package.json

contrib/playground/README.md

vasucp1207 · 2023-08-04T06:17:29Z

Regarding #89 , templates only contain necessary files it does not include folders like node_modules etc.

As I understand, #89's request is just to put .gitignore file in those templates. But, on second thought, I'm not sure what should be in there. Does create-vue generate .gitignore file?

Yes, create-vue generates a .gitignore file, I think a minimal file is okay for this like create-vue .gitignore

dai-shi · 2023-08-04T12:55:49Z

contrib/create-waku/cli.js

+  let targetDir;
+  let defaultProjectName = 'waku-project'
+
+  const CHOICES = fs.readdirSync(path.resolve(cwd, '../../examples'))


This doesn't work as we don't publish examples dir.

We have two options.

add build step to copy examples dir

download from github

Eventually, we should go with 1 because it fixes #81, but for now 2 is also fine.
If we were to go with 1, we would like to make the code in TypeScript and transpile with SWC in the build step.

This doesn't work as we don't publish examples dir.

We have two options.

add build step to copy examples dir

download from github

Eventually, we should go with 1 because it fixes #81, but for now 2 is also fine. If we were to go with 1, we would like to make the code in TypeScript and transpile with SWC in the build step.

Using esbuild,

If we npm run build:esbuild an out.js file generated.

Running npm run build:estemplate generates an copy.js file.

If we run node copy.js templates copied from example dir and a template folder generated.

Finally, running node cli.js works fine.

Problem with transpiling with swr,

If we transpiling files with swr then the imports in output files are not working ex,

import { renderTemplate } from './renderTemplate'

This import statement would not be able to resolve the file.

Is, I'm missing something about this swr.

Okay, I don't mind using esbuild for now. I just thought SWC might work better and we also use it in waku. We can try that later.

Can you move TS files into ./src folder please?

Yeah, sure we can look around it in the near future.

dai-shi · 2023-08-31T10:40:16Z

Please check CI errors.

packages/create-waku/package.json

dai-shi

Please check CI errors again.

packages/create-waku/package.json

packages/create-waku/src/cli.ts

packages/create-waku/package.json

dai-shi · 2023-09-05T22:57:34Z

packages/create-waku/package.json

+    "dist",
+    "template"
+  ],
+  "type": "commonjs",


Future TODO: make type=module and use swc instead of esbuild.

Sure, I will take look into this.

packages/create-waku/src/cli.ts

dai-shi

Let's merge it. Feel free to work on improvements later.

dai-shi · 2023-09-11T11:04:28Z

https://www.npmjs.com/package/create-waku/v/0.5.1 is published.
@vasucp1207 Can you please check if it works as expected?

better cli

a78b815

vercel bot deployed to Preview August 3, 2023 05:14 View deployment

playground

abc2096

vercel bot deployed to Preview August 3, 2023 08:46 View deployment

vasucp1207 added 2 commits August 3, 2023 17:55

build project

04cdc5c

build project

c81c506

vercel bot deployed to Preview August 3, 2023 12:27 View deployment

dai-shi requested changes Aug 4, 2023

View reviewed changes

contrib/create-waku/cli.js Outdated Show resolved Hide resolved

contrib/create-waku/cli.js Outdated Show resolved Hide resolved

contrib/create-waku/package.json Outdated Show resolved Hide resolved

contrib/create-waku/package.json Outdated Show resolved Hide resolved

dai-shi reviewed Aug 4, 2023

View reviewed changes

contrib/playground/README.md Outdated Show resolved Hide resolved

remove esbuild templates

78551d2

vercel bot deployed to Preview August 4, 2023 05:58 View deployment

remove esbuild templates

51df8a4

vercel bot deployed to Preview August 4, 2023 05:58 View deployment

vasucp1207 requested a review from dai-shi August 4, 2023 06:18

update test

1bdaba8

vercel bot deployed to Preview August 4, 2023 06:35 View deployment

dai-shi reviewed Aug 4, 2023

View reviewed changes

trying building the package

1d36e1e

vercel bot deployed to Preview August 5, 2023 12:15 View deployment

trying building the package

c387dcd

vercel bot deployed to Preview August 5, 2023 12:15 View deployment

vasucp1207 requested a review from dai-shi August 5, 2023 12:29

move files to scr/ folder

82cd7ac

vercel bot deployed to Preview August 6, 2023 10:31 View deployment

new monorepo structure

b7f030c

vasucp1207 force-pushed the better-cli branch from 4b10c9d to b7f030c Compare August 30, 2023 19:50

vercel bot had a problem deploying to Preview August 30, 2023 19:51 Failure

update dir structure

f025623

vercel bot had a problem deploying to Preview August 30, 2023 19:52 Failure

Update package.json

6b990b3

vercel bot had a problem deploying to Preview August 30, 2023 19:55 Failure

update pnpm yaml

472d830

vercel bot deployed to Preview September 2, 2023 17:33 View deployment

vasucp1207 requested a review from dai-shi September 2, 2023 17:35

dai-shi reviewed Sep 3, 2023

View reviewed changes

packages/create-waku/package.json Outdated Show resolved Hide resolved

Update packages/create-waku/package.json

31792f0

vercel bot deployed to Preview September 3, 2023 00:20 View deployment

dai-shi requested changes Sep 3, 2023

View reviewed changes

packages/create-waku/package.json Outdated Show resolved Hide resolved

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

packages/create-waku/package.json Show resolved Hide resolved

types for fs-extra

2a52aac

vercel bot deployed to Preview September 3, 2023 18:48 View deployment

Update types.d.ts

81a54d0

vercel bot deployed to Preview September 3, 2023 18:50 View deployment

fix prettier issue

016f005

vercel bot deployed to Preview September 4, 2023 22:06 View deployment

Update .gitignore

47e71fa

vercel bot deployed to Preview September 5, 2023 18:46 View deployment

vasucp1207 requested a review from dai-shi September 5, 2023 18:47

dai-shi reviewed Sep 5, 2023

View reviewed changes

Update packages/create-waku/src/cli.ts

4c549d9

vercel bot deployed to Preview September 5, 2023 22:59 View deployment

dai-shi approved these changes Sep 9, 2023

View reviewed changes

dai-shi merged commit 56b8162 into dai-shi:main Sep 11, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feature: better frameworks like cli #115

feature: better frameworks like cli #115

vasucp1207 commented Aug 3, 2023 •

edited

Loading

vercel bot commented Aug 3, 2023 •

edited

Loading

codesandbox-ci bot commented Aug 3, 2023 •

edited

Loading

dai-shi commented Aug 3, 2023

vasucp1207 commented Aug 3, 2023

dai-shi commented Aug 4, 2023

dai-shi left a comment

vasucp1207 commented Aug 4, 2023

dai-shi Aug 4, 2023

vasucp1207 Aug 5, 2023 •

edited

Loading

dai-shi Aug 6, 2023

vasucp1207 Aug 6, 2023

dai-shi commented Aug 31, 2023

dai-shi left a comment

dai-shi Sep 5, 2023

vasucp1207 Sep 6, 2023

dai-shi left a comment

dai-shi commented Sep 11, 2023

feature: better frameworks like cli #115

feature: better frameworks like cli #115

Conversation

vasucp1207 commented Aug 3, 2023 • edited Loading

Cli including,

vercel bot commented Aug 3, 2023 • edited Loading

codesandbox-ci bot commented Aug 3, 2023 • edited Loading

dai-shi commented Aug 3, 2023

vasucp1207 commented Aug 3, 2023

dai-shi commented Aug 4, 2023

dai-shi left a comment

Choose a reason for hiding this comment

vasucp1207 commented Aug 4, 2023

dai-shi Aug 4, 2023

Choose a reason for hiding this comment

vasucp1207 Aug 5, 2023 • edited Loading

Choose a reason for hiding this comment

dai-shi Aug 6, 2023

Choose a reason for hiding this comment

vasucp1207 Aug 6, 2023

Choose a reason for hiding this comment

dai-shi commented Aug 31, 2023

dai-shi left a comment

Choose a reason for hiding this comment

dai-shi Sep 5, 2023

Choose a reason for hiding this comment

vasucp1207 Sep 6, 2023

Choose a reason for hiding this comment

dai-shi left a comment

Choose a reason for hiding this comment

dai-shi commented Sep 11, 2023

vasucp1207 commented Aug 3, 2023 •

edited

Loading

vercel bot commented Aug 3, 2023 •

edited

Loading

codesandbox-ci bot commented Aug 3, 2023 •

edited

Loading

vasucp1207 Aug 5, 2023 •

edited

Loading