@loopress/cli 0.23.0 → 0.24.1

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@loopress/cli",
   "description": "CLI tool for syncing WordPress code snippets, plugins, and Composer dependencies via the REST API",
-  "version": "0.23.0",
+  "version": "0.24.1",
   "author": "jean-smaug",
   "bin": {
     "loopress": "bin/run.js",
@@ -11,19 +11,22 @@
     "url": "https://github.com/loopress/loopress/issues"
   },
   "dependencies": {
-    "@inquirer/prompts": "^8.7.1",
+    "@inquirer/prompts": "^8.7.2",
     "@oclif/core": "^5.0.0",
     "@oclif/plugin-help": "^7.0.0",
     "@oclif/plugin-warn-if-update-available": "^4.0.0",
-    "@sentry/node": "^10.73.0",
+    "@sentry/node": "^10.74.0",
     "chokidar": "^5.0.0",
     "compare-versions": "^6.1.1",
+    "diff": "^9.0.0",
     "glob": "13.0.6",
     "got": "^16.0.0",
     "listr2": "^11.1.0",
+    "microdiff": "^1.6.0",
     "open": "^11.0.2",
-    "playwright-core": "^1.62.1",
+    "playwright-core": "^1.63.0",
     "slugify": "^1.6.9",
+    "tty-table": "^5.0.0",
     "write-file-atomic": "^8.0.0"
   },
   "devDependencies": {
@@ -31,10 +34,10 @@
     "@oclif/prettier-config": "^0.2.1",
     "@stryker-mutator/core": "^10.0.0",
     "@stryker-mutator/vitest-runner": "^10.0.0",
-    "@types/node": "26.4.1",
+    "@types/node": "26.5.0",
     "@types/write-file-atomic": "^4.0.3",
-    "@vitest/coverage-v8": "5.0.0",
-    "eslint": "^10.9.1",
+    "@vitest/coverage-v8": "^4.1.11",
+    "eslint": "^10.10.0",
     "eslint-config-oclif": "^7.1.7",
     "eslint-config-prettier": "^10",
     "eslint-plugin-sonarjs": "^4.2.0",
@@ -45,7 +48,7 @@
     "ts-node": "10.9.2",
     "tsx": "4.23.13",
     "typescript": "^6.0.3",
-    "vitest": "^5.0.0"
+    "vitest": "^4.1.11"
   },
   "engines": {
     "node": ">=18.0.0"

package/schemas/project-config.schema.json

@@ -34,21 +34,26 @@
       "description": "Directory where forms (WPForms today) are read from and written to, relative to rootDir.",
       "default": "forms"
     },
-    "pageDir": {
-      "type": "string",
-      "description": "Directory where WordPress pages are read from and written to, relative to rootDir.",
-      "default": "pages"
-    },
     "apiDir": {
       "type": "string",
       "description": "Directory where custom API route files are read from and written to, relative to rootDir.",
       "default": "api"
     },
+    "hooksDir": {
+      "type": "string",
+      "description": "Directory where hook files (WordPress actions, filters, and scheduled tasks) are read from and written to, relative to rootDir.",
+      "default": "hooks"
+    },
     "appsDir": {
       "type": "string",
       "description": "Directory where single-page app bundles are read from and written to, relative to rootDir. Each subdirectory is one app: a loopress.app.json plus a built dist/ folder.",
       "default": "apps"
     },
