create-payload-canvas 0.5.1 → 0.6.0

package/README.md

@@ -27,7 +27,7 @@ The CLI asks for the project name, your Postgres details, which starter features
 5. Sets the package name, removes the repo-only scripts and the dev dependencies they needed, and points `payload-canvas` at a source (see below).
 6. Writes `.env` from `.env.example` with your `DATABASE_URL` and a new random `PAYLOAD_SECRET`.
 7. Creates the database.
-8. Installs dependencies with pnpm (npm if pnpm is missing).
+8. Installs dependencies with pnpm (npm if pnpm is missing), then writes `src/payload-types.ts` again for the kept features.
 9. Runs `seed:demo` if you chose to seed. On a fresh database the seed creates the tables. Without the demo seed, it runs `seed:classes`, which adds the editable classes that the ready-made sections use.
 10. Prints a summary with the exact next commands.
 
@@ -35,17 +35,20 @@ It never runs `payload migrate`. Local development uses `push: true`, so the sch
 
 ## Features
 
-The starter has a few parts you can leave out. All of them are kept by default. Without `--yes`, the CLI shows a list with all of them checked. Uncheck the ones you do not want. A `--no-<feature>` flag leaves a feature out without asking.
+The starter has a few optional parts. Google reviews is off by default; all the others are on. Without `--yes`, the CLI shows a list with the default ones checked. Check or uncheck the ones you want. A `--<feature>` flag adds a feature and a `--no-<feature>` flag leaves it out, without asking.
 
-| Feature | Flag | What you lose |
+| Feature | Flag | What it changes |
 |---|---|---|
-| Admin look | `--no-look` | Neutral colors and finer details in the admin (`src/admin/look`). |
+| Admin look | `--no-look` | Neutral colors and finer details in the admin (`src/admin/look`), status badges and list cells by field type (`src/admin/list`), and array rows named by their content (`src/admin/fields`). |
 | Sidebar navigation | `--no-nav` | The grouped sidebar with icons (`src/admin/nav`). The admin uses Payload's default sidebar. |
-| Dashboard widgets | `--no-dashboard` | Quick actions, recent edits, drafts, form messages, site checks, scheduled publishes and analytics (`src/admin/dashboard`). The admin shows Payload's collection cards. |
+| Dashboard widgets | `--no-dashboard` | Quick actions, recent edits, open comments, form messages, site checks, broken links (404s and links to missing pages), unused media (with a full list at `/admin/unused-media`), scheduled publishes and analytics; "Waiting to publish" can be added (`src/admin/dashboard`). The reference index behind unused media and broken links (`src/admin/references`, `pnpm references:rebuild`). The admin shows Payload's collection cards. |
 | Demo content | `--no-demo` | The demo pages, posts and images seed (`scripts/seed-demo.ts` and the `seed:demo` script). This also turns off seeding. |
 | AI assistant | `--no-ai` | The chat panel in the page builder, and its settings in `.env`. |
