@knocklabs/cli 0.1.0-rc.0

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.
Files changed (36) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +377 -0
  3. package/bin/dev +17 -0
  4. package/bin/dev.cmd +3 -0
  5. package/bin/run +5 -0
  6. package/bin/run.cmd +3 -0
  7. package/dist/commands/ping.js +24 -0
  8. package/dist/commands/workflow/get.js +161 -0
  9. package/dist/commands/workflow/list.js +128 -0
  10. package/dist/commands/workflow/pull.js +139 -0
  11. package/dist/commands/workflow/push.js +128 -0
  12. package/dist/index.js +9 -0
  13. package/dist/lib/api-v1.js +76 -0
  14. package/dist/lib/base-command.js +91 -0
  15. package/dist/lib/helpers/date.js +21 -0
  16. package/dist/lib/helpers/dir-context.js +33 -0
  17. package/dist/lib/helpers/env.js +63 -0
  18. package/dist/lib/helpers/error.js +60 -0
  19. package/dist/lib/helpers/json.js +72 -0
  20. package/dist/lib/helpers/object.js +111 -0
  21. package/dist/lib/helpers/page.js +92 -0
  22. package/dist/lib/helpers/request.js +38 -0
  23. package/dist/lib/helpers/string.js +34 -0
  24. package/dist/lib/marshal/conditions/helpers.js +26 -0
  25. package/dist/lib/marshal/conditions/index.js +17 -0
  26. package/dist/lib/marshal/conditions/types.js +4 -0
  27. package/dist/lib/marshal/shared/types.js +4 -0
  28. package/dist/lib/marshal/workflow/helpers.js +139 -0
  29. package/dist/lib/marshal/workflow/index.js +19 -0
  30. package/dist/lib/marshal/workflow/reader.js +233 -0
  31. package/dist/lib/marshal/workflow/types.js +15 -0
  32. package/dist/lib/marshal/workflow/writer.js +214 -0
  33. package/dist/lib/run-context.js +79 -0
  34. package/dist/lib/user-config.js +83 -0
  35. package/oclif.manifest.json +220 -0
  36. package/package.json +94 -0
