Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

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

ESLint config for PeopleDoc frontend projects
https://github.com/peopledoc/eslint-config-peopledoc

approved-public eslint eslint-config ghec-mig-migrated peopledoc-opensource tribe-js

Last synced: 3 months ago
JSON representation

ESLint config for PeopleDoc frontend projects

Host: GitHub
URL: https://github.com/peopledoc/eslint-config-peopledoc
Owner: peopledoc
License: mit
Created: 2017-08-17T13:15:59.000Z (over 7 years ago)
Default Branch: master
Last Pushed: 2024-01-05T23:21:27.000Z (12 months ago)
Last Synced: 2024-09-30T06:02:32.194Z (3 months ago)
Topics: approved-public, eslint, eslint-config, ghec-mig-migrated, peopledoc-opensource, tribe-js
Language: JavaScript
Size: 290 KB
Stars: 1
Watchers: 13
Forks: 1
Open Issues: 4
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

## `eslint-config-peopledoc`

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

> JavaScript linting rules for PeopleDoc.

## Installation

In your project, remove exisiting ESLint's plugins or configuration, then:

```sh
# with npm
npm install --save-dev eslint-config-peopledoc

# or with yarn
yarn add eslint-config-peopledoc --dev
```

If you add this configuration to a project using Ember, you need to install `@babel/core`, `@babel/eslint-parser` and `@babel/plugin-proposal-decorators`:

```sh
# with npm
npm install eslint @babel/core @babel/eslint-parser @babel/plugin-proposal-decorators --save-dev

# or with yarn
yarn add eslint @babel/core @babel/eslint-parser @babel/plugin-proposal-decorators -D
```

## Usage

In your project, edit your [`eslint` configuration](https://eslint.org/docs/user-guide/getting-started#global-installation-and-usage) to extend `peopledoc` ESLint config:

```js
module.exports = {
root: true,
extends: ['peopledoc'],
rules: {}
}
```

Preset configurations are available for:

**Vanilla JS:**

```js
extends: ['peopledoc']
```

**Ember Application:**

```js
extends: ['peopledoc/ember']
```

**Ember Addon:**

```js
extends: ['peopledoc/ember-addon']
```

**ES5 only**

```js
extends: ['peopledoc/es5']
```

**Prettier**

```js
extends: ['peopledoc/prettier']
```