@bb-cli/bb-wc2upgrade

Upgrade a widget collection 2 provision package for cx6

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
@bb-cli/bb-wc2upgrade
Minified + gzip package size for @bb-cli/bb-wc2upgrade in KB

Readme

NAME

SYNOPSIS

 [--help]
 cx6 [--help] [-o|--output <file-path>] <wc2-package>
 cx6-src [--help] [-y|--yes] [srcdir]

COMMANDS

NAME

cx6 - Create a CX6 compatible provision package from a CX6 package

SYNOPSIS

 cx6 [--help] [-o|--output <file-path>] <wc2-package>

DESCRIPTION

Upgrades a Widget Collection 2.X provision package, which is compatible with CXP v5 to a provision package that is compatible with CX6.

For each widget package, does the following modifications:

  • Renames index.html to index.hbs
  • Replaces g:include with datasource, for loading widget extension
  • Adds the datasource property to the model.xml

Warning: this is only intended for use with official Backbase Widget Collection and not custom collection.

OPTIONS

Option Description
-o, --output <file-path> Output package
--help Output usage information

EXAMPLES

Upgrade a retail banking widget collection:

  $ bb-wc2upgrade cx6 retail-banking-collection.zip --output cx6-retail-banking-collection.zip

NAME

cx6-src - Update widget source files in a project from WC2 CXP v5 to be compatible with CXS v6

SYNOPSIS

 cx6-src [--help] [-y|--yes] [srcdir]

DESCRIPTION

Upgrades a Widget Collection 2 project, which is compatible with CXP v5 to a provision package that is compatible with CXS v6.

For each widget package, does the following modifications:

  • Renames index.html to index.hbs
  • Replaces g:include with datasource, for loading widget extension
  • Adds the datasource property to the model.xml

Warning: this will update your source code. Ensure your project is safely committed to your version control system first

OPTIONS

Option Description
-y, --yes Confirm with yes, that you accept the warning that this will update your files
--help Output usage information

EXAMPLES

Upgrade a widget source files to be CXS v6 compatible:

  $ bb-wc2upgrade cx6-src statics/widgets

ENVIRONMENT VARIABLES

Set the amount of log output

LOG_LEVEL=silly|verbose|info|warn|error

Set whether or not to use colors in output

COLOR=false|true

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.