The Deepgram Style Guide

Introduction

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

This project has been forked from Vercel's style guide, for use in Deepgram's own JS-ecosystem projects.

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

• Prettier
• ESLint
• TypeScript

Contributing

Please read our contributing guide before creating a pull request.

Installation

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

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

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

# If you use Yarn
yarn add --dev @deepgram/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": "@deepgram/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

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:

• @deepgram/style-guide/eslint/browser
• @deepgram/style-guide/eslint/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:

• @deepgram/style-guide/eslint/jest
• @deepgram/style-guide/eslint/jest-react (includes rules for @testing-library/react)
• @deepgram/style-guide/eslint/next (requires @next/eslint-plugin-next to be installed at the same version as next)
• @deepgram/style-guide/eslint/playwright-test
• @deepgram/style-guide/eslint/react
• @deepgram/style-guide/eslint/typescript (requires typescript to be installed and additional configuration)
• @deepgram/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, use the shared ESLint config(s) in a Next.js project, set the following in .eslintrc.js.

module.exports = {
  extends: [
    require.resolve('@deepgram/style-guide/eslint/browser'),
    require.resolve('@deepgram/style-guide/eslint/react'),
    require.resolve('@deepgram/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('@deepgram/style-guide/eslint/node'),
    require.resolve('@deepgram/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('@deepgram/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, Jest rules are only being applied to files matching Jest's default test match pattern.

module.exports = {
  extends: [require.resolve('@deepgram/style-guide/eslint/node')],
  overrides: [
    {
      files: ['**/__tests__/**/*.[jt]s?(x)', '**/?(*.)+(spec|test).[jt]s?(x)'],
      extends: [require.resolve('@deepgram/style-guide/eslint/jest')],
    },
  ],
};

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

This style guide provides multiple TypeScript configs. These configs correlate to the LTS Node.js versions, providing the appropriate lib, module, target, and moduleResolution settings for each version. The following configs are available:

Node.js Version	TypeScript Config
v16	@deepgram/style-guide/typescript/node16
v18	@deepgram/style-guide/typescript/node18
v20	@deepgram/style-guide/typescript/node20

To use the shared TypeScript config, set the following in tsconfig.json.

{
  "extends": "@deepgram/style-guide/typescript/node16"
}

The base TypeScript config is also available as @deepgram/style-guide/typescript which only specifies a set of general rules. You should inherit from this file when setting custom lib, module, target, and moduleResolution settings.