npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

lux-design-system

v6.1.0

Published

## [View the Design System](https://pulibrary.github.io/lux-design-system/)

Downloads

4,536

Readme

Lux Design System

View the Design System

Adding Lux to an application or website

Project setup

npm install

Serve the styleguide documentation locally

npm run styleguide

Running tests

  • Run all tests with npm run test
  • Run a single test file with npx jest tests/unit/specs/components/luxGridItem.spec.js
  • 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"

Release 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 [email protected] # don't add this as a devDependency, otherwise you won't be able to push to npm
npm run release

Tips

  • 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 .prettierrc file. Code linting rules should be set in eslintrc.js.

Style Linting

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:
  • bundle exec vite clobber for ruby projects
  • yarn dev --force for Vue projects

Upgrade Instructions

  1. Upgrade from lux 4 to lux 5