The webstone-plugins from webstonehq

Wrap up the `create-webstone-app` script

Set up docs infrastructure

A few requirements:

docs directory at the root of this repo as an entry point
Each packages/* package contains a README.md which acts as the main docs entry point for a given package
Each packages/* package contains its own docs directory for additional documentation that does not fit into the package's README.md
~~packages/cli/docs/commands/* should be auto-generated and updated with a pre-commit git hook. One file per command.~~
- Not worth the effort at this point.
Update console message with link to correct docs (webstone/packages/cli/src/commands/deploy/web.ts)
Content written in Markdown
For v1, no need for docs to be hosted on any domain

Document how anyone can contribute Webstone CLI commands

A key requirement for the Webstone CLI has been to simplify contributions. The CLI scans the node_modules directory and looks for Gluegun Plugins named webstone-cli-* (see code)

Tasks:

Mark 3rd party plugins as visible (code)

Develop `webstone web delete page <name>`

Blocked by #75

Consolidate & clean up dependencies

#106 brought to light that there's a bit of a mess with dependencies.

For example, we have 2 different versions of prettier.

Let's review the PR, clean that up (we do use pnpm after all 😉) and merge main into #106 to see if Renovate bot decides to open fewer than 24 PRs.

Create a unit testing infrastructure for the framework

Read https://shift.infinite.red/integration-testing-interactive-clis-93af3cc0d56f

Requirements

pnpm test at the root tests all packages
Each package provides its own test NPM script
Tests run as a pre-commit git hook, only for packages that have changed compared to the main branch
All tests (i.e. pnpm test at the root) run as a GitHub Action for each pull request

Keep the `create-webstone-app` template dependency on `core` updated

Create a testing infrastructure for any Webstone app

This is to ensure every Webstone app comes with a testing framework configured and ready to be extended by developers as they work on their application.

For e2e tests, we'll use ~~Cypress~~ Playwright.
For unit tests, we'll use uvu.

Discord link in readme is expired

`pnpm init webstone-app` outputs `TimeoutOverflowWarning` messages

Creating app directory...
Copying template...
Installing web app in test/services/web...
Installing dependencies...
Scope: all 2 workspace projects
(node:3540) TimeoutOverflowWarning: Infinity does not fit into a 32-bit signed integer.
Timeout duration was set to 1.
(Use `node --trace-warnings ...` to show where the warning was created)
(node:3540) TimeoutOverflowWarning: Infinity does not fit into a 32-bit signed integer.
Timeout duration was set to 1.

Develop `webstone dev web`

Update the documentation
Update the create-webstone-app console output when the command completes (use webstone dev instead of pnpm dev)

Provide an alias for each command

Some examples:

ws w c p <name> => webstone web create page <name>
ws w d p <name> => webstone web delete page <name>

Not all commands need an alias, e.g. deploy is short enough.

The `webstone-dev-app` does not get created in the Gitpod prebuild phase

From an initial investigation, it looks like the content of webstone-dev-app/services/web is either not generated in the prebuild or lost between the prebuild and the workspace startup.

Enable the Begin / Architect `web` adapter

Blocked by architect/architect#1236

Provide CLI autocompletion

Investigate https://github.com/f/omelette

Set up package publishing process

Implement a process to auto-generate changelogs and publish packages to NPM.

Be more specific with the template `copy` filter

We don't want template/node_modules to be copied, this causes problems for contributors. The filter we added recently took care of that, but now that the template is ignored as a pnpm workspace package, we no longer need the filter.

Document the package release process

Only allow `pnpm`

Some projects work with npm, some with yarn. Some ensure you can use both package managers.

Webstone requires pnpm and is not tested with any other package manager.

Hence, let's implement https://pnpm.io/only-allow-pnpm and update the documentation accordingly.

Provide the monorepo structure & add the first draft of the Webstone template

Introduce a framework to develop the `@webstone/cli` commands

Requirements

Sub-commands (e.g. ws web configure tailwind)
Automatically generated ws --help
Create new files based on templates (see https://plopjs.com/ for example)

Available CLI tools

plop
oclif
yargs
commander.js
inquirer.js
gluegun ✔️
Any others?

Fix the `cli` release process

See https://github.com/WebstoneHQ/webstone/runs/4419990481?check_suite_focus=true

Develop `webstone deploy web`

Blocked by #77

Ensure an adapter is installed before deploying
- If none is found, suggest webstone web configure deployment
Accept a --preview flag to run
- pnpm build --filter ./services/web
- pnpm preview --filter ./services/web

Document the backstory in the `README`

Don't use `workspace:*` in the template

Alright I should have seen that coming, using workspace:* in the template clearly doesn't work 😉. Let's try with the actual dependency version number and keep the template as part of the pnpm workspace.

Ideally, we get to a point where the CLI dependency for the template is updated automatically when a new release of the CLI happens. Can't be that hard, eh?

Use `listr2` to visualize the project creation progress

Docs: https://www.npmjs.com/package/listr2

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Rate-Limited

These updates are currently rate-limited. Click on a checkbox below to force their creation now.

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

Ignored or Blocked

These are blocked by an existing closed PR and will not be recreated unless you click a checkbox below.

chore(deps): update dependency typescript to ^4.9.5

Detected dependencies

github-actions

.github/workflows/release.yml

jetpack-io/devbox-install-action v0.5.0

changesets/action v1

npm

package.json

@changesets/cli ^2.26.2

@playwright/test ^1.37.0

@svitejs/changesets-changelog-github-compact ^1.1.0

@types/fs-extra ^11.0.1

@types/node 20.4.10

@types/sinon ^10.0.16

@typescript-eslint/eslint-plugin ^6.2.1

@typescript-eslint/parser ^6.2.1

c8 ^8.0.1

commitizen ^4.3.0

cz-conventional-changelog ^3.3.0

eslint ^8.46.0

eslint-config-prettier ^9.0.0

husky ^8.0.3

lint-staged ^13.2.3

prettier ^3.0.1

sinon ^15.2.0

tsx ^3.12.7

typescript ^5.1.6

uvu ^0.5.6

node >=v20

packages/cli/package.json

@webstone/gluegun ^0.0.5

npm-watch ^0.11.0

node >=v20

packages/core/package.json

tsup ^6.7.0

packages/create-webstone-app/package.json

chalk 5.3.0

create-svelte ^5.0.5

enquirer 2.4.1

fs-extra 11.1.1

ts-deepmerge ^6.2.0

@types/node 20.4.10

tsup ^6.7.0

type-fest ^4.2.0

typescript ^5.1.6

packages/plugin-request-logger/package.json

@playwright/test ^1.37.1

@sveltejs/adapter-auto ^2.1.0

@sveltejs/kit ^1.22.6

@sveltejs/package ^2.2.1

@typescript-eslint/eslint-plugin ^6.4.0

@typescript-eslint/parser ^6.4.0

@webstone/gluegun 0.0.5

eslint ^8.47.0

eslint-config-prettier ^9.0.0

eslint-plugin-svelte ^2.32.4

fs-jetpack ^5.1.0

nodemon ^3.0.1

npm-run-all ^4.1.5

prettier ^3.0.2

prettier-plugin-svelte ^3.0.3

publint ^0.2.1

rimraf ^5.0.1

svelte ^4.2.0

svelte-check ^3.5.0

tslib ^2.6.2

tsup ^7.2.0

typescript ^5.1.6

vite ^4.4.9

vitest ^0.34.2

svelte ^4.0.0

packages/plugin-trpc/cli/package.json

@mrleebo/prisma-ast ^0.4.3

ts-morph ^17.0.1

@webstone/gluegun ^0.0.5

copyfiles ^2.4.1

npm-run-all ^4.1.5

npm-watch ^0.11.0

prettier ^2.8.8

rimraf ^3.0.2

typescript ^4.7.4

packages/plugin-trpc/web/package.json

@trpc/client ^10.37.1

@trpc/server ^10.37.1

zod ^3.21.4

@playwright/test ^1.37.0

@sveltejs/adapter-auto ^2.1.0

@sveltejs/kit ^1.22.5

@sveltejs/package ^2.2.1

@typescript-eslint/eslint-plugin ^6.3.0

@typescript-eslint/parser ^6.3.0

eslint ^8.46.0

eslint-config-prettier ^9.0.0

eslint-plugin-svelte3 ^4.0.0

prettier ^3.0.1

prettier-plugin-svelte ^3.0.3

svelte ^4.1.2

svelte-check ^3.4.6

tslib ^2.6.1

typescript ^5.1.6

vite ^4.4.9

Check this box to trigger a request for Renovate to run again on this repository

Configure Gitpod

Switch to pnpm

Fixes the broken release workflow for #4 and makes monorepo management easier.

Clean up `.gitpod.yml`

Experiment with a cleaner approach to the tasks defined in .gitpod.yml

Install & configure Renovate

See https://github.com/renovatebot/renovate

Document the CLI command & sub-command hierarchy

Blocked by #87

Before we dive into developing the API, let's define & document its hierarchy. Due to its complexity in later versions, there is likely not a single pattern we can follow.

Requirements

As few keystrokes as possible (i.e. provide an alias wherever possible)
Smart defaults, can be overwritten via CLI flags
Each error must provide a link to docs explaining the error and how to resolve it

Service commands
Commands specific to a given service (located in services/*)

Pattern: webstone <service> <action> <arguments>
Examples:

webstone web svelte-add tailwind|mdsvex|auth|payment
webstone web create page about-us
webstone db create model team
webstone db update model team
webstone db delete model team
webstone api create team

Development commands
Commands solely related to development, either for Webstone itself or for a Webstone app

Pattern: webstone dev <category> <action>
Examples:

webstone dev [service]
webstone dev gitpod web-patch-svelte-config-js
webstone dev stats [service]
- Various "fun fact" statistics about the application. Things like # of routes, # of DB models, total web bundle size for different routes, ...

Deployment commands
Commands needed to deploy a Webstone app

Pattern: webstone deploy [service]
Examples:

webstone deploy
webstone deploy web

Combine `changeset` & `pnpm install`

Install `typescript-eslint` at the root and run automatically

Develop `webstone web configure deployment <name>`

Read <name> or provide choices to pick from if <name> is missing
If an adapter is already installed, prompt the user to replace it and do so automatically if confirmed by the user
Install the correct adapter NPM package
Display a post-install link to the adapter's configuration docs. The steps differ among adapters, let a human do it

Challenge
When the CLI is linked into the webstone-dev-app project, the link is overwritten when the CLI runs a pnpm add command.

Figure out a way to execute the pnpm link command in development mode after a pnpm add
- Solution: Use pnpm add -w -D ../webstone/packages/cli instead

Configure SvelteKit's HMR on Gitpod

Create an e2e testing infrastructure for the framework

Requirements

Use Cypress
Run pnpm test:e2e for every Gitpod workspace
~~The e2e tests must create the webstone-dev-app currently created via CLI in the .gitpod.yml file~~
- Overkill, it's ok to use the create-webstone-app script directly

Use the latest dependency versions

Due to changesets/changesets#585, the most recent release failed (logs).

Let's use fixed dependency versions until the above PR is merged.

Add the Webstone CLI to the app template

Tasks

Add the @webstone/cli dependency to the @webstone/core package
Add the @webstone/core dependency to the web app template package.json
- This needs to be done in the create-webstone-app init script after the Sveltekit init script completes
Add a dev script to the app template package.json that starts the web (and later the api) services
- Something like "dev": "webstone dev"

Add the v1 CLI commands

Please refer to #66 for patterns on how to structure the CLI.

For v1 of Webstone, the following CLI commands are required:

Skip `commitizen` in a CI environment

This is to avoid the GitHub workflow failure as seen in this case.

Extend `@webstone/cli` to wrap `svelte-add`

The svelte-add project (repo link) is a convenient way to configure various things in SvelteKit apps, e.g. Tailwind CSS, mdsvex, etc.

The Webstone CLI should provide a command which acts as a thin wrapper around svelte-add. For example, webstone web configure tailwind is a wrapper for npx svelte-add@latest tailwindcss (docs).

Update: Since this is the first CLI command, let's also set us up for success as we add more commands. See best practices docs.

Learn more about conventional commits at https://www.conventionalcommits.org
Follow the "Optional: Running Commitizen on git commit" chapter
Configure the "scope" to match the package names, plus "webstone" for the root package and general project-wide changes

Write the package README.md
Connect the CLI to the template, via the @webstone/core package
~~Develop the webstone dev command (which for now starts the web service)~~
- Instead, we leverage pnpm and dev scripts in the services' package.json file. This may turn out to be confusing or not powerful enough, at which time we can revisit this decision.

webstonehq / webstone-plugins Goto Github PK

webstone-plugins's People

Contributors

Stargazers

Watchers

Forkers

webstone-plugins's Issues

Rate-Limited

Open

Ignored or Blocked

Detected dependencies

Recommend Projects

Recommend Topics

Recommend Org