@nebula.js/cli-sense - npm Package Compare versions

Comparing version 1.7.0 to 2.0.0-beta.1

CHANGELOG.md

		@@ -6,2 +6,6 @@ # Change Log

		# [2.0.0-beta.1](https://github.com/qlik-oss/nebula.js/compare/v1.7.0...v2.0.0-beta.1) (2021-09-21)

		Note: Version bump only for package @nebula.js/cli-sense

		# [1.7.0](https://github.com/qlik-oss/nebula.js/compare/v1.6.0...v1.7.0) (2021-08-24)
		@@ -8,0 +12,0 @@

package.json

		{
		"name": "@nebula.js/cli-sense",
		"version": "1.7.0",
		"version": "2.0.0-beta.1",
		"description": "Build a supernova as a Qlik Sense extension",
		@@ -31,5 +31,5 @@ "license": "MIT",
		"@babel/cli": "7.14.8",
		"@babel/core": "7.14.8",
		"@babel/preset-env": "7.14.9",
		"@nebula.js/stardust": "^1.7.0",
		"@babel/core": "7.15.0",
		"@babel/preset-env": "7.15.0",
		"@nebula.js/stardust": "^2.0.0-beta.1",
		"@rollup/plugin-commonjs": "20.0.0",
		@@ -41,8 +41,8 @@ "@rollup/plugin-node-resolve": "13.0.4",
		"node-event-emitter": "0.0.1",
		"rollup": "2.55.1",
		"rollup": "2.56.3",
		"rollup-plugin-babel": "4.4.0",
		"rollup-plugin-terser": "7.0.2",
		"yargs": "17.0.1"
		"yargs": "17.1.1"
		},
		"gitHead": "2be7668ab9aa6e5e1a1f3f1d2bc31b8c095b7392"
		"gitHead": "851bf623f70a49f07615fe3b7e37b8b44fad534f"
		}

README.md

		@@ -25,9 +25,14 @@ # @nebula.js/cli-sense
		--sourcemap Generate sourcemaps [boolean] [default: false]
		--legacy Generate legacy extension [boolean] [default: false]
		-h, --help Show help [boolean]
		```

		### Extension
		## Example

		You can provide some additional information as part of the Qlik Sense Extension API by creating a separate file for the extension info and providing it as argument to `--ext`:
		### EXT

		You can set property panel definition and feature supprts by creating a separate file for the extension info and providing it as argument to `--ext`:

		Create a file called def.js and add the following:

		```js
		@@ -40,7 +45,14 @@ // def.js
		support: {
		export: true,
		exportData: true,
		snapshot: true,
		viewData: true,
		},
		importProperties: null,
		exportProperties: null,
		};
		```

		Run the command:

		```bash
		@@ -50,15 +62,24 @@ nebula sense --ext def.js

		The command generates all required files into the specified `--output` folder. You can the zip the folder and upload it as an extension on [Qlik Sense Enterprise for Windows](https://help.qlik.com/en-US/sense-developer/April2020/Subsystems/Extensions/Content/Sense_Extensions/Howtos/deploy-extensions.htm) or [Qlik Sense Enterprise on Kubernetes](https://help.qlik.com/en-US/sense-admin/April2020/Subsystems/DeployAdministerQSE/Content/Sense_DeployAdminister/QSEoK/Administer_QSEoK/mc-extensions.htm)
		Note:
		Using the --ext option will overwrite any ext definition already presented on the chart, its main purpose is to support legacy option below.

		### Meta

		You can add more meta about the extension by providing a `.json` formatted file with `--meta`:
		You can improve meta info about the extension, such as extension name, extension
		icon, and description by providing a `.json` formatted file and supply that filename
		as an argument to the `nebula sense` command with `--meta` option.

		Create a file called meta.json and add the following code demonstrating an example
		to set the extension meta information:

		```json
		{
		"name": "My tasty banana extension",
		"icon": "barchart"
		"icon": "barchart",
		"description": "Nebula test table wrapped in a Qlik Sense extension"
		}
		```

		Run the command:

		```bash
		@@ -68,2 +89,59 @@ nebula sense --meta meta.json

		The meta data will be ended up in the `.qext` file used by the Qlik Sense.

		Copy the updated `your-chart-ext` directory to your `Extension` directory,
		overwriting the old version. Then the meta data of the extension has been changed.

		The rest of the required information is populated automatically based on the content in `package.json`.

		### Output

		Generate all required files into the specified `--output` folder called sn-table-ext:

		```bash
		nebula sense --output sn-table-ext
		```

		You can upload that folder as an extension on [Qlik Sense Enterprise for Windows](https://help.qlik.com/en-US/sense-developer/August2021/Subsystems/Extensions/Content/Sense_Extensions/Howtos/deploy-extensions.htm) or [SaaS editions of Qlik Sense](https://help.qlik.com/en-US/cloud-services/Subsystems/Hub/Content/Sense_Hub/Admin/mc-extensions.htm)

		### QEXT

		Running nebula sense generates a `QEXT` file for you, which is
		required for loading the visualization into sense.

		The `QEXT` file can also be manually created by yourself.
		Create a file called `your-extension-name.qext` and add the following code as an
		example:

		```json
		{
		"name": "your-extension-name",
		"version": "0.1.0",
		"description": "",
		"author": {
		"name": "",
		"email": ""
		},
		"icon": "extension",
		"type": "visualization",
		"supernova": true
		}
		```

		The `"supernova": true` attribute should not be added when building with the
		--legacy option below.

		### Legacy

		Qlik Sense before 2020 does not support nebula supernova natively, so a special
		build path is needed for visualizations to load properly in the client.
		For this purpose, use the --legacy option.

		```bash
		nebula sense --legacy
		```

		You can find that the generated `QEXT` file does not include `supernova: true`.

		Note:
		For old Qlik Sense, not all features of extension are presented.

@nebula.js/cli-sense - npm Package Compare versions

New alerts

Improved metrics

Worsened metrics

Dependency changes