Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jgarber623/eslint-config

Shareable ESLint configuration.
https://github.com/jgarber623/eslint-config

eslint eslint-config javascript nodejs

Last synced: 2 days ago
JSON representation

Shareable ESLint configuration.

Awesome Lists containing this project

README

        

# @jgarber/eslint-config

**Shareable [ESLint](https://eslint.org) configuration.**

[![npm](https://img.shields.io/npm/v/@jgarber/eslint-config.svg?logo=npm&style=for-the-badge)](https://www.npmjs.com/package/@jgarber/eslint-config)
[![Downloads](https://img.shields.io/npm/dt/@jgarber/eslint-config.svg?logo=npm&style=for-the-badge)](https://www.npmjs.com/package/@jgarber/eslint-config)
[![Build](https://img.shields.io/github/actions/workflow/status/jgarber623/eslint-config/ci.yml?branch=main&logo=github&style=for-the-badge)](https://github.com/jgarber623/eslint-config/actions/workflows/ci.yml)

> [!IMPORTANT]\
> This shareable configuration uses ESLint's new "flat" configuration file format, which may not be suitable for every project. See [the official documentation](https://eslint.org/docs/latest/use/configure/configuration-files-new) for details.

## Installation

```sh
npm install --save-dev @jgarber/eslint-config
```

## Usage

Using [ECMAScript module (ESM)](https://nodejs.org/api/esm.html) syntax:

```js
// eslint.config.js
export { default } from "@jgarber/eslint-config";
```

Using [CommonJS module](https://nodejs.org/api/modules.html) syntax:

```js
// eslint.config.js
module.exports = (async () => await require("@jgarber/eslint-config"))();
```

## License

@jgarber/eslint-config is freely available under the [MIT License](https://opensource.org/licenses/MIT).