create-payload-canvas 0.6.1 → 0.7.0-next.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +5 -3
- package/dist/config.js +6 -3
- package/package.json +4 -3
package/README.md
CHANGED
|
@@ -6,7 +6,9 @@
|
|
|
6
6
|
|
|
7
7
|
Creates a new Payload CMS website builder project from the Payload Canvas starter.
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
This is the Payload 4 line (`create-payload-canvas@next`): projects get Payload 4 beta and `payload-canvas@next`. For Payload 3, use `create-payload-canvas@latest`.
|
|
10
|
+
|
|
11
|
+
Requirements: Node.js 24.22.1 or later, a running PostgreSQL server, and pnpm (npm works too). The starter itself is downloaded from GitHub, so the first run needs network access.
|
|
10
12
|
|
|
11
13
|
```bash
|
|
12
14
|
pnpm create payload-canvas my-website
|
|
@@ -69,7 +71,7 @@ For each feature that is off, the CLI deletes its files and its npm packages fro
|
|
|
69
71
|
| `--no-look`, `--no-nav`, `--no-dashboard`, `--no-demo`, `--no-ai`, `--no-gallery`, `--no-workflows` | Leave out a starter feature. See [Features](#features). `--no-demo` also turns off seeding. |
|
|
70
72
|
| `--reviews` | Add Google reviews, which is off by default. Every feature also takes `--<feature>` and `--no-<feature>`. |
|
|
71
73
|
| `--github` | Download the starter from GitHub, even when the CLI runs inside a checkout. |
|
|
72
|
-
| `--ref <name>` | Branch or tag to download. Default `main
|
|
74
|
+
| `--ref <name>` | Branch or tag to download. Default: the release tag of this CLI version (`v0.7.0-next.0` on the Payload 4 next line, `main` on the Payload 3 line). |
|
|
73
75
|
| `--packages <path>` | Path to a checkout of the repo. The CLI packs the `payload-canvas` package from there. |
|
|
74
76
|
| `-h`, `--help` | Show help. |
|
|
75
77
|
|
|
@@ -78,7 +80,7 @@ For each feature that is off, the CLI deletes its files and its npm packages fro
|
|
|
78
80
|
| Case | `payload-canvas` in the new project |
|
|
79
81
|
|---|---|
|
|
80
82
|
| The CLI runs inside a checkout, or you pass `--packages <path>` | a `file:./.tarballs/...` tarball, packed with `pnpm pack` (it builds `dist/` first). Commit `.tarballs/` with the project. |
|
|
81
|
-
| Neither | The version on npm (`^0.6.
|
|
83
|
+
| Neither | The version on npm (`^0.6.0`). |
|
|
82
84
|
|
|
83
85
|
Without `--packages`, and outside a checkout, the CLI checks the npm registry first. If the package is not on npm (for example, a `--ref` with an unreleased version), it stops before it writes any file and tells you to use `--packages <path>` or `--no-install`.
|
|
84
86
|
|
package/dist/config.js
CHANGED
|
@@ -1,15 +1,18 @@
|
|
|
1
1
|
// The GitHub repo that hosts Payload Canvas. Change it here if the repo moves.
|
|
2
2
|
export const GITHUB_OWNER = 'jon8800';
|
|
3
3
|
export const GITHUB_REPO = 'payload-canvas';
|
|
4
|
-
|
|
4
|
+
// The Payload 4 next line downloads the starter from its release tag, so a project matches the
|
|
5
|
+
// published `payload-canvas@next`. Keep it equal to `v${version}` of this package
|
|
6
|
+
// (scripts/check-next-release.mjs checks it). The Payload 3 line on `main` uses 'main'.
|
|
7
|
+
export const DEFAULT_REF = 'v0.7.0-next.0';
|
|
5
8
|
export const STARTER_SUBDIR = 'apps/starter';
|
|
6
9
|
// Guides that the starter's .env.example points to. They live at the repo root.
|
|
7
10
|
export const DOCS_SUBDIR = 'docs/ai';
|
|
8
11
|
export function tarballUrl(ref) {
|
|
9
12
|
return `https://codeload.github.com/${GITHUB_OWNER}/${GITHUB_REPO}/tar.gz/${ref}`;
|
|
10
13
|
}
|
|
11
|
-
// Version range for the payload-canvas package when it comes from npm.
|
|
12
|
-
export const PUBLISHED_VERSION = '^0.
|
|
14
|
+
// Version range for the payload-canvas package when it comes from npm: the Payload 4 next line.
|
|
15
|
+
export const PUBLISHED_VERSION = '^0.7.0-next.0';
|
|
13
16
|
// The package the starter depends on: its npm name and its folder under `packages/` in the repo.
|
|
14
17
|
export const BUILDER_PACKAGE = { name: 'payload-canvas', dir: 'payload-canvas' };
|
|
15
18
|
// Files and folders of the starter that only make sense inside the repo. The CLI does not copy them.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "create-payload-canvas",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.7.0-next.0",
|
|
4
4
|
"description": "Create a new Payload CMS website with Payload Canvas: the visual page builder, Postgres, a seeded demo and the AI guides.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"payload",
|
|
@@ -33,7 +33,8 @@
|
|
|
33
33
|
"LICENSE"
|
|
34
34
|
],
|
|
35
35
|
"publishConfig": {
|
|
36
|
-
"access": "public"
|
|
36
|
+
"access": "public",
|
|
37
|
+
"tag": "next"
|
|
37
38
|
},
|
|
38
39
|
"dependencies": {
|
|
39
40
|
"@clack/prompts": "^1.8.1",
|
|
@@ -49,7 +50,7 @@
|
|
|
49
50
|
"typescript": "^7.0.2"
|
|
50
51
|
},
|
|
51
52
|
"engines": {
|
|
52
|
-
"node": ">=
|
|
53
|
+
"node": ">=24.22.1"
|
|
53
54
|
},
|
|
54
55
|
"scripts": {
|
|
55
56
|
"build": "node -e \"require('node:fs').rmSync('dist',{recursive:true,force:true})\" && tsc",
|