+    "optionsDir": {
+      "type": "string",
+      "description": "Directory where explicitly tracked WordPress options (wp_options rows) are read from and written to, relative to rootDir. Only options added via `lps option add` live here, this is never the whole options table.",
+      "default": "options"
+    },
     "projectId": {
       "type": "string",
       "description": "Project identifier from the global Loopress config. When set, takes precedence over the currently active project in the global config."

package/dist/commands/page/list.js

@@ -1,19 +0,0 @@
-import { LoopressCommand } from '../../lib/base.js';
-import { getPageId, getPageTitle, PAGE_ENDPOINT, PAGE_LIST_QUERY } from '../../utils/page-format.js';
-export default class List extends LoopressCommand {
-    static description = 'List pages from WordPress';
-    static enableJsonFlag = true;
-    static examples = ['$ lps page list'];
-    async run() {
-        const pages = await this.wp.get(`${PAGE_ENDPOINT}?${PAGE_LIST_QUERY}`);
-        this.log(`Pages (${pages.length}):`);
-        if (pages.length === 0) {
-            this.log('  (none)');
-            return pages;
-        }
-        for (const page of pages) {
-            this.log(`  ${getPageId(page) ?? '(no id)'}. ${getPageTitle(page)}`);
-        }
-        return pages;
-    }
-}

package/dist/commands/page/pull.js

@@ -1,57 +0,0 @@
-import { Args } from '@oclif/core';
-import { writeFile } from 'node:fs/promises';
-import { join } from 'node:path';
-import { LoopressCommand } from '../../lib/base.js';
-import { findOrphanedFiles, numericPrefixKey } from '../../lib/find-orphaned-files.js';
-import { getPageContent, getPageId, getPageTitle, PAGE_ENDPOINT, PAGE_LIST_QUERY, pageFileBase, pickPageMeta } from '../../utils/page-format.js';
-import { pluralize } from '../../utils/pluralize.js';
-export default class Pull extends LoopressCommand {
-    static args = {
-        path: Args.string({ description: 'Path to pages directory (overrides project config)' }),
-    };
-    static description = 'Pull pages from WordPress';
-    static enableJsonFlag = true;
-    static examples = ['$ lps page pull'];
-    static flags = {
-        ...LoopressCommand.dryRunFlag,
-        ...LoopressCommand.yesFlag,
-    };
-    async run() {
-        const { args } = await this.parse(Pull);
-        const { url } = this.siteConfig;
-        const path = this.resolvePagePath(args.path);
-        this.log(`Pulling pages from ${url}`);
-        this.log(`Pages path: ${path}`);
-        // context=edit returns title/content/excerpt as raw editable source instead of rendered
-        // HTML, needed for the file to be a faithful, re-pushable copy (requires edit_pages).
-        const remoteList = await this.wp.get(`${PAGE_ENDPOINT}?${PAGE_LIST_QUERY}&context=edit`);
-        const withId = remoteList.filter((page) => getPageId(page) !== null);
-        const skipped = remoteList.length - withId.length;
-        // Every page writes an `.html` (content) and `.json` (everything else) pair; both
-        // extensions are candidates for orphan cleanup, same principle as `snippet pull`.
-        const orphans = await findOrphanedFiles(path, new Set(withId.map((page) => String(getPageId(page)))), {
-            extensions: ['.json', '.html'],
-            key: numericPrefixKey,
-        });
-        const pulled = withId.map((page) => ({ id: getPageId(page), title: getPageTitle(page) }));
-        await this.pullDirectory(path, withId, orphans, {
-            dryRunMessage: `Would pull ${pluralize(withId.length, 'page')} to ${path}`,
-            orphanReason: `in ${path} no longer present on WordPress`,
-            pulledMessage: `Pulled ${pluralize(withId.length, 'page')} to ${path}`,
-            title: (page) => getPageTitle(page),
-            async write(page, writeDir) {
-                const base = pageFileBase(getPageId(page), getPageTitle(page));
-                // `content` lives entirely in the `.html` file; the `.json` sidecar keeps only the
-                // fields WordPress actually accepts back on write, see pickPageMeta.
-                await writeFile(join(writeDir, `${base}.html`), getPageContent(page));
-                await writeFile(join(writeDir, `${base}.json`), JSON.stringify(pickPageMeta(page), null, 2) + '\n');
-            },
-        });
-        if (this.dryRun)
-            return { orphans, pulled, skipped, status: 'dry-run' };
-        if (skipped > 0) {
-            this.warn(`${pluralize(skipped, 'page')} skipped because they have no id`);
-        }
-        return { orphans, pulled, skipped, status: 'success' };
-    }
-}

package/dist/commands/page/push.js

@@ -1,132 +0,0 @@
-import { Args } from '@oclif/core';
-import { readFile, rename, writeFile } from 'node:fs/promises';
-import { basename, dirname, extname, join } from 'node:path';
-import { PushCommand } from '../../lib/push-command.js';
-import { putOrCreate } from '../../lib/put-or-create.js';
-import { readdirTolerant } from '../../lib/readdir-tolerant.js';
-import { getPageId, getPageTitle, PAGE_ENDPOINT, pageFileBase } from '../../utils/page-format.js';
-import { pluralize } from '../../utils/pluralize.js';
-export default class Push extends PushCommand {
-    static args = {
-        path: Args.string({ description: 'Path to pages directory (overrides project config)' }),
-    };
-    static description = 'Push pages to WordPress. Local files created or updated remotely are renamed on disk to the `<id>-<slug>` convention.';
-    static enableJsonFlag = true;
-    static examples = ['$ lps page push'];
-    static flags = {
-        ...PushCommand.dryRunFlag,
-        ...PushCommand.yesFlag,
-    };
-    async run() {
-        const { args } = await this.parse(Push);
-        const { url } = this.siteConfig;
-        const path = this.resolvePagePath(args.path);
-        this.log(`Pushing pages to ${url}`);
-        this.log(`Pages path: ${path}`);
-        const pages = await this.loadFiles(path);
-        this.log(`Found ${pluralize(pages.length, 'page')} to push`);
-        const pushed = [];
-        await this.runPushTasks(pages, (page) => getPageTitle(page.meta), async (page, task) => {
-            const id = await this.pushPage(page, task);
-            pushed.push({ id, title: getPageTitle(page.meta) });
-        });
-        if (this.failedCount > 0) {
-            this.error(`${pluralize(this.failedCount, 'page')} failed to push.`);
-        }
-        if (this.dryRun)
-            return { pushed, status: 'dry-run' };
-        await this.recordSuccess();
-        this.log('All pages pushed.');
-        return { pushed, status: 'success' };
-    }
-    // Renames the local file pair to the `<id>-<slug>` convention used by `page pull` whenever it
-    // doesn't already match, same principle as ensureCanonicalFilename in commands/snippet/push.ts:
-    // the id is persisted into the sidecar before any rename, so a crash mid-rename still leaves a
-    // valid, matchable pair on disk instead of an orphaned one that would be recreated as a duplicate.
-    async ensureCanonicalFilename(page, id, title) {
-        const dir = dirname(page.contentPath);
-        const canonicalBase = pageFileBase(id, title);
-        const currentBase = basename(page.contentPath, '.html');
-        const meta = { ...page.meta, id };
-        await writeFile(page.metaPath, JSON.stringify(meta, null, 2) + '\n');
-        if (currentBase === canonicalBase)
-            return;
-        await rename(page.contentPath, join(dir, `${canonicalBase}.html`));
-        await rename(page.metaPath, join(dir, `${canonicalBase}.json`));
-    }
-    // A page is its `.html` content file plus an optional `.json` sidecar for everything else
-    // (a fresh hand-created page may have no sidecar yet). One page is read in isolation: a
-    // corrupted or hand-broken sidecar must only skip that page, not abort loading the rest of
-    // the directory, same principle as commands/form/push.ts.
-    async loadFiles(dir) {
-        const files = await readdirTolerant(dir);
-        const pages = [];
-        for (const file of files) {
-            if (extname(file) !== '.html')
-                continue;
-            const contentPath = join(dir, file);
-            const metaPath = join(dir, `${basename(file, '.html')}.json`);
-            let meta = {};
-            try {
-                const parsed = JSON.parse(await readFile(metaPath, 'utf8'));
-                if (typeof parsed !== 'object' || parsed === null) {
-                    this.warn(`Skipping "${metaPath}": not a JSON object`);
-                    continue;
-                }
-                meta = parsed;
-            }
-            catch (error) {
-                if (error.code !== 'ENOENT') {
-                    this.warn(`Skipping "${metaPath}": ${error.message}`);
-                    continue;
-                }
-            }
-            let content;
-            try {
-                content = await readFile(contentPath, 'utf8');
-            }
-            catch (error) {
-                this.warn(`Skipping "${contentPath}": ${error.message}`);
-                continue;
-            }
-            pages.push({ content, contentPath, meta, metaPath });
-        }
-        return pages;
-    }
-    // ponytail: `parent` round-trips as the source site's numeric page id untouched, so pushing
-    // to a site where that id belongs to a different page (or nothing) silently mis-parents or
-    // orphans the page. No id-remapping across sites here; fine for same-hierarchy environments,
-    // revisit if pushing across sites with divergent page trees becomes a real workflow.
-    async pushPage(page, task) {
-        const title = getPageTitle(page.meta);
-        if (this.dryRun) {
-            if (task)
-                task.output = `[dry-run] Would push: ${title}`;
-            return getPageId(page.meta);
-        }
-        try {
-            const id = getPageId(page.meta);
-            const payload = { ...page.meta, content: page.content };
-            // WordPress core rejects any POST that still carries a (now stale) `id` field with a
-            // 400 "Cannot create existing post", regardless of whether that id actually exists.
-            const postPayload = { ...payload };
-            delete postPayload.id;
-            const { body, created } = await putOrCreate(this.wp, {
-                id,
-                payload,
-                postEndpoint: PAGE_ENDPOINT,
-                postPayload,
-                putEndpoint: (pageId) => `${PAGE_ENDPOINT}/${pageId}`,
-            });
-            const resultId = created ? getPageId(body) : id;
-            if (resultId !== null)
-                await this.ensureCanonicalFilename(page, resultId, title);
-            if (task)
-                task.output = `Pushed: ${title}`;
-            return resultId;
-        }
-        catch (error) {
-            this.reportTaskFailure(`Failed to push ${title}: ${error.message}`, error, task);
-        }
-    }
-}

package/dist/utils/page-format.d.ts

@@ -1,7 +0,0 @@
-export declare const PAGE_ENDPOINT = "wp/v2/pages";
-export declare const PAGE_LIST_QUERY = "per_page=100";
-export declare function getPageId(data: Record<string, unknown>): null | number;
-export declare function getPageTitle(data: Record<string, unknown>): string;
-export declare function pageFileBase(id: number, title: string): string;
-export declare function pickPageMeta(data: Record<string, unknown>): Record<string, unknown>;
-export declare function getPageContent(data: Record<string, unknown>): string;

package/dist/utils/page-format.js

@@ -1,78 +0,0 @@
-import { toSlug } from './to-slug.js';
-// WordPress core's own REST endpoint (`wp/v2/pages`), unlike acf/form/seo/snippet there is no
-// Loopress-plugin controller behind this one, same principle as `wp/v2/plugins` in plugin push/pull.
-export const PAGE_ENDPOINT = 'wp/v2/pages';
-// ponytail: fixed cap, not a paged loop; fine for typical page counts, revisit with real
-// pagination (X-WP-TotalPages) if a site ever has more than 100 pages.
-export const PAGE_LIST_QUERY = 'per_page=100';
-export function getPageId(data) {
-    const id = Number(data.id);
-    return Number.isSafeInteger(id) && id > 0 ? id : null;
-}
-// `title`/`content`/`excerpt` come back as `{raw, rendered}` from `?context=edit` (what `page
-// pull` requests) but round-trip fine as plain strings too for a hand-created file, same
-// looseness as getFormTitle in form-format.ts.
-export function getPageTitle(data) {
-    const { title } = data;
-    if (typeof title === 'string' && title.trim() !== '')
-        return title;
-    if (title && typeof title === 'object') {
-        const { raw, rendered } = title;
-        if (typeof raw === 'string' && raw.trim() !== '')
-            return raw;
-        if (typeof rendered === 'string' && rendered.trim() !== '')
-            return rendered;
-    }
-    return '(untitled)';
-}
-export function pageFileBase(id, title) {
-    return `${id}-${toSlug(title, 'untitled')}`;
-}
-// The fields WordPress core actually accepts on write to `wp/v2/pages` (confirmed via
-// `OPTIONS wp/v2/pages`), plus `id` for local identity. A GET response carries a lot more:
-// `guid`, `link`, `modified`/`modified_gmt`, `permalink_template`, `generated_slug`,
-// `class_list`, `type`, `_links`, all of it readonly/computed by WordPress, most of it
-// domain- or revision-specific. `_links` alone is the bulk of the file and, like
-// `modified`/`modified_gmt`, changes on every edit regardless of whether the page's actual
-// content changed, which would make every `page pull` produce a spurious git diff if kept.
-const PAGE_META_FIELDS = [
-    'id',
-    'date',
-    'date_gmt',
-    'slug',
-    'status',
-    'password',
-    'parent',
-    'title',
-    'author',
-    'excerpt',
-    'featured_media',
-    'comment_status',
-    'ping_status',
-    'menu_order',
-    'meta',
-    'template',
-];
-export function pickPageMeta(data) {
-    const meta = {};
-    for (const field of PAGE_META_FIELDS) {
-        if (Object.hasOwn(data, field))
-            meta[field] = data[field];
-    }
-    return meta;
-}
-// `content` comes back as `{raw, rendered}` from `?context=edit` (what `page pull` requests);
-// a hand-created file only has the plain string. This is the one field split out into its own
-// `.html` file by pull/push: raw Gutenberg block markup escaped inside a JSON string is neither
-// readable nor safely hand-editable, same reasoning as the code/meta split in snippet-format.ts.
-export function getPageContent(data) {
-    const { content } = data;
-    if (typeof content === 'string')
-        return content;
-    if (content && typeof content === 'object') {
-        const { raw } = content;
-        if (typeof raw === 'string')
-            return raw;
-    }
-    return '';
-}