@justeattakeaway/pie-button
Advanced tools
Comparing version 0.34.0 to 0.35.0
{ | ||
"name": "@justeattakeaway/pie-button", | ||
"version": "0.34.0", | ||
"version": "0.35.0", | ||
"description": "PIE design system button built using web components", | ||
@@ -5,0 +5,0 @@ "type": "module", |
@@ -17,12 +17,9 @@ <p align="center"> | ||
4. [Peer Dependencies](#peer-dependencies) | ||
5. [Local Development](#local-development) | ||
6. [Props](#props) | ||
7. [Events](#events) | ||
5. [Props](#props) | ||
6. [Events](#events) | ||
- [HTML example](#html) | ||
- [Vue example (using Nuxt 3)](#vue-templates-using-nuxt-3) | ||
- [React example (using Next 13)](#react-templates-using-next-13) | ||
6. [Forms usage](#forms-usage) | ||
7. [Testing](#testing) | ||
- [Browser Tests](#browser-tests) | ||
- [Visual Tests](#visual-tests) | ||
7. [Forms usage](#forms-usage) | ||
8. [Contributing](#contributing) | ||
@@ -75,26 +72,2 @@ | ||
## Local development | ||
Install the dependencies. Note that this, and the following commands below, should be run from the **root of the monorepo**: | ||
```bash | ||
yarn | ||
``` | ||
To build the `pie-button` package, run the following command: | ||
```bash | ||
yarn build --filter=pie-button | ||
``` | ||
If you'd like to develop using the component storybook, then you should build the component in `watch` mode, and run storybook in a separate terminal tab: | ||
```bash | ||
yarn watch --filter=pie-button | ||
# in a separate terminal tab, run | ||
yarn dev --filter=pie-storybook | ||
``` | ||
## Props | ||
@@ -224,34 +197,4 @@ | ||
## Testing | ||
## Contributing | ||
### Browser tests | ||
To run the browser tests, run the following command from the root of the monorepo: | ||
```bash | ||
yarn test:browsers --filter=pie-button | ||
``` | ||
### Visual tests | ||
To run the visual regression tests, run the following command from the root of the monorepo: | ||
```bash | ||
yarn test:visual --filter=pie-button | ||
``` | ||
Note: To run these locally, you will need to ensure that any environment variables required are set up on your machine to mirror those on CI (such as Percy tokens). How you achieve this will differ between operating systems. | ||
#### Setup via bash | ||
```bash | ||
export PERCY_TOKEN_PIE_BUTTON=abcde | ||
``` | ||
#### Setup via package.json | ||
Under scripts `test:visual` replace the environment variable with the below: | ||
```bash | ||
PERCY_TOKEN_PIE_BUTTON=abcde | ||
``` | ||
Check out our [contributing guide](https://github.com/justeattakeaway/pie/wiki/Contributing-Guide) for more information on [local development](https://github.com/justeattakeaway/pie/wiki/Contributing-Guide#local-development) and how to run specific [component tests](https://github.com/justeattakeaway/pie/wiki/Contributing-Guide#testing). |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
85237
197