lux-design-system 7.0.0 → 7.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +11 -6
- package/dist/lux-styleguidist.iife.js +30 -30
- package/dist/lux-styleguidist.mjs +2225 -2227
- package/dist/lux-styleguidist.umd.js +30 -30
- package/dist/style.css +1 -1
- package/package.json +7 -2
package/README.md
CHANGED
|
@@ -23,7 +23,12 @@ npm run styleguide
|
|
|
23
23
|
* Run a single test file with `npx jest tests/unit/specs/components/luxGridItem.spec.js`
|
|
24
24
|
* Run a single test with the name of the test from the `it()` call: `npx jest -t "should have the appropriate class to define the columns"`
|
|
25
25
|
|
|
26
|
-
|
|
26
|
+
#### Running playwright
|
|
27
|
+
|
|
28
|
+
* `npx playwright install`
|
|
29
|
+
* `npx playwright test --ui`
|
|
30
|
+
|
|
31
|
+
## Release a new version
|
|
27
32
|
|
|
28
33
|
This requires you to have an account on npm with 2fa enabled. You will also
|
|
29
34
|
need to be part of the PULibrary organization on npm.
|
|
@@ -34,28 +39,28 @@ npm install --global np # don't add this as a devDependency, otherwise you won't
|
|
|
34
39
|
npm run release
|
|
35
40
|
```
|
|
36
41
|
|
|
37
|
-
|
|
42
|
+
### Tips
|
|
38
43
|
* If you have a passphrase on your ssh key, run ssh-add ~/.ssh/id_ed25519 (or wherever your key is located).
|
|
39
44
|
* If you use a security key, rather than an authenticator app, for two-factor authentication in npmjs.com, make sure that "Require two-factor authentication for write actions" is not checked in your account 2FA settings.
|
|
40
45
|
* Go to:Account -> Manage Two-Factor Authentication -> Uncheck 'Additional Options' -> Update Preferences. If it is checked, np will ask you for an OTP from your phone, and won't allow you to push without it.
|
|
41
46
|
|
|
42
|
-
|
|
47
|
+
## Deploy the styleguide to GitHub Pages
|
|
43
48
|
```
|
|
44
49
|
npm run deploy
|
|
45
50
|
```
|
|
46
51
|
This will update the docs at [https://pulibrary.github.io/lux-design-system/](https://pulibrary.github.io/lux-design-system/).
|
|
47
52
|
Please note: For informational purposes only. Don't do this outside of a release!
|
|
48
53
|
|
|
49
|
-
|
|
54
|
+
## Linting
|
|
50
55
|
We are using the eslint_plugin-prettier to lint our files. To adjust the lint format settings, please use the `.prettierrc` file. Code linting rules should be set in `eslintrc.js`.
|
|
51
56
|
|
|
52
57
|
### Style Linting
|
|
53
58
|
We are using stylelint and stylelint-config-standard-scss to lint scss files. To disable or customize any rules use the `.stylelintrc.json`. Run `npx stylelint "**/*.scss"` to lint the scss files.
|
|
54
59
|
|
|
55
|
-
|
|
60
|
+
## Customize configuration
|
|
56
61
|
See [Configuration Reference](https://cli.vuejs.org/config/).
|
|
57
62
|
|
|
58
|
-
|
|
63
|
+
## Using a local copy of lux-design-system in your project
|
|
59
64
|
|
|
60
65
|
1. `yarn global add yalc` (yalc has to be installed globally, it doesn't work as part of the package.json)
|
|
61
66
|
2. In lux-design-system run: `npm run build && yarn exec yalc publish`
|