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

@swrlab/style-guide

v1.0.2

Published

SWR Audio Lab's engineering style guide

Downloads

433

Readme

license version

Introduction

This repository is the home of an based on Vercel's style guide, which includes configs for popular linting and styling tools.

The following configs are available, and are designed to be used together.

Installation

All of our configs are contained in one package, @swrlab/style-guide. To install:

# If you use Bun
bun add --dev @swrlab/style-guide

# If you use Yarn
yarn add --dev @swrlab/style-guide

# If you use npm
npm i --save-dev @swrlab/style-guide

# If you use pmpm
pnpm i --save-dev @swrlab/style-guide

Some of our ESLint configs require peer dependencies. We'll note those alongside the available configs in the ESLint section.

Prettier

Note: Prettier is a peer-dependency of this package, and should be installed at the root of your project.

See: https://prettier.io/docs/en/install.html

To use the shared Prettier config, set the following in package.json.

{
  "prettier": "@swrlab/style-guide/prettier"
}

ESLint

Note: ESLint is a peer-dependency of this package, and should be installed at the root of your project.

See: https://eslint.org/docs/user-guide/getting-started#installation-and-usage

Usage:

// eslint.config.mjs
import { audiolab } from '@swrlab/style-guide/eslint/presets.js'

export default audiolab(
  [
    /* your custom ESLint config */
  ],
  {
    prettier: true,
    vue: true,
  }
)

Presets

You can also import and compose individual presets. However, it is recommended that you use the factory function above.

// eslint.config.js
import { presetAll, presetBasic } from '@swrlab/style-guide/eslint/presets.js'

export default presetBasic

Biome

To use the shared Biome config, set the following in biome.json:

{
  "extends": ["@swrlab/style-guide/biome"]
}

Credits

This config is inspired by the work of The Vercel Style Guide and is further based on

  • https://github.com/antfu/eslint-config
  • https://github.com/sxzz/eslint-config

Contributing

After cloning, you can run bun install (or npm install) to install the npm dependencies.

License

ISC