@loopress/cli 0.15.0 → 0.16.0

package/dist/commands/composer/pull.js

@@ -2,21 +2,24 @@ import { writeFile } from 'node:fs/promises';
 import { join } from 'node:path';
 import { LoopressCommand } from '../../lib/base.js';
 export default class ComposerPull extends LoopressCommand {
-    static description = 'Pull composer.lock from WordPress';
+    static description = 'Pull composer.json and composer.lock from WordPress';
     static examples = ['$ lps composer pull', '$ lps composer pull --dry-run'];
     static flags = {
         ...LoopressCommand.dryRunFlag,
     };
     async run() {
         const { url } = this.siteConfig;
-        this.log(`Pulling composer.lock from ${url}`);
+        this.log(`Pulling composer.json and composer.lock from ${url}`);
+        const { composerJson } = await this.wp.get('loopress/v1/composer/json');
         const { composerLock } = await this.wp.get('loopress/v1/composer/lock');
         if (this.dryRun) {
-            this.log('[dry-run] Would write composer.lock');
+            this.log('[dry-run] Would write composer.json and composer.lock');
             return;
         }
+        const composerJsonPath = join(process.cwd(), this.rootDir, 'composer.json');
         const lockPath = join(process.cwd(), this.rootDir, 'composer.lock');
+        await writeFile(composerJsonPath, composerJson, 'utf8');
         await writeFile(lockPath, composerLock, 'utf8');
-        this.log(`Wrote composer.lock`);
+        this.log(`Wrote composer.json and composer.lock`);
     }
 }

package/dist/help.js

