Hazelcast Hive
Design system built with A11Y in mind. Developed as a Lerna monorepo with shared frontend libraries for a variety of Hazelcast product offerings.
Design system is available live at URL: https://master--5f80b6aa3ceb290022dfea61.chromatic.com/
- Installation
- Usage
- Global CSS
- SSR
- Project structure
- How-to
- Setup
- Deploy
- Add a new shared dependency
- Add a new local dependency (for one package only)
- Make changes to several packages and test it
- Run storybook for development
- Run linting
- Run unit tests
- Run visual regression tests
- Approve the updated for visual regression test screenshots
- Generate new screenshots for the new/updated components
- Run all checks at once
- Releasing a new version
Installation
npm i @hazelcast/ui
(npm i @hazelcast/ui@next
- canary version) - set of Hive UI componentsnpm i @hazelcast/services
(npm i @hazelcast/services@next
- canary version) - Hive servicesnpm i @hazelcast/helpers
(npm i @hazelcast/helpers@next
- canary version) - Hiver helpersnpm i -D @hazelcast/test-helpers
(npm i -D @hazelcast/test-helpers@next
- canary version) - Hive test helpers
Usage
Be aware, that we compile our TypeScript code to the modern ES2018
JavaScript. To run it in legacy environment, please, configure webpack or any other bundler accordingly.
Moreover, we do not do anything about styles (scss
in our case). We just import them as modules. Please, configure webpack or any other bundler to handle them.
The latest version of the design system is accessible at https://master--5f80b6aa3ceb290022dfea61.chromatic.com/.
Global CSS
This library is used from Next.js projects. Individual projects should transpile @hazelcast/ui. However, Next.js still forbids to import files with .css / .scss extension unless they're in _app.tsx
So please make sure to import the following global styles in your projects if you need them.
import '@hazelcast/ui/styles/datepicker.scss'
or
import '@hazelcast/ui/styles/datepicker.module.scss'
if you need a CSS modules version
SSR
Stable IDs
We use react-uid
to generate stable IDs. you'll need UIDReset
and UIDFork
(optionally) to properly handle SSR. See the README.
Project structure
packages
contains a list of published packages:
helpers
(full name@hazelcast/helpers
)services
(full name@hazelcast/services
)test-helpers
(full name@hazelcast/test-helpers
)ui
(full name@hazelcast/ui
)
Automated visual regression testing
Uses stories from Storybook as test cases. In other words, any story is going to result in a set of screenshots. Moreover, any story is required to have an associated set of screenshots. Based on Loki, which uses headless Chrome to render the screenshots in Docker.
How-to
Setup
npm ci
Under the hood
It runs a regular npm ci
and executes a postinstall
hook. In that hook it runs:
lerna bootstrap --hoist
Installs dependencies for all packages.link-parent-bin
Creates symlinks inpackages/*/node_modules/.bin
to all executables innode_modules/.bin
. We store shared dependencies at the root level. This command allows us to run executables from these modules in our child packages.lerna run compile
Our child packages are written in TypeScript. To import them fromnode_modules
in other packages they must be compiled to JavaScript first.
Deploy
Every commit to master
is automatically deployed new canary version of the package (@hazelcast/xxx@next
) by Hazelcast Jenkins.
Add a new shared dependency
In the root folder run
npm i [-D] dependency-name
If it contains an executable we want to run in our child packages, run npm run link-parent-bin
after it.
If it is a production (not dev only) dependency for one or several of our child packages, add it to their package.json
as a peer dependency.
Add a new local dependency (for one package only)
In the root folder run (replace @hazelcast/ui with @hazelcast/helpers, @hazelcast/test-helpers or @hazelcast/services if needed)
lerna add --scope @hazelcast/ui dependency-name
Make changes to several packages and test it
When Lerna does the bootstrapping, it creates symlinks to the local packages other packages depend on. In our case, @hazelcast/ui
depends on @hazelcast/helpers
. Lerna is going to create a symlink ./packages/ui/node_modules/@hazelcast/helpers
that points to ./packages/helpers
. When we change our TypeScript code, the associated compiled JavaScript is not updated automatically. So if we change something in @hazelcast/helpers
and we want to test how it works in @hazelcast/ui
, we need to compile our changes in @hazelcast/helpers
. To do that we have two options:
- Compile all packages with
npm run compile
in the root directory - Compile a specific package, e.g.
cd packages/helpers && npm run compile
Now we can use the updated code in @hazelcast/ui
.
Run storybook for development
In the root directory
npm start
Run linting
In the root directory
npm run lint
Run unit tests
In the root directory
npm test
Run visual regression tests
In the root directory
npm run build-storybook
npm run test:visual
Approve the updated for visual regression test screenshots
Say, we have changed something in our components. First we need to run the visual regression tests to make sure that the change affected how the component is displayed.
npm run build-storybook
npm run test:visual
Now, if the test suite failed, we need to go to packages/ui/.loki
and manually review the screenshots in the current
folder and the diff in the difference
folder. If we like what we see, we need to run npm run test:visual:approve
in the packages/ui
folder. It will update the reference screenshots.
Generate new screenshots for the new/updated components
Go to packages/ui
and run command for screenshot generation. The command builds storybook and updates screenshots.
cd packages/ui
npm run generate-screenshots
Run all checks at once
npm run verify-all
If you PR passes this check locally, it is almost guaranteed to pass it on the CI.
Releasing a new version
Assuming you're on latest master and the build is alright (npm run build
runs without errors).
- First we create a release branch for the next version locally (in this case v1.1.0):
git checkout -b release/v1.1.0
We push this new branch to Github:
git push -u origin release/v1.1.0
- Then we run
lerna version
: This updates the package versions (in package.json, package-lock.json), creates a commit with necessary tags and pushes to Github automatically.
npx lerna version 1.1.0
At this point you should create a pull request and merge the new version branch (v1.1.0) to master.
- Now, after merging this pull request, we have the latest version available on GitHub. And it will be automatically published to npm with the required tags and releases;
Wait for a few seconds/minutes (depends on how busy npm is at the time), and you should see the latest version we just released in the list returned by:
npm view @hazelcast/ui versions
If something went wrong and npm did not create a new release, then you can manually inform it about our new release:
npx lerna publish from-git