@craftworks/eslint-config-cypress

An ESLint config optimized for Cypress.

Contains the configs of

• @craftworks/eslint-config-typescript
  • eslint:recommended
  • @typescript-eslint/recommended-type-checked
  • @typescript-eslint/strict-type-checked
  • @typescript-eslint/stylistic-type-checked
  • unicorn/recommended
  • jsdoc/recommended-typescript
• eslint-plugin-cypress
• prettier

and applies a custom config.

Following configurations are provided

• @craftworks/eslint-config-cypress
• @craftworks/eslint-config-cypress/unsafe-typing Use on top of @craftworks/eslint-config-cypress; disables rules regarding ! and any which may be convenient for the developer if disabled, although they come with some degree of type safety reduction.
• @craftworks/eslint-config-cypress/speed-up Use on top of @craftworks/eslint-config-cypress; disables some of the rules that run for relatively too long compared to the value they provide.

Installation

npm install @craftworks/eslint-config-cypress --save-dev

Check for necessary peer dependencies.

Usage

.eslintrc.js

module.exports = {
  root: true,
  extends: ['@craftworks/eslint-config-cypress'],
  parser: '@typescript-eslint/parser',
  parserOptions: {
    project: ['./tsconfig.lint.json'],
  },
  rules: {
    // Optional rule overwrites
  },
};

Create a tsconfig.lint.json for your project that defines all the files that should be linted.

{
  "extends": "./tsconfig.json",
  "include": ["cypress"]
}

Peer Dependencies

• eslint: ^8.56.0
• typescript: ^4.7.5 || ^5.0.0
• @typescript-eslint/parser: ^7.0.0

The minimal node version is 18.18.0.

See package.json for more details

Change Log

See CHANGELOG.md

License

MIT