@vercel/style-guide

style-guide

This repository is the home of our style guide, along with configs for popular linting and styling tools.

Prettier

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

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

ESLint

To use the shared ESLint config, set the following in .eslintrc.js.

Note that the Jest config can be scoped to include/exclude specific paths.

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

Coming soon

• EditorConfig
• Stylelint
• Automatic publishing
• More?