+| Media gallery | `--no-gallery` | Media as a grid of thumbnails with a lightbox and drag-and-drop upload ([`payload-media-gallery`](https://www.npmjs.com/package/payload-media-gallery)). Without it, Media uses Payload's table. |
+| Workflows | `--no-workflows` | The visual workflow builder (Automation → Workflows), the Run tab on jobs, and the starter tasks in `src/jobs` ([`payload-workflows`](https://www.npmjs.com/package/payload-workflows)). |
+| Google reviews | `--reviews` (off by default) | Adds a Reviews collection and Review Settings that sync a Google place's reviews ([`payload-google-reviews`](https://www.npmjs.com/package/payload-google-reviews), with the optional scraper). You set the place in the admin after setup. |
 
-The CLI deletes the feature's files and removes its lines from `src/payload.config.ts`, `src/app/(payload)/custom.scss`, `.env.example` and the admin import map. The project type-checks with any mix of features.
+For each feature that is off, the CLI deletes its files and its npm packages from `package.json`, and removes its lines from `src/payload.config.ts`, `next.config.ts`, `src/app/(payload)/custom.scss`, `.env.example`, `README.md` and the admin import map. After the install it runs `generate:types`, so `src/payload-types.ts` matches the kept features. The project type-checks with any mix of features.
 
 ## Flags
 
@@ -63,7 +66,8 @@ The CLI deletes the feature's files and removes its lines from `src/payload.conf
 | `--skip-db` | Do not connect to Postgres. Writes `.env` only. This also skips seeding. |
 | `--seed` / `--no-seed` | Seed demo content, or not. |
 | `--no-install` | Do not install. This also skips seeding. |
-| `--no-look`, `--no-nav`, `--no-dashboard`, `--no-demo`, `--no-ai` | Leave out a starter feature. See [Features](#features). `--no-demo` also turns off seeding. |
+| `--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. |
+| `--reviews` | Add Google reviews, which is off by default. Every feature also takes `--<feature>` and `--no-<feature>`. |
 | `--github` | Download the starter from GitHub, even when the CLI runs inside a checkout. |
 | `--ref <name>` | Branch or tag to download. Default `main`. |
 | `--packages <path>` | Path to a checkout of the repo. The CLI packs the `payload-canvas` package from there. |
@@ -74,7 +78,7 @@ The CLI deletes the feature's files and removes its lines from `src/payload.conf
 | Case | `payload-canvas` in the new project |
 |---|---|
 | 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. |
-| Neither | The version on npm (`^0.5.1`). |
+| Neither | The version on npm (`^0.6.0`). |
 
 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`.
 
@@ -93,6 +97,9 @@ npx create-payload-canvas my-website --yes --no-install --skip-db
 # Without the AI assistant and the demo content
 npx create-payload-canvas my-website --yes --no-ai --no-demo
 
+# With Google reviews, without the media gallery and workflows
+npx create-payload-canvas my-website --yes --reviews --no-gallery --no-workflows
+
 # From GitHub, with the package from a local checkout (before it is published)
 npx create-payload-canvas my-website --yes --github --packages C:\code\payload-canvas
 
@@ -130,7 +137,7 @@ If the copy or pack step fails, the CLI deletes the half-made folder. If the ins
 ## Maintainers
 
 - The GitHub owner is `GITHUB_OWNER` in `src/config.ts`. The list of files the CLI leaves out is `SKIP_NAMES` and `SKIP_PATHS` in the same file.
-- The starter's `starter-features.json` lists each feature's files and scripts. In code, a line with `@feature:<id>` starts a part that belongs to a feature, and a line with `@end:<id>` ends it. The prompt and the flags come from `FEATURES` in `src/config.ts`. Add a new feature in both places.
+- The starter's `starter-features.json` lists each feature's files, scripts and npm `dependencies`. In code, a line with `@feature:<id>` starts a part that belongs to a feature, and a line with `@end:<id>` ends it (in Markdown, inside an HTML comment). The prompt, the flags and the default (`on`) come from `FEATURES` in `src/config.ts`. Add a new feature in both places.
 - `pnpm check:features` copies the starter for every mix of features, applies it, and runs the starter's TypeScript check. Run it after you change a feature. `pnpm test` runs the unit tests.
 - After copying, the CLI checks the new project for leftovers (`workspace:` links, paths into `packages/`, `baseUrl`, Docker files) and prints a warning for each one it finds.
 - Build with `pnpm build`. Run from the repo with `node dist/index.js`. `pnpm pack` builds first (`prepack`).

package/dist/config.js

@@ -9,7 +9,7 @@ export function tarballUrl(ref) {
     return `https://codeload.github.com/${GITHUB_OWNER}/${GITHUB_REPO}/tar.gz/${ref}`;
 }
 // Version range for the payload-canvas package when it comes from npm.
-export const PUBLISHED_VERSION = '^0.5.1';
+export const PUBLISHED_VERSION = '^0.6.0';
 // The package the starter depends on: its npm name and its folder under `packages/` in the repo.
 export const BUILDER_PACKAGE = { name: 'payload-canvas', dir: 'payload-canvas' };
 // Files and folders of the starter that only make sense inside the repo. The CLI does not copy them.
@@ -34,14 +34,21 @@ export const SKIP_NAMES = new Set([
     'docker-compose.yml',
 ]);
 // Paths relative to the starter folder.
-export const SKIP_PATHS = ['scripts/setup.ts', 'scripts/lib/create-database.ts', 'scripts/lib/generate-env.ts', 'docs/qa'];
-// Starter features the user can turn off. The CLI asks about these and has a `--no-<id>` flag for each.
-// The starter's `starter-features.json` says which files, config lines and scripts belong to each one.
-// A feature in that file but not in this list is always kept.
+// `uploads`: files visitors sent with forms (private, never part of a new project).
+export const SKIP_PATHS = ['scripts/setup.ts', 'scripts/lib/create-database.ts', 'scripts/lib/generate-env.ts', 'docs/qa', 'uploads'];
+// Starter features the user can turn on or off. The CLI asks about these and has a `--<id>` and a
+// `--no-<id>` flag for each. `on: false` features are off unless the user picks them.
+// The starter's `starter-features.json` says which files, config lines, scripts and dependencies
+// belong to each one. A feature in that file but not in this list is always kept.
 export const FEATURES = [
-    { id: 'look', label: 'Admin look', hint: 'Neutral colors and finer details in the admin' },
-    { id: 'nav', label: 'Sidebar navigation', hint: 'Grouped sidebar with icons' },
-    { id: 'dashboard', label: 'Dashboard widgets', hint: 'Quick actions, recent edits, form messages, site checks, analytics' },
-    { id: 'demo', label: 'Demo content', hint: 'The demo pages, posts and images seed' },
-    { id: 'ai', label: 'AI assistant', hint: 'The chat panel in the page builder' },
+    { id: 'look', label: 'Admin look', hint: 'Neutral colors and finer details in the admin', on: true },
+    { id: 'nav', label: 'Sidebar navigation', hint: 'Grouped sidebar with icons', on: true },
+    { id: 'dashboard', label: 'Dashboard widgets', hint: 'Quick actions, recent edits, form messages, site checks, analytics', on: true },
+    { id: 'demo', label: 'Demo content', hint: 'The demo pages, posts and images seed', on: true },
+    { id: 'ai', label: 'AI assistant', hint: 'The chat panel in the page builder', on: true },
+    { id: 'gallery', label: 'Media gallery', hint: 'Media as a grid with a lightbox and drag-and-drop upload (payload-media-gallery)', on: true },
+    { id: 'workflows', label: 'Workflows', hint: 'A visual workflow builder and a graph of every job run (payload-workflows)', on: true },
+    { id: 'reviews', label: 'Google reviews', hint: 'Syncs Google reviews into a collection; needs a Google place (payload-google-reviews)', on: false },
 ];
+/** The features that are on when the user passes no flags. */
+export const DEFAULT_FEATURES = FEATURES.filter((feature) => feature.on).map((feature) => feature.id);

package/dist/features.js

@@ -53,11 +53,14 @@ function importMapKey(removedPath) {
     return rel.slice('src'.length).replace(/\.[cm]?[jt]sx?$/, '');
 }
 /**
- * Removes the importMap.js lines that point into deleted files or folders: the import lines
- * and the map entries. `removedPaths` are relative to the project root, like `src/admin/nav`.
+ * Removes the importMap.js lines that point into deleted files or folders, or into removed
+ * packages: the import lines and the map entries. `removedPaths` are relative to the project root,
+ * like `src/admin/nav`. `removedPackages` are npm names, like `payload-workflows`.
  */
-export function stripImportMap(text, removedPaths) {
+export function stripImportMap(text, removedPaths, removedPackages = []) {
     const keys = removedPaths.map(importMapKey).filter((key) => key !== null);
+    // A package specifier starts right after a quote: 'pkg/rsc' or "pkg/rsc#Name".
+    keys.push(...removedPackages.flatMap((name) => [`'${name}`, `"${name}`]));
     if (keys.length === 0)
         return text;
     // The key must end at a path separator, a quote or the `#export` part, so `/admin/nav` does not match `/admin/navbar`.
@@ -114,8 +117,8 @@ export function filesWithMarkers(targetDir) {
 }
 /**
  * Turns the starter's features on or off in a copied project. For each known feature that is not in
- * `enabledIds`, it deletes the feature's files, its package.json scripts, its marked regions and its
- * importMap.js lines. Then it deletes `starter-features.json`.
+ * `enabledIds`, it deletes the feature's files, its package.json scripts and dependencies, its marked
+ * regions and its importMap.js lines. Then it deletes `starter-features.json`.
  * Returns the ids it turned off, or null when the starter has no manifest (then it changes nothing).
  */
 export function applyFeatures(targetDir, enabledIds) {
@@ -141,17 +144,22 @@ export function applyFeatures(targetDir, enabledIds) {
     const removedPaths = off.flatMap((feature) => feature.paths);
     for (const rel of removedPaths)
         fs.rmSync(resolveInside(targetDir, rel), { recursive: true, force: true });
+    const removedPackages = off.flatMap((feature) => feature.dependencies ?? []);
     const importMap = path.join(targetDir, IMPORT_MAP_FILE);
-    if (removedPaths.length > 0 && fs.existsSync(importMap)) {
-        fs.writeFileSync(importMap, stripImportMap(fs.readFileSync(importMap, 'utf8'), removedPaths));
+    if ((removedPaths.length > 0 || removedPackages.length > 0) && fs.existsSync(importMap)) {
+        fs.writeFileSync(importMap, stripImportMap(fs.readFileSync(importMap, 'utf8'), removedPaths, removedPackages));
     }
-    // package.json scripts.
+    // package.json scripts and dependencies.
     const scripts = off.flatMap((feature) => feature.scripts ?? []);
     const pkgFile = path.join(targetDir, 'package.json');
-    if (scripts.length > 0 && fs.existsSync(pkgFile)) {
+    if ((scripts.length > 0 || removedPackages.length > 0) && fs.existsSync(pkgFile)) {
         const pkg = JSON.parse(fs.readFileSync(pkgFile, 'utf8'));
         for (const name of scripts)
             delete pkg.scripts?.[name];
+        for (const name of removedPackages) {
+            delete pkg.dependencies?.[name];
+            delete pkg.devDependencies?.[name];
+        }
         fs.writeFileSync(pkgFile, `${JSON.stringify(pkg, null, 2)}\n`);
     }
     fs.rmSync(path.join(targetDir, MANIFEST_FILE));

package/dist/index.js

@@ -109,6 +109,12 @@ async function main() {
         if (!installed) {
             throw new Error(`"${manager} install" failed. The project is in ${targetDir}. Fix the error above, then run "${manager} install" there.`);
         }
+        // The starter's payload-types.ts has the collections of every feature. Write it again for the kept ones.
+        if (removed && removed.length > 0) {
+            p.log.step('Updating src/payload-types.ts for the chosen features...');
+            if (!run(manager, ['run', 'generate:types'], targetDir))
+                p.log.warn(`Updating the types failed. Run "${manager} run generate:types" in ${targetDir}.`);
+        }
     }
     // 5. Seed.
     let seeded = false;

package/dist/options.js

@@ -14,12 +14,15 @@ Project:
       --no-install          Do not install dependencies (this also skips seeding)
       --seed / --no-seed    Seed demo content (default: yes with --yes, else ask)
 
-Features (all kept by default; without --yes the CLI asks about the ones you did not pass):
+Features (without --yes the CLI asks about the ones you did not pass):
       --no-look             Leave out the admin look (neutral colors, finer details)
       --no-nav              Leave out the grouped sidebar navigation
       --no-dashboard        Leave out the dashboard widgets
       --no-demo             Leave out the demo content seed (this also turns off seeding)
       --no-ai               Leave out the AI assistant in the page builder
+      --no-gallery          Leave out the media gallery (Media keeps Payload's table)
+      --no-workflows        Leave out the workflow builder and the job run viewer
+      --reviews             Add Google reviews (off by default; needs a Google place)
 
 Database (default user and password: postgres):
       --db-url <url>        postgresql://user:pass@host:5432/name (replaces the flags below)
@@ -39,8 +42,28 @@ Source:
 
   -h, --help                Show this help
 `;
-// One `--no-<id>` flag per starter feature.
-const featureFlags = Object.fromEntries(FEATURES.map((feature) => [`no-${feature.id}`, { type: 'boolean' }]));
+// A `--<id>` and a `--no-<id>` flag per starter feature. Help lists the one that changes the default.
+const featureFlags = Object.fromEntries(FEATURES.flatMap((feature) => [
+    [feature.id, { type: 'boolean' }],
+    [`no-${feature.id}`, { type: 'boolean' }],
+]));
+/**
+ * The features chosen with flags: `--<id>` turns one on, `--no-<id>` turns it off. Returns the
+ * features that are on (flag or default) and the ids the flags decided, which the CLI does not ask about.
+ */
+export function featuresFromFlags(values) {
+    const decided = new Set();
+    const features = FEATURES.filter((feature) => {
+        const on = values[feature.id] === true;
+        const off = values[`no-${feature.id}`] === true;
+        if (on && off)
+            throw new Error(`--${feature.id} and --no-${feature.id} cannot be used together.`);
+        if (on || off)
+            decided.add(feature.id);
+        return on || (!off && feature.on);
+    }).map((feature) => feature.id);
+    return { features, decided };
+}
 function parseFlags() {
     return parseArgs({
         allowPositionals: true,
@@ -156,20 +179,21 @@ export async function resolveOptions() {
         db.name = values['db-name'];
     // Source.
     const packages = values.packages ? path.resolve(process.cwd(), values.packages) : null;
-    // Features. A --no-<id> flag turns one off without asking. Ask about the rest.
-    const turnedOff = new Set(FEATURES.filter((feature) => values[`no-${feature.id}`] === true).map((feature) => feature.id));
-    const open = FEATURES.filter((feature) => !turnedOff.has(feature.id));
-    let features = open.map((feature) => feature.id);
+    // Features. A --<id> or --no-<id> flag decides one without asking. Ask about the rest.
+    const fromFlags = featuresFromFlags(values);
+    let features = fromFlags.features;
+    const open = FEATURES.filter((feature) => !fromFlags.decided.has(feature.id));
     if (!yes && open.length > 0) {
         const answer = await p.multiselect({
             message: 'Which starter features do you want? (space toggles, enter confirms)',
             options: open.map((feature) => ({ value: feature.id, label: feature.label, hint: feature.hint })),
-            initialValues: features,
+            initialValues: open.filter((feature) => feature.on).map((feature) => feature.id),
             required: false,
         });
         if (p.isCancel(answer))
             cancelled();
-        features = answer;
+        const picked = new Set(answer);
+        features = FEATURES.filter((feature) => (fromFlags.decided.has(feature.id) ? features.includes(feature.id) : picked.has(feature.id))).map((feature) => feature.id);
     }
     const demo = features.includes('demo');
     // Install and seed.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-payload-canvas",
-  "version": "0.5.1",
+  "version": "0.6.0",
   "description": "Create a new Payload CMS website with Payload Canvas: the visual page builder, Postgres, a seeded demo and the AI guides.",
   "keywords": [
     "payload",