Skip to content

valtech-commerce/eslint-config

Repository files navigation

@valtech-commerce/eslint-config

npm npms.io: Score libraries.io: SourceRank Tests License: MIT

Opinionated ESLint shareable configs.

Rulesets

Ruleset Description
core Core rules
typescript TypeScript rules
node/script Node.js rules in "script" mode
node/module Node.js rules in "module" mode
node/module/typescript Node.js rules in "module" mode using TypeScript
jest Jest rules
browser Browser rules
react React rules
react/typescript React rules using TypeScript
jsdoc JSDoc rules
json JSON rules

Dependency tree

  graph TD;
    core --> browser & node/script & node/module
      browser --> react
        react --> react/typescript
      node/module --> jest & node/module/typescript
    jsdoc
    json
    typescript
Loading

Install

$ npm install @valtech-commerce/eslint-config

Usage

Add some ESLint config to your .eslintrc.yaml:

extends: "@valtech-commerce/eslint-config/[RULESET]"

Specifications

core

Used plugins / configuration

typescript

Add your tsconfig file to your .eslintrc.yaml:

parserOptions:
  project:
    - "./tsconfig.json" # Your TS config file

Used parser / plugin / configuration

node/script

Used plugin / configuration

node/module

Used plugin / configuration

node/module/typescript

Add your tsconfig file to your .eslintrc.yaml:

settings:
  import/resolver:
    typescript:
      project: "./tsconfig.json" # Your TS config file

Used configuration

jest

Used plugin / configuration

react

Used parser / plugin / configuration

jsdoc

Used plugin / configuration

json

Used plugin / configuration

Documentation

See the Changelog to see what has changed.

Contribute

See the Contributing Guidelines for ways to get started.

See the Support Guide for ways to get help.

See the Security Policy for sharing vulnerability reports.

This project has a Code of Conduct. By interacting with this repository, organization, or community you agree to abide by its terms.

License

MIT © Valtech Canada inc.