https://github.com/frctl/eslint-config-frctl
ESLint configuration to be shared across all Fractal repositories
https://github.com/frctl/eslint-config-frctl
Last synced: 22 days ago
JSON representation
ESLint configuration to be shared across all Fractal repositories
- Host: GitHub
- URL: https://github.com/frctl/eslint-config-frctl
- Owner: frctl
- License: mit
- Created: 2017-01-23T15:43:24.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2017-08-04T08:50:23.000Z (almost 9 years ago)
- Last Synced: 2025-09-25T12:32:21.185Z (9 months ago)
- Language: JavaScript
- Homepage:
- Size: 4.88 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# eslint-config-frctl
ESLint configuration to be shared across all Fractal repositories.
[](https://www.npmjs.com/package/@frctl/eslint-config-frctl)
## Overview
This package is an [ESLint shareable config](http://eslint.org/docs/developer-guide/shareable-configs) which can be used in conjunction with an ESLint based plugin such as [xo](https://github.com/sindresorhus/xo), in order to help maintain consistent styles across a codebase.
```
"xo": {
"extends": "@frctl/eslint-config-frctl"
}
```
## Installation
Installation is via [npm](https://www.npmjs.com/).
`npm i @frctl/eslint-config-frctl`
## Usage
To use with `xo`, first ensure the package has been installed (see above) and then pass the package name to the the [`extends`](https://github.com/sindresorhus/xo#extends) option in `package.json`:
```
{
"name": "repo-name",
...
},
"devDependencies": {
"@frctl/eslint-config-frctl": "0.1.0"
},
"xo": {
"extends": "@frctl/eslint-config-frctl"
}
}
```
## Requirements
Node: >= 6.0.0