Skip to content

Latest commit

 

History

History
33 lines (20 loc) · 1.22 KB

File metadata and controls

33 lines (20 loc) · 1.22 KB

Design System Rails Engine

A Rails Engine packaged as a gem which provides a set of view components for each design system component. See the published guidance on using this with your own Rails application. The rest of this document is about developing the engine code locally.

Running engine checks

Run tests with via just or, within the engine directory directly via rake:

just lint-engine test-engine

This will run all rspec, rubocop, and erb-lint checks. You can view all available tasks with rake -T.

## Working with Appraisal

We use Appraisal for managing different gemfiles for older Rails versions as well as for testing new ViewComponent versions. By default the just recipe above will run all appraisal specs, you can run appraisals using:

bundle exec appraisal help

See the Appraisal docs for a full list of commands and how to work with the Appraisals file.

Utility tasks

We provide some additional utility tasks for developing the engine.

Font files can be synced between the package and the engine with:

rake sync_fonts