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

@energise/style-guide

v1.0.2

Published

Energise's javascript style guide

Downloads

67

Readme

npm version license build status

Introduction

This repository is the home of Energise's style guide, which includes configs for popular linting and style tools.

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

Installation

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

# If you use pnpm
pnpm add -D @energise/style-guide

# If you use npm
npm install -D @energise/style-guide

# If you use yarn
yarn add -D @energise/style-guide

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": "@energise/style-guide/prettier"
}

ESLint

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

This ESLint config is designed to be composable.

The following base configs are available. You can use one or both of these configs, but they should always be first in extends:

  • @energise/style-guide/browser
  • @energise/style-guide/node

Note that you can scope configs, so that configs only target specific files. For more information, see: Scoped configuration with overrides.

The following additional configs are available:

  • @energise/style-guide/eslint/next (requires @next/eslint-plugin-next to be installed at the same version as next)
  • @energise/style-guide/eslint/playwright-test
  • @energise/style-guide/eslint/react
  • @energise/style-guide/eslint/storybook
  • @energise/style-guide/eslint/typescript (requires typescript to be installed and additional configuration)
  • @energise/style-guide/eslint/vitest

You'll need to use require.resolve to provide ESLint with absolute paths, due to an issue around ESLint config resolution (see eslint/eslint#9188)

For example, to use the shared ESLint config(s) in a Next.js project, set the following in .eslintrc.cjs:

module.exports = {
  extends: [
    require.resolve('@energise/style-guide/eslint/browser'),
    require.resolve('@energise/style-guide/eslint/react'),
    require.resolve('@energise/style-guide/eslint/next'),
  ],
};

Configuring ESLint for TypeScript

Some of the rules enabled in the TypeScript config require additional type information, you'll need to provide the path to your tsconfig.json.

For more information, see: https://typescript-eslint.io/docs/linting/type-linting

const { resolve } = require('node:path');

const project = resolve(__dirname, 'tsconfig.json');

module.exports = {
  root: true,
  extends: [
    require.resolve('@energise/style-guide/eslint/node'),
    require.resolve('@energise/style-guide/eslint/typescript'),
  ],
  parserOptions: {
    project,
  },
  settings: {
    'import/resolver': {
      typescript: {
        project.
      },
    },
  },
};

Configuring custom components for jsx-a11y

It's common practice for React apps to have shared components like Button, which wrap native elements. You can pass this information along to jsx-a11y via the components setting.

The below list is not exhaustive.

module.exports = {
  root: true,
  extends: [require.resolve('@energise/style-guide/eslint/react')],
  settings: {
    'jsx-a11y': {
      components: {
        Article: 'article',
        Button: 'button',
        Image: 'img',
        Input: 'input',
        Link: 'a',
        Video: 'video',
      },
    },
  },
};

Scoped configuration with overrides

ESLint configs can be scoped to include/exclude specific paths. This ensures that rules don't leak into places where those rules don't apply.

In this example, Vitest rules are only being applied to files matching Vitest's default test match pattern.

module.exports = {
  extends: [require.resolve('@energise/style-guide/eslint/node')],
  overrides: [
    {
      files: [],
      extends: [require.resolve('@energise/style-guide/eslint/vitest')],
    },
  ],
};

A note on file extensions

By default, all TypeScript rules are scoped to files ending with .ts and .tsx.

However, when using overrides, file extensions must be included or ESLint will only include .js files.

module.exports = {
  overrides: [
    {
      files: [`directory/**/*.[jt]s?(x)`, rules: { my-rule: 'off' }],
    },
  ],
};

TypeScript

The following configs are available:

  • @energise/style-guide/tsconfig/base
  • @energise/style-guide/tsconfig/cloudflare
  • @energise/style-guide/tsconfig/next

For example, to use the next TypeScript config in a Next.js project, set the following in tsconfig.json:

{
  "extends": "@energise/style-guide/tsconfig/next"
}

Acknowledgements