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

Extension Engine's eslint config
https://github.com/extensionengine/eslint-config

eslint eslint-config

Last synced: 13 days ago
JSON representation

Extension Engine's eslint config

• Host: GitHub
• URL: https://github.com/extensionengine/eslint-config
• Owner: ExtensionEngine
• License: mit
• Created: 2019-10-02T08:42:47.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-07-13T15:43:27.000Z (over 1 year ago)
• Last Synced: 2025-01-19T06:14:30.721Z (14 days ago)
• Topics: eslint, eslint-config
• Language: JavaScript
• Size: 293 KB
• Stars: 10
• Watchers: 10
• Forks: 2
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  

    

  



# @extensionengine/eslint-config

[![circleci build status](https://badgen.net/circleci/github/ExtensionEngine/eslint-config/master?icon)](https://app.circleci.com/pipelines/github/ExtensionEngine/eslint-config?branch=master)

[![install size](https://badgen.net/packagephobia/install/@extensionengine/eslint-config)](https://packagephobia.now.sh/result?p=@extensionengine/eslint-config)

[![npm package version](https://badgen.net/npm/v/@extensionengine/eslint-config)](https://npm.im/@extensionengine/eslint-config)

[![github license](https://badgen.net/github/license/ExtensionEngine/eslint-config)](https://github.com/ExtensionEngine/eslint-config/blob/master/LICENSE)

This package provides Extension Engine's extensible ESLint config.

## Usage

Package contains two shared ESLint configs:

### @extensionengine/eslint-config

This is default configuration supporting both server & Vue powered client codebases.

### @extensionengine/eslint-config/base

This is base configuration without Vue specific rules.

### Install

Use `install-peerdeps`

```

npx install-peerdeps --dev @extensionengine/eslint-config

```

or the classic way:

```

npm install --save-dev eslint @extensionengine/eslint-config @babel/eslint-parser @babel/eslint-plugin eslint-plugin-import eslint-plugin-node eslint-plugin-promise eslint-plugin-require-sort eslint-plugin-vue eslint-config-standard eslint-config-semistandard

```

### Using `@extensionengine/eslint-config` in your project

In your local `.eslintrc.*` extend this configuration

```js

'use strict';

module.exports = {

  root: true,

  extends: '@extensionengine'

};

```

If you don't need Vue you can use base configuration:

```js

'use strict';

module.exports = {

  root: true,

  extends: '@extensionengine/eslint-config/base'

};

```

Check [ESlint documentation](https://eslint.org/docs/rules/) for rules explanation.

### Badge

If you are using this config in your project you can include this badge in a

readme to let people know that your code is using it.

[![js @extensionengine style](https://badgen.net/badge/code%20style/@extensionengine/black)](https://github.com/ExtensionEngine/eslint-config)

```markdown

[![js @extensionengine style](https://badgen.net/badge/code%20style/@extensionengine/black)](https://github.com/ExtensionEngine/eslint-config)

```