@loopress/cli 0.8.0 → 0.10.0

package/dist/commands/snippet/pull.js

@@ -1,4 +1,5 @@
 import { Args } from '@oclif/core';
+import { Listr } from 'listr2';
 import { mkdir, writeFile } from 'node:fs/promises';
 import { join } from 'node:path';
 import slugify from 'slugify';
@@ -43,14 +44,8 @@ export default class Pull extends LoopressCommand {
         path: Args.string({ description: 'Path to snippets directory (overrides project config)' }),
     };
     static description = 'Pull snippets from WordPress';
-    static examples = [
-        '$ lps snippet pull',
-        '$ lps snippet pull --url http://example.com',
-        '$ lps snippet pull --path ./snippets',
-        '$ lps snippet pull --plugin wpcode',
-    ];
+    static examples = ['$ lps snippet pull', '$ lps snippet pull --path ./snippets', '$ lps snippet pull --plugin wpcode'];
     static flags = {
-        ...LoopressCommand.baseFlags,
         ...LoopressCommand.dryRunFlag,
         ...snippetPluginFlag,
     };
@@ -69,22 +64,20 @@ export default class Pull extends LoopressCommand {
             return;
         }
         await mkdir(path, { recursive: true });
-        let count = 0;
-        let skipped = 0;
-        for (const snippet of snippets) {
-            if (!snippet.name.trim()) {
-                skipped++;
-                continue;
-            }
-            const ext = EXTENSIONS[snippet.type];
-            const slug = slugify(snippet.name, { lower: true, strict: true });
-            const base = `${snippet.id}-${slug}`;
-            await writeFile(join(path, `${base}.${ext}`), buildSnippetFile(snippet));
-            await writeFile(join(path, `${base}.json`), buildMetaFile(snippet));
-            count++;
-            this.log(`  Pulled: ${snippet.name}`);
-        }
-        this.log(`Pulled ${count} snippet${count === 1 ? '' : 's'} to ${path}`);
+        const pullable = snippets.filter((snippet) => snippet.name.trim());
+        const skipped = snippets.length - pullable.length;
+        await new Listr(pullable.map((snippet) => ({
+            async task(_ctx, task) {
+                const ext = EXTENSIONS[snippet.type];
+                const slug = slugify(snippet.name, { lower: true, strict: true });
+                const base = `${snippet.id}-${slug}`;
+                await writeFile(join(path, `${base}.${ext}`), buildSnippetFile(snippet));
+                await writeFile(join(path, `${base}.json`), buildMetaFile(snippet));
+                task.output = `Pulled: ${snippet.name}`;
+            },
+            title: `Pull ${snippet.name}`,
+        }))).run();
+        this.log(`Pulled ${pullable.length} snippet${pullable.length === 1 ? '' : 's'} to ${path}`);
         if (skipped > 0) {
             this.warn(`${skipped} snippet${skipped === 1 ? '' : 's'} skipped because they have no name`);
         }

package/dist/commands/snippet/push.d.ts

