Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

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

Pluggable ESLint config used in SOCIFI
https://github.com/socifi/eslint-config

eslint eslint-config

Last synced: 28 days ago
JSON representation

Pluggable ESLint config used in SOCIFI

Awesome Lists containing this project

README

        

# ESLint Config SOCIFI

[![npm version](https://badge.fury.io/js/%40socifi%2Feslint-config.svg)](https://badge.fury.io/js/%40socifi%2Feslint-config)
[![CircleCI](https://circleci.com/gh/socifi/eslint-config/tree/master.svg?style=shield)](https://circleci.com/gh/socifi/eslint-config/tree/master)

This is default ESlint configurations for projects in SOCIFI.

## Usage

First install the package:

```nodemon
npm install @socifi/eslint-config --save-dev
```

and update you ESLint configuration:

```javascript
module.exports = {
extends: [
'@socifi',
],
};

```

In basic configuration following plugins are included:

- **import** - We use ECMAScript 6 modules.
- **jsdoc** - Predefined style for comments of methods.
- **promise** - Predefined style for promises.
- **compat** - To check that used features are supported by certain browsers.
- **unicorn** - Various lints.
- **filenames** - Lint file names.
- **sonar** - various piggy code detection
- **typescript**
- **array-func**

There are more extendable configurations for tests or different envs:

```javascript
module.exports = {
extends: [
'@socifi',
'@socifi/eslint-config/react',
'@socifi/eslint-config/jasmine',
'@socifi/eslint-config/jest',
'@socifi/eslint-config/babel-resolver',
],
};
```