@knocklabs/cli 0.1.14 → 0.1.16

package/README.md

@@ -16,7 +16,7 @@ $ npm install -g @knocklabs/cli
 $ knock COMMAND
 running command...
 $ knock (--version)
-@knocklabs/cli/0.1.14 linux-x64 node-v18.20.2
+@knocklabs/cli/0.1.16 linux-x64 node-v18.20.3
 $ knock --help [COMMAND]
 USAGE
   $ knock COMMAND
@@ -31,22 +31,12 @@ USAGE
 * [`knock commit get ID`](#knock-commit-get-id)
 * [`knock commit list`](#knock-commit-list)
 * [`knock commit promote`](#knock-commit-promote)
-* [`knock help [COMMANDS]`](#knock-help-commands)
+* [`knock help [COMMAND]`](#knock-help-command)
 * [`knock layout get EMAILLAYOUTKEY`](#knock-layout-get-emaillayoutkey)
 * [`knock layout list`](#knock-layout-list)
 * [`knock layout pull [EMAILLAYOUTKEY]`](#knock-layout-pull-emaillayoutkey)
 * [`knock layout push [EMAILLAYOUTKEY]`](#knock-layout-push-emaillayoutkey)
 * [`knock layout validate [EMAILLAYOUTKEY]`](#knock-layout-validate-emaillayoutkey)
-* [`knock plugins`](#knock-plugins)
-* [`knock plugins:install PLUGIN...`](#knock-pluginsinstall-plugin)
-* [`knock plugins:inspect PLUGIN...`](#knock-pluginsinspect-plugin)
-* [`knock plugins:install PLUGIN...`](#knock-pluginsinstall-plugin-1)
-* [`knock plugins:link PLUGIN`](#knock-pluginslink-plugin)
-* [`knock plugins:uninstall PLUGIN...`](#knock-pluginsuninstall-plugin)
-* [`knock plugins reset`](#knock-plugins-reset)
-* [`knock plugins:uninstall PLUGIN...`](#knock-pluginsuninstall-plugin-1)
-* [`knock plugins:uninstall PLUGIN...`](#knock-pluginsuninstall-plugin-2)
-* [`knock plugins update`](#knock-plugins-update)
 * [`knock translation get TRANSLATIONREF`](#knock-translation-get-translationref)
 * [`knock translation list`](#knock-translation-list)
 * [`knock translation pull [TRANSLATIONREF]`](#knock-translation-pull-translationref)
@@ -78,7 +68,7 @@ FLAGS
       --service-token=<value>   (required) The service token to authenticate with.
 ```
 
-_See code: [src/commands/commit/index.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.14/src/commands/commit/index.ts)_
+_See code: [src/commands/commit/index.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.16/src/commands/commit/index.ts)_
 
 ## `knock commit get ID`
 
@@ -95,7 +85,7 @@ GLOBAL FLAGS
   --json  Format output as json.
 ```
 
-_See code: [src/commands/commit/get.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.14/src/commands/commit/get.ts)_
+_See code: [src/commands/commit/get.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.16/src/commands/commit/get.ts)_
 
 ## `knock commit list`
 
@@ -119,7 +109,7 @@ GLOBAL FLAGS
   --json  Format output as json.
 ```
 
-_See code: [src/commands/commit/list.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.14/src/commands/commit/list.ts)_
+_See code: [src/commands/commit/list.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.16/src/commands/commit/list.ts)_
 
 ## `knock commit promote`
 
@@ -136,18 +126,18 @@ FLAGS
   --to=<value>             The destination environment to promote all changes from the preceding environment.
 ```
 
-_See code: [src/commands/commit/promote.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.14/src/commands/commit/promote.ts)_
+_See code: [src/commands/commit/promote.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.16/src/commands/commit/promote.ts)_
 
-## `knock help [COMMANDS]`
+## `knock help [COMMAND]`
 
 Display help for knock.
 
 ```
 USAGE
-  $ knock help [COMMANDS...] [-n]
+  $ knock help [COMMAND...] [-n]
 
 ARGUMENTS
-  COMMANDS...  Command to show help for.
+  COMMAND...  Command to show help for.
 
 FLAGS
   -n, --nested-commands  Include all nested commands in the output.
@@ -156,7 +146,7 @@ DESCRIPTION
   Display help for knock.
 ```
 
-_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.0.14/src/commands/help.ts)_
+_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.3/src/commands/help.ts)_
 
 ## `knock layout get EMAILLAYOUTKEY`
 
@@ -176,7 +166,7 @@ GLOBAL FLAGS
   --json  Format output as json.
 ```
 
-_See code: [src/commands/layout/get.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.14/src/commands/layout/get.ts)_
+_See code: [src/commands/layout/get.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.16/src/commands/layout/get.ts)_
 
 ## `knock layout list`
 
@@ -199,7 +189,7 @@ GLOBAL FLAGS
   --json  Format output as json.
 ```
 
-_See code: [src/commands/layout/list.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.14/src/commands/layout/list.ts)_
+_See code: [src/commands/layout/list.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.16/src/commands/layout/list.ts)_
 
 ## `knock layout pull [EMAILLAYOUTKEY]`
 
@@ -219,7 +209,7 @@ FLAGS
   --service-token=<value>     (required) The service token to authenticate with.
 ```
 
-_See code: [src/commands/layout/pull.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.14/src/commands/layout/pull.ts)_
+_See code: [src/commands/layout/pull.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.16/src/commands/layout/pull.ts)_
 
 ## `knock layout push [EMAILLAYOUTKEY]`
 
@@ -241,7 +231,7 @@ FLAGS
       --service-token=<value>   (required) The service token to authenticate with.
 ```
 
-_See code: [src/commands/layout/push.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.14/src/commands/layout/push.ts)_
+_See code: [src/commands/layout/push.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.16/src/commands/layout/push.ts)_
 
 ## `knock layout validate [EMAILLAYOUTKEY]`
 
@@ -260,286 +250,7 @@ FLAGS
   --service-token=<value>  (required) The service token to authenticate with.
 ```
 
-_See code: [src/commands/layout/validate.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.14/src/commands/layout/validate.ts)_
-
-## `knock plugins`
-
-List installed plugins.
-
-```
-USAGE
-  $ knock plugins [--json] [--core]
-
-FLAGS
-  --core  Show core plugins.
-
-GLOBAL FLAGS
-  --json  Format output as json.
-
-DESCRIPTION
-  List installed plugins.
-
-EXAMPLES
-  $ knock plugins
-```
-
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v4.3.3/src/commands/plugins/index.ts)_
-
-## `knock plugins:install PLUGIN...`
-
-Installs a plugin into the CLI.
-
-```
-USAGE
-  $ knock plugins add plugins:install PLUGIN...
-
-ARGUMENTS
-  PLUGIN...  Plugin to install.
-
-FLAGS
-  -f, --force    Run yarn install with force flag.
-  -h, --help     Show CLI help.
-  -s, --silent   Silences yarn output.
-  -v, --verbose  Show verbose yarn output.
-
-GLOBAL FLAGS
-  --json  Format output as json.
-
-DESCRIPTION
-  Installs a plugin into the CLI.
-  Can be installed from npm or a git url.
-
-  Installation of a user-installed plugin will override a core plugin.
-
-  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
-  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
-  the CLI without the need to patch and update the whole CLI.
-
-
-ALIASES
-  $ knock plugins add
-
-EXAMPLES
-  $ knock plugins add myplugin 
-
-  $ knock plugins add https://github.com/someuser/someplugin
-
-  $ knock plugins add someuser/someplugin
-```
-
-## `knock plugins:inspect PLUGIN...`
-
-Displays installation properties of a plugin.
-
-```
-USAGE
-  $ knock plugins inspect PLUGIN...
-
-ARGUMENTS
-  PLUGIN...  [default: .] Plugin to inspect.
-
-FLAGS
-  -h, --help     Show CLI help.
-  -v, --verbose
-
-GLOBAL FLAGS
-  --json  Format output as json.
-
-DESCRIPTION
-  Displays installation properties of a plugin.
-
-EXAMPLES
-  $ knock plugins inspect myplugin
-```
-
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v4.3.3/src/commands/plugins/inspect.ts)_
-
-## `knock plugins:install PLUGIN...`
-
-Installs a plugin into the CLI.
-
-```
-USAGE
-  $ knock plugins install PLUGIN...
-
-ARGUMENTS
-  PLUGIN...  Plugin to install.
-
-FLAGS
-  -f, --force    Run yarn install with force flag.
-  -h, --help     Show CLI help.
-  -s, --silent   Silences yarn output.
-  -v, --verbose  Show verbose yarn output.
-
-GLOBAL FLAGS
-  --json  Format output as json.
-
-DESCRIPTION
-  Installs a plugin into the CLI.
-  Can be installed from npm or a git url.
-
-  Installation of a user-installed plugin will override a core plugin.
-
-  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
-  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
-  the CLI without the need to patch and update the whole CLI.
-
-
-ALIASES
-  $ knock plugins add
-
-EXAMPLES
-  $ knock plugins install myplugin 
-
-  $ knock plugins install https://github.com/someuser/someplugin
-
-  $ knock plugins install someuser/someplugin
-```
-
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v4.3.3/src/commands/plugins/install.ts)_
-
-## `knock plugins:link PLUGIN`
-
-Links a plugin into the CLI for development.
-
-```
-USAGE
-  $ knock plugins link PLUGIN
-
-ARGUMENTS
-  PATH  [default: .] path to plugin
-
-FLAGS
-  -h, --help          Show CLI help.
-  -v, --verbose
-      --[no-]install  Install dependencies after linking the plugin.
-
-DESCRIPTION
-  Links a plugin into the CLI for development.
-  Installation of a linked plugin will override a user-installed or core plugin.
-
-  e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
-  command will override the user-installed or core plugin implementation. This is useful for development work.
-
-
-EXAMPLES
-  $ knock plugins link myplugin
-```
-
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v4.3.3/src/commands/plugins/link.ts)_
-
-## `knock plugins:uninstall PLUGIN...`
-
-Removes a plugin from the CLI.
-
-```
-USAGE
-  $ knock plugins remove plugins:uninstall PLUGIN...
-
-ARGUMENTS
-  PLUGIN...  plugin to uninstall
-
-FLAGS
-  -h, --help     Show CLI help.
-  -v, --verbose
-
-DESCRIPTION
-  Removes a plugin from the CLI.
-
-ALIASES
-  $ knock plugins unlink
-  $ knock plugins remove
-
-EXAMPLES
-  $ knock plugins remove myplugin
-```
-
-## `knock plugins reset`
-
-Remove all user-installed and linked plugins.
-
-```
-USAGE
-  $ knock plugins reset [--hard] [--reinstall]
-
-FLAGS
-  --hard       Delete node_modules and package manager related files in addition to uninstalling plugins.
-  --reinstall  Reinstall all plugins after uninstalling.
-```
-
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v4.3.3/src/commands/plugins/reset.ts)_
-
-## `knock plugins:uninstall PLUGIN...`
-
-Removes a plugin from the CLI.
-
-```
-USAGE
-  $ knock plugins uninstall PLUGIN...
-
-ARGUMENTS
-  PLUGIN...  plugin to uninstall
-
-FLAGS
-  -h, --help     Show CLI help.
-  -v, --verbose
-
-DESCRIPTION
-  Removes a plugin from the CLI.
-
-ALIASES
-  $ knock plugins unlink
-  $ knock plugins remove
-
-EXAMPLES
-  $ knock plugins uninstall myplugin
-```
-
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v4.3.3/src/commands/plugins/uninstall.ts)_
-
-## `knock plugins:uninstall PLUGIN...`
-
-Removes a plugin from the CLI.
-
-```
-USAGE
-  $ knock plugins unlink plugins:uninstall PLUGIN...
-
-ARGUMENTS
-  PLUGIN...  plugin to uninstall
-
-FLAGS
-  -h, --help     Show CLI help.
-  -v, --verbose
-
-DESCRIPTION
-  Removes a plugin from the CLI.
-
-ALIASES
-  $ knock plugins unlink
-  $ knock plugins remove
-
-EXAMPLES
-  $ knock plugins unlink myplugin
-```
-
-## `knock plugins update`
-
-Update installed plugins.
-
-```
-USAGE
-  $ knock plugins update [-h] [-v]
-
-FLAGS
-  -h, --help     Show CLI help.
-  -v, --verbose
-
-DESCRIPTION
-  Update installed plugins.
-```
-
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v4.3.3/src/commands/plugins/update.ts)_
+_See code: [src/commands/layout/validate.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.16/src/commands/layout/validate.ts)_
 
 ## `knock translation get TRANSLATIONREF`
 
@@ -548,7 +259,7 @@ Display a single translation from an environment.
 ```
 USAGE
   $ knock translation get TRANSLATIONREF --service-token <value> [--json] [--environment <value>]
-    [--hide-uncommitted-changes]
+    [--hide-uncommitted-changes] [--format json|po]
 
 ARGUMENTS
   TRANSLATIONREF  Translation ref is a identifier string that refers to a unique translation.
@@ -557,6 +268,8 @@ ARGUMENTS
 
 FLAGS
   --environment=<value>       [default: development] The environment to use.
+  --format=<option>           [default: json] Specify the output format of the returned translations.
+                              <options: json|po>
   --hide-uncommitted-changes  Hide any uncommitted changes.
   --service-token=<value>     (required) The service token to authenticate with.
 
@@ -564,7 +277,7 @@ GLOBAL FLAGS
   --json  Format output as json.
 ```
 
-_See code: [src/commands/translation/get.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.14/src/commands/translation/get.ts)_
+_See code: [src/commands/translation/get.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.16/src/commands/translation/get.ts)_
 
 ## `knock translation list`
 
@@ -587,7 +300,7 @@ GLOBAL FLAGS
   --json  Format output as json.
 ```
 
-_See code: [src/commands/translation/list.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.14/src/commands/translation/list.ts)_
+_See code: [src/commands/translation/list.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.16/src/commands/translation/list.ts)_
 
 ## `knock translation pull [TRANSLATIONREF]`
 
@@ -596,7 +309,7 @@ Pull one or more translations from an environment into a local file system.
 ```
 USAGE
   $ knock translation pull [TRANSLATIONREF] --service-token <value> [--environment <value>] [--translations-dir
-    <value> --all] [--hide-uncommitted-changes] [--force]
+    <value> --all] [--hide-uncommitted-changes] [--force] [--format json|po]
 
 ARGUMENTS
   TRANSLATIONREF  Translation ref is a identifier string that refers to a unique translation.
@@ -607,12 +320,14 @@ FLAGS
   --all                       Whether to pull all translations from the specified environment.
   --environment=<value>       [default: development] The environment to use.
   --force                     Remove the confirmation prompt.
+  --format=<option>           [default: json] Specify the output format of the returned translations.
+                              <options: json|po>
   --hide-uncommitted-changes  Hide any uncommitted changes.
   --service-token=<value>     (required) The service token to authenticate with.
   --translations-dir=<value>  The target directory path to pull all translations into.
 ```
 
-_See code: [src/commands/translation/pull.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.14/src/commands/translation/pull.ts)_
+_See code: [src/commands/translation/pull.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.16/src/commands/translation/pull.ts)_
 
 ## `knock translation push [TRANSLATIONREF]`
 
@@ -639,7 +354,7 @@ FLAGS
       --translations-dir=<value>  The target directory path to find all translations to push.
 ```
 
-_See code: [src/commands/translation/push.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.14/src/commands/translation/push.ts)_
+_See code: [src/commands/translation/push.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.16/src/commands/translation/push.ts)_
 
 ## `knock translation validate [TRANSLATIONREF]`
 
@@ -664,7 +379,7 @@ FLAGS
   --translations-dir=<value>  The target directory path to find all translations to validate.
 ```
 
-_See code: [src/commands/translation/validate.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.14/src/commands/translation/validate.ts)_
+_See code: [src/commands/translation/validate.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.16/src/commands/translation/validate.ts)_
 
 ## `knock whoami`
 
@@ -681,7 +396,7 @@ GLOBAL FLAGS
   --json  Format output as json.
 ```
 
-_See code: [src/commands/whoami.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.14/src/commands/whoami.ts)_
+_See code: [src/commands/whoami.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.16/src/commands/whoami.ts)_
 
 ## `knock workflow activate WORKFLOWKEY`
 
@@ -708,7 +423,7 @@ DESCRIPTION
   with `false` in order to deactivate it.
 ```
 
-_See code: [src/commands/workflow/activate.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.14/src/commands/workflow/activate.ts)_
+_See code: [src/commands/workflow/activate.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.16/src/commands/workflow/activate.ts)_
 
 ## `knock workflow get WORKFLOWKEY`
 
@@ -728,7 +443,7 @@ GLOBAL FLAGS
   --json  Format output as json.
 ```
 
-_See code: [src/commands/workflow/get.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.14/src/commands/workflow/get.ts)_
+_See code: [src/commands/workflow/get.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.16/src/commands/workflow/get.ts)_
 
 ## `knock workflow list`
 
@@ -751,7 +466,7 @@ GLOBAL FLAGS
   --json  Format output as json.
 ```
 
-_See code: [src/commands/workflow/list.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.14/src/commands/workflow/list.ts)_
+_See code: [src/commands/workflow/list.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.16/src/commands/workflow/list.ts)_
 
 ## `knock workflow pull [WORKFLOWKEY]`
 
@@ -771,7 +486,7 @@ FLAGS
   --workflows-dir=<value>     The target directory path to pull all workflows into.
 ```
 
-_See code: [src/commands/workflow/pull.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.14/src/commands/workflow/pull.ts)_
+_See code: [src/commands/workflow/pull.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.16/src/commands/workflow/pull.ts)_
 
 ## `knock workflow push [WORKFLOWKEY]`
 
@@ -792,7 +507,7 @@ FLAGS
       --workflows-dir=<value>   The target directory path to find all workflows to push.
 ```
 
-_See code: [src/commands/workflow/push.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.14/src/commands/workflow/push.ts)_
+_See code: [src/commands/workflow/push.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.16/src/commands/workflow/push.ts)_
 
 ## `knock workflow run WORKFLOWKEY`
 
@@ -813,7 +528,7 @@ FLAGS
   --tenant=<value>         A tenant id for the workflow run.
 ```
 
-_See code: [src/commands/workflow/run.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.14/src/commands/workflow/run.ts)_
+_See code: [src/commands/workflow/run.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.16/src/commands/workflow/run.ts)_
 
 ## `knock workflow validate [WORKFLOWKEY]`
 
@@ -832,5 +547,5 @@ FLAGS
   --workflows-dir=<value>  The target directory path to find all workflows to validate.
 ```
 
-_See code: [src/commands/workflow/validate.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.14/src/commands/workflow/validate.ts)_
+_See code: [src/commands/workflow/validate.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.16/src/commands/workflow/validate.ts)_
 <!-- commandsstop -->

package/dist/commands/translation/get.js

@@ -85,7 +85,7 @@ class TranslationGet extends _basecommand.default {
     }
     render(translation) {
         const { translationRef } = this.props.args;
-        const { environment: env, "hide-uncommitted-changes": commitedOnly } = this.props.flags;
+        const { environment: env, "hide-uncommitted-changes": commitedOnly, format } = this.props.flags;
         const qualifier = env === "development" && !commitedOnly ? "(including uncommitted)" : "";
         this.log(`‣ Showing translation \`${translationRef}\` in \`${env}\` environment ${qualifier}\n`);
         /*
@@ -123,7 +123,11 @@ class TranslationGet extends _basecommand.default {
             }
         });
         this.log("");
-        _core.ux.styledJSON(JSON.parse(translation.content));
+        if (format === "json") {
+            _core.ux.styledJSON(JSON.parse(translation.content));
+        } else {
+            _core.ux.log(translation.content);
+        }
     }
 }
 _define_property(TranslationGet, "summary", "Display a single translation from an environment.");
@@ -134,7 +138,15 @@ _define_property(TranslationGet, "flags", {
     }),
     "hide-uncommitted-changes": _core.Flags.boolean({
         summary: "Hide any uncommitted changes."
-    })
+    }),
+    format: _core.Flags.option({
+        summary: "Specify the output format of the returned translations.",
+        options: [
+            "json",
+            "po"
+        ],
+        default: "json"
+    })()
 });
 _define_property(TranslationGet, "args", {
     translationRef: _core.Args.string({

package/dist/commands/translation/pull.js

@@ -102,7 +102,9 @@ class TranslationPull extends _basecommand.default {
             if (!input) return;
         }
         const resp = await (0, _request.withSpinner)(()=>this.apiV1.getTranslation(this.props, targetCtx));
-        await _translation.writeTranslationFile(targetCtx, resp.data);
+        await _translation.writeTranslationFile(targetCtx, resp.data, {
+            format: flags.format
+        });
         const actioned = targetCtx.exists ? "updated" : "created";
         this.log(`‣ Successfully ${actioned} \`${targetCtx.ref}\` at ${targetCtx.abspath}`);
     }
@@ -120,7 +122,9 @@ class TranslationPull extends _basecommand.default {
             localeCode: targetCtx.key
         };
         const translations = await this.listAllTranslations(filters);
-        await _translation.writeTranslationFiles(targetCtx, translations);
+        await _translation.writeTranslationFiles(targetCtx, translations, {
+            format: flags.format
+        });
         _ux.spinner.stop();
         const actioned = targetCtx.exists ? "updated" : "created";
         this.log(`‣ Successfully ${actioned} the \`${targetCtx.key}\` translations directory at ${targetCtx.abspath}`);
@@ -135,7 +139,9 @@ class TranslationPull extends _basecommand.default {
         // Fetch all translations then write them to the local file system.
         _ux.spinner.start(`‣ Loading`);
         const translations = await this.listAllTranslations();
-        await _translation.writeTranslationFiles(targetCtx, translations);
+        await _translation.writeTranslationFiles(targetCtx, translations, {
+            format: flags.format
+        });
         _ux.spinner.stop();
         const action = targetCtx.exists ? "updated" : "created";
         this.log(`‣ Successfully ${action} the translations directory at ${targetCtx.abspath}`);
@@ -182,7 +188,15 @@ _define_property(TranslationPull, "flags", {
     }),
     force: _core.Flags.boolean({
         summary: "Remove the confirmation prompt."
-    })
+    }),
+    format: _core.Flags.option({
+        summary: "Specify the output format of the returned translations.",
+        options: [
+            "json",
+            "po"
+        ],
+        default: "json"
+    })()
 });
 _define_property(TranslationPull, "args", {
     translationRef: _core.Args.string({

package/dist/commands/translation/push.js

@@ -107,7 +107,8 @@ class TranslationPush extends _basecommand.default {
             const resp = await this.apiV1.upsertTranslation(this.props, {
                 locale_code: translation.localeCode,
                 namespace: translation.namespace,
-                content: translation.content
+                content: translation.content,
+                format: translation.format
             });
             if ((0, _request.isSuccessResp)(resp)) continue;
             const message = (0, _request.formatErrorRespMessage)(resp);

package/dist/commands/translation/validate.js

@@ -106,7 +106,8 @@ class TranslationValidate extends _basecommand.default {
             const resp = await api.validateTranslation(props, {
                 locale_code: translation.localeCode,
                 namespace: translation.namespace,
-                content: translation.content
+                content: translation.content,
+                format: translation.format
             });
             if ((0, _request.isSuccessResp)(resp)) return;
             const message = (0, _request.formatErrorRespMessage)(resp);

package/dist/lib/api-v1.js

@@ -149,6 +149,7 @@ class ApiV1 {
             hide_uncommitted_changes: flags["hide-uncommitted-changes"],
             locale_code: filters.localeCode,
             namespace: filters.namespace,
+            format: flags.format,
             ...(0, _page.toPageParams)(flags)
         });
         return this.get("/translations", {
@@ -159,7 +160,8 @@ class ApiV1 {
         const params = (0, _objectisomorphic.prune)({
             environment: flags.environment,
             hide_uncommitted_changes: flags["hide-uncommitted-changes"],
-            namespace: translation.namespace
+            namespace: translation.namespace,
+            format: flags.format
         });
         return this.get(`/translations/${translation.localeCode}`, {
             params

package/dist/lib/helpers/liquid.js

@@ -19,6 +19,7 @@ const disabled = {
         throw new Error(`"${token.name}" tag is not supported in Knock`);
     }
 };
+// TODO(KNO-6058) - Enable render tag for partials
 engine.registerTag("render", disabled);
 engine.registerTag("include", disabled);
 function validateLiquidSyntax(input) {

package/dist/lib/marshal/partial/index.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+_export_star(require("./processor.isomorphic"), exports);
+_export_star(require("./types"), exports);
+function _export_star(from, to) {
+    Object.keys(from).forEach(function(k) {
+        if (k !== "default" && !Object.prototype.hasOwnProperty.call(to, k)) {
+            Object.defineProperty(to, k, {
+                enumerable: true,
+                get: function() {
+                    return from[k];
+                }
+            });
+        }
+    });
+    return from;
+}

package/dist/lib/marshal/partial/processor.isomorphic.js

@@ -0,0 +1,122 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+function _export(target, all) {
+    for(var name in all)Object.defineProperty(target, name, {
+        enumerable: true,
+        get: all[name]
+    });
+}
+_export(exports, {
+    PARTIAL_JSON: function() {
+        return PARTIAL_JSON;
+    },
+    buildPartialDirBundle: function() {
+        return buildPartialDirBundle;
+    },
+    toPartialJson: function() {
+        return toPartialJson;
+    }
+});
+const _lodash = require("lodash");
+const _objectisomorphic = require("../../helpers/object.isomorphic");
+const _constisomorphic = require("../shared/const.isomorphic");
+const _types = require("./types");
+const PARTIAL_JSON = "partial.json";
+/*
+ * Sanitize the partial content into a format that's appropriate for reading
+ * and writing, by stripping out any annotation fields and handling readonly
+ * fields.
+ */ const toPartialJson = (partial)=>{
+    var _partial___annotation;
+    // Move read only field under the dedicated field "__readonly".
+    const readonlyFields = ((_partial___annotation = partial.__annotation) === null || _partial___annotation === void 0 ? void 0 : _partial___annotation.readonly_fields) || [];
+    const [readonly, remainder] = (0, _objectisomorphic.split)(partial, readonlyFields);
+    const partialjson = {
+        ...remainder,
+        __readonly: readonly
+    };
+    // Strip out all schema annotations, so not to expose them to end users.
+    return (0, _objectisomorphic.omitDeep)(partialjson, [
+        "__annotation"
+    ]);
+};
+// Maps the partial type to the correct file extension. Defaults to 'txt'
+const partialTypeToFileExt = (type)=>{
+    switch(type){
+        case _types.PartialType.Html:
+            return "html";
+        case _types.PartialType.Json:
+            return "json";
+        case _types.PartialType.Markdown:
+            return "md";
+        case _types.PartialType.Text:
+        default:
+            return "txt";
+    }
+};
+const compileExtractionSettings = (partial)=>{
+    const extractableFields = (0, _lodash.get)(partial, [
+        "__annotation",
+        "extractable_fields"
+    ], {});
+    const map = new Map();
+    for (const key of Object.keys(partial)){
+        // If the field we are on is extractable, then add its extraction
+        // settings to the map with the current object path.
+        //
+        // NOTE: Partial content type is dynamically set based on the partial type
+        // rather than being explicitly set in the annotation.
+        if (key in extractableFields) {
+            const file_ext = partialTypeToFileExt(partial.type);
+            const extractable_settings = {
+                ...extractableFields[key],
+                file_ext
+            };
+            map.set([
+                key
+            ], extractable_settings);
+        }
+    }
+    return map;
+};
+const buildPartialDirBundle = (remotePartial, localPartial = {})=>{
+    const bundle = {};
+    const mutRemotePartial = (0, _lodash.cloneDeep)(remotePartial);
+    // A map of extraction settings of every field in the partial
+    const compiledExtractionSettings = compileExtractionSettings(mutRemotePartial);
+    // Iterate through each extractable field, determine whether we need to
+    // extract the field content, and if so, perform the
+    // extraction.
+    for (const [objPathParts, extractionSettings] of compiledExtractionSettings){
+        // If this partial doesn't have this field path, then we don't extract.
+        if (!(0, _lodash.has)(mutRemotePartial, objPathParts)) continue;
+        // If the field at this path is extracted in the local partial, then
+        // always extract; otherwise extract based on the field settings default.
+        const objPathStr = _objectisomorphic.ObjPath.stringify(objPathParts);
+        const extractedFilePath = (0, _lodash.get)(localPartial, `${objPathStr}${_constisomorphic.FILEPATH_MARKER}`);
+        const { default: extractByDefault, file_ext: fileExt } = extractionSettings;
+        if (!extractedFilePath && !extractByDefault) continue;
+        // By this point, we have a field where we need to extract its content.
+        const data = (0, _lodash.get)(mutRemotePartial, objPathParts);
+        const fileName = objPathParts.pop();
+        // If we have an extracted file path from the local partial, we use that.
+        // In the other case we use the default path.
+        const relpath = typeof extractedFilePath === "string" ? extractedFilePath : `${fileName}.${fileExt}`;
+        // Perform the extraction by adding the content and its file path to the
+        // bundle for writing to the file system later. Then replace the field
+        // content with the extracted file path and mark the field as extracted
+        // with @ suffix.
+        (0, _lodash.set)(bundle, [
+            relpath
+        ], data);
+        (0, _lodash.set)(mutRemotePartial, `${objPathStr}${_constisomorphic.FILEPATH_MARKER}`, relpath);
+        (0, _lodash.unset)(mutRemotePartial, objPathStr);
+    }
+    // At this point the bundle contains all extractable files, so we finally add
+    // the partial JSON relative path + the file content.
+    return (0, _lodash.set)(bundle, [
+        PARTIAL_JSON
+    ], toPartialJson(mutRemotePartial));
+};

package/dist/lib/marshal/partial/types.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "PartialType", {
+    enumerable: true,
+    get: function() {
+        return PartialType;
+    }
+});
+var PartialType;
+(function(PartialType) {
+    PartialType["Html"] = "HTML";
+    PartialType["Json"] = "JSON";
+    PartialType["Markdown"] = "MARKDOWN";
+    PartialType["Text"] = "TEXT";
+})(PartialType || (PartialType = {}));

package/dist/lib/marshal/translation/helpers.js

@@ -104,15 +104,15 @@ const isTranslationDir = (dirPath)=>{
     const locale = _nodepath.basename(dirPath);
     return isValidLocale(locale);
 };
-const buildTranslationFileCtx = async (dirPath, localeCode, namespace)=>{
-    const ref = (0, _processorisomorphic.formatRef)(localeCode, namespace);
-    const filename = (0, _processorisomorphic.formatFileName)(ref);
+const buildTranslationFileCtx = async (dirPath, translationIdentifier, options)=>{
+    const ref = (0, _processorisomorphic.formatRef)(translationIdentifier.localeCode, translationIdentifier.namespace);
+    const filename = (0, _processorisomorphic.formatFileName)(ref, options);
     const abspath = _nodepath.resolve(dirPath, filename);
     const exists = await _fsextra.pathExists(abspath);
     return {
         ref,
-        localeCode,
-        namespace,
+        localeCode: translationIdentifier.localeCode,
+        namespace: translationIdentifier.namespace,
         abspath,
         exists
     };
@@ -182,10 +182,34 @@ const ensureValidCommandTarget = async (props, runContext)=>{
     // Got translationRef arg but no --all flag, which means target only a single
     // translation file.
     if (!flags.all) {
-        const translationFileCtx = await buildTranslationFileCtx(targetDirPath, localeCode, namespace);
+        // If specified, check the given format; otherwise check for all supported formats
+        const formats = flags.format ? [
+            flags.format
+        ] : _processorisomorphic.SUPPORTED_TRANSLATION_FORMATS;
+        const translationFileCtxs = await Promise.all(formats.map(async (format)=>buildTranslationFileCtx(targetDirPath, {
+                localeCode,
+                namespace
+            }, {
+                format
+            })));
+        if (flags.format) {
+            return {
+                type: "translationFile",
+                context: translationFileCtxs[0]
+            };
+        }
+        // If no format is specified, look for the first existing file and return that context
+        const existingFileCtx = translationFileCtxs.find((ctx)=>ctx.exists);
+        if (existingFileCtx) {
+            return {
+                type: "translationFile",
+                context: existingFileCtx
+            };
+        }
+        // If no file exists, fall back to the file context with the default format (json)
         return {
             type: "translationFile",
-            context: translationFileCtx
+            context: translationFileCtxs[0]
         };
     }
     // From this point on, we have both translationRef and --all flag used
@@ -212,7 +236,8 @@ const lsTranslationDir = async (pathToDir)=>{
     return dirents.filter((dirent)=>{
         if (dirent.isDirectory()) return false;
         const filename = dirent.name.toLowerCase();
-        if (!filename.endsWith(`${localeCode}.json`)) return false;
+        const isValidExtension = _processorisomorphic.SUPPORTED_TRANSLATION_FORMATS.some((extension)=>filename.endsWith(`${localeCode}.${extension}`));
+        if (!isValidExtension) return false;
         const { name: translationRef } = _nodepath.parse(filename);
         const parsedRef = parseTranslationRef(translationRef);
         if (!parsedRef) return false;

package/dist/lib/marshal/translation/processor.isomorphic.js

@@ -9,6 +9,12 @@ function _export(target, all) {
     });
 }
 _export(exports, {
+    DEFAULT_TRANSLATION_FORMAT: function() {
+        return DEFAULT_TRANSLATION_FORMAT;
+    },
+    SUPPORTED_TRANSLATION_FORMATS: function() {
+        return SUPPORTED_TRANSLATION_FORMATS;
+    },
     buildTranslationDirBundle: function() {
         return buildTranslationDirBundle;
     },
@@ -19,21 +25,35 @@ _export(exports, {
         return formatRef;
     }
 });
+const SUPPORTED_TRANSLATION_FORMATS = [
+    "json",
+    "po"
+];
+const DEFAULT_TRANSLATION_FORMAT = "json";
 const formatRef = (localeCode, namespace)=>namespace ? `${namespace}.${localeCode}` : localeCode;
-const formatFileName = (input)=>{
+const formatFileName = (input, options)=>{
+    var _options_format;
+    const extension = (_options_format = options === null || options === void 0 ? void 0 : options.format) !== null && _options_format !== void 0 ? _options_format : DEFAULT_TRANSLATION_FORMAT;
     const ref = typeof input === "string" ? input : formatRef(input.locale_code, input.namespace);
-    return `${ref}.json`;
+    return `${ref}.${extension}`;
 };
-const buildTranslationDirBundle = (input)=>{
+const buildTranslationDirBundle = (input, options)=>{
+    var _options_format;
+    const format = (_options_format = options === null || options === void 0 ? void 0 : options.format) !== null && _options_format !== void 0 ? _options_format : DEFAULT_TRANSLATION_FORMAT;
     if (Array.isArray(input)) {
         const translations = input;
         return Object.fromEntries(translations.map((translation)=>[
-                formatFileName(translation),
+                formatFileName(translation, {
+                    format
+                }),
                 JSON.parse(translation.content)
             ]));
     }
     const translation = input;
+    const content = format === "json" ? JSON.parse(translation.content) : translation.content;
     return {
-        [formatFileName(translation)]: JSON.parse(translation.content)
+        [formatFileName(translation, {
+            format
+        })]: content
     };
 };

package/dist/lib/marshal/translation/reader.js

@@ -14,6 +14,7 @@ const _fsextra = /*#__PURE__*/ _interop_require_wildcard(require("fs-extra"));
 const _error = require("../../helpers/error");
 const _json = require("../../helpers/json");
 const _helpers = require("./helpers");
+const _processorisomorphic = require("./processor.isomorphic");
 function _getRequireWildcardCache(nodeInterop) {
     if (typeof WeakMap !== "function") return null;
     var cacheBabelInterop = new WeakMap();
@@ -76,10 +77,9 @@ function _interop_require_wildcard(obj, nodeInterop) {
         // push commands. Consider making this an option in the future.
         if (namespace === _helpers.SYSTEM_NAMESPACE) continue;
         // eslint-disable-next-line no-await-in-loop
-        const [content, readJsonErrors] = await (0, _json.readJson)(abspath);
-        if (readJsonErrors.length > 0) {
-            const e = new _error.SourceError((0, _error.formatErrors)(readJsonErrors), abspath);
-            errors.push(e);
+        const [content, sourceError, format] = await readTranslationFile(abspath);
+        if (sourceError) {
+            errors.push(sourceError);
             continue;
         }
         translations.push({
@@ -88,7 +88,8 @@ function _interop_require_wildcard(obj, nodeInterop) {
             namespace,
             abspath,
             exists: true,
-            content: JSON.stringify(content)
+            content,
+            format
         });
     }
     return [
@@ -96,6 +97,56 @@ function _interop_require_wildcard(obj, nodeInterop) {
         errors
     ];
 };
+const readTranslationFile = async (filePath)=>{
+    // Get translation format from file extension
+    const format = getFormatFromFilePath(filePath);
+    switch(format){
+        case "json":
+            {
+                const [jsonContent, readErrors] = await (0, _json.readJson)(filePath);
+                if (readErrors.length > 0) {
+                    const e = new _error.SourceError((0, _error.formatErrors)(readErrors), filePath);
+                    return [
+                        undefined,
+                        e,
+                        format
+                    ];
+                }
+                const content = JSON.stringify(jsonContent);
+                return [
+                    content,
+                    undefined,
+                    format
+                ];
+            }
+        case "po":
+            {
+                try {
+                    const content = await _fsextra.readFile(filePath, "utf8");
+                    return [
+                        content,
+                        undefined,
+                        format
+                    ];
+                } catch (error) {
+                    const e = new _error.SourceError(error.message, filePath);
+                    return [
+                        undefined,
+                        e,
+                        format
+                    ];
+                }
+            }
+        default:
+            throw new Error(`unsupported translation file extension: ${filePath}`);
+    }
+};
+const getFormatFromFilePath = (filePath)=>{
+    // Path.extname returns the extension with a period (e.g. .json)
+    // so we use slice to get just the name
+    const extension = _nodepath.extname(filePath).slice(1);
+    return _processorisomorphic.SUPPORTED_TRANSLATION_FORMATS.includes(extension) ? extension : undefined;
+};
 const readAllForCommandTarget = async (target)=>{
     const { type: targetType, context: targetCtx } = target;
     if (!targetCtx.exists) {

package/dist/lib/marshal/translation/types.js

@@ -1,4 +1,3 @@
-// Translation payload data from the API.
 "use strict";
 Object.defineProperty(exports, "__esModule", {
     value: true

package/dist/lib/marshal/translation/writer.js

@@ -22,6 +22,7 @@ const _lodash = require("lodash");
 const _const = require("../../helpers/const");
 const _json = require("../../helpers/json");
 const _helpers = require("./helpers");
+const _processorisomorphic = require("./processor.isomorphic");
 function _getRequireWildcardCache(nodeInterop) {
     if (typeof WeakMap !== "function") return null;
     var cacheBabelInterop = new WeakMap();
@@ -63,10 +64,21 @@ function _interop_require_wildcard(obj, nodeInterop) {
     }
     return newObj;
 }
-const writeTranslationFile = async (translationFileCtx, translation)=>_fsextra.outputJson(translationFileCtx.abspath, JSON.parse(translation.content), {
-        spaces: _json.DOUBLE_SPACES
-    });
-const writeTranslationFiles = async (targetDirCtx, translations)=>{
+const writeTranslationFile = async (translationFileCtx, translation, options)=>{
+    var _options_format;
+    const format = (_options_format = options === null || options === void 0 ? void 0 : options.format) !== null && _options_format !== void 0 ? _options_format : _processorisomorphic.DEFAULT_TRANSLATION_FORMAT;
+    switch(format){
+        case "json":
+            return _fsextra.outputJson(translationFileCtx.abspath, JSON.parse(translation.content), {
+                spaces: _json.DOUBLE_SPACES
+            });
+        case "po":
+            return _fsextra.outputFile(translationFileCtx.abspath, translation.content);
+        default:
+            throw new Error(`Invalid translation file format: ${options === null || options === void 0 ? void 0 : options.format}`);
+    }
+};
+const writeTranslationFiles = async (targetDirCtx, translations, options)=>{
     const backupDirPath = _nodepath.resolve(_const.sandboxDir, (0, _lodash.uniqueId)("backup"));
     try {
         // If the index directory already exists, back it up in the temp sandbox
@@ -81,8 +93,11 @@ const writeTranslationFiles = async (targetDirCtx, translations)=>{
             // to write translation files in; otherwise for translations index
             // directory, we want to nest translation files under each locale dir.
             const localeDirPath = "key" in targetDirCtx ? targetDirCtx.abspath : _nodepath.resolve(targetDirCtx.abspath, translation.locale_code);
-            const translationFileCtx = await (0, _helpers.buildTranslationFileCtx)(localeDirPath, translation.locale_code, translation.namespace);
-            return writeTranslationFile(translationFileCtx, translation);
+            const translationFileCtx = await (0, _helpers.buildTranslationFileCtx)(localeDirPath, {
+                localeCode: translation.locale_code,
+                namespace: translation.namespace
+            }, options);
+            return writeTranslationFile(translationFileCtx, translation, options);
         });
         await Promise.all(writeTranslationDirPromises);
     } catch (error) {

package/oclif.manifest.json

@@ -817,6 +817,18 @@
           "summary": "Hide any uncommitted changes.",
           "allowNo": false,
           "type": "boolean"
+        },
+        "format": {
+          "name": "format",
+          "summary": "Specify the output format of the returned translations.",
+          "default": "json",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "json",
+            "po"
+          ],
+          "type": "option"
         }
       },
       "hasDynamicHelp": false,
@@ -979,6 +991,18 @@
           "summary": "Remove the confirmation prompt.",
           "allowNo": false,
           "type": "boolean"
+        },
+        "format": {
+          "name": "format",
+          "summary": "Specify the output format of the returned translations.",
+          "default": "json",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "json",
+            "po"
+          ],
+          "type": "option"
         }
       },
       "hasDynamicHelp": false,
@@ -1758,5 +1782,5 @@
       ]
     }
   },
-  "version": "0.1.14"
+  "version": "0.1.16"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knocklabs/cli",
-  "version": "0.1.14",
+  "version": "0.1.16",
   "description": "Knock CLI",
   "author": "@knocklabs",
   "bin": {
@@ -19,26 +19,25 @@
   "dependencies": {
     "@oclif/core": "^3",
     "@oclif/plugin-help": "^6",
-    "@oclif/plugin-plugins": "^4",
     "@prantlf/jsonlint": "^14.0.3",
-    "axios": "^1.5.1",
+    "axios": "^1.6.8",
     "date-fns": "^2.30.0",
     "enquirer": "^2.4.1",
     "fs-extra": "^11.2.0",
-    "liquidjs": "^10.10.2",
+    "liquidjs": "^10.13.1",
     "locale-codes": "^1.3.1",
     "lodash": "^4.17.21",
     "yup": "^1.4.0"
   },
   "devDependencies": {
     "@oclif/test": "^3",
-    "@swc/cli": "^0.3.9",
-    "@swc/core": "^1.4.6",
-    "@swc/helpers": "^0.5.6",
+    "@swc/cli": "^0.3.12",
+    "@swc/core": "^1.5.7",
+    "@swc/helpers": "^0.5.11",
     "@types/chai": "^4",
     "@types/fs-extra": "^11.0.4",
     "@types/mocha": "^10.0.6",
-    "@types/node": "^20.12.7",
+    "@types/node": "^20.14.8",
     "chai": "^4",
     "eslint": "^7.32.0",
     "eslint-config-oclif": "^4",
@@ -47,23 +46,22 @@
     "eslint-plugin-prettier": "^4.2.1",
     "eslint-plugin-simple-import-sort": "^10.0.0",
     "mocha": "^10",
-    "nock": "^13.5.3",
+    "nock": "^13.5.4",
     "oclif": "^4",
     "prettier": "2.8.8",
     "shx": "^0.3.4",
     "sinon": "^16.1.3",
     "ts-node": "^10.9.1",
     "tsconfig-paths": "^4.2.0",
-    "tslib": "^2.6.2",
-    "typescript": "^5.1.6"
+    "tslib": "^2.6.3",
+    "typescript": "^5.5.2"
   },
   "oclif": {
     "bin": "knock",
     "dirname": "knock",
     "commands": "./dist/commands",
     "plugins": [
-      "@oclif/plugin-help",
-      "@oclif/plugin-plugins"
+      "@oclif/plugin-help"
     ],
     "topicSeparator": " ",
     "topics": {