feat(xo-cli): document config export (#2662)
This commit is contained in:
parent
c5fdab7d47
commit
fd2580f5da
@ -105,6 +105,12 @@ encoding by prefixing with `json:`:
|
|||||||
> xo-cli foo.bar baz='json:[1, 2, 3]'
|
> xo-cli foo.bar baz='json:[1, 2, 3]'
|
||||||
```
|
```
|
||||||
|
|
||||||
|
##### Configuration export
|
||||||
|
|
||||||
|
```
|
||||||
|
> xo-cli xo.exportConfig @=config.json
|
||||||
|
```
|
||||||
|
|
||||||
##### VM export
|
##### VM export
|
||||||
|
|
||||||
```
|
```
|
||||||
|
@ -328,6 +328,15 @@ async function listObjects (args) {
|
|||||||
}
|
}
|
||||||
exports.listObjects = listObjects
|
exports.listObjects = listObjects
|
||||||
|
|
||||||
|
function ensurePathParam (method, value) {
|
||||||
|
if (typeof value !== 'string') {
|
||||||
|
const error =
|
||||||
|
method +
|
||||||
|
' requires the @ parameter to be a path (e.g. @=/tmp/config.json)'
|
||||||
|
throw error
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
async function call (args) {
|
async function call (args) {
|
||||||
if (!args.length) {
|
if (!args.length) {
|
||||||
throw new Error('missing command name')
|
throw new Error('missing command name')
|
||||||
@ -350,6 +359,7 @@ async function call (args) {
|
|||||||
key = keys[0]
|
key = keys[0]
|
||||||
|
|
||||||
if (key === '$getFrom') {
|
if (key === '$getFrom') {
|
||||||
|
ensurePathParam(method, file)
|
||||||
url = resolveUrl(baseUrl, result[key])
|
url = resolveUrl(baseUrl, result[key])
|
||||||
const output = createWriteStream(file)
|
const output = createWriteStream(file)
|
||||||
|
|
||||||
@ -371,6 +381,7 @@ async function call (args) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
if (key === '$sendTo') {
|
if (key === '$sendTo') {
|
||||||
|
ensurePathParam(method, file)
|
||||||
url = resolveUrl(baseUrl, result[key])
|
url = resolveUrl(baseUrl, result[key])
|
||||||
|
|
||||||
const stats = await stat(file)
|
const stats = await stat(file)
|
||||||
|
Loading…
Reference in New Issue
Block a user