@knocklabs/cli 0.1.9 → 0.1.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -16,7 +16,7 @@ $ npm install -g @knocklabs/cli
16
16
  $ knock COMMAND
17
17
  running command...
18
18
  $ knock (--version)
19
- @knocklabs/cli/0.1.9 linux-x64 node-v18.19.0
19
+ @knocklabs/cli/0.1.10 linux-x64 node-v18.19.0
20
20
  $ knock --help [COMMAND]
21
21
  USAGE
22
22
  $ knock COMMAND
@@ -77,7 +77,7 @@ FLAGS
77
77
  --service-token=<value> (required) The service token to authenticate with.
78
78
  ```
79
79
 
80
- _See code: [src/commands/commit/index.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.9/src/commands/commit/index.ts)_
80
+ _See code: [src/commands/commit/index.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.10/src/commands/commit/index.ts)_
81
81
 
82
82
  ## `knock commit get ID`
83
83
 
@@ -94,7 +94,7 @@ GLOBAL FLAGS
94
94
  --json Format output as json.
95
95
  ```
96
96
 
97
- _See code: [src/commands/commit/get.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.9/src/commands/commit/get.ts)_
97
+ _See code: [src/commands/commit/get.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.10/src/commands/commit/get.ts)_
98
98
 
99
99
  ## `knock commit list`
100
100
 
@@ -118,7 +118,7 @@ GLOBAL FLAGS
118
118
  --json Format output as json.
119
119
  ```
120
120
 
121
- _See code: [src/commands/commit/list.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.9/src/commands/commit/list.ts)_
121
+ _See code: [src/commands/commit/list.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.10/src/commands/commit/list.ts)_
122
122
 
123
123
  ## `knock commit promote`
124
124
 
@@ -135,7 +135,7 @@ FLAGS
135
135
  --to=<value> The destination environment to promote all changes from the preceding environment.
136
136
  ```
137
137
 
138
- _See code: [src/commands/commit/promote.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.9/src/commands/commit/promote.ts)_
138
+ _See code: [src/commands/commit/promote.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.10/src/commands/commit/promote.ts)_
139
139
 
140
140
  ## `knock help [COMMANDS]`
141
141
 
@@ -175,7 +175,7 @@ GLOBAL FLAGS
175
175
  --json Format output as json.
176
176
  ```
177
177
 
178
- _See code: [src/commands/layout/get.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.9/src/commands/layout/get.ts)_
178
+ _See code: [src/commands/layout/get.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.10/src/commands/layout/get.ts)_
179
179
 
180
180
  ## `knock layout list`
181
181
 
@@ -198,7 +198,7 @@ GLOBAL FLAGS
198
198
  --json Format output as json.
199
199
  ```
200
200
 
201
- _See code: [src/commands/layout/list.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.9/src/commands/layout/list.ts)_
201
+ _See code: [src/commands/layout/list.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.10/src/commands/layout/list.ts)_
202
202
 
203
203
  ## `knock layout pull [EMAILLAYOUTKEY]`
204
204
 
@@ -218,7 +218,7 @@ FLAGS
218
218
  --service-token=<value> (required) The service token to authenticate with.
219
219
  ```
220
220
 
221
- _See code: [src/commands/layout/pull.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.9/src/commands/layout/pull.ts)_
221
+ _See code: [src/commands/layout/pull.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.10/src/commands/layout/pull.ts)_
222
222
 
223
223
  ## `knock layout push [EMAILLAYOUTKEY]`
224
224
 
@@ -240,7 +240,7 @@ FLAGS
240
240
  --service-token=<value> (required) The service token to authenticate with.
241
241
  ```
242
242
 
243
- _See code: [src/commands/layout/push.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.9/src/commands/layout/push.ts)_
243
+ _See code: [src/commands/layout/push.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.10/src/commands/layout/push.ts)_
244
244
 
245
245
  ## `knock layout validate [EMAILLAYOUTKEY]`
246
246
 
@@ -259,7 +259,7 @@ FLAGS
259
259
  --service-token=<value> (required) The service token to authenticate with.
