@loopress/cli 0.9.0 → 0.10.0

package/README.md

@@ -21,7 +21,7 @@ $ npm install -g @loopress/cli
 $ lps COMMAND
 running command...
 $ lps (--version)
-@loopress/cli/0.9.0 linux-x64 node-v24.18.0
+@loopress/cli/0.10.0 linux-x64 node-v24.18.0
 $ lps --help [COMMAND]
 USAGE
   $ lps COMMAND
@@ -84,7 +84,7 @@ EXAMPLES
   $ lps composer pull --dry-run
 ```
 
-_See code: [src/commands/composer/pull.ts](https://github.com/loopress/loopress/blob/v0.9.0/src/commands/composer/pull.ts)_
+_See code: [src/commands/composer/pull.ts](https://github.com/loopress/loopress/blob/v0.10.0/src/commands/composer/pull.ts)_
 
 ## `lps composer push`
 
@@ -106,7 +106,7 @@ EXAMPLES
   $ lps composer push --dry-run
 ```
 
-_See code: [src/commands/composer/push.ts](https://github.com/loopress/loopress/blob/v0.9.0/src/commands/composer/push.ts)_
+_See code: [src/commands/composer/push.ts](https://github.com/loopress/loopress/blob/v0.10.0/src/commands/composer/push.ts)_
 
 ## `lps help [COMMAND]`
 
@@ -143,7 +143,7 @@ EXAMPLES
   $ lps init
 ```
 
-_See code: [src/commands/init.ts](https://github.com/loopress/loopress/blob/v0.9.0/src/commands/init.ts)_
+_See code: [src/commands/init.ts](https://github.com/loopress/loopress/blob/v0.10.0/src/commands/init.ts)_
 
 ## `lps login`
 
@@ -160,7 +160,7 @@ EXAMPLES
   $ lps login
 ```
 
-_See code: [src/commands/login.ts](https://github.com/loopress/loopress/blob/v0.9.0/src/commands/login.ts)_
+_See code: [src/commands/login.ts](https://github.com/loopress/loopress/blob/v0.10.0/src/commands/login.ts)_
 
 ## `lps logout`
 
@@ -177,7 +177,7 @@ EXAMPLES
   $ lps logout
 ```
 
-_See code: [src/commands/logout.ts](https://github.com/loopress/loopress/blob/v0.9.0/src/commands/logout.ts)_
+_See code: [src/commands/logout.ts](https://github.com/loopress/loopress/blob/v0.10.0/src/commands/logout.ts)_
 
 ## `lps plugin add SLUG [VERSION]`
 
@@ -205,7 +205,7 @@ EXAMPLES
   $ lps plugin add contact-form-7 --dry-run
 ```
 
-_See code: [src/commands/plugin/add.ts](https://github.com/loopress/loopress/blob/v0.9.0/src/commands/plugin/add.ts)_
+_See code: [src/commands/plugin/add.ts](https://github.com/loopress/loopress/blob/v0.10.0/src/commands/plugin/add.ts)_
 
 ## `lps plugin pull`
 
@@ -227,7 +227,7 @@ EXAMPLES
   $ lps plugin pull --dry-run
 ```
 
-_See code: [src/commands/plugin/pull.ts](https://github.com/loopress/loopress/blob/v0.9.0/src/commands/plugin/pull.ts)_
+_See code: [src/commands/plugin/pull.ts](https://github.com/loopress/loopress/blob/v0.10.0/src/commands/plugin/pull.ts)_
 
 ## `lps plugin push`
 
@@ -249,7 +249,7 @@ EXAMPLES
   $ lps plugin push --dry-run
 ```
 
-_See code: [src/commands/plugin/push.ts](https://github.com/loopress/loopress/blob/v0.9.0/src/commands/plugin/push.ts)_
+_See code: [src/commands/plugin/push.ts](https://github.com/loopress/loopress/blob/v0.10.0/src/commands/plugin/push.ts)_
 
 ## `lps project config`
 
@@ -266,7 +266,7 @@ EXAMPLES
   $ lps project config
 ```
 
-_See code: [src/commands/project/config.ts](https://github.com/loopress/loopress/blob/v0.9.0/src/commands/project/config.ts)_
+_See code: [src/commands/project/config.ts](https://github.com/loopress/loopress/blob/v0.10.0/src/commands/project/config.ts)_
 
 ## `lps project list`
 
@@ -283,7 +283,7 @@ EXAMPLES
   $ lps project list
 ```
 
-_See code: [src/commands/project/list.ts](https://github.com/loopress/loopress/blob/v0.9.0/src/commands/project/list.ts)_
+_See code: [src/commands/project/list.ts](https://github.com/loopress/loopress/blob/v0.10.0/src/commands/project/list.ts)_
 
 ## `lps project remove`
 
@@ -300,7 +300,7 @@ EXAMPLES
   $ lps project remove
 ```
 
-_See code: [src/commands/project/remove.ts](https://github.com/loopress/loopress/blob/v0.9.0/src/commands/project/remove.ts)_
+_See code: [src/commands/project/remove.ts](https://github.com/loopress/loopress/blob/v0.10.0/src/commands/project/remove.ts)_
 
 ## `lps project switch`
 
@@ -317,7 +317,7 @@ EXAMPLES
   $ lps project switch
 ```
 
-_See code: [src/commands/project/switch.ts](https://github.com/loopress/loopress/blob/v0.9.0/src/commands/project/switch.ts)_
+_See code: [src/commands/project/switch.ts](https://github.com/loopress/loopress/blob/v0.10.0/src/commands/project/switch.ts)_
 
 ## `lps snippet list`
 
@@ -341,7 +341,7 @@ EXAMPLES
   $ lps snippet list --plugin wpcode
 ```
 
-_See code: [src/commands/snippet/list.ts](https://github.com/loopress/loopress/blob/v0.9.0/src/commands/snippet/list.ts)_
+_See code: [src/commands/snippet/list.ts](https://github.com/loopress/loopress/blob/v0.10.0/src/commands/snippet/list.ts)_
 
 ## `lps snippet pull [PATH]`
 
@@ -370,7 +370,7 @@ EXAMPLES
   $ lps snippet pull --plugin wpcode
 ```
 
-_See code: [src/commands/snippet/pull.ts](https://github.com/loopress/loopress/blob/v0.9.0/src/commands/snippet/pull.ts)_
+_See code: [src/commands/snippet/pull.ts](https://github.com/loopress/loopress/blob/v0.10.0/src/commands/snippet/pull.ts)_
 
 ## `lps snippet push [PATH]`
 
@@ -400,7 +400,7 @@ EXAMPLES
   $ lps snippet push --plugin wpcode
 ```
 
-_See code: [src/commands/snippet/push.ts](https://github.com/loopress/loopress/blob/v0.9.0/src/commands/snippet/push.ts)_
+_See code: [src/commands/snippet/push.ts](https://github.com/loopress/loopress/blob/v0.10.0/src/commands/snippet/push.ts)_
 
 ## `lps status`
 
@@ -417,5 +417,5 @@ EXAMPLES
   $ lps status
 ```
 
-_See code: [src/commands/status.ts](https://github.com/loopress/loopress/blob/v0.9.0/src/commands/status.ts)_
+_See code: [src/commands/status.ts](https://github.com/loopress/loopress/blob/v0.10.0/src/commands/status.ts)_
 <!-- commandsstop -->

package/oclif.manifest.json

@@ -570,5 +570,5 @@
       ]
     }
   },
-  "version": "0.9.0"
+  "version": "0.10.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.9.0",
+  "version": "0.10.0",
   "author": "jean-smaug",
   "bin": {
     "loopress": "bin/run.js",
@@ -46,6 +46,7 @@
   "files": [
     "./bin",
     "./dist",
+    "./schemas",
     "./oclif.manifest.json"
   ],
   "homepage": "https://github.com/loopress/loopress",

package/schemas/global-config.schema.json

@@ -0,0 +1,83 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://loopress.dev/schema/global-config.json",
+  "title": "Loopress global configuration",
+  "description": "Global CLI state stored at ~/.loopress/config.json: known projects, their environments, and which one is currently active.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["currentProject", "projects"],
+  "properties": {
+    "currentProject": {
+      "description": "Pointer to the currently active project and environment, or null if none is selected.",
+      "oneOf": [{"type": "null"}, {"$ref": "#/definitions/CurrentProjectPointer"}]
+    },
+    "projects": {
+      "type": "object",
+      "description": "Known projects, keyed by project id.",
+      "additionalProperties": {"$ref": "#/definitions/ProjectConfig"}
+    }
+  },
+  "definitions": {
+    "CurrentProjectPointer": {
+      "title": "CurrentProjectPointer",
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["env", "id"],
+      "properties": {
+        "env": {
+          "type": "string",
+          "description": "Name of the currently active environment."
+        },
+        "id": {
+          "type": "string",
+          "description": "Id of the currently active project."
+        }
+      }
+    },
+    "ProjectConfig": {
+      "title": "ProjectConfig",
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["addedAt", "environments", "name"],
+      "properties": {
+        "addedAt": {
+          "type": "string",
+          "description": "ISO timestamp of when the project was added."
+        },
+        "environments": {
+          "type": "object",
+          "description": "Environments for this project, keyed by environment name.",
+          "additionalProperties": {"$ref": "#/definitions/EnvironmentConfig"}
+        },
+        "name": {
+          "type": "string",
+          "description": "Human-readable project name."
+        }
+      }
+    },
+    "EnvironmentConfig": {
+      "title": "EnvironmentConfig",
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["addedAt", "name", "url"],
+      "properties": {
+        "addedAt": {
+          "type": "string",
+          "description": "ISO timestamp of when the environment was added."
+        },
+        "name": {
+          "type": "string",
+          "description": "Environment name (e.g. \"production\", \"staging\")."
+        },
+        "token": {
+          "type": "string",
+          "description": "API token used to authenticate against this environment."
+        },
+        "url": {
+          "type": "string",
+          "description": "Base URL of the WordPress site for this environment."
+        }
+      }
+    }
+  }
+}

package/schemas/project-config.schema.json

@@ -0,0 +1,48 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://loopress.dev/schema/project-config.json",
+  "title": "Loopress project configuration",
+  "description": "Project-level config for the Loopress CLI (loopress.json).",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "$schema": {
+      "type": "string"
+    },
+    "rootDir": {
+      "type": "string",
+      "description": "Base directory for all Loopress paths. All other path options are resolved relative to this directory.",
+      "default": "."
+    },
+    "snippetsDir": {
+      "type": "string",
+      "description": "Directory where code snippets are read from and written to, relative to rootDir.",
+      "default": "snippets"
+    },
+    "projectId": {
+      "type": "string",
+      "description": "Project identifier from the global Loopress config. When set, takes precedence over the currently active project in the global config."
+    },
+    "snippetPlugin": {
+      "type": "string",
+      "description": "WordPress snippet plugin to use for pull and push commands.",
+      "enum": ["wpcode", "code-snippets"],
+      "default": "wpcode"
+    },
+    "plugins": {
+      "type": "object",
+      "description": "Pinned plugin versions. Keys are WordPress.org plugin slugs, values are version constraints.",
+      "additionalProperties": {
+        "type": "string",
+        "description": "Version to pin. Use an exact version (e.g. \"8.9.1\") or \"latest\".",
+        "examples": ["8.9.1", "latest"]
+      },
+      "examples": [
+        {
+          "woocommerce": "8.9.1",
+          "contact-form-7": "latest"
+        }
+      ]
+    }
+  }
+}

package/schemas/snippet.schema.json

@@ -0,0 +1,61 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://loopress.dev/schema/snippet.json",
+  "title": "Loopress snippet metadata",
+  "description": "Sidecar .json file paired with a snippet's code file in the snippets directory (e.g. `123-my-snippet.php` + `123-my-snippet.json`).",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "$schema": {
+      "type": "string"
+    },
+    "id": {
+      "type": "integer",
+      "description": "Remote snippet id. Omitted until the snippet has been pushed for the first time."
+    },
+    "name": {
+      "type": "string",
+      "description": "Snippet name/title. Defaults to the code file's name when omitted."
+    },
+    "type": {
+      "type": "string",
+      "description": "Snippet language. Defaults to the type inferred from the code file's extension when omitted.",
+      "enum": ["css", "html", "js", "php", "text"]
+    },
+    "active": {
+      "type": "boolean",
+      "description": "Whether the snippet is enabled.",
+      "default": false
+    },
+    "location": {
+      "type": "string",
+      "description": "Where the snippet runs. Supported values depend on the target plugin and snippet type.",
+      "enum": ["admin", "body", "everywhere", "footer", "frontend", "header", "once"]
+    },
+    "description": {
+      "type": "string",
+      "description": "Free-text note about the snippet."
+    },
+    "tags": {
+      "type": "array",
+      "description": "Tags for organizing snippets.",
+      "items": {"type": "string"}
+    },
+    "insertMethod": {
+      "type": "string",
+      "description": "How the snippet is inserted into the page.",
+      "enum": ["auto", "shortcode"],
+      "default": "auto"
+    },
+    "priority": {
+      "type": "integer",
+      "description": "Execution priority. Lower runs earlier.",
+      "default": 10
+    },
+    "shortcodeAttributes": {
+      "type": "array",
+      "description": "Attribute names accepted by the snippet's shortcode, used when insertMethod is \"shortcode\".",
+      "items": {"type": "string"}
+    }
+  }
+}