VMware Cloud Director UI Common Components
Repo Structure
This monorepo contains four separate but related projects:
Component Library (./projects/components) @vcd/ui-components
Reusable components for vcd-ui and its plugin developers. See its README for further details
Internalization Library (./projects/i18n) @vcd/i18n
Translation code for vcd-ui and its plugin developers. See its README for further details
Examples App (./projects/examples)
The application that showcases @vcd/ui-components using @vmw/ng-live-docs.
Run npm install first. Then run npm run build:i18n followed by npm run build:components to build.
Run npm start for a dev server. Navigate to http://localhost:4200/. The app will automatically reload if
you change any of the source files. This is where you'll see changes made in components.
Online Examples
Visit our live examples site for live examples, with source code, that you run on stackblitz. Powered by Live Docs
Route Analyzer (./projects/route-analyzer) @vcd/route-analyzer
Route Analyzer statically analyzes angular source code and generates a json file with all the available routes, including the ones from lazy loaded modules. See its README for further details
Peer Dependencies
The component library depends on Clarity and Angular
which must must be installed from your application's package.json. See package.json for version
information.
Code scaffolding
Run ng generate component component-name to generate a new component. You can also use
ng generate directive|pipe|service|class|guard|interface|enum|module.
Build
Run npm run build:i18n and npm run build:components. The build artifacts will be stored in the dist/ directory.
Running unit tests
Run npm run test:components, or npm run test:i18n to execute the unit tests via Karma.
Running end-to-end tests (Examples App)
Run ng e2e to execute the end-to-end tests via Protractor.
Cloning the repo
We typically use git clone https://github.com/vmware/vmware-cloud-director-ui-components ./vcd-ui-common to avoid
the extremely long folder name.
Versioning
For all official releases, versioning should be semantic as per NPM's documentation.
For all development, nightly builds, the version should be created using npm version prerelease --preid=dev.
Publishing
See ci-cd.yml
We recommend that a separate PR be created when publishing a new version of the library. To publish a new version
of @vcd/ui-components or @vcd/route-analyzer or @vcd/i18n, you must add the following anywhere in your commit message:
[publish lib-name]to publish an@nextrelease[publish lib-name@latest]to publish an@latestrelease
Where lib-name is one of the following:
@vcd/ui-components@vcd/route-analyzer@vcd/i18n
And modify the corresponding package.json files:
Note that @latest releases are only to be created when we release a version of VCD. Most releases, except for the
final release that is used by a release of VCD, should be @next.
Merging the PR will publish the mentioned packages when it's pushed to master
Angular CLI
This project was generated with Angular CLI version 8.3.20. We attempt to keep the project following CLI guidelines so we can benefit from ng update.
Further help
To get further help, please file issues on github.
To get more help on the Angular CLI use ng help or go check out the
Angular CLI README.