Skip to content

Latest commit

 

History

History
82 lines (63 loc) · 1.54 KB

README.md

File metadata and controls

82 lines (63 loc) · 1.54 KB

Features

  • Designed to work with Prettier, React, Typescript, JSX, Node, AdonisJS out of the box
  • Lint json files ( TSConfig, package.json )
  • Super easy to use ( one line of code )
  • ESLint flat config
  • Use .gitignore as ignore file

Usage

Important

  • This config is using the new ESLint Flat config
  • New/updated rules will not be considered as breaking changes. Only API changes will be considered as breaking changes.

Install

pnpm add -D eslint prettier @verful/tooling-configs

Eslint

// .eslintrc
import { verful } from '@verful/tooling-configs/eslint'

export default await verful({
  // Your config here
})

You don't need .eslintignore as it has been provided by the preset.

Add script for package.json

For example:

{
  "scripts": {
    "lint": "eslint .",
    "lint:fix": "eslint . --fix"
  }
}

Prettier

{
  "prettier": "@verful/tooling-configs/prettier"
}

Tsconfig

Node ( ESM ) :

{
  "extends": "@verful/tooling-configs/tsconfigs/tsconfig.node",
  "compilerOptions": {
    "rootDir": "./",
    "outDir": "./build"
  }
}

React :

{
  "extends": "@verful/tooling-configs/tsconfigs/tsconfig.react",
  "compilerOptions": {
    "rootDir": "./",
    "outDir": "./build"
  }
}