@appland/components

appmap-js

This repository bundles together AppMap models and Vue components in a single dependency.

Project setup

yarn install

Development

Development is typically done while running Storybook.

yarn run storybook

Committing

Commits must be made according to the Conventional Commits specification to facilitate automated releases.

Bundling

Bundles are output to the dist directory.

yarn run build

Testing

New features and fixes should always have test coverage.

Unit tests

Unit testing is performed with Jest and JSDom.

To run unit tests:

yarn run test:unit

End-to-end tests

End-to-end testing is performed with Cypress. To open the Cypress frontend, run:

yarn run test:e2e

Otherwise, Cypress can be run in headless mode by providing the --headless flag.

yarn run test:e2e -- --headless

TravisCI

Travis will run the entire test suite in headless mode via:

yarn run test

This command will also be run as a pre-push hook to ensure that tests are passing before pushing. To skip this step, use the --no-verify flag:

git push origin my-branch --no-verify