package/oclif.manifest.json ADDED
@@ -0,0 +1,220 @@
1
+ {
2
+ "version": "0.1.0-rc.0",
3
+ "commands": {
4
+ "ping": {
5
+ "id": "ping",
6
+ "description": "Ping the Knock management API to verify access.",
7
+ "strict": true,
8
+ "pluginName": "@knocklabs/cli",
9
+ "pluginAlias": "@knocklabs/cli",
10
+ "pluginType": "core",
11
+ "aliases": [],
12
+ "examples": [
13
+ "<%= config.bin %> <%= command.id %>"
14
+ ],
15
+ "flags": {
16
+ "service-token": {
17
+ "name": "service-token",
18
+ "type": "option",
19
+ "summary": "service token to authenticate with",
20
+ "required": true,
21
+ "multiple": false
22
+ },
23
+ "api-origin": {
24
+ "name": "api-origin",
25
+ "type": "option",
26
+ "hidden": true,
27
+ "required": false,
28
+ "multiple": false
29
+ }
30
+ },
31
+ "args": {}
32
+ },
33
+ "workflow:get": {
34
+ "id": "workflow:get",
35
+ "strict": true,
36
+ "pluginName": "@knocklabs/cli",
37
+ "pluginAlias": "@knocklabs/cli",
38
+ "pluginType": "core",
39
+ "aliases": [],
40
+ "flags": {
41
+ "service-token": {
42
+ "name": "service-token",
43
+ "type": "option",
44
+ "summary": "service token to authenticate with",
45
+ "required": true,
46
+ "multiple": false
47
+ },
48
+ "api-origin": {
49
+ "name": "api-origin",
50
+ "type": "option",
51
+ "hidden": true,
52
+ "required": false,
53
+ "multiple": false
54
+ },
55
+ "environment": {
56
+ "name": "environment",
57
+ "type": "option",
58
+ "multiple": false,
59
+ "default": "development"
60
+ },
61
+ "hide-uncommitted-changes": {
62
+ "name": "hide-uncommitted-changes",
63
+ "type": "boolean",
64
+ "allowNo": false
65
+ },
66
+ "json": {
67
+ "name": "json",
68
+ "type": "boolean",
69
+ "description": "Format output as json.",
70
+ "helpGroup": "GLOBAL",
71
+ "allowNo": false
72
+ }
73
+ },
74
+ "args": {
75
+ "workflowKey": {
76
+ "name": "workflowKey",
77
+ "required": true
78
+ }
79
+ }
80
+ },
81
+ "workflow:list": {
82
+ "id": "workflow:list",
83
+ "strict": true,
84
+ "pluginName": "@knocklabs/cli",
85
+ "pluginAlias": "@knocklabs/cli",
86
+ "pluginType": "core",
87
+ "aliases": [],
88
+ "flags": {
89
+ "service-token": {
90
+ "name": "service-token",
91
+ "type": "option",
92
+ "summary": "service token to authenticate with",
93
+ "required": true,
94
+ "multiple": false
95
+ },
96
+ "api-origin": {
97
+ "name": "api-origin",
98
+ "type": "option",
99
+ "hidden": true,
100
+ "required": false,
101
+ "multiple": false
102
+ },
103
+ "environment": {
104
+ "name": "environment",
105
+ "type": "option",
106
+ "multiple": false,
107
+ "default": "development"
108
+ },
109
+ "hide-uncommitted-changes": {
110
+ "name": "hide-uncommitted-changes",
111
+ "type": "boolean",
112
+ "allowNo": false
113
+ },
114
+ "after": {
115
+ "name": "after",
116
+ "type": "option",
117
+ "multiple": false
118
+ },
119
+ "before": {
120
+ "name": "before",
121
+ "type": "option",
122
+ "multiple": false
123
+ },
124
+ "limit": {
125
+ "name": "limit",
126
+ "type": "option",
127
+ "multiple": false
128
+ },
129
+ "json": {
130
+ "name": "json",
131
+ "type": "boolean",
132
+ "description": "Format output as json.",
133
+ "helpGroup": "GLOBAL",
134
+ "allowNo": false
135
+ }
136
+ },
137
+ "args": {}
138
+ },
139
+ "workflow:pull": {
140
+ "id": "workflow:pull",
141
+ "strict": true,
142
+ "pluginName": "@knocklabs/cli",
143
+ "pluginAlias": "@knocklabs/cli",
144
+ "pluginType": "core",
145
+ "aliases": [],
146
+ "flags": {
147
+ "service-token": {
148
+ "name": "service-token",
149
+ "type": "option",
150
+ "summary": "service token to authenticate with",
151
+ "required": true,
152
+ "multiple": false
153
+ },
154
+ "api-origin": {
155
+ "name": "api-origin",
156
+ "type": "option",
157
+ "hidden": true,
158
+ "required": false,
159
+ "multiple": false
160
+ },
161
+ "environment": {
162
+ "name": "environment",
163
+ "type": "option",
164
+ "multiple": false,
165
+ "default": "development"
166
+ },
167
+ "hide-uncommitted-changes": {
168
+ "name": "hide-uncommitted-changes",
169
+ "type": "boolean",
170
+ "allowNo": false
171
+ }
172
+ },
173
+ "args": {
174
+ "workflowKey": {
175
+ "name": "workflowKey",
176
+ "required": false
177
+ }
178
+ }
179
+ },
180
+ "workflow:push": {
181
+ "id": "workflow:push",
182
+ "strict": true,
183
+ "pluginName": "@knocklabs/cli",
184
+ "pluginAlias": "@knocklabs/cli",
185
+ "pluginType": "core",
186
+ "aliases": [],
187
+ "flags": {
188
+ "service-token": {
189
+ "name": "service-token",
190
+ "type": "option",
191
+ "summary": "service token to authenticate with",
192
+ "required": true,
193
+ "multiple": false
194
+ },
195
+ "api-origin": {
196
+ "name": "api-origin",
197
+ "type": "option",
198
+ "hidden": true,
199
+ "required": false,
200
+ "multiple": false
201
+ },
202
+ "environment": {
203
+ "name": "environment",
204
+ "type": "option",
205
+ "multiple": false,
206
+ "options": [
207
+ "development"
208
+ ],
209
+ "default": "development"
210
+ }
211
+ },
212
+ "args": {
213
+ "workflowKey": {
214
+ "name": "workflowKey",
215
+ "required": false
216
+ }
217
+ }
218
+ }
219
+ }
220
+ }
package/package.json ADDED
@@ -0,0 +1,94 @@
1
+ {
2
+ "name": "@knocklabs/cli",
3
+ "version": "0.1.0-rc.0",
4
+ "description": "Knock CLI",
5
+ "author": "@knocklabs",
6
+ "bin": {
7
+ "knock": "./bin/run"
8
+ },
9
+ "homepage": "https://github.com/knocklabs/knock-cli",
10
+ "license": "MIT",
11
+ "main": "dist/index.js",
12
+ "repository": "knocklabs/knock-cli",
13
+ "files": [
14
+ "/bin",
15
+ "/dist",
16
+ "/npm-shrinkwrap.json",
17
+ "/oclif.manifest.json"
18
+ ],
19
+ "dependencies": {
20
+ "@oclif/core": "^1.26.1",
21
+ "@oclif/plugin-help": "^5",
22
+ "@oclif/plugin-plugins": "^2.3.0",
23
+ "@prantlf/jsonlint": "^11.7.0",
24
+ "axios": "^1.3.2",
25
+ "date-fns": "^2.29.3",
26
+ "enquirer": "^2.3.6",
27
+ "fs-extra": "^10.1.0",
28
+ "lodash": "^4.17.21",
29
+ "yup": "^0.32.11"
30
+ },
31
+ "devDependencies": {
32
+ "@oclif/test": "^2.3.0",
33
+ "@swc/cli": "^0.1.61",
34
+ "@swc/core": "^1.3.29",
35
+ "@swc/helpers": "^0.4.14",
36
+ "@types/chai": "^4",
37
+ "@types/fs-extra": "^9.0.13",
38
+ "@types/mocha": "^9.0.0",
39
+ "@types/node": "^16.18.11",
40
+ "chai": "^4",
41
+ "eslint": "^7.32.0",
42
+ "eslint-config-oclif": "^4",
43
+ "eslint-config-oclif-typescript": "^1.0.3",
44
+ "eslint-config-prettier": "^8.6.0",
45
+ "eslint-plugin-prettier": "^4.2.1",
46
+ "eslint-plugin-simple-import-sort": "^8.0.0",
47
+ "mocha": "^9",
48
+ "nock": "^13.3.0",
49
+ "oclif": "^3",
50
+ "prettier": "2.8.3",
51
+ "shx": "^0.3.4",
52
+ "sinon": "^15.0.1",
53
+ "ts-node": "^10.9.1",
54
+ "tsconfig-paths": "^4.1.2",
55
+ "tslib": "^2.5.0",
56
+ "typescript": "^4.9.4"
57
+ },
58
+ "oclif": {
59
+ "bin": "knock",
60
+ "dirname": "knock",
61
+ "commands": "./dist/commands",
62
+ "plugins": [
63
+ "@oclif/plugin-help",
64
+ "@oclif/plugin-plugins"
65
+ ],
66
+ "topicSeparator": " ",
67
+ "topics": {
68
+ "workflow": {
69
+ "description": "interact with and manage workflows"
70
+ }
71
+ }
72
+ },
73
+ "scripts": {
74
+ "build": "shx rm -rf dist && swc src -d dist",
75
+ "lint": "eslint . --ext .ts --config .eslintrc.json",
76
+ "lint.fix": "yarn run lint --fix",
77
+ "format": "prettier \"src/**/*.+(ts|js)\" \"test/**/*.+(ts|js)\"",
78
+ "format.write": "yarn run format --write",
79
+ "format.check": "yarn run format --check",
80
+ "type.check": "tsc",
81
+ "postpack": "shx rm -f oclif.manifest.json",
82
+ "prepack": "yarn build && oclif manifest && oclif readme",
83
+ "test": "mocha --forbid-only \"test/**/*.test.ts\"",
84
+ "version": "oclif readme && git add README.md"
85
+ },
86
+ "engines": {
87
+ "node": ">=12.0.0"
88
+ },
89
+ "bugs": "https://github.com/knocklabs/knock-cli/issues",
90
+ "keywords": [
91
+ "oclif"
92
+ ],
93
+ "types": "dist/index.d.ts"
94
+ }