WIP: (refactor): Templates management and workflows #6

JayaKrishnaNamburu · 2023-07-29T16:44:28Z

closes #5

Now, the cli has three commands, sync, link, build. Here is the workflow that this aims to solve.

Creating a new project

Users deploy a project in the studio (I am not sure, if this limitation can be removed).
Then webstudio link <url> links the project and adds to the global configuration.
webstudio build <projectId> clone the project locally by creating a folder webstudio-projectand then saves the project data aswebstudio.json` inside the project.
Once the build it is, it is ready to be hosted.

Managing the existing project

Since the project is already linked, the link steps is not needed anymore.
Then we can run webstudio sync inside the project. If the users want to decide to just sync the data.
webstudio buil builds the project once again. The above step webstudio sync is not mandatory. Since during the webstudio build command the cli sync's the project anyways with the latest data.

TODO:

Download all the assets, so they can be hosted on their own. Right now, assets don't work at all.
Decide if the cli needs hosting integrated in the first iteration.
the function executeComputingExpressions is needed for Instace component. But currently we are not sending it now. Need to see why it is needed.

Added authToken instead of session token

add package manager detection

fix suggestions

JayaKrishnaNamburu · 2023-07-29T16:56:39Z

package.json

@@ -6,33 +6,34 @@
  "repository": "[email protected]:webstudio-is/webstudio-cli.git",
  "homepage": "https://webstudio.is",
  "scripts": {
-    "dev": "pnpm build --watch",
-    "prebuild": "tsx ./lib/prebuild.js",


the prebuild script is needed for building the project. But this way, this is going to go as a project script instead of running inside users project. So, this need to be run as a build step inside users project folder.

JayaKrishnaNamburu · 2023-07-29T16:57:06Z

package.json

    "format": "prettier --write \"**/*.{ts,tsx,md}\"",
    "build": "pnpm format && pnpm clean && esbuild ./src/* --outdir=./lib --platform=node",
    "clean": "rm -fr ./lib"
  },
  "type": "module",
  "bin": {
-    "webstudio": "./bin/cli.sh"


bin/cli.js is enough, the cli don't need to have .sh script

JayaKrishnaNamburu · 2023-07-29T16:59:03Z

bin/cli.js

@@ -1,4 +1,4 @@
-#!/usr/bin/env node
+#!/usr/bin/env node --experimental-specifier-resolution=node


The cli is written in ecam modules. And they are being disctributed without any build step. But after node@18 node needs .js extension to resolve any file. Because they introduced support for .mjs extension. This works fine when the project is not using any deps. But in this case we have many dependencies for the cli which don't use .js. This flag let's the node that it can resolve them without using .js extension.

kof · 2023-07-30T14:48:02Z

src/templates.ts

@@ -0,0 +1,84 @@
+/*


please use __generated__ folder like we do in the builder repo

kof · 2023-07-30T14:52:01Z

src/sync.ts

@@ -1,51 +1,39 @@
-import { loadProject } from "@webstudio-is/http-client";


why is it being removed? the idea is that http-client is ALWAYS used to access the API from both: saas deployment and CLI ...

No clue, got this from my upstream branch

istarkov · 2023-07-30T16:19:43Z

Having this repo out of main repo would cause same issues we permanently have in SaaS repo.
As no change in the main monorepo somehow affects developer to do fixes here.

So the plan is to move the cli into the main monorepo under the apps/cli directory.
And let's do move using smallest possible PRs.

I see move steps like.

Move only parsing and command execution logic. Like it's done in wrangler or similar tools.
Source of inspiration
No need to use yargs etc, naive node parser is ok. The idea is to universally add any command to the cli.
Should be small simple PR.
Add command by command. Single/Multiple small PR/PRs for each.
2.1. link, config
2.2 sync json
2.3 sync artifacts
2.4 Create build for ${PLATFORM:-vercel}
2.4 add remix build of some existing project to github action/vercel so at every PR we will know that publishing is working (for simplicity we do not add publish button support to monorepo, we just publish any single existing project during PR build/checks/deploy)
2.5 PLATFORM=nextPlatform(); GOTO 2.4

cc @TrySound @kof

TrySound · 2023-07-30T16:34:42Z

please use node native import { parseArgs } from 'node:util' for parsing arguments
we want our cli to be small in example for others

JayaKrishnaNamburu · 2023-08-01T06:40:23Z

@TrySound and @istarkov right now the cli is using the same from node:util should we keep it the same or move to yargs or something ??
https://github.com/webstudio-is/webstudio-cli/blob/refactor/new-cli/src/index.ts#L22

TrySound · 2023-08-01T07:33:18Z

ah, good. keep it

kof · 2023-08-06T09:46:33Z

Just to inform: we decided this PR can't be merged and we will rewrite this PR in small chunks as part of the builder monorepo package. One PR at a time

Follow progress here https://github.com/webstudio-is/webstudio-builder/pulls?q=is%3Apr+label%3Aarea%3Acli+

## Description This PR moves the cli from `apps/cli` into `packages` folder. It was initially started under `app/cli` from this [comment](webstudio-is/webstudio-cli#6 (comment)). But looks like, `packages` is the good place for it.

andrasbacsai and others added 25 commits June 20, 2023 13:05

init

18bb701

wip

eb89645

add default sitedata for testing

16606d0

wip

fda0e35

wip

7a734f0

Added all templates

e9ac0ba

Added authToken instead of session token

Add help, debug flags

f8122fd

Update README.md

4755e9b

wip

cbb62fb

fix endpoint

dadaeee

update lock file

4c12898

wip

bc9de6f

wip

002f444

remove serve command

092f6a2

add package manager detection

fix: wrong args given

c41cff0

readme update

05e5a78

readme update

ddf6d3f

fix

f7a5542

Add eslint + prettier

abbab52

fix suggestions

fix: imports

7dd3be8

prettier

217a2aa

(refactor): Refactor new version of cli

3946aab

Full refactor of prebuild and finally some projects started building

c5a5153

some more clean up and add remix-starter-app

de00038

Refactor and improve the workflow with the build and sync

e303bf3

JayaKrishnaNamburu changed the title ~~(refactor): Templates management and workflows~~ WIP: (refactor): Templates management and workflows Jul 29, 2023

JayaKrishnaNamburu commented Jul 29, 2023

View reviewed changes

JayaKrishnaNamburu self-assigned this Jul 29, 2023

Download image assets locally

eb57d0d

JayaKrishnaNamburu linked an issue Jul 29, 2023 that may be closed by this pull request

Workflow and use-cases #5

Open

TrySound changed the base branch from new-cli to main July 30, 2023 10:25

kof reviewed Jul 30, 2023

View reviewed changes

src/templates.ts

@@ -0,0 +1,84 @@

/*

Copy link

Member

kof Jul 30, 2023

Choose a reason for hiding this comment

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

please use __generated__ folder like we do in the builder repo

kof reviewed Jul 30, 2023

View reviewed changes

kof closed this Aug 6, 2023

JayaKrishnaNamburu mentioned this pull request Aug 27, 2023

Moving cli from apps folder into packages folder webstudio-is/webstudio#2198

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

WIP: (refactor): Templates management and workflows #6

WIP: (refactor): Templates management and workflows #6

JayaKrishnaNamburu commented Jul 29, 2023 •

edited

Loading

JayaKrishnaNamburu Jul 29, 2023

JayaKrishnaNamburu Jul 29, 2023

JayaKrishnaNamburu Jul 29, 2023

kof Jul 30, 2023

kof Jul 30, 2023

JayaKrishnaNamburu Aug 1, 2023

istarkov commented Jul 30, 2023 •

edited

Loading

TrySound commented Jul 30, 2023 •

edited

Loading

JayaKrishnaNamburu commented Aug 1, 2023

TrySound commented Aug 1, 2023

kof commented Aug 6, 2023

		@@ -1,4 +1,4 @@
		#!/usr/bin/env node
		#!/usr/bin/env node --experimental-specifier-resolution=node

		@@ -1,51 +1,39 @@
		import { loadProject } from "@webstudio-is/http-client";

WIP: (refactor): Templates management and workflows #6

WIP: (refactor): Templates management and workflows #6

Conversation

JayaKrishnaNamburu commented Jul 29, 2023 • edited Loading

Creating a new project

Managing the existing project

JayaKrishnaNamburu Jul 29, 2023

Choose a reason for hiding this comment

JayaKrishnaNamburu Jul 29, 2023

Choose a reason for hiding this comment

JayaKrishnaNamburu Jul 29, 2023

Choose a reason for hiding this comment

kof Jul 30, 2023

Choose a reason for hiding this comment

kof Jul 30, 2023

Choose a reason for hiding this comment

JayaKrishnaNamburu Aug 1, 2023

Choose a reason for hiding this comment

istarkov commented Jul 30, 2023 • edited Loading

TrySound commented Jul 30, 2023 • edited Loading

JayaKrishnaNamburu commented Aug 1, 2023

TrySound commented Aug 1, 2023

kof commented Aug 6, 2023

JayaKrishnaNamburu commented Jul 29, 2023 •

edited

Loading

istarkov commented Jul 30, 2023 •

edited

Loading

TrySound commented Jul 30, 2023 •

edited

Loading