## [View the Design System](https://pulibrary.github.io/lux-design-system/)
* Instructions for adding lux
* If you are looking for examples, take a look at one of the many PUL applications and sites that use Lux.
npm install
$3
npm run styleguide
$3
* Run all tests with
* Run a single test file with
* Run a single test with the name of the test from the call: npx jest -t "should have the appropriate class to define the columns"#### Running playwright
Playwright is an end to end testing harness. It is installed as a packge in the system and is run as part if the CI testing suite.
On first installation you must run
to get the browsers for playwright.* to run the tests without a ui and on multiple browsers
`
npx playwright test
* to run the test with screen shots of each step
npx playwright test --uiRelease a new version
This requires you to have an account on npm with 2fa enabled. You will also
need to be part of the PULibrary organization on npm.
npm login
npm install --global np # don't add this as a devDependency, otherwise you won't be able to push to npm
git switch main
git pull
npm run release
$3
* If you have a passphrase on your ssh key, run ssh-add ~/.ssh/id_ed25519 (or wherever your key is located).
* 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.
* 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.Deploy the styleguide to GitHub Pages
npm run deploy
This will update the docs at https://pulibrary.github.io/lux-design-system/.
Please note: For informational purposes only. Don't do this outside of a release!Linting
We are using the eslint_plugin-prettier to lint our files. To adjust the lint format settings, please use the file. Code linting rules should be set in eslintrc.js.$3
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.Customize configuration
See Configuration Reference.Using a local copy of lux-design-system in your project
1.
yarn global add yalc (yalc has to be installed globally, it doesn't work as part of the package.json)
2. In lux-design-system run: npm run build && yarn exec yalc publish
You should see a note that it's published in store
3. In the application where lux-design-system is installed,
run: yarn exec yalc add lux-design-system
4. Sometimes, your application's vite will have cached the old version.
If you are not seeing your changes, in your application directory run:
* for ruby projects
* yarn dev --force` for Vue projects