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

@zedix's eslint shareable configs
https://github.com/zedix/eslint-config

eslint-config eslint-config-vue eslint-configs eslint-configurations eslint-shareable-config eslint-shareable-configs vue vuejs

Last synced: about 2 months ago
JSON representation

@zedix's eslint shareable configs

• Host: GitHub
• URL: https://github.com/zedix/eslint-config
• Owner: zedix
• License: mit
• Created: 2018-11-25T16:33:02.000Z (over 7 years ago)
• Default Branch: main
• Last Pushed: 2023-07-19T05:01:41.000Z (almost 3 years ago)
• Last Synced: 2025-05-13T18:54:37.786Z (about 1 year ago)
• Topics: eslint-config, eslint-config-vue, eslint-configs, eslint-configurations, eslint-shareable-config, eslint-shareable-configs, vue, vuejs
• Language: JavaScript
• Homepage:
• Size: 212 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# @zedix/eslint-config

![version](https://img.shields.io/github/package-json/v/zedix/eslint-config.svg?maxAge=60) ![tag](https://img.shields.io/github/tag/zedix/eslint-config.svg?maxAge=60)

> ESLint [shareable config](http://eslint.org/docs/developer-guide/shareable-configs.html) with [Prettier](https://prettier.io/)

## Installation

```

$ yarn add --dev eslint prettier zedix/eslint-config.git#v1.x.x

```

## Usage

Once the `@zedix/eslint-config` package is installed, you can use it by specifying `@zedix/eslint-config` in the [`extends`](http://eslint.org/docs/user-guide/configuring#extending-configuration-files) section of the [ESLint configuration](http://eslint.org/docs/user-guide/configuring).

In your `.eslintrc.js`:

```js

// .eslintrc.js

module.exports = {

  extends: ['@zedix/eslint-config'],

};

```

or

```js

// .eslintrc.js

module.exports = {

  extends: ['@zedix/eslint-config/vue'],

};

```

Alternatively, you can add an eslint config in the `package.json`:

```json

{

  "eslintConfig": {

    "extends": "@zedix/eslint-config/vue"

  }

}

```

For Vue 3:

```json

{

  "eslintConfig": {

    "extends": "@zedix/eslint-config/vue3"

  }

}

```

In your `.prettierrc.js`:

```js

// .prettierrc.js

module.exports = require('@zedix/eslint-config/prettier');

```

## References

[Awesome ESLint](https://github.com/dustinspecker/awesome-eslint)