hashicc
9204c63b17
* chore: 🤖 replace CopyButton usage with Hds::Copy::Button * chore: 🤖 remove ember-cli-clipboard * test: 💍 fix test by stubbing writeText The hds copy button uses the browser clipboard api. The writeText api can fail if the window is not active. This does not happen in practice because the window has to be active to be clicked by the user. But in tests with synthetic triggers this can fail. Stubbing the writeText method is also how hds tests their component: https://github.com/hashicorp/design-system/blob/990981b5741f9a6bf28d100c330b7865ba74e506/showcase/tests/integration/components/hds/copy/button/index-test.gts#L20
Rose - Style & Component Ember Addon for Boundary
This addon contains common styles and components shared by Boundary UIs.
Table of Contents generated with DocToc
- Add Styles to an App
- Installation
- Pnpm Commands
- Linting
- Formatting
- Building Components
- Using Components
- Running tests
- Running the dummy application
- Contributing
Add Styles to an App
Add this addon to an Ember application's devDependencies as:
"rose": "workspace:*", for applications included in this monorepo. Application's
may then import rose styles by adding @use 'rose'; to their stylesheets.
Installation
See monorepo README for installation instructions.
Pnpm Commands
List of available project commands. pnpm run <command-name>
| Command | Description |
|---|---|
| build:development | Builds the dummy app in development mode. |
| build | Builds the dummy app for production. |
| lint | Runs all lint commands. |
| lint:fix | Runs automatic lint fixes for all files. |
| lint:hbs | Lints template hbs files. |
| lint:hbs:fix | Runs automatic lint fixes for hbs files. |
| lint:js | Lints js files. |
| lint:js:fix | Runs automatic lint fixes for js files. |
| lint:sass | Lints scss files. |
| format | Runs all auto-formatters. |
| format:js | Auto-formats js files using Prettier. |
| format:hbs | Auto-formats hbs files using Prettier. |
| format:sass | Auto-formats scss files using Prettier. |
| start | Runs the dummy app local server. |
| test | Runs all tests. |
| test:ember-compatibility | Runs tests across multiple Ember versions with ember-try. |
| precommit | Runs all lint, format and tests. |
| doc:toc | Automatically generates a table of contents for this README file. |
Additional commands in the monorepo package may affect this projects.
Linting
pnpm lint:hbspnpm lint:jspnpm lint:js --fix
Formatting
Before submitting your work, be sure to run auto-formatters (see commands above). This helps to ensure consistency among authors.
pnpm format
Building Components
To build a new component, start by generating it on the command line with
ember g component rose/component-name.
Running tests
pnpm test– Runs the test suite on the current Ember versionpnpm test --server– Runs the test suite in "watch mode"pnpm test:all– Runs the test suite against multiple Ember versions
Running the dummy application
pnpm start- Visit the dummy application at http://localhost:4200.
Contributing
See monorepo README for more contribution instructions.
Building ToC
To autogenerate a ToC (table of contents) for this README,
run pnpm doc:toc. Please update the ToC whenever editing the structure
of README.