# @isfawwaz/eslint-config-base

> Fawwaz's ESLint base configuration

Latest version **1.0.0-beta.1** (published 2023-03-19) · MIT license · 0 weekly downloads

## Install

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

## 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-beta.1 |
| Published | 2023-03-19 |
| First published | 2023-03-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=10 |
| Dependencies | 3 |
| Unpacked size | 97.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | A. F. Fawwazulkarim |
| Maintainers | isfawwaz |
| Keywords | eslint-config, eslintconfig, eslint, lint, linter, style, base |

## Links

- npm: https://www.npmjs.com/package/@isfawwaz/eslint-config-base
- Repository: https://github.com/isfawwaz/config
- Issues: https://github.com/isfawwaz/config/issues
- npm.io page: https://npm.io/package/@isfawwaz/eslint-config-base

## Dependencies (3)

- [eslint](https://npm.io/package/eslint.md) ^7.23.0
- [eslint-plugin-jsdoc](https://npm.io/package/eslint-plugin-jsdoc.md) ^40.1.0
- [eslint-plugin-import](https://npm.io/package/eslint-plugin-import.md) ^2.27.5

## Alternatives

- [eslint-plugin-sonarjs](https://npm.io/package/eslint-plugin-sonarjs.md) — 2.9M weekly downloads
- [eslint-config-expo](https://npm.io/package/eslint-config-expo.md) — 1.5M weekly downloads
- [@matter/protocol](https://npm.io/package/@matter/protocol.md) — 63.5K weekly downloads
- [@eventcatalog/linter](https://npm.io/package/@eventcatalog/linter.md) — 24.8K weekly downloads
- [@pandacss/eslint-plugin](https://npm.io/package/@pandacss/eslint-plugin.md) — 18.7K weekly downloads

## Recent versions

- 1.0.0-beta.1 (latest) — 2023-03-19
- 1.0.0-rc.2 (pre/rc) — 2023-03-19
- 1.0.0-rc.1 — 2023-03-19

## README

# @isfawwaz/eslint-config-base

[![NPM version][npm-image]][npm-url]
[![Downloads][downloads-image]][npm-url]

[npm-url]: https://npmjs.org/package/@isfawwaz/eslint-config-base
[npm-image]: https://img.shields.io/npm/v/@isfawwaz/eslint-config-base
[downloads-image]: https://img.shields.io/npm/dm/@isfawwaz/eslint-config-base

Shared [ESLint](http://eslint.org/) **base** configuration for my projects.

## Installation

```bash
npm install --save-dev @isfawwaz/eslint-config-base
# or
pnpm add -D @isfawwaz/eslint-config-base
# or
yarn add -D @isfawwaz/eslint-config-base
```

## Usage

Create a `.eslintrc.json` file in the project root and extend from one of these base configurations:

- `@isfawwaz/eslint-config-base` - Latest ECMAScript version without modules.
- `@isfawwaz/eslint-config-base/esm` - Latest ECMAScript version with ECMAScript modules.
- `@isfawwaz/eslint-config-base/cjs` - Latest ECMAScript version with CommonJS modules.

Instead of the latest ECMAScript version (2020), you may target **specific versions** of ECMAScript by using their configurations instead.

<details>
  <summary>List of all base configurations</summary>

- `@isfawwaz/eslint-config-base/es2015` - ECMAScript 2015 (aka es6) without modules.
- `@isfawwaz/eslint-config-base/es2016` - ECMAScript 2016 (aka es7) without modules.
- `@isfawwaz/eslint-config-base/es2017` - ECMAScript 2017 (aka es8) without modules.
- `@isfawwaz/eslint-config-base/es2018` - ECMAScript 2018 (aka es9) without modules.
- `@isfawwaz/eslint-config-base/es2019` - ECMAScript 2019 (aka es10) without modules.
- `@isfawwaz/eslint-config-base/es2020` - ECMAScript 2020 (aka es11) without modules.
- `@isfawwaz/eslint-config-base/esm/es2015` - ECMAScript 2015 (aka es6) with ECMAScript modules.
- `@isfawwaz/eslint-config-base/esm/es2016` - ECMAScript 2016 (aka es7) with ECMAScript modules.
- `@isfawwaz/eslint-config-base/esm/es2017` - ECMAScript 2017 (aka es8) with ECMAScript modules.
- `@isfawwaz/eslint-config-base/esm/es2018` - ECMAScript 2018 (aka es9) with ECMAScript modules.
- `@isfawwaz/eslint-config-base/esm/es2019` - ECMAScript 2019 (aka es10) with ECMAScript modules.
- `@isfawwaz/eslint-config-base/esm/es2020` - ECMAScript 2020 (aka es11) with ECMAScript modules.
- `@isfawwaz/eslint-config-base/cjs/es2015` - ECMAScript 2015 (aka es6) with CommonJS modules.
- `@isfawwaz/eslint-config-base/cjs/es2016` - ECMAScript 2016 (aka es7) with CommonJS modules.
- `@isfawwaz/eslint-config-base/cjs/es2017` - ECMAScript 2017 (aka es8) with CommonJS modules.
- `@isfawwaz/eslint-config-base/cjs/es2018` - ECMAScript 2018 (aka es9) with CommonJS modules.
- `@isfawwaz/eslint-config-base/cjs/es2019` - ECMAScript 2019 (aka es10) with CommonJS modules.
- `@isfawwaz/eslint-config-base/cjs/es2020` - ECMAScript 2020 (aka es11) with CommonJS modules.
</details>

All files that end in `.config.js` within your project root folder will **automatically be treated as Node.js** files as they relate to tooling, such as `babel.config.js` and `commitlint.config.js`.

### Examples

- Example of `.eslintrc.json` for Node.js projects:

  ```json
  {
    "root": true,
    "env": {
      "node": true
    },
    "extends": ["@isfawwaz/eslint-config-base/cjs/es2019"]
  }
  ```

- Example of `.eslintrc.json` for browser only projects that use ECMAScript modules:

  ```json
  {
    "root": true,
    "env": {
      "browser": true
    },
    "extends": ["@isfawwaz/eslint-config-base/esm"]
  }
  ```

- Example of `.eslintrc.json` for isomorphic / universal projects that use ECMAScript modules:

  ```json
  {
    "root": true,
    "env": {
      "browser": true,
      "node": true
    },
    "extends": ["@isfawwaz/eslint-config-base/esm"]
  }
  ```

ℹ️ Note that by setting `root` to true, we ensure that no ancestor configuration is used which also improves `ESLint` performance because no more file lookups need to be done.

## Shared functionality

This package contains functionality that may be used directly if necessary:

- [_rules_](./lib/rules)
- [_modules_](./lib/modules)
- [_test-patterns_](./lib/test-patterns.js)

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