@@ -8,10 +8,8 @@ export default class Push extends PushCommand {
     static flags: {
         plugin: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
         'dry-run': import("@oclif/core/interfaces").BooleanFlag<boolean>;
-        password: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
-        url: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
-        user: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
     };
+    private failedCount;
     run(): Promise<void>;
     private ensureCanonicalFilename;
     private loadSnippets;

package/dist/commands/snippet/push.js

@@ -1,4 +1,5 @@
 import { Args } from '@oclif/core';
+import { Listr } from 'listr2';
 import { readdir, readFile, rename, rm, writeFile } from 'node:fs/promises';
 import { basename, dirname, extname, join } from 'node:path';
 import slugify from 'slugify';
@@ -17,17 +18,12 @@ export default class Push extends PushCommand {
         path: Args.string({ description: 'Path to snippets directory (overrides project config)' }),
     };
     static description = 'Push snippets to WordPress. Local snippet files created or updated remotely are renamed on disk to the `<id>-<slug>` convention.';
-    static examples = [
-        '$ lps snippet push',
-        '$ lps snippet push --url http://example.com',
-        '$ lps snippet push --path ./snippets',
-        '$ lps snippet push --plugin wpcode',
-    ];
+    static examples = ['$ lps snippet push', '$ lps snippet push --path ./snippets', '$ lps snippet push --plugin wpcode'];
     static flags = {
-        ...PushCommand.baseFlags,
         ...PushCommand.dryRunFlag,
         ...snippetPluginFlag,
     };
+    failedCount = 0;
     async run() {
         const { args, flags } = await this.parse(Push);
         const { url } = this.siteConfig;
@@ -38,14 +34,12 @@ export default class Push extends PushCommand {
         const snippets = await this.loadSnippets(path);
         this.log(`Found ${snippets.length} snippet${snippets.length === 1 ? '' : 's'} to push`);
         const adapter = getSnippetPlugin(resolvedPlugin);
-        let failed = 0;
-        for (const snippet of snippets) {
-            const pushed = await this.pushSnippet(snippet, adapter);
-            if (!pushed)
-                failed++;
-        }
-        if (failed > 0) {
-            this.error(`${failed} snippet${failed === 1 ? '' : 's'} failed to push.`);
+        await new Listr(snippets.map((snippet) => ({
+            task: async (_ctx, task) => this.pushSnippet(snippet, adapter, task),
+            title: `Push ${snippet.name}`,
+        })), { concurrent: false, exitOnError: false }).run();
+        if (this.failedCount > 0) {
+            this.error(`${this.failedCount} snippet${this.failedCount === 1 ? '' : 's'} failed to push.`);
         }
         if (this.dryRun)
             return;
@@ -85,7 +79,6 @@ export default class Push extends PushCommand {
         await rename(snippet.path, newPath);
         await writeFile(newMetaPath, JSON.stringify(meta, null, 2) + '\n');
         await rm(oldMetaPath, { force: true });
-        this.log(`  Renamed: ${snippet.path} → ${newPath}`);
     }
     async loadSnippets(path) {
         const snippets = [];
@@ -145,30 +138,38 @@ export default class Push extends PushCommand {
         }
         return snippets;
     }
-    async pushSnippet(snippet, adapter) {
+    // Throwing on failure (rather than returning a boolean) is what lets Listr mark the task as
+    // failed (red cross) instead of completed; `exitOnError: false` on the task list still lets
+    // sibling snippets push regardless.
+    async pushSnippet(snippet, adapter, task) {
         if (this.dryRun) {
-            this.log(`[dry-run] Would push: ${snippet.name}`);
-            return true;
+            if (task)
+                task.output = `[dry-run] Would push: ${snippet.name}`;
+            return;
         }
         const endpointPath = adapter.endpointPath();
         try {
             const payload = adapter.toPayload(snippet);
             if (snippet.id) {
                 await this.wp.put(`${endpointPath}/${snippet.id}`, payload);
-                this.log(`  Updated: ${snippet.name} (id: ${snippet.id})`);
                 await this.ensureCanonicalFilename(snippet, snippet.id, snippet.name);
             }
             else {
                 const response = await this.wp.post(endpointPath, payload);
                 const created = adapter.fromRemote(response);
-                this.log(`  Created: ${snippet.name} (id: ${created.id})`);
                 await this.ensureCanonicalFilename(snippet, created.id, created.name);
             }
-            return true;
+            if (task)
+                task.output = `Pushed: ${snippet.name}`;
         }
         catch (error) {
-            this.warn(`  Failed to push ${snippet.name}: ${error.message}`);
-            return false;
+            const message = `Failed to push ${snippet.name}: ${error.message}`;
+            if (task)
+                task.output = message;
+            else
+                this.warn(`  ${message}`);
+            this.failedCount++;
+            throw error;
         }
     }
 }

package/dist/hooks/finally.d.ts

@@ -0,0 +1,3 @@
+import type { Hook } from '@oclif/core';
+declare const hook: Hook.Finally;
+export default hook;

package/dist/hooks/finally.js

@@ -0,0 +1,21 @@
+import * as Sentry from '@sentry/node';
+import { isTelemetryDisabled, runtimeContext } from '../lib/sentry.js';
+// oclif has no `command_error` hook (checked @oclif/core@4.11.11's hooks.d.ts). `finally`
+// is the closest equivalent: it always runs at the end of the CLI lifecycle and carries
+// the error, if any, so it's where we report crashes before the process exits.
+const hook = async function (options) {
+    if (!options.error || isTelemetryDisabled())
+        return;
+    try {
+        Sentry.captureException(options.error, {
+            contexts: { runtime: runtimeContext() },
+            extra: { argv: options.argv },
+            tags: { command: options.id },
+        });
+        await Sentry.flush(2000);
+    }
+    catch (error) {
+        this.debug('Failed to report error to Sentry: %O', error);
+    }
+};
+export default hook;

package/dist/hooks/init.d.ts

@@ -0,0 +1,3 @@
+import type { Hook } from '@oclif/core';
+declare const hook: Hook.Init;
+export default hook;

package/dist/hooks/init.js

@@ -0,0 +1,18 @@
+import * as Sentry from '@sentry/node';
+import { consumeErrorReportingFlag, isTelemetryDisabled, resolveEnvironment, SENTRY_DSN } from '../lib/sentry.js';
+const hook = async function (options) {
+    consumeErrorReportingFlag(options.argv);
+    if (isTelemetryDisabled())
+        return;
+    try {
+        Sentry.init({
+            dsn: SENTRY_DSN,
+            environment: resolveEnvironment(),
+            release: this.config.version,
+        });
+    }
+    catch (error) {
+        this.debug('Failed to initialize Sentry: %O', error);
+    }
+};
+export default hook;

package/dist/lib/base.d.ts

@@ -3,11 +3,6 @@ import { EnvironmentConfig } from '../types/config.js';
 import { LoopressLocalConfig } from '../utils/loopress-config.js';
 import { WpClient } from './wp-client.js';
 export declare abstract class LoopressCommand extends Command {
-    static baseFlags: {
-        password: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
-        url: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
-        user: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
-    };
     static dryRunFlag: {
         'dry-run': import("@oclif/core/interfaces").BooleanFlag<boolean>;
     };

package/dist/lib/base.js

@@ -4,20 +4,6 @@ import { configManager } from '../config/project-config.manager.js';
 import { readLocalConfig } from '../utils/loopress-config.js';
 import { WpClient } from './wp-client.js';
 export class LoopressCommand extends Command {
-    static baseFlags = {
-        password: Flags.string({
-            description: 'WordPress application password (overrides project config, requires --user)',
-            helpGroup: 'GLOBAL',
-        }),
-        url: Flags.string({
-            description: 'WordPress URL (overrides project config)',
-            helpGroup: 'GLOBAL',
-        }),
-        user: Flags.string({
-            description: 'WordPress username (overrides project config, requires --password)',
-            helpGroup: 'GLOBAL',
-        }),
-    };
     static dryRunFlag = {
         'dry-run': Flags.boolean({ char: 'd', description: 'Show what would change without making changes' }),
     };
@@ -47,21 +33,7 @@ export class LoopressCommand extends Command {
         }));
         this.dryRun = Boolean(flags['dry-run']);
         this.localConfig = await readLocalConfig();
-        if (Boolean(flags.user) !== Boolean(flags.password)) {
-            this.error('--user and --password must be provided together.');
-        }
-        const flagToken = flags.user && flags.password ? `${flags.user}:${flags.password}` : undefined;
-        if (flags.url) {
-            this.siteConfig = {
-                addedAt: new Date().toISOString(),
-                name: 'cli-flags',
-                token: flagToken,
-                url: flags.url.replace(/\/+$/, ''),
-            };
-            return;
-        }
-        const env = this.resolveEnvironment();
-        this.siteConfig = flagToken ? { ...env, token: flagToken } : env;
+        this.siteConfig = this.resolveEnvironment();
     }
     resolveSnippetPlugin(flag) {
         if (flag)

package/dist/lib/sentry.d.ts

@@ -0,0 +1,8 @@
+export declare const SENTRY_DSN = "https://a08dd56bfffc2a45d5b8f665e4cb8b7d@o4511586904309760.ingest.de.sentry.io/4511673275973712";
+export declare function consumeErrorReportingFlag(argv: string[]): void;
+export declare function isTelemetryDisabled(): boolean;
+export declare function resolveEnvironment(): string;
+export declare function runtimeContext(): {
+    node: string;
+    os: string;
+};

package/dist/lib/sentry.js

@@ -0,0 +1,24 @@
+import { platform, release } from 'node:os';
+// DSNs are write-only and safe to embed in a distributed CLI, see https://docs.sentry.io/product/security/#can-i-make-my-sentry-dsn-private
+export const SENTRY_DSN = 'https://a08dd56bfffc2a45d5b8f665e4cb8b7d@o4511586904309760.ingest.de.sentry.io/4511673275973712';
+export function consumeErrorReportingFlag(argv) {
+    const index = argv.indexOf('--no-error-reporting');
+    if (index === -1)
+        return;
+    argv.splice(index, 1);
+    process.env.LOOPRESS_TELEMETRY_DISABLED = '1';
+}
+export function isTelemetryDisabled() {
+    return process.env.LOOPRESS_TELEMETRY_DISABLED === '1';
+}
+export function resolveEnvironment() {
+    if (process.env.SENTRY_ENVIRONMENT)
+        return process.env.SENTRY_ENVIRONMENT;
+    return process.env.NODE_ENV === 'development' ? 'development' : 'production';
+}
+export function runtimeContext() {
+    return {
+        node: process.version,
+        os: `${platform()} ${release()}`,
+    };
+}

package/dist/types/config.d.ts

@@ -1,19 +1 @@
-export interface EnvironmentConfig {
-    addedAt: string;
-    name: string;
-    token?: string;
-    url: string;
-}
-export interface ProjectConfig {
-    addedAt: string;
-    environments: Record<string, EnvironmentConfig>;
-    name: string;
-}
-export interface CurrentProjectPointer {
-    env: string;
-    id: string;
-}
-export interface LoopressConfig {
-    currentProject: CurrentProjectPointer | null;
-    projects: Record<string, ProjectConfig>;
-}
+export type { CurrentProjectPointer, EnvironmentConfig, LoopressGlobalConfiguration as LoopressConfig, ProjectConfig, } from './global-config.generated.js';

package/dist/types/global-config.generated.d.ts

@@ -0,0 +1,59 @@
+/**
+ * Global CLI state stored at ~/.loopress/config.json: known projects, their environments, and which one is currently active.
+ */
+export interface LoopressGlobalConfiguration {
+    /**
+     * Pointer to the currently active project and environment, or null if none is selected.
+     */
+    currentProject: null | CurrentProjectPointer;
+    /**
+     * Known projects, keyed by project id.
+     */
+    projects: {
+        [k: string]: ProjectConfig;
+    };
+}
+export interface CurrentProjectPointer {
+    /**
+     * Name of the currently active environment.
+     */
+    env: string;
+    /**
+     * Id of the currently active project.
+     */
+    id: string;
+}
+export interface ProjectConfig {
+    /**
+     * ISO timestamp of when the project was added.
+     */
+    addedAt: string;
+    /**
+     * Environments for this project, keyed by environment name.
+     */
+    environments: {
+        [k: string]: EnvironmentConfig;
+    };
+    /**
+     * Human-readable project name.
+     */
+    name: string;
+}
+export interface EnvironmentConfig {
+    /**
+     * ISO timestamp of when the environment was added.
+     */
+    addedAt: string;
+    /**
+     * Environment name (e.g. "production", "staging").
+     */
+    name: string;
+    /**
+     * API token used to authenticate against this environment.
+     */
+    token?: string;
+    /**
+     * Base URL of the WordPress site for this environment.
+     */
+    url: string;
+}

package/dist/types/global-config.generated.js

@@ -0,0 +1,2 @@
+// This file is generated from schemas/global-config.schema.json by `pnpm run schema:types`. Do not edit by hand.
+export {};

package/dist/types/project-config.generated.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Project-level config for the Loopress CLI (loopress.json).
+ */
+export interface LoopressProjectConfiguration {
+    $schema?: string;
+    /**
+     * Base directory for all Loopress paths. All other path options are resolved relative to this directory.
+     */
+    rootDir?: string;
+    /**
+     * Directory where code snippets are read from and written to, relative to rootDir.
+     */
+    snippetsDir?: string;
+    /**
+     * Project identifier from the global Loopress config. When set, takes precedence over the currently active project in the global config.
+     */
+    projectId?: string;
+    /**
+     * WordPress snippet plugin to use for pull and push commands.
+     */
+    snippetPlugin?: 'wpcode' | 'code-snippets';
+    /**
+     * Pinned plugin versions. Keys are WordPress.org plugin slugs, values are version constraints.
+     */
+    plugins?: {
+        /**
+         * Version to pin. Use an exact version (e.g. "8.9.1") or "latest".
+         */
+        [k: string]: string;
+    };
+}

package/dist/types/project-config.generated.js

@@ -0,0 +1,2 @@
+// This file is generated from schemas/project-config.schema.json by `pnpm run schema:types`. Do not edit by hand.
+export {};

package/dist/types/snippet.generated.d.ts

@@ -0,0 +1,46 @@
+/**
+ * Sidecar .json file paired with a snippet's code file in the snippets directory (e.g. `123-my-snippet.php` + `123-my-snippet.json`).
+ */
+export interface LoopressSnippetMetadata {
+    $schema?: string;
+    /**
+     * Remote snippet id. Omitted until the snippet has been pushed for the first time.
+     */
+    id?: number;
+    /**
+     * Snippet name/title. Defaults to the code file's name when omitted.
+     */
+    name?: string;
+    /**
+     * Snippet language. Defaults to the type inferred from the code file's extension when omitted.
+     */
+    type?: 'css' | 'html' | 'js' | 'php' | 'text';
+    /**
+     * Whether the snippet is enabled.
+     */
+    active?: boolean;
+    /**
+     * Where the snippet runs. Supported values depend on the target plugin and snippet type.
+     */
+    location?: 'admin' | 'body' | 'everywhere' | 'footer' | 'frontend' | 'header' | 'once';
+    /**
+     * Free-text note about the snippet.
+     */
+    description?: string;
+    /**
+     * Tags for organizing snippets.
+     */
+    tags?: string[];
+    /**
+     * How the snippet is inserted into the page.
+     */
+    insertMethod?: 'auto' | 'shortcode';
+    /**
+     * Execution priority. Lower runs earlier.
+     */
+    priority?: number;
+    /**
+     * Attribute names accepted by the snippet's shortcode, used when insertMethod is "shortcode".
+     */
+    shortcodeAttributes?: string[];
+}

package/dist/types/snippet.generated.js

@@ -0,0 +1,2 @@
+// This file is generated from schemas/snippet.schema.json by `pnpm run schema:types`. Do not edit by hand.
+export {};

package/dist/utils/loopress-config.d.ts

@@ -1,9 +1,4 @@
-export interface LoopressLocalConfig {
-    plugins?: Record<string, string>;
-    projectId?: string;
-    rootDir?: string;
-    snippetPlugin?: 'code-snippets' | 'wpcode';
-    snippetsDir?: string;
-}
+import { LoopressProjectConfiguration } from '../types/project-config.generated.js';
+export type LoopressLocalConfig = LoopressProjectConfiguration;
 export declare function readLocalConfig(): Promise<LoopressLocalConfig>;
 export declare function writeLocalConfig(config: LoopressLocalConfig): Promise<void>;