@swell/cli 2.0.1-alpha.0 → 2.0.1-alpha.3

package/README.md

@@ -1,141 +1,3 @@
-# @swell/cli
+# @swell/cli 2 alpha
 
-#We're in beta: commands and arguments can still change.#
-
-Install with:
-
-```sh
-npm install -g @swell/cli
-```
-
-If you are using tools for version managing like [asdf](https://asdf-vm.com/), make sure you [reshim](https://asdf-vm.com/manage/core.html#reshim) after install:
-
-```sh
-asdf reshim
-```
-
-# Commands
-
-## General options
-
-Commands tend to support the following helper options:
-
-- --quiet (-q): Boolean, quiets the progress indicator and output of intermediary commands
-- --verbose (-v): Boolean, outputs all commands
-- --dry-run: Boolean, dry runs requests that delete data, but doesn't run them
-- --yes (-y): Boolean, answers all confirmation questions with **yes**.
-
-## Login
-
-The `admin login` command authenticates and stores a user's session locally. Saved sessions can/will be used by other commands, unless a secret key is specified.
-
-```sh
-swell login [--username (-u) String] [--password (-p) String] [--set-default Boolean]
-```
-
-### Examples
-
-```sh
-swell login
-swell login --set-default
-```
-
-## Storefronts
-
-List all storefronts associated to logged in user:
-
-```sh
-swell storefronts list
-```
-
-Retrieves storefront configuration data from the server and writes it to a file if specified or stdout by default. It requires a type to run. Configuration types allowed are "editor", "menus" and "settings":
-```sh
-swell storefronts pull --id String --type (-t) String [--file (-f) String]
-```
-
-Send storefront configuration data to the server. Configuration types allowed are "editor", "menus" and "settings":
-```sh
-swell storefronts push --id String --type (-t) String [--file (-f) String] [--strategy (-i) String]
-```
-
-### Examples
-
-```sh
-swell storefronts pull --id P5OzfzLD -t editor
-swell storefronts pull --id P5OzfzLD -t menus -f menus.json
-swell storefronts push --id P5OzfzLD -t editor -s set -f ../origin-storefront/config/editor.json
-```
-
-### Without logging in
-
-```sh
-swell storefronts pull --id P5OzfzLD -t editor --store my-test-store --secret-key my-dev-secret-key
-swell storefronts pull --id P5OzfzLD -t menus -f menus.json --store my-test-store --secret-key my-dev-secret-key
-swell storefronts push --id P5OzfzLD -t editor -s set -f ../origin-storefront/config/editor.json --store my-test-store --secret-key my-dev-secret-key
-```
-
-## Model
-
-Push or pull model definitions, including namespaced models (e.g. content models), abstract content models and content fields.
-
-```sh
-# pull => retrieves a model from the server and tries to merge and/or write to a specified JSON file or stdout (by default)
-# --content flag toggles between base models and abstract content models or content fields
-swell model pull -m MODEL_ID [--file (-f) String] [--strategy (-s) String] [--content Boolean]
-
-# push => send a model definition from a JSON file or stdin to the server
-swell model push [--file (-f) String] [--input (-i) stdin] [--content Boolean]
-```
-
-It is important that the model definition includes some fields depending on the type/source of the model.
-
-#### Basic model
-
-```json
-{
-    "name": "Test", // slug will be assumed from this field
-    "slug": "test_model", // or you can define one explicitly
-    "fields": { ... }
-}
-```
-
-#### Namespaced model
-
-```json
-{
-    "name": "Page", // slug will be assumed from this field
-    "namespace": "content",
-    "fields": { ... }
-}
-```
-
-#### Theme content (abstract) model/fields (use with --content flag)
-
-```json
-{
-    "name": "Test", // slug will be assumed from this field
-    "fields": { ... },
-    "source_type": "theme",
-    "source_id": "origin"
-}
-```
-
-### Examples
-
-```sh
-swell model pull -m products # pull products model and display in stdout
-swell model pull -m theme.origin.page --content -f models/page.json # pull a content model and save it to a file
-
-swell model push -f models/orders.json
-swell model push -c -f models/page.json # push a content model
-```
-
-### Without logging in
-
-```sh
-swell model pull -m products --store my-test-store --secret-key my-dev-secret-key
-swell model pull -m theme.origin.page --content -f models/page.json --store my-test-store --secret-key my-dev-secret-key
-
-swell model push -f models/orders.json --store my-test-store --secret-key my-dev-secret-key
-swell model push -c -f models/page.json --store my-test-store --secret-key my-dev-secret-key
-```
+Find the alpha docs at https://www.notion.so/swellcorp/CLI-reference-c3553ebb3de24d94becbedf95a5a25d8?pvs=4

package/oclif.manifest.json

@@ -1081,5 +1081,5 @@
       ]
     }
   },