@@ -7,7 +7,7 @@ const BANNER = `
    @@@@          ++++     ▗▖    ▗▄▖  ▗▄▖ ▗▄▄▖ ▗▄▄▖ ▗▄▄▄▖ ▗▄▄▖ ▗▄▄▖
   @@@@            ++++    ▐▌   ▐▌ ▐▌▐▌ ▐▌▐▌ ▐▌▐▌ ▐▌▐▌   ▐▌   ▐▌   
  @@@@              ++++   ▐▌   ▐▌ ▐▌▐▌ ▐▌▐▛▀▘ ▐▛▀▚▖▐▛▀▀▘ ▝▀▚▖ ▝▀▚▖
-  @@@@            ++++    ▐▙▄▄▖▝▚▄▞▘▝▚▄▞▘▐▌   ▐▌ ▐▌▐▙▄▄▖▗▄▄▞▘▗▄▄▞▘  (BETA)
+  @@@@            ++++    ▐▙▄▄▖▝▚▄▞▘▝▚▄▞▘▐▌   ▐▌ ▐▌▐▙▄▄▖▗▄▄▞▘▗▄▄▞▘  (ALPHA)
    @@@@          ++++   
     @@@@        ++++    
      @@@@@@@@@@@*++     

package/dist/lib/base.d.ts

@@ -13,6 +13,7 @@ export declare abstract class LoopressCommand extends Command {
     protected get rootDir(): string;
     protected get wp(): WpClient;
     init(): Promise<void>;
+    protected resolveAcfPath(override?: string): string;
     protected resolveSnippetsPath(override?: string): string;
     private resolveEnvironment;
 }

package/dist/lib/base.js

@@ -35,6 +35,11 @@ export class LoopressCommand extends Command {
         this.localConfig = await readLocalConfig();
         this.siteConfig = this.resolveEnvironment();
     }
+    resolveAcfPath(override) {
+        if (override)
+            return override;
+        return join(this.rootDir, this.localConfig.acfDir ?? 'acf');
+    }
     resolveSnippetsPath(override) {
         if (override)
             return override;

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

@@ -11,6 +11,10 @@ export interface LoopressProjectConfiguration {
      * Directory where code snippets are read from and written to, relative to rootDir.
      */
     snippetsDir?: string;
+    /**
+     * Directory where ACF field groups, post types, taxonomies and options pages are read from and written to, relative to rootDir.
+     */
+    acfDir?: string;
     /**
      * Project identifier from the global Loopress config. When set, takes precedence over the currently active project in the global config.
      */

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

@@ -0,0 +1,4 @@
+export declare const ACF_OBJECT_TYPES: readonly ["field-groups", "post-types", "taxonomies", "options-pages"];
+export type AcfObjectType = (typeof ACF_OBJECT_TYPES)[number];
+export declare function acfEndpoint(type: AcfObjectType): string;
+export declare function getAcfKey(data: Record<string, unknown>): null | string;

package/dist/utils/acf-format.js

@@ -0,0 +1,12 @@
+export const ACF_OBJECT_TYPES = ['field-groups', 'post-types', 'taxonomies', 'options-pages'];
+export function acfEndpoint(type) {
+    return `loopress/v1/acf/${type}`;
+}
+// Deliberately loose: ACF's own export JSON is large, deeply nested, and versioned by ACF
+// itself (new settings appear across ACF releases). We only need `key` for filenames/identity;
+// everything else round-trips through pull/push untouched, so there's no generated type for it
+// (see the plan for why: shadowing ACF's own schema would be an ongoing losing battle, and the
+// shared schema:types compiler options (additionalProperties: false) would be actively wrong here).
+export function getAcfKey(data) {
+    return typeof data.key === 'string' && data.key.trim() !== '' ? data.key : null;
+}

package/dist/utils/composer.d.ts

@@ -1,4 +1,12 @@
 export interface ComposerJson {
+    extra?: {
+        'installer-paths'?: Record<string, string[]>;
+    };
+    name?: string;
+    repositories?: Array<{
+        type: string;
+        url: string;
+    }>;
     require?: Record<string, string>;
     'require-dev'?: Record<string, string>;
 }

package/dist/utils/plugins.js

@@ -1,7 +1,9 @@
 // Loopress must never manage itself: pulling it into loopress.json would make a later
 // `plugin push` try to reinstall it from WordPress.org, where it doesn't exist, potentially
-// clobbering the plugin's own directory in the process.
-const LOOPRESS_PLUGIN_SLUG = 'loopress';
+// clobbering the plugin's own directory in the process. Checked against every slug this
+// plugin has ever shipped under (pre-rename "loopress", and the current "loopress-full" /
+// "loopress-light" editions), since a given site could be running any of them.
+const LOOPRESS_PLUGIN_SLUGS = new Set(['loopress', 'loopress-full', 'loopress-light']);
 export function mergePluginManifest(existing, incoming) {
     const merged = { ...existing, ...incoming };
     const added = Object.keys(incoming).filter((s) => !(s in existing));
@@ -25,7 +27,7 @@ export function parseInstalledPlugins(raw) {
         slug: slugFromPluginFile(item.plugin),
         version: item.version,
     }))
-        .filter((plugin) => plugin.slug !== LOOPRESS_PLUGIN_SLUG);
+        .filter((plugin) => !LOOPRESS_PLUGIN_SLUGS.has(plugin.slug));
 }
 export function diffPlugins(manifest, installed) {
     const installedMap = new Map(installed.map((p) => [p.slug, p]));

package/oclif.manifest.json

@@ -113,12 +113,13 @@
         "status.js"
       ]
     },
-    "snippet:list": {
+    "acf:list": {
       "aliases": [],
       "args": {},
-      "description": "List snippets from WordPress",
+      "description": "List ACF field groups, post types, taxonomies, and options pages from WordPress",
       "examples": [
-        "$ lps snippet list"
+        "$ lps acf list",
+        "$ lps acf list --type field-groups"
       ],
       "flags": {
         "json": {
@@ -127,11 +128,24 @@
           "name": "json",
           "allowNo": false,
           "type": "boolean"
+        },
+        "type": {
+          "description": "Limit to specific ACF object types",
+          "name": "type",
+          "hasDynamicHelp": false,
+          "multiple": true,
+          "options": [
+            "field-groups",
+            "post-types",
+            "taxonomies",
+            "options-pages"
+          ],
+          "type": "option"
         }
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "snippet:list",
+      "id": "acf:list",
       "pluginAlias": "@loopress/cli",
       "pluginName": "@loopress/cli",
       "pluginType": "core",
@@ -149,52 +163,81 @@
       "relativePath": [
         "dist",
         "commands",
-        "snippet",
+        "acf",
         "list.js"
       ]
     },
-    "snippet:publish": {
+    "acf:pull": {
       "aliases": [],
       "args": {
         "path": {
-          "description": "Path to snippets directory (overrides project config)",
+          "description": "Path to ACF directory (overrides project config)",
           "name": "path"
         }
       },
-      "description": "Publish snippets to your Loopress account so they can be deployed to other projects. Does not touch any WordPress site.",
+      "description": "Pull ACF field groups, post types, taxonomies, and options pages from WordPress",
       "examples": [
-        "$ lps snippet publish",
-        "$ lps snippet publish --path ./snippets"
+        "$ lps acf pull",
+        "$ lps acf pull --type field-groups"
       ],
-      "flags": {},
+      "flags": {
+        "dry-run": {
+          "char": "d",
+          "description": "Show what would change without making changes",
+          "name": "dry-run",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "type": {
+          "description": "Limit to specific ACF object types",
+          "name": "type",
+          "hasDynamicHelp": false,
+          "multiple": true,
+          "options": [
+            "field-groups",
+            "post-types",
+            "taxonomies",
+            "options-pages"
+          ],
+          "type": "option"
+        }
+      },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "snippet:publish",
+      "id": "acf:pull",
       "pluginAlias": "@loopress/cli",
       "pluginName": "@loopress/cli",
       "pluginType": "core",
       "strict": true,
       "enableJsonFlag": false,
+      "dryRunFlag": {
+        "dry-run": {
+          "char": "d",
+          "description": "Show what would change without making changes",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
       "isESM": true,
       "relativePath": [
         "dist",
         "commands",
-        "snippet",
-        "publish.js"
+        "acf",
+        "pull.js"
       ]
     },
-    "snippet:pull": {
+    "acf:push": {
       "aliases": [],
       "args": {
         "path": {
-          "description": "Path to snippets directory (overrides project config)",
+          "description": "Path to ACF directory (overrides project config)",
           "name": "path"
         }
       },
-      "description": "Pull snippets from WordPress",
+      "description": "Push ACF field groups, post types, taxonomies, and options pages to WordPress",
       "examples": [
-        "$ lps snippet pull",
-        "$ lps snippet pull --path ./snippets"
+        "$ lps acf push",
+        "$ lps acf push --type field-groups"
       ],
       "flags": {
         "dry-run": {
@@ -203,11 +246,56 @@
           "name": "dry-run",
           "allowNo": false,
           "type": "boolean"
+        },
+        "type": {
+          "description": "Limit to specific ACF object types",
+          "name": "type",
+          "hasDynamicHelp": false,
+          "multiple": true,
+          "options": [
+            "field-groups",
+            "post-types",
+            "taxonomies",
+            "options-pages"
+          ],
+          "type": "option"
         }
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "snippet:pull",
+      "id": "acf:push",
+      "pluginAlias": "@loopress/cli",
+      "pluginName": "@loopress/cli",
+      "pluginType": "core",
+      "strict": true,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "acf",
+        "push.js"
+      ]
+    },
+    "composer:init": {
+      "aliases": [],
+      "args": {},
+      "description": "Create a composer.json wired to WPackagist for installing WordPress.org plugins and themes",
+      "examples": [
+        "$ lps composer init",
+        "$ lps composer init --dry-run"
+      ],
+      "flags": {
+        "dry-run": {
+          "char": "d",
+          "description": "Show what would change without making changes",
+          "name": "dry-run",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "composer:init",
       "pluginAlias": "@loopress/cli",
       "pluginName": "@loopress/cli",
       "pluginType": "core",
@@ -225,22 +313,58 @@
       "relativePath": [
         "dist",
         "commands",
-        "snippet",
-        "pull.js"
+        "composer",
+        "init.js"
       ]
     },
-    "snippet:push": {
+    "composer:pull": {
       "aliases": [],
-      "args": {
-        "path": {
-          "description": "Path to snippets directory (overrides project config)",
-          "name": "path"
+      "args": {},
+      "description": "Pull composer.json and composer.lock from WordPress",
+      "examples": [
+        "$ lps composer pull",
+        "$ lps composer pull --dry-run"
+      ],
+      "flags": {
+        "dry-run": {
+          "char": "d",
+          "description": "Show what would change without making changes",
+          "name": "dry-run",
+          "allowNo": false,
+          "type": "boolean"
         }
       },
-      "description": "Push snippets to WordPress. Local snippet files created or updated remotely are renamed on disk to the `<id>-<slug>` convention.",
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "composer:pull",
+      "pluginAlias": "@loopress/cli",
+      "pluginName": "@loopress/cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "dryRunFlag": {
+        "dry-run": {
+          "char": "d",
+          "description": "Show what would change without making changes",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "composer",
+        "pull.js"
+      ]
+    },
+    "composer:push": {
+      "aliases": [],
+      "args": {},
+      "description": "Push composer.json and composer.lock to WordPress and run composer install",
       "examples": [
-        "$ lps snippet push",
-        "$ lps snippet push --path ./snippets"
+        "$ lps composer push",
+        "$ lps composer push --dry-run"
       ],
       "flags": {
         "dry-run": {
@@ -253,7 +377,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "snippet:push",
+      "id": "composer:push",
       "pluginAlias": "@loopress/cli",
       "pluginName": "@loopress/cli",
       "pluginType": "core",
@@ -262,7 +386,7 @@
       "relativePath": [
         "dist",
         "commands",
-        "snippet",
+        "composer",
         "push.js"
       ]
     },
@@ -410,6 +534,159 @@
         "switch.js"
       ]
     },
+    "snippet:list": {
+      "aliases": [],
+      "args": {},
+      "description": "List snippets from WordPress",
+      "examples": [
+        "$ lps snippet list"
+      ],
+      "flags": {
+        "json": {
+          "char": "j",
+          "description": "Output in JSON format",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "snippet:list",
+      "pluginAlias": "@loopress/cli",
+      "pluginName": "@loopress/cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "dryRunFlag": {
+        "dry-run": {
+          "char": "d",
+          "description": "Show what would change without making changes",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "snippet",
+        "list.js"
+      ]
+    },
+    "snippet:publish": {
+      "aliases": [],
+      "args": {
+        "path": {
+          "description": "Path to snippets directory (overrides project config)",
+          "name": "path"
+        }
+      },
+      "description": "Publish snippets to your Loopress account so they can be deployed to other projects. Does not touch any WordPress site.",
+      "examples": [
+        "$ lps snippet publish",
+        "$ lps snippet publish --path ./snippets"
+      ],
+      "flags": {},
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "snippet:publish",
+      "pluginAlias": "@loopress/cli",
+      "pluginName": "@loopress/cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "snippet",
+        "publish.js"
+      ]
+    },
+    "snippet:pull": {
+      "aliases": [],
+      "args": {
+        "path": {
+          "description": "Path to snippets directory (overrides project config)",
+          "name": "path"
+        }
+      },
+      "description": "Pull snippets from WordPress",
+      "examples": [
+        "$ lps snippet pull",
+        "$ lps snippet pull --path ./snippets"
+      ],
+      "flags": {
+        "dry-run": {
+          "char": "d",
+          "description": "Show what would change without making changes",
+          "name": "dry-run",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "snippet:pull",
+      "pluginAlias": "@loopress/cli",
+      "pluginName": "@loopress/cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "dryRunFlag": {
+        "dry-run": {
+          "char": "d",
+          "description": "Show what would change without making changes",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "snippet",
+        "pull.js"
+      ]
+    },
+    "snippet:push": {
+      "aliases": [],
+      "args": {
+        "path": {
+          "description": "Path to snippets directory (overrides project config)",
+          "name": "path"
+        }
+      },
+      "description": "Push snippets to WordPress. Local snippet files created or updated remotely are renamed on disk to the `<id>-<slug>` convention.",
+      "examples": [
+        "$ lps snippet push",
+        "$ lps snippet push --path ./snippets"
+      ],
+      "flags": {
+        "dry-run": {
+          "char": "d",
+          "description": "Show what would change without making changes",
+          "name": "dry-run",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "snippet:push",
+      "pluginAlias": "@loopress/cli",
+      "pluginName": "@loopress/cli",
+      "pluginType": "core",
+      "strict": true,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "snippet",
+        "push.js"
+      ]
+    },
     "plugin:add": {
       "aliases": [],
       "args": {
@@ -577,80 +854,7 @@
         "telemetry",
         "enable.js"
       ]
-    },
-    "composer:pull": {
-      "aliases": [],
-      "args": {},
-      "description": "Pull composer.lock from WordPress",
-      "examples": [
-        "$ lps composer pull",
-        "$ lps composer pull --dry-run"
-      ],
-      "flags": {
-        "dry-run": {
-          "char": "d",
-          "description": "Show what would change without making changes",
-          "name": "dry-run",
-          "allowNo": false,
-          "type": "boolean"
-        }
-      },
-      "hasDynamicHelp": false,
-      "hiddenAliases": [],
-      "id": "composer:pull",
-      "pluginAlias": "@loopress/cli",
-      "pluginName": "@loopress/cli",
-      "pluginType": "core",
-      "strict": true,
-      "enableJsonFlag": false,
-      "dryRunFlag": {
-        "dry-run": {
-          "char": "d",
-          "description": "Show what would change without making changes",
-          "allowNo": false,
-          "type": "boolean"
-        }
-      },
-      "isESM": true,
-      "relativePath": [
-        "dist",
-        "commands",
-        "composer",
-        "pull.js"
-      ]
-    },
-    "composer:push": {
-      "aliases": [],
-      "args": {},
-      "description": "Push composer.json and composer.lock to WordPress and run composer install",
-      "examples": [
-        "$ lps composer push",
-        "$ lps composer push --dry-run"
-      ],
-      "flags": {
-        "dry-run": {
-          "char": "d",
-          "description": "Show what would change without making changes",
-          "name": "dry-run",
-          "allowNo": false,
-          "type": "boolean"
-        }
-      },
-      "hasDynamicHelp": false,
-      "hiddenAliases": [],
-      "id": "composer:push",
-      "pluginAlias": "@loopress/cli",
-      "pluginName": "@loopress/cli",
-      "pluginType": "core",
-      "strict": true,
-      "isESM": true,
-      "relativePath": [
-        "dist",
-        "commands",
-        "composer",
-        "push.js"
-      ]
     }
   },
-  "version": "0.15.0"
+  "version": "0.16.0"
 }

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.15.0",
+  "version": "0.16.0",
   "author": "jean-smaug",
   "bin": {
     "loopress": "bin/run.js",
@@ -84,6 +84,9 @@
     ],
     "topicSeparator": " ",
     "topics": {
+      "acf": {
+        "description": "Manage ACF field groups, post types, taxonomies, and options pages"
+      },
       "composer": {
         "description": "Sync composer.json and composer.lock between your project and WordPress"
       },