jprdonnelly/nebula.js
1
0
Fork 0
mirror of https://github.com/qlik-oss/nebula.js.git synced 2025-12-19 17:58:43 -05:00
Code Issues Projects Releases Wiki Activity

docs: update command docs (#447)

Browse Source
This commit is contained in:
Miralem Drek
2020-06-09 10:38:39 +02:00
committed by GitHub
parent c02a7ab17f
commit b5abd12fb0
8 changed files with 51 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
commands/build/README.md
View File

@@ -1,9 +1,11 @@
# @nebula.js/cli-build # @nebula.js/cli-build
Build nebula.js visualization.
## Install ## Install
```sh ```sh
npm install @nebula.js/cli npm install @nebula.js/cli @nebula.js/cli-build -g
``` ```
## Usage ## Usage
@@ -11,11 +13,12 @@ npm install @nebula.js/cli
```sh ```sh
nebula build nebula build
Build supernova Build nebula.js visualization
Options: Options:
--version Show version number [boolean] --version Show version number [boolean]
--watch, -w [boolean] [default: false] --config, -c Path to JSON config file
--sourcemap, -m [boolean] [default: true] [string] [default: "nebula.config.js"]
-h, --help Show help [boolean] --watch, -w Watch source files [boolean] [default: false]
--sourcemap, -m Generate source map [boolean] [default: true]
``` ```

2
commands/build/command.js
View File

@@ -4,7 +4,7 @@ const init = require('./lib/init-config');
module.exports = { module.exports = {
command: 'build', command: 'build',
desc: 'Build supernova', desc: 'Build visualization',
builder(yargs) { builder(yargs) {
init(yargs).argv; init(yargs).argv;
}, },

7
commands/cli/README.md
View File

@@ -1,5 +1,7 @@
# @nebula.js/cli # @nebula.js/cli
Command line interface for nebula.js
## Install ## Install
```sh ```sh
@@ -12,9 +14,10 @@ npm install -g @nebula.js/cli
nebula <command> [options] nebula <command> [options]
Commands: Commands:
nebula build Build supernova nebula build Build visualization
nebula create <name> Create a supernova nebula create <name> Create a visualization
nebula serve Dev server nebula serve Dev server
nebula sense Build a nebula visualization as a Qlik Sense extension
Options: Options:
--version Show version number [boolean] --version Show version number [boolean]

17
commands/create/README.md
View File

@@ -1,5 +1,7 @@
# @nebula.js/cli-create # @nebula.js/cli-create
Scaffold a nebula visualization or mashup.
## Install ## Install
```sh ```sh
@@ -13,7 +15,10 @@ npm install -g @nebula.js/cli
```sh ```sh
nebula create <name> nebula create <name>
Create a supernova Create a visualization
Commands:
nebula create mashup <name> Create a mashup
Positionals: Positionals:
name name of the project [string] [required] name name of the project [string] [required]
@@ -22,11 +27,21 @@ Options:
--version Show version number [boolean] --version Show version number [boolean]
--install Run package installation step [boolean] [default: true] --install Run package installation step [boolean] [default: true]
--pkgm Package manager [string] [choices: "npm", "yarn"] --pkgm Package manager [string] [choices: "npm", "yarn"]
--picasso Picasso template [string] [choices: "none", "minimal", "barchart"]
--author Package author [string]
-h, --help Show help [boolean] -h, --help Show help [boolean]
``` ```
#### Example #### Example
**Create a visualization**
```sh ```sh
nebula create hello-sunshine nebula create hello-sunshine
``` ```
**Create a mashup**
```sh
nebula create mashup hello-mashie
```

2
commands/create/command.js
View File

@@ -16,7 +16,7 @@ const mashup = {
module.exports = { module.exports = {
command: 'create <name>', command: 'create <name>',
desc: 'Create a supernova', desc: 'Create a visualization',
builder(yargs) { builder(yargs) {
yargs.command(mashup); yargs.command(mashup);

1
commands/sense/README.md
View File

@@ -22,7 +22,6 @@ Options:
--output Destination directory [string] [default: "<name>-ext"] --output Destination directory [string] [default: "<name>-ext"]
--minify Minify and uglify code [boolean] [default: true] --minify Minify and uglify code [boolean] [default: true]
--sourcemap Generate sourcemaps [boolean] [default: false] --sourcemap Generate sourcemaps [boolean] [default: false]
--partial Generate partial extension [boolean] [default: false]
-h, --help Show help [boolean] -h, --help Show help [boolean]
``` ```

1
commands/sense/command.js
View File

@@ -38,6 +38,7 @@ module.exports = {
required: false, required: false,
default: false, default: false,
desc: 'Generate partial extension', desc: 'Generate partial extension',
hidden: true,
}); });
}, },
handler(argv) { handler(argv) {

28
commands/serve/README.md
View File

@@ -1,11 +1,11 @@
# @nebula.js/cli-serve # @nebula.js/cli-serve
Basic web development server for supernovas. Basic web development server for nebula.js visualizations.
## Install ## Install
```sh ```sh
npm install @nebula.js/cli -g npm install @nebula.js/cli @nebula.js/cli-serve -g
``` ```
## Usage ## Usage
@@ -18,16 +18,24 @@ nebula serve -h
Dev server Dev server
Options: Options:
--version Show version number [boolean] --version Show version number [boolean]
--entry File entrypoint [string] --config, -c Path to JSON config file
--type Generic object type [string] [string] [default: "nebula.config.js"]
--entry File entrypoint [string]
--type Generic object type [string]
--build [boolean] [default: true] --build [boolean] [default: true]
--host [string] --host [string] [default: "localhost"]
--port [number] --port [number]
--enigma.host [string] --disableHostCheck [boolean] [default: false]
--enigma.port [default: 9076] --resources Path to a folder that will be served as static files under
--ACCEPT_EULA, -a [boolean] [default: false] /resources [string]
-h, --help Show help [boolean] --scripts Array of scripts to inject [array]
--stylesheets Array of stylesheets to inject [array]
--enigma.host [string] [default: "localhost"]
--enigma.port [number] [default: 9076]
--webIntegrationId [string]
--ACCEPT_EULA [boolean] [default: false]
-h, --help Show help [boolean]
``` ```
#### Example #### Example