@bb-cli/bb-ang
v6.0.6
Published
Extending angular cli
Downloads
782
Readme
NAME
bb-ang - Extending angular cli
SYNOPSIS
bb-ang [--help] [-v|--version]
bb-ang package-libs [--help] [projec]
bb-ang package-apps [--help] [--node-deps-scope <npm scope>] [--configuration <configuration>]
[--dev] [--ts-config <ts config>] [--output-hashing]
[--build-memory <mb>] [--serial-build] [--catalog-root <root path>]
[--portal-version <version>] [--cx-version <version>] [--applications <applications>]
[--extend-container] [projec]
bb-ang copy-assets [--help] [--dist <dist folder path>] [projec]
bb-ang combine-coverage [--help] [--dist <dist folder path>] [--reporters <reporters>] [projec]
bb-ang check-api [--help] [--lib <lib>] [--report-folder <report-folder>] [projec]
bb-ang extract-api [--help] [--lib <lib>] [--report-folder <report-folder>] [projec]
bb-ang build-apps [--help] [--configuration <configuration>] [--node-deps-scope <npm scope>]
[--ts-config <ts config>] [--output-hashing] [--build-memory <mb>]
[--serial-build] [--catalog-root <root path>] [--applications <applications>]
[--portal-version <version>] [--cx-version <version>] [projec]
bb-ang create-provisioning-package [--help] [--cx-items <cx item>] [--portal-version <version>]
[--cx-version <version>] [--applications <applications>] [projec]
DESCRIPTION
The bb-ang command gives additional ability to the standard "ng" CLI for Backbase applications and libraries.
The standard ng command doesn't provide a solution for packaging reusable Angular libraries, and for this reason we provide the "bb-ang package-libs" command. This command wraps the well-known "ng-packagr" command.
bb-ang also has the ability to create a provision package of your App, which can be imported into a Backbase Experience Catalog, where you can manage your Angular app.
OPTIONS
| Option | Description | | ------ | ----------- | | -v, --version | output the version number | | --help | Output usage information |
COMMANDS
NAME
bb-ang package-libs - Transpile your libraries to Angular Package Format.
SYNOPSIS
bb-ang package-libs [--help] [projec]
EXAMPLES
Run the command:
$ bb-ang package-libs
NAME
bb-ang package-apps - Build Angular apps into a Backbase Provisioning Package.
SYNOPSIS
bb-ang package-apps [--help] [--node-deps-scope <npm scope>] [--configuration <configuration>]
[--dev] [--ts-config <ts config>] [--output-hashing]
[--build-memory <mb>] [--serial-build] [--catalog-root <root path>]
[--portal-version <version>] [--cx-version <version>] [--applications <applications>]
[--extend-container] [projec]
DESCRIPTION
:warning: Starting from v4.3.3, the resulting Backbase Provisioning Package doesn't include any Feature items of the Object Model.
OPTIONS
| Option | Description | | ------ | ----------- | | --node-deps-scope <npm scope> | Models from the node_modules in this NPM scope will be included in the package | | --configuration <configuration> | Use the specified configuration (default: "production") | | --dev | Package app for development (overrides --configuration).This option is deprecated. It doesn't make sense to package your application for development. | | --ts-config <ts config> | Use a specified ts-config file for the build | | --output-hashing | Enable output hashing for cache busting of built js/css | | --build-memory <mb> | Amount of memory to allocate to node for running "ng build" (MB set via node's --max_old_space_size) | | --serial-build | Build apps in serial instead of parallel to reduce CPU and memory footprint | | --catalog-root <root path> | Static resources path root (default: "$(staticResourcesRoot)/static/items") | | --portal-version <version> | Version of CX being used | | --cx-version <version> | Alias for portal-version | | --applications <applications> | Comma separated list of applications to be built | | --extend-container | Add ability to extend application template and model | | --help | Output usage information |
EXAMPLES
Run the command:
$ bb-ang package-apps
NAME
bb-ang copy-assets - Command to find and copy all the assets to the build directory
SYNOPSIS
bb-ang copy-assets [--help] [--dist <dist folder path>] [projec]
OPTIONS
| Option | Description | | ------ | ----------- | | --dist <dist folder path> | Use a specified folder for items while serving | | --help | Output usage information |
EXAMPLES
Run the command:
$ bb-ang copy-assets
NAME
bb-ang combine-coverage - Combine all coverage reports generated by ng test into a single report
SYNOPSIS
bb-ang combine-coverage [--help] [--dist <dist folder path>] [--reporters <reporters>] [projec]
DESCRIPTION
This command will find all applications and libraries from the angular.json in the [project root], that have a "test" architect with the "codeCoverage" option set to true.
The reports that are already generated must include a json report. The json report should be found in the coverage directory and be named coverage-final.json.
The coverage directory is assumed to be called coverage, and be in the root of the application/library (as specified in the angular.json).
Check your karma.conf.js to ensure:
- The json report is being created
- The report is generated in the %library root%/coverage/
OPTIONS
| Option | Description | | ------ | ----------- | | --dist <dist folder path> | Output coverage to the given directory (default to coverage) | | --reporters [reporters] | Comma separated list of coverage reporters. Possible values: text-summary,html,lcov. | | --help | Output usage information |
EXAMPLES
Run the command:
$ bb-ang combine-coverage
Change the output dir:
$ bb-ang combine-coverage --dist my-coverage
NAME
bb-ang check-api - Ensure public APIs are not accidentally broken.
SYNOPSIS
bb-ang check-api [--help] [--lib <lib>] [--report-folder <report-folder>] [projec]
OPTIONS
| Option | Description | | ------ | ----------- | | --lib <lib> | Only extract the API for this library. | | --report-folder <report-folder> | where we can check library API. | | --help | Output usage information |
EXAMPLES
Run the command:
$ bb-ang check-api
specify library to be check:
$ bb-ang check-api --lib my-library
where we can check library API:
$ bb-ang check-api --report-folder ./apis
NAME
bb-ang extract-api - Extract public APIs from your libraries and generate a report.
SYNOPSIS
bb-ang extract-api [--help] [--lib <lib>] [--report-folder <report-folder>] [projec]
OPTIONS
| Option | Description | | ------ | ----------- | | --lib <lib> | Only extract the API for this library. | | --report-folder <report-folder> | The place to extract library API. | | --help | Output usage information |
EXAMPLES
Run the command:
$ bb-ang extract-api
specify library to be extract:
$ bb-ang check-api --lib my-library
specify the place to extract library API.:
$ bb-ang extract-api --report-folder ./apis
NAME
bb-ang build-apps - Build Angular apps.
SYNOPSIS
bb-ang build-apps [--help] [--configuration <configuration>] [--node-deps-scope <npm scope>]
[--ts-config <ts config>] [--output-hashing] [--build-memory <mb>]
[--serial-build] [--catalog-root <root path>] [--applications <applications>]
[--portal-version <version>] [--cx-version <version>] [projec]
DESCRIPTION
:warning: Starting from v4.3.3, the resulting Backbase Provisioning Package doesn't include any Feature items of the Object Model.
OPTIONS
| Option | Description | | ------ | ----------- | | --configuration <configuration> | Use the specified configuration (default: "production") | | --node-deps-scope <npm scope> | Models from the node_modules in this NPM scope will be included in the build | | --ts-config <ts config> | Use a specified ts-config file for the build | | --output-hashing | Enable output hashing for cache busting of built js/css | | --build-memory <mb> | Amount of memory to allocate to node for running "ng build" (MB set via node's --max_old_space_size) | | --serial-build | Build apps in serial instead of parallel to reduce CPU and memory footprint | | --catalog-root <root path> | Static resources path root (default: "$(staticResourcesRoot)/static/items") | | --applications <applications> | Comma separated list of applications to be built | | --portal-version <version> | Version of CX being used | | --cx-version <version> | Alias for portal-version | | --help | Output usage information |
EXAMPLES
Run the command:
$ bb-ang build-apps
NAME
bb-ang create-provisioning-package - package Angular apps into a Backbase Provisioning Package.
SYNOPSIS
bb-ang create-provisioning-package [--help] [--cx-items <cx item>] [--portal-version <version>]
[--cx-version <version>] [--applications <applications>] [projec]
OPTIONS
| Option | Description | | ------ | ----------- | | --cx-items <cx item> | Comma separated list of directories, models from this directories will be included in the package | | --portal-version <version> | Version of CX being used | | --cx-version <version> | Alias for portal-version | | --applications <applications> | Comma separated list of applications to be packaged | | --help | Output usage information |
EXAMPLES
Run the command:
$ bb-ang package-apps
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