Product
Introducing License Enforcement in Socket
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
@vercel/style-guide
Advanced tools
This repository is the home of our style guide, along with configs for popular linting and styling tools.
To use the shared Prettier config, set the following in package.json
.
{
"prettier": "@vercel/style-guide/prettier"
}
To use the shared ESLint config, set the following in .eslintrc.js
.
This ESLint config is designed to be composable. The base config,
@vercel/style-guide/eslint
, sets up a project for JavaScript and should
always be set first.
The following optional configs are available:
@vercel/style-guide/eslint/jest
@vercel/style-guide/eslint/next
(requires @vercel/style-guide/eslint/react
)@vercel/style-guide/eslint/react
@vercel/style-guide/eslint/typescript
(needs parserOptions.project
)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).
module.exports = {
extends: [
require.resolve('@vercel/style-guide/eslint'),
require.resolve('@vercel/style-guide/eslint/next'),
],
};
As some TypeScript rules require additional type information, you'll need to provide the path to your tsconfig.
module.exports = {
extends: [
require.resolve('@vercel/style-guide/eslint'),
require.resolve('@vercel/style-guide/eslint/typescript'),
],
parserOptions: {
project: './tsconfig.json',
},
};
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.
By default, all TypeScript rules are scoped to files ending with
.ts
and.tsx
.
module.exports = {
extends: [require.resolve('@vercel/style-guide/eslint')],
overrides: [
{
files: ['**/__tests__/**/*.[jt]s?(x)', '**/?(*.)+(spec|test).[jt]s?(x)'],
extends: [require.resolve('@vercel/style-guide/eslint/jest')],
},
],
};
FAQs
Vercel's engineering style guide
The npm package @vercel/style-guide receives a total of 213,366 weekly downloads. As such, @vercel/style-guide popularity was classified as popular.
We found that @vercel/style-guide demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 9 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
Product
We're launching a new set of license analysis and compliance features for analyzing, managing, and complying with licenses across a range of supported languages and ecosystems.
Product
We're excited to introduce Socket Optimize, a powerful CLI command to secure open source dependencies with tested, optimized package overrides.