Scaleway UI

Scaleway official UI library.

Develop

Start storybook using yarn dev.

Test

$ yarn run test # Will run all tests
$ yarn run test --updateSnapshot # Will update all snapshots
$ yarn run test:watch # Will watch tests and only rerun the one who are modified
$ yarn run test:coverage # Will generate a coverage report

Lint

$ yarn run lint
$ yarn run lint:fix

Build

$ yarn run build
$ yarn run build:profile

Use local changes on shire

NPM link

$ # In the scaleway-ui project
$ yarn link
$ # In the project where you want to use it
$ yarn link @test-random/ui
$ # When you are done, to restore the original package
$ yarn unlink @test-random/ui && yarn install --force

Manual way

Only valid when used with shire and both project are located in the same folder

$ yarn run transfer

Versioning

We enforce the conventionnal commits convention in order to infer package bump versions and generate changelog.

Only the feat, fix and perf types will generate a new package on the master branch