@constructor-io/constructorio-connect-cli 1.0.0 → 1.0.2
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 +0 -42
- package/oclif.manifest.json +1 -1
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -53,7 +53,6 @@ EXAMPLES
|
|
|
53
53
|
$ constructorio-connect-cli deploy production
|
|
54
54
|
```
|
|
55
55
|
|
|
56
|
-
_See code: [src/commands/deploy.ts](https://github.com/Constructor-io/constructorio-connect-cli/blob/v1.0.0/src/commands/deploy.ts)_
|
|
57
56
|
|
|
58
57
|
## `constructorio-connect-cli execute`
|
|
59
58
|
|
|
@@ -90,7 +89,6 @@ EXAMPLES
|
|
|
90
89
|
$ constructorio-connect-cli execute --template-path=mapping/mapping.jsonata
|
|
91
90
|
```
|
|
92
91
|
|
|
93
|
-
_See code: [src/commands/execute.ts](https://github.com/Constructor-io/constructorio-connect-cli/blob/v1.0.0/src/commands/execute.ts)_
|
|
94
92
|
|
|
95
93
|
## `constructorio-connect-cli help [COMMAND]`
|
|
96
94
|
|
|
@@ -110,7 +108,6 @@ DESCRIPTION
|
|
|
110
108
|
Display help for constructorio-connect-cli.
|
|
111
109
|
```
|
|
112
110
|
|
|
113
|
-
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.0.21/src/commands/help.ts)_
|
|
114
111
|
|
|
115
112
|
## `constructorio-connect-cli init NAME`
|
|
116
113
|
|
|
@@ -132,7 +129,6 @@ EXAMPLES
|
|
|
132
129
|
$ constructorio-connect-cli init new-repo-name
|
|
133
130
|
```
|
|
134
131
|
|
|
135
|
-
_See code: [src/commands/init.ts](https://github.com/Constructor-io/constructorio-connect-cli/blob/v1.0.0/src/commands/init.ts)_
|
|
136
132
|
<!-- commandsstop -->
|
|
137
133
|
|
|
138
134
|
## Development
|
|
@@ -144,41 +140,3 @@ npm run lint # run lint on source code and tests
|
|
|
144
140
|
npm run test # run tests
|
|
145
141
|
npm run test:cov # run tests with coverage report
|
|
146
142
|
```
|
|
147
|
-
|
|
148
|
-
### Running locally
|
|
149
|
-
|
|
150
|
-
First, install dependencies:
|
|
151
|
-
|
|
152
|
-
```bash
|
|
153
|
-
npm ci
|
|
154
|
-
```
|
|
155
|
-
|
|
156
|
-
Then, set up your local environment and fill `.env` with your credentials:
|
|
157
|
-
|
|
158
|
-
```bash
|
|
159
|
-
cp .env.example .env
|
|
160
|
-
```
|
|
161
|
-
|
|
162
|
-
All done! You can now run the package locally:
|
|
163
|
-
|
|
164
|
-
```bash
|
|
165
|
-
npm run dev [command] -- [arguments and flags]
|
|
166
|
-
# or, you can just directly access the built CLI:
|
|
167
|
-
bin/dev.js [command] [arguments and flags]
|
|
168
|
-
```
|
|
169
|
-
|
|
170
|
-
You can also test inside other projects with:
|
|
171
|
-
|
|
172
|
-
```bash
|
|
173
|
-
npm i full/path/to/this/repo
|
|
174
|
-
# or even install it globally
|
|
175
|
-
|
|
176
|
-
npm i -g full/path/to/this/repo
|
|
177
|
-
constructorio-connect-cli --help
|
|
178
|
-
```
|
|
179
|
-
|
|
180
|
-
Finally, you can switch the host you're sending requests to if you need. For example, you can point to a local host if you have a local instance running.
|
|
181
|
-
|
|
182
|
-
```
|
|
183
|
-
HOST=http://localhost:3000 constructorio-connect-cli deploy development
|
|
184
|
-
```
|
package/oclif.manifest.json
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@constructor-io/constructorio-connect-cli",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.2",
|
|
4
4
|
"description": "CLI tool to enable users to interface with the Constructor Connect Ecosystem",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
@@ -18,7 +18,7 @@
|
|
|
18
18
|
"dev": "bin/dev.js",
|
|
19
19
|
"dev:debug": "node --inspect-brk bin/dev.js",
|
|
20
20
|
"prod": "npm run build && bin/run.js",
|
|
21
|
-
"generate-readme": "
|
|
21
|
+
"generate-readme": "ts-node scripts/generate-readme.ts",
|
|
22
22
|
"prepare": "npm run build",
|
|
23
23
|
"build": "tsc --project tsconfig.production.json",
|
|
24
24
|
"prebuild": "shx rm -rf dist",
|
|
@@ -31,7 +31,7 @@
|
|
|
31
31
|
"lint:fix": "eslint \"{src,apps,libs,test}/**/*.ts\" --fix",
|
|
32
32
|
"license-check": "license-checker --production --onlyAllow 'Apache-2.0;BSD-3-Clause;BSD-2-Clause;ISC;MIT;0BSD'",
|
|
33
33
|
"postpack": "shx rm -f oclif.manifest.json",
|
|
34
|
-
"prepack": "npm run build &&
|
|
34
|
+
"prepack": "npm run build && npm run generate-readme && oclif manifest"
|
|
35
35
|
},
|
|
36
36
|
"oclif": {
|
|
37
37
|
"dirname": "constructorio-connect-cli",
|