@prestashopcorp/eslint-config-ts/README.md

Typescript Eslint rules for PrestaShop projects

# Prestashop eslint-config-ts

An eslint sharable config for typescript project.
This config include @prestashopcorp/eslint-config, @typescript-eslint/recommended-type-checked and @typescript-eslint/stylistic-type-checked rules.

## Npm config

This package is published in an Npm private registry.

if it is not done, you have to set the authentication config by running this commands:

```bash
npm set "//npm.pkg.github.com/:_authToken=$GITHUB_TOKEN"
npm set "@prestashopcorp:registry=https://npm.pkg.github.com"
```

## Install

```bash
yarn install -D @prestashopcorp/eslint-config-ts
```

## Usage

Shareable configs are designed to work with the extends feature of .eslintrc files. You can learn more about [Shareable Configs](https://eslint.org/docs/latest/extend/shareable-configs) on the official ESLint website.

Add this to your .eslintrc file:

```json
{
  "extends": "@prestashopcorp/eslint-config-ts"
}
```