Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@dusk-network/eslint-config

dusk-network74MPL-2.04.0.1TypeScript support: included

ESLint config used by Dusk JavaScript apps

dusk, dusk network, eslint, eslintconfig

readme

Dusk ESLint rules

ESLint config used by Dusk JavaScript apps.

Installation

npm i -D @dusk-network/eslint-config

Your package requires the following dev-dependencies:

If you are using Svelte rules your package needs the following dev-dependency:

If you are using Vitest rules your package needs the following dev-dependency:

Usage

Add the rulesets you want in the extends section of your ESLint configuration file.

e.g. to use both JS, Svelte and Vitest rules:

// ...

extends: [
    "@dusk-network/eslint-config/js",
    "@dusk-network/eslint-config/svelte",
    "@dusk-network/eslint-config/vitest"
]

// ...

npm scripts

  • npm run check checks for deprecated rules and performs the linting check
  • npm run check-js checks for deprecated JS rules
  • npm run check-rules checks for deprecated JS and Svelte rules
  • npm run check-svelte checks for deprecated Svelte rules
  • npm run format performs the Prettier formatting check
  • npm run format:fix reformats according to the Prettier rules
  • npm run lint performs the linting check
  • npm run lint:fix fixes fixable linting errors