# @agiledigital/eslint-config

> Agile Digital's standard ESLint config

Latest version **4.2.0** (published 2024-03-01) · MIT license · 0 weekly downloads

## Install

```sh
npm install @agiledigital/eslint-config
pnpm add @agiledigital/eslint-config
yarn add @agiledigital/eslint-config
bun add @agiledigital/eslint-config
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: no vulnerabilities; high maintenance score.

Warnings: low downloads; no types; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 4.2.0 |
| Published | 2024-03-01 |
| First published | 2023-09-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=16.10.0 |
| Dependencies | 0 |
| Unpacked size | 321.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Daniel Nixon |
| Maintainers | sammurphy, rorystokes, haolinj, danielnixon, dspasojevic, dbalmain |

## Links

- npm: https://www.npmjs.com/package/@agiledigital/eslint-config
- Repository: https://github.com/agiledigital-labs/eslint-config-agile-digital
- npm.io page: https://npm.io/package/@agiledigital/eslint-config

## Recent versions

- 4.2.0 (latest) — 2024-03-01
- 4.1.0 — 2023-10-16
- 4.0.0 — 2023-09-29

## README

# eslint-config-agile-digital

Agile Digital's standard ESLint config

[![Build Status](https://github.com/agiledigital-labs/eslint-config-agile-digital/actions/workflows/node.js.yml/badge.svg)](https://github.com/agiledigital-labs/eslint-config-agile-digital/actions/workflows/node.js.yml)
[![Type Coverage](https://img.shields.io/badge/dynamic/json.svg?label=type-coverage&prefix=%E2%89%A5&suffix=%&query=$.typeCoverage.atLeast&uri=https%3A%2F%2Fraw.githubusercontent.com%2Fagiledigital-labs%2Feslint-config-agile-digital%2Fmaster%2Fpackage.json)](https://github.com/plantain-00/type-coverage)
[![npm](https://img.shields.io/npm/v/@agiledigital/eslint-config)](https://www.npmjs.com/package/@agiledigital/eslint-config)
![Snyk Vulnerabilities for GitHub Repo](https://img.shields.io/snyk/vulnerabilities/github/agiledigital-labs/eslint-config-agile-digital)

## Installation

```sh
yarn add --dev @agiledigital/eslint-config \
  eslint-config-typed-fp \
  @typescript-eslint/eslint-plugin \
  @typescript-eslint/parser \
  eslint \
  eslint-plugin-functional \
  eslint-plugin-total-functions \
  eslint-plugin-jest \
  eslint-plugin-prettier \
  eslint-plugin-sonarjs \
  eslint-plugin-import \
  eslint-plugin-simple-import-sort \
  eslint-plugin-filename-rules \
  eslint-plugin-jsdoc \
  eslint-plugin-tsdoc \
  eslint-plugin-no-secrets \
  eslint-plugin-prefer-arrow-functions \
  eslint-plugin-react \
  eslint-plugin-react-hooks \
  eslint-plugin-jsx-a11y \
  eslint-plugin-react-refresh \
  typescript
```

## Usage

1. Turn on TypeScript's [strict mode](https://www.typescriptlang.org/tsconfig#strict) and [noUncheckedIndexedAccess](https://www.typescriptlang.org/tsconfig#noUncheckedIndexedAccess) option.
2. Set up [ESLint + TypeScript](https://github.com/typescript-eslint/typescript-eslint/blob/master/docs/getting-started/linting/README.md).
3. Update your `.eslintrc.js`:

```diff
module.exports = {
+  parser: "@typescript-eslint/parser",
  parserOptions: {
+    project: "./tsconfig.json",
+    ecmaVersion: 2018,
+    sourceType: "module"
+    tsconfigRootDir: __dirname,
  },
  extends: [
+  "@agiledigital",
+  "@agiledigital/eslint-config/react", // In addition to the above if this is a React project 
  ...
  ],
  rules: {
    ...
  }
};

```

---
_Source: https://npm.io/package/@agiledigital/eslint-config · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._