@shopify/oxygen-cli 1.3.1 → 1.4.0

package/README.md

@@ -35,14 +35,14 @@ oxygen:deploy [options]
 ### Options
 
 - -t, --token <token>: (required) Oxygen deployment token. Can also be set using the `OXYGEN_DEPLOYMENT_TOKEN` environment variable (see below).
-- -r, --rootPath <rootPath>: Root path (defaults to the current working directory).
+- -p, --path <rootPath>: Root path (defaults to the current working directory).
 - -e, --environmentTag <environmentTag>: Tag of the environment to deploy to. Defaults to branch name in supported CI environments (see below).
 - -w, --workerFolder <workerFolder>: Worker folder (default: `dist/worker/`).
 - -a, --assetsFolder <assetsFolder>: Assets folder (default: `dist/client/`).
 - -o, --workerOnly: Worker only deployment.
 - -s, --skipBuild: Skip running build command.
-- -p, --publicDeployment: set the deployment to be publicly accessible.
 - -b, --buildCommand <buildCommand>: Build command (default: `yarn build`).
+- --publicDeployment: set the deployment to be publicly accessible.
 - --metadataUrl <metadataUrl>: URL that links to the deployment.
 - --metadataUser <metadataUser>: User that initiated the deployment.
 - --metadataVersion <metadataVersion>: A version identifier for the deployment.
@@ -52,7 +52,7 @@ oxygen:deploy [options]
 ### Example:
 
 ```
-oxygen:deploy -t my-deployment-token -e staging --rootPath="/my-project" --workerOnly
+oxygen:deploy -t my-deployment-token -e staging --path="/my-project" --workerOnly
 ```
 
 This command will deploy your Oxygen project to the staging environment with the provided deployment token and root path. No static assets will be uploaded.

package/dist/commands/oxygen/deploy.d.ts

@@ -6,8 +6,8 @@ declare class Deploy extends Command {
     static description: string;
     static hidden: boolean;
     static flags: {
-        token: _oclif_core_lib_interfaces_parser_js.OptionFlag<string, _oclif_core_lib_interfaces_parser_js.CustomOptions>;
-        rootPath: _oclif_core_lib_interfaces_parser_js.OptionFlag<string, _oclif_core_lib_interfaces_parser_js.CustomOptions>;
+        token: _oclif_core_lib_interfaces_parser_js.OptionFlag<string | undefined, _oclif_core_lib_interfaces_parser_js.CustomOptions>;
+        path: _oclif_core_lib_interfaces_parser_js.OptionFlag<string, _oclif_core_lib_interfaces_parser_js.CustomOptions>;
         environmentTag: _oclif_core_lib_interfaces_parser_js.OptionFlag<string | undefined, _oclif_core_lib_interfaces_parser_js.CustomOptions>;
         workerFolder: _oclif_core_lib_interfaces_parser_js.OptionFlag<string, _oclif_core_lib_interfaces_parser_js.CustomOptions>;
         assetsFolder: _oclif_core_lib_interfaces_parser_js.OptionFlag<string, _oclif_core_lib_interfaces_parser_js.CustomOptions>;

package/dist/commands/oxygen/deploy.js

@@ -12,10 +12,10 @@ class Deploy extends Command {
       char: "t",
       description: "Oxygen deployment token",
       env: "OXYGEN_DEPLOYMENT_TOKEN",
-      required: true
+      required: false
     }),
-    rootPath: Flags.string({
-      char: "r",
+    path: Flags.string({
+      char: "p",
       description: "Root path",
       default: "./",
       required: false
@@ -60,7 +60,6 @@ class Deploy extends Command {
       }
     }),
     publicDeployment: Flags.boolean({
-      char: "p",
       env: "OXYGEN_PUBLIC_DEPLOYMENT",
       description: "Marks a preview deployment as publicly accessible.",
       required: false,
@@ -102,7 +101,7 @@ class Deploy extends Command {
           version: flags.metadataVersion
         },
         publicDeployment: flags.publicDeployment,
-        rootPath: normalizePath(flags.rootPath),
+        rootPath: normalizePath(flags.path),
         skipBuild: flags.skipBuild,
         workerDir: normalizePath(flags.workerFolder),
         workerOnly: flags.workerOnly

package/dist/utils/utils.js

@@ -72,6 +72,11 @@ function stderrLogger(log) {
 }
 const maxLabelLength = 90;
 function parseToken(inputToken) {
+  if (!inputToken) {
+    throw new Error(
+      "No deployment token provided. Use the --token flag to set a deployment token."
+    );
+  }
   try {
     const decodedToken = Buffer.from(inputToken, "base64").toString("utf-8");
     const rawToken = JSON.parse(decodedToken);

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.3.1",
+  "version": "1.4.0",
   "commands": {
     "oxygen:deploy": {
       "id": "oxygen:deploy",
@@ -16,13 +16,13 @@
           "type": "option",
           "char": "t",
           "description": "Oxygen deployment token",
-          "required": true,
+          "required": false,
           "multiple": false
         },
-        "rootPath": {
-          "name": "rootPath",
+        "path": {
+          "name": "path",
           "type": "option",
-          "char": "r",
+          "char": "p",
           "description": "Root path",
           "required": false,
           "multiple": false,
@@ -82,7 +82,6 @@
         "publicDeployment": {
           "name": "publicDeployment",
           "type": "boolean",
-          "char": "p",
           "description": "Marks a preview deployment as publicly accessible.",
           "required": false,
           "allowNo": false

package/package.json

@@ -5,7 +5,7 @@
     "@shopify:registry": "https://registry.npmjs.org"
   },
   "license": "MIT",
-  "version": "1.3.1",
+  "version": "1.4.0",
   "type": "module",
   "scripts": {
     "build": "tsup --clean --config ./tsup.config.ts && oclif manifest",
@@ -31,8 +31,8 @@
     "/oclif.manifest.json"
   ],
   "dependencies": {
-    "@oclif/core": "2.8.6",
-    "@shopify/cli-kit": "^3.46.0",
+    "@oclif/core": "2.8.7",
+    "@shopify/cli-kit": "^3.46.5",
     "async": "^3.2.4"
   },
   "devDependencies": {
@@ -40,15 +40,15 @@
     "@shopify/eslint-plugin": "^42.1.0",
     "@shopify/prettier-config": "^1.1.2",
     "@types/async": "^3.2.18",
-    "@types/node": "^18.15.11",
+    "@types/node": "^20.3.1",
     "@types/prettier": "^2.7.3",
-    "eslint": "^8.42.0",
+    "eslint": "^8.43.0",
     "node-fetch": "^3.3.1",
     "oclif": "^3",
     "tsup": "^6.7.0",
     "typescript": "^5.1.3",
     "vite": "^4.3.9",
-    "vitest": "^0.32.0"
+    "vitest": "^0.32.2"
   },
   "prettier": "@shopify/prettier-config",
   "oclif": {