# @sulcata/eslint-config

> Some ESLint configs

Latest version **1.0.0** (published 2021-12-24) · MIT license · 0 weekly downloads

## Install

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

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2021-12-24 |
| First published | 2021-02-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 18.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | sulcata |
| Maintainers | sulcata |

## Links

- npm: https://www.npmjs.com/package/@sulcata/eslint-config
- Repository: https://github.com/sulcata/sulcata-eslint-config
- Homepage: https://github.com/sulcata/sulcata-eslint-config#readme
- Issues: https://github.com/sulcata/sulcata-eslint-config/issues
- npm.io page: https://npm.io/package/@sulcata/eslint-config

## Dependencies (1)

- [eslint-config-prettier](https://npm.io/package/eslint-config-prettier.md) ^8.3.0

## Recent versions

- 1.0.0 (latest) — 2021-12-24
- 0.4.1 — 2021-10-16
- 0.4.0 — 2021-10-16
- 0.3.0 — 2021-03-01
- 0.2.0 — 2021-02-21
- 0.1.1 — 2021-02-07
- 0.1.0 — 2021-02-06
- 0.0.1 — 2021-02-06

## README

# @sulcata/eslint-config

![npm latest version](https://img.shields.io/npm/v/@sulcata/eslint-config)
![npm weekly downloads](https://img.shields.io/npm/dw/@sulcata/eslint-config)
![GitHub](https://img.shields.io/github/license/sulcata/sulcata-eslint-config)
![GitHub Workflow Deployment Status](https://img.shields.io/github/workflow/status/sulcata/sulcata-eslint-config/Node.js%20Package?label=deployment)
![GitHub Workflow Integration Status](https://img.shields.io/github/workflow/status/sulcata/sulcata-eslint-config/Node.js%20CI?label=integration)
![supported node versions](https://img.shields.io/node/v/@sulcata/eslint-config)

A shareable set of [ESLint](https://eslint.org/) configurations for [TypeScript](https://www.typescriptlang.org/), [React](https://reactjs.org/), and more. Intended to be opinionated in practices, not style.

If you're looking for opinionated style, I highly recommend [Prettier](https://github.com/prettier/prettier).

## Install

```bash
npm install @sulcata/eslint-config
```

Sadly because of the way the configuration system currently works, you'll also need to install the following peer dependencies for now.

```bash
npm install eslint-plugin-jest eslint-plugin-jsx-a11y eslint-plugin-react eslint-plugin-react-hooks
```

Once ESLint starts rolling out the [new configuration system](https://github.com/eslint/rfcs/pull/9), this package will be changed to bundle them transparently.

## Usage

Writing your ESLint `.eslintrc.js` config file can be as simple as:

```js
"use strict";

module.exports = {
  root: true,
  parserOptions: {
    tsconfigRootDir: __dirname,
    project: ["./tsconfig.json"],
  },
  extends: ["@sulcata/eslint-config"],
};
```

This package exports a number of shareable configs that can be imported into your configuration using the ESLint config [`"extends"`](https://eslint.org/docs/user-guide/configuring/configuration-files#extending-configuration-files) key.

- `@sulcata/eslint-config` The kitchen sink, most likely what you want for minimal configuration. Pre-configured using the overrides feature to match file extensions to the appropriate configs. Includes `recommended`, `typescript`, `react`, and `jest`. Requires `tsconfigRootDir` and `project` to be configured in `parserOptions` for type information.
- `@sulcata/eslint-config/recommended` for general JavaScript linting.
- `@sulcata/eslint-config/typescript` for TypeScript linting. Requires `tsconfigRootDir` and `project` to be configured in `parserOptions` for type information.
- `@sulcata/eslint-config/react` for React apps.
- `@sulcata/eslint-config/jest` for Jest test suites.

## Issues

Raise an issue (or a PR) if you notice any styling related rules bubbling up.

[GitHub Issues](https://github.com/sulcata/sulcata-eslint-config/issues)

## License

[MIT License](LICENSE)

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