README.md

@graz-sh/style-guide

ESLint and Prettier style guide for various Graz projects, which includes configs for popular linting and styling tools. Heavily based on Vercel's style guide.

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

• Prettier
• ESLint
• TypeScript

---

Installing

Starting with v3.0.0, using this package requires installing its direct peer dependencies: eslint, prettier, and typescript.

# using npm
npm install --save-dev @graz-sh/style-guide eslint prettier typescript

# using yarn
yarn add --dev @graz-sh/style-guide eslint prettier typescript

# using pnpm
pnpm install --save-dev @graz-sh/style-guide eslint prettier typescript

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

If you're not working with frontend related projects (React, Next.js, TailwindCSS), you can install @graz-sh/style-guide-core which does not include packages listed here.

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": "@graz-sh/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:

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

• @graz-sh/style-guide/eslint/jest (requires eslint-plugin-jest and eslint-plugin-testing-library to be installed)
• @graz-sh/style-guide/eslint/next (requires @next/eslint-plugin-next to be installed at the same version as next)
• @graz-sh/style-guide/eslint/playwright-test (requires eslint-plugin-playwright to be installed)
• @graz-sh/style-guide/eslint/react
• @graz-sh/style-guide/eslint/tailwindcss (requires tailwindcss to be installed)
• @graz-sh/style-guide/eslint/typescript (requires typescript to be installed and additional configuration)

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("@graz-sh/style-guide/eslint/browser"),
    require.resolve("@graz-sh/style-guide/eslint/react"),
    require.resolve("@graz-sh/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 { getTsconfigPath } = require("@graz-sh/style-guide/eslint/utils/tsconfig");

const tsconfigPath = getTsconfigPath();

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

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("@graz-sh/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" to 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("@graz-sh/style-guide/eslint/node")],
  overrides: [
    {
      files: ["**/__tests__/**/*.[jt]s?(x)", "**/?(*.)+(spec|test).[jt]s?(x)"],
      extends: [require.resolve("@graz-sh/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

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

{
  "extends": "@graz-sh/style-guide"
}

The following optional configs are available:

• @graz-sh/style-guide/tsconfig (same as @graz-sh/style-guide)
• @graz-sh/style-guide/tsconfig/next (for Next.js projects)

Acknowledgements

• https://github.com/vercel/style-guide

License

Mozilla Public License Version 2.0