-  "version": "2.0.1-alpha.0"
+  "version": "2.0.1-alpha.3"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@swell/cli",
-  "version": "2.0.1-alpha.0",
+  "version": "2.0.1-alpha.3",
   "type": "module",
   "description": "Swell's command line interface/utility",
   "keywords": [
@@ -26,27 +26,28 @@
     "/oclif.manifest.json"
   ],
   "dependencies": {
+    "@inquirer/prompts": "3.2.0",
     "@npmcli/git": "5.0.3",
     "@oclif/core": "3.7.1",
+    "@oclif/errors": "1.3.6",
     "@oclif/plugin-help": "6.0.4",
     "@oclif/plugin-plugins": "3.9.4",
+    "chalk": "5.3.0",
     "conf": "11.0.2",
     "configstore": "6.0.0",
+    "esbuild": "0.19.5",
     "inflection": "3.0.0",
+    "lodash": "4.17.21",
     "node-fetch": "3.3.2",
     "oclif": "4.0.3",
     "open": "9.1.0",
+    "ora": "7.0.1",
     "semver": "7.5.4",
     "table": "6.8.1"
   },
   "devDependencies": {
-    "@inquirer/prompts": "3.2.0",
     "@inquirer/testing": "2.1.8",
-    "@oclif/errors": "1.3.6",
     "@oclif/test": "3.0.3",
-    "@rollup/plugin-commonjs": "25.0.7",
-    "@rollup/plugin-json": "6.0.1",
-    "@rollup/plugin-node-resolve": "15.2.3",
     "@types/chai": "4.3.9",
     "@types/configstore": "6.0.1",
     "@types/inquirer": "9.0.6",
@@ -54,30 +55,20 @@
     "@types/node": "20.8.8",
     "@typescript-eslint/eslint-plugin": "6.9.0",
     "chai": "4.3.10",
-    "chalk": "5.3.0",
-    "configstore": "6.0.0",
     "dotenv": "16.3.1",
-    "esbuild": "0.19.5",
     "eslint": "8.52.0",
     "eslint-config-oclif": "5.0.0",
     "eslint-config-oclif-typescript": "3.0.8",
     "eslint-config-prettier": "9.0.0",
     "eslint-plugin-prettier": "5.0.1",
     "eslint-plugin-unicorn": "48.0.1",
-    "list-it": "1.3.12",
-    "lodash": "4.17.21",
     "mocha": "10.2.0",
     "nock": "13.3.6",
-    "npm-decode": "1.4.2",
     "oclif": "4.0.3",
-    "ora": "7.0.1",
-    "rollup": "4.1.4",
     "shx": "0.3.4",
     "testdouble": "3.20.0",
     "ts-node": "10.9.1",
-    "tslib": "2.6.2",
-    "typescript": "5.2.2",
-    "uvu": "0.5.6"
+    "typescript": "5.2.2"
   },
   "oclif": {
     "bin": "swell",
@@ -103,7 +94,7 @@
     "posttest": "npm run lint",
     "prepack": "npm run build && oclif manifest && oclif readme",
     "test": "mocha --forbid-only \"test/**/*.test.ts\"",
-    "version": "oclif readme && git add README.md"
+    "publish-alpha": "npm version prerelease --preid=alpha && npm publish --tag alpha"
   },
   "engines": {
     "node": ">= 18.16.1"