https://github.com/eden-js/eslint-config-eden

ESLint config for EdenJS
https://github.com/eden-js/eslint-config-eden

Last synced: 27 days ago
JSON representation

ESLint config for EdenJS

• Host: GitHub
• URL: https://github.com/eden-js/eslint-config-eden
• Owner: eden-js
• License: gpl-3.0
• Created: 2018-06-10T04:58:17.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2021-05-31T17:29:12.000Z (over 3 years ago)
• Last Synced: 2024-11-14T18:09:49.722Z (about 1 month ago)
• Language: JavaScript
• Size: 190 KB
• Stars: 2
• Watchers: 2
• Forks: 1
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# eslint-config-eden [![npm][npm-image]][npm-url] [![downloads][downloads-image]][downloads-image]

[npm-image]: https://img.shields.io/npm/v/@eden-js/eslint-config-eden.svg?style=flat-square

[npm-url]: https://www.npmjs.com/package/@eden-js/eslint-config-eden

[downloads-image]: https://img.shields.io/npm/dm/@eden-js/eslint-config-eden.svg?style=flat-square

[downloads-url]: https://npmjs.org/package/@eden-js/eslint-config-eden

#### An ESLint [Shareable Config](http://eslint.org/docs/developer-guide/shareable-configs) for [EdenJS](https://github.com/eden-js/eden)

## Install

Using NPM:

```bash

npm install --save-dev @eden-js/eslint-config-eden

```

Using Yarn:

```bash

yarn add --dev @eden-js/eslint-config-eden

```

## Usage

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

To use the EdenJS shareable config, first run this:

Using NPM:

```bash

npm install --save-dev eslint @eden-js/eslint-config-eden

```

Using Yarn:

```bash

yarn add --dev eslint @eden-js/eslint-config-eden

```

Then, add this to your .eslintrc file:

```json

{

  "extends": "@eden-js/eden"

}

```

*Note: We omitted the `eslint-config-` prefix since it is automatically assumed by ESLint.*

You can override settings from the shareable config by adding them directly into your `.eslintrc` file.