@workleap/eslint-plugin

@workleap/eslint-plugin

Workleap’s ESLint configs.

Installation

Install the package.

With pnpm

pnpm add -D @workleap/eslint-plugin

Usage

This package provides ESLint configurations by project type. By providing configurations by project type, the burden of composing ESLint configurations is shifted from the consumer to the package maintainers. This approach allows for more accurate defaults and assumptions about the target environment. Additionally, it simplifies the process for consumers who only need to configure a single ESLint plugin.

The following configurations are available:

web-application

The web-application configuration is suitable for a web application developed in React with TypeScript.

To use this configuration, add the following to your .eslintrc.json file:

{
    "$schema": "https://json.schemastore.org/eslintrc",
    "root": true,
    "extends": "plugin:@workleap/web-application"
}

react-library

The react-library configuration is suitable for a React component library developed with TypeScript.

To use this configuration, add the following to your .eslintrc.json file:

{
    "$schema": "https://json.schemastore.org/eslintrc",
    "root": true,
    "extends": "plugin:@workleap/react-library"
}

typescript-library

The typescript-library configuration is suitable for a TypeScript library developed without React.

To use this configuration, add the following to your .eslintrc.json file:

{
    "$schema": "https://json.schemastore.org/eslintrc",
    "root": true,
    "extends": "plugin:@workleap/typescript-library"
}

monorepo-root

The monorepo-root configuration is suitable for the root tsconfig file of a monorepo project.

To use this configuration, add the following to your .eslintrc.json file:

{
    "$schema": "https://json.schemastore.org/eslintrc",
    "root": true,
    "extends": "plugin:@workleap/typescript-library"
}

ESLint ignore

You can configure ESLint to ignore certain files and directories while linting by specifying one or more glob patterns. Heres the ESLint ignore file we usually use at Workleap:

// .eslintignore

**/dist/*
node_modules
*.md
pnpm-lock.yaml

Advanced Usage

If the default configuration doesn’t fit your needs, please read the advanced usage documentation.

License

Copyright © 2023, GSoft inc. This code is licensed under the Apache License, Version 2.0. You may obtain a copy of this license at https://github.com/gsoft-inc/gsoft-license/blob/master/LICENSE.