eslint-config-pdcp

This repository contains the ESLint configuration for the PDCP project. It provides a set of rules and configurations to enforce consistent coding standards and best practices across projects.

Installation

To install the eslint-config-pdcp package, you can use npm, pnpm, bun or yarn:

# Using npm
npm install --save-dev @pdc-protocol/eslint-config-pdcp

# Using pnpm
pnpm install --dev @pdc-protocol/eslint-config-pdcp

# Using bun
bun install --dev @pdc-protocol/eslint-config-pdcp

# Using yarn
yarn add --dev @pdc-protocol/eslint-config-pdcp

Usage

Once installed, you can extend the pdcp configuration in your ESLint configuration file. For example, in a .eslintrc file:

{
  "extends": "@pdc-protocol/eslint-config-pdcp/<configuration>"
}

Alternatively, you can specify the configuration in the eslintConfig field of your package.json file:

Configurations list

You can choose any configuration in the following list:

• "@pdc-protocol/eslint-config-pdcp/react": for any React project.
• "@pdc-protocol/eslint-config-pdcp/base" : for any project that cannot use any configuration from above.

{
  "eslintConfig": {
    "extends": "@pdc-protocol/eslint-config-pdcp/<configuration>"
  }
}

Troubleshooting

Cannot use default eslint-config-pdcp exported config

This decision was taken so that you have to choose the best suitable configuration for your project.

You can use a configuration from the list in Configurations list.