260
260
  ```
261
261
 
262
- _See code: [src/commands/layout/validate.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.9/src/commands/layout/validate.ts)_
262
+ _See code: [src/commands/layout/validate.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.10/src/commands/layout/validate.ts)_
263
263
 
264
264
  ## `knock plugins`
265
265
 
@@ -531,7 +531,7 @@ GLOBAL FLAGS
531
531
  --json Format output as json.
532
532
  ```
533
533
 
534
- _See code: [src/commands/translation/get.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.9/src/commands/translation/get.ts)_
534
+ _See code: [src/commands/translation/get.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.10/src/commands/translation/get.ts)_
535
535
 
536
536
  ## `knock translation list`
537
537
 
@@ -554,7 +554,7 @@ GLOBAL FLAGS
554
554
  --json Format output as json.
555
555
  ```
556
556
 
557
- _See code: [src/commands/translation/list.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.9/src/commands/translation/list.ts)_
557
+ _See code: [src/commands/translation/list.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.10/src/commands/translation/list.ts)_
558
558
 
559
559
  ## `knock translation pull [TRANSLATIONREF]`
560
560
 
@@ -579,7 +579,7 @@ FLAGS
579
579
  --translations-dir=<value> The target directory path to pull all translations into.
580
580
  ```
581
581
 
582
- _See code: [src/commands/translation/pull.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.9/src/commands/translation/pull.ts)_
582
+ _See code: [src/commands/translation/pull.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.10/src/commands/translation/pull.ts)_
583
583
 
584
584
  ## `knock translation push [TRANSLATIONREF]`
585
585
 
@@ -606,7 +606,7 @@ FLAGS
606
606
  --translations-dir=<value> The target directory path to find all translations to push.
607
607
  ```
608
608
 
609
- _See code: [src/commands/translation/push.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.9/src/commands/translation/push.ts)_
609
+ _See code: [src/commands/translation/push.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.10/src/commands/translation/push.ts)_
610
610
 
611
611
  ## `knock translation validate [TRANSLATIONREF]`
612
612
 
@@ -631,7 +631,7 @@ FLAGS
631
631
  --translations-dir=<value> The target directory path to find all translations to validate.
632
632
  ```
633
633
 
634
- _See code: [src/commands/translation/validate.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.9/src/commands/translation/validate.ts)_
634
+ _See code: [src/commands/translation/validate.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.10/src/commands/translation/validate.ts)_
635
635
 
636
636
  ## `knock whoami`
637
637
 
@@ -648,7 +648,7 @@ GLOBAL FLAGS
648
648
  --json Format output as json.
649
649
  ```
650
650
 
651
- _See code: [src/commands/whoami.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.9/src/commands/whoami.ts)_
651
+ _See code: [src/commands/whoami.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.10/src/commands/whoami.ts)_
652
652
 
653
653
  ## `knock workflow activate WORKFLOWKEY`
654
654
 
@@ -675,7 +675,7 @@ DESCRIPTION
675
675
  with `false` in order to deactivate it.
676
676
  ```
677
677
 
678
- _See code: [src/commands/workflow/activate.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.9/src/commands/workflow/activate.ts)_
678
+ _See code: [src/commands/workflow/activate.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.10/src/commands/workflow/activate.ts)_
679
679
 
680
680
  ## `knock workflow get WORKFLOWKEY`
681
681
 
@@ -695,7 +695,7 @@ GLOBAL FLAGS
695
695
  --json Format output as json.
696
696
  ```
697
697
 
698
- _See code: [src/commands/workflow/get.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.9/src/commands/workflow/get.ts)_
698
+ _See code: [src/commands/workflow/get.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.10/src/commands/workflow/get.ts)_
699
699
 
700
700
  ## `knock workflow list`
701
701
 
@@ -718,7 +718,7 @@ GLOBAL FLAGS
718
718
  --json Format output as json.
719
719
  ```
720
720
 
721
- _See code: [src/commands/workflow/list.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.9/src/commands/workflow/list.ts)_
721
+ _See code: [src/commands/workflow/list.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.10/src/commands/workflow/list.ts)_
722
722
 
723
723
  ## `knock workflow pull [WORKFLOWKEY]`
724
724
 
@@ -738,7 +738,7 @@ FLAGS
738
738
  --workflows-dir=<value> The target directory path to pull all workflows into.
739
739
  ```
740
740
 
741
- _See code: [src/commands/workflow/pull.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.9/src/commands/workflow/pull.ts)_
741
+ _See code: [src/commands/workflow/pull.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.10/src/commands/workflow/pull.ts)_
742
742
 
743
743
  ## `knock workflow push [WORKFLOWKEY]`
744
744
 
@@ -759,7 +759,7 @@ FLAGS
759
759
  --workflows-dir=<value> The target directory path to find all workflows to push.
760
760
  ```
761
761
 
762
- _See code: [src/commands/workflow/push.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.9/src/commands/workflow/push.ts)_
762
+ _See code: [src/commands/workflow/push.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.10/src/commands/workflow/push.ts)_
763
763
 
764
764
  ## `knock workflow run WORKFLOWKEY`
765
765
 
@@ -780,7 +780,7 @@ FLAGS
780
780
  --tenant=<value> A tenant id for the workflow run.
781
781
  ```
782
782
 
783
- _See code: [src/commands/workflow/run.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.9/src/commands/workflow/run.ts)_
783
+ _See code: [src/commands/workflow/run.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.10/src/commands/workflow/run.ts)_
784
784
 
785
785
  ## `knock workflow validate [WORKFLOWKEY]`
786
786
 
@@ -799,5 +799,5 @@ FLAGS
799
799
  --workflows-dir=<value> The target directory path to find all workflows to validate.
800
800
  ```
801
801
 
802
- _See code: [src/commands/workflow/validate.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.9/src/commands/workflow/validate.ts)_
802
+ _See code: [src/commands/workflow/validate.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.10/src/commands/workflow/validate.ts)_
803
803
  <!-- commandsstop -->
@@ -82,7 +82,7 @@ class TranslationList extends _baseCommand.default {
82
82
  */ _core.ux.table(entries, {
83
83
  ref: {
84
84
  header: "Ref",
85
- get: (entry)=>_translation.formatRef(entry)
85
+ get: (entry)=>_translation.formatRef(entry.locale_code, entry.namespace)
86
86
  },
87
87
  language_name: {
88
88
  header: "Language",
@@ -12,7 +12,9 @@ function _export(target, all) {
12
12
  }
13
13
  _export(exports, {
14
14
  buildEmailLayoutDirBundle: ()=>_processorIsomorphic.buildEmailLayoutDirBundle,
15
- buildWorkflowDirBundle: ()=>_processorIsomorphic1.buildWorkflowDirBundle
15
+ buildTranslationDirBundle: ()=>_processorIsomorphic1.buildTranslationDirBundle,
16
+ buildWorkflowDirBundle: ()=>_processorIsomorphic2.buildWorkflowDirBundle
16
17
  });
17
18
  const _processorIsomorphic = require("./email-layout/processor.isomorphic");
18
- const _processorIsomorphic1 = require("./workflow/processor.isomorphic");
19
+ const _processorIsomorphic1 = require("./translation/processor.isomorphic");
20
+ const _processorIsomorphic2 = require("./workflow/processor.isomorphic");
@@ -11,7 +11,6 @@ function _export(target, all) {
11
11
  _export(exports, {
12
12
  translationRefDescription: ()=>translationRefDescription,
13
13
  formatLanguage: ()=>formatLanguage,
14
- formatRef: ()=>formatRef,
15
14
  isValidLocale: ()=>isValidLocale,
16
15
  isTranslationDir: ()=>isTranslationDir,
17
16
  buildTranslationFileCtx: ()=>buildTranslationFileCtx,
@@ -24,6 +23,7 @@ const _core = require("@oclif/core");
24
23
  const _fsExtra = /*#__PURE__*/ _interopRequireWildcard(require("fs-extra"));
25
24
  const _localeCodes = /*#__PURE__*/ _interopRequireDefault(require("locale-codes"));
26
25
  const _fs = require("../../helpers/fs");
26
+ const _processorIsomorphic = require("./processor.isomorphic");
27
27
  function _interopRequireDefault(obj) {
28
28
  return obj && obj.__esModule ? obj : {
29
29
  default: obj
@@ -77,15 +77,15 @@ const formatLanguage = (translation)=>{
77
77
  const lang = _localeCodes.default.getByTag(translation.locale_code);
78
78
  return lang.location ? `${lang.name}, ${lang.location}` : lang.name;
79
79
  };
80
- const formatRef = ({ locale_code , namespace })=>namespace ? `${namespace}.${locale_code}` : locale_code;
81
80
  const isValidLocale = (localeCode)=>Boolean(_localeCodes.default.getByTag(localeCode));
82
81
  const isTranslationDir = (dirPath)=>{
83
82
  const locale = _nodePath.basename(dirPath);
84
83
  return isValidLocale(locale);
85
84
  };
86
85
  const buildTranslationFileCtx = async (dirPath, localeCode, namespace)=>{
87
- const ref = namespace ? `${namespace}.${localeCode}` : localeCode;
88
- const abspath = _nodePath.resolve(dirPath, `${ref}.json`);
86
+ const ref = (0, _processorIsomorphic.formatRef)(localeCode, namespace);
87
+ const filename = (0, _processorIsomorphic.formatFileName)(ref);
88
+ const abspath = _nodePath.resolve(dirPath, filename);
89
89
  const exists = await _fsExtra.pathExists(abspath);
90
90
  return {
91
91
  ref,
@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", {
3
3
  value: true
4
4
  });
5
5
  _exportStar(require("./helpers"), exports);
6
+ _exportStar(require("./processor.isomorphic"), exports);
6
7
  _exportStar(require("./reader"), exports);
7
8
  _exportStar(require("./types"), exports);
8
9
  _exportStar(require("./writer"), exports);
@@ -0,0 +1,33 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", {
3
+ value: true
4
+ });
5
+ function _export(target, all) {
6
+ for(var name in all)Object.defineProperty(target, name, {
7
+ enumerable: true,
8
+ get: all[name]
9
+ });
10
+ }
11
+ _export(exports, {
12
+ formatRef: ()=>formatRef,
13
+ formatFileName: ()=>formatFileName,
14
+ buildTranslationDirBundle: ()=>buildTranslationDirBundle
15
+ });
16
+ const formatRef = (localeCode, namespace)=>namespace ? `${namespace}.${localeCode}` : localeCode;
17
+ const formatFileName = (input)=>{
18
+ const ref = typeof input === "string" ? input : formatRef(input.locale_code, input.namespace);
19
+ return `${ref}.json`;
20
+ };
21
+ const buildTranslationDirBundle = (input)=>{
22
+ if (Array.isArray(input)) {
23
+ const translations = input;
24
+ return Object.fromEntries(translations.map((translation)=>[
25
+ formatFileName(translation),
26
+ JSON.parse(translation.content)
27
+ ]));
28
+ }
29
+ const translation = input;
30
+ return {
31
+ [formatFileName(translation)]: JSON.parse(translation.content)
32
+ };
33
+ };
@@ -1,5 +1,5 @@
1
1
  {
2
- "version": "0.1.9",
2
+ "version": "0.1.10",
3
3
  "commands": {
4
4
  "knock": {
5
5
  "id": "knock",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@knocklabs/cli",
3
- "version": "0.1.9",
3
+ "version": "0.1.10",
4
4
  "description": "Knock CLI",
5
5
  "author": "@knocklabs",
6
6
  "bin": {
@@ -28,7 +28,7 @@
28
28
  "liquidjs": "^10.9.4",
29
29
  "locale-codes": "^1.3.1",
30
30
  "lodash": "^4.17.21",
31
- "yup": "^1.3.2"
31
+ "yup": "^1.3.3"
32
32
  },
33
33
  "devDependencies": {
34
34
  "@oclif/test": "^2.5.6",
@@ -37,7 +37,7 @@
37
37
  "@swc/helpers": "^0.4.14",
38
38
  "@types/chai": "^4",
39
39
  "@types/fs-extra": "^11.0.4",
40
- "@types/mocha": "^10.0.1",
40
+ "@types/mocha": "^10.0.6",
41
41
  "@types/node": "^20.9.0",
42
42
  "chai": "^4",
43
43
  "eslint": "^7.32.0",