eslint-config-fullstack

KO | EN

gitlite — search

#javascript #python #react #go #android #linux #docker #java #windows #awesome #kubernetes #vue #awesome-list #pytorch

eslint-config-fullstack

(★ 17)

A complete ESLint config file to help students avoid errors and learn best practices

eslint-config-fullstack Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# `eslint-config-fullstack`

[![Built at Fullstack Academy](https://img.shields.io/badge/built%20at-Fullstack%20Academy-green.svg)](http://www.fullstackacademy.com)
[![npm version](https://img.shields.io/npm/v/eslint-config-fullstack.svg?maxAge=3600)](https://www.npmjs.com/package/eslint-config-fullstack)
[![Build Status](https://travis-ci.org/FullstackAcademy/eslint-config-fullstack.svg?branch=master)](https://travis-ci.org/FullstackAcademy/eslint-config-fullstack)
[![Greenkeeper badge](https://badges.greenkeeper.io/FullstackAcademy/eslint-config-fullstack.svg)](https://greenkeeper.io/)

### An ESLint [Shareable Config](http://eslint.org/docs/developer-guide/shareable-configs) for [Fullstack Education Group](http://www.fullstackacademy.com/) Students

## Installation

### Global

Global installation is recommended for [Fullstack Education Group](http://www.fullstackacademy.com/) students. To install or upgrade the config along with its peer dependencies:

```sh
npm install -g eslint eslint-config-fullstack eslint-plugin-react babel-eslint
```

In your global `~/.eslintrc.json` file:

```json
{
    "extends": "fullstack"
}
```

Note that the `eslint-config-` portion of the module name is assumed by ESLint.

### Local

A specific project can extend this definition by including `eslint eslint-config-fullstack eslint-plugin-react babel-eslint` as saved dev-dependencies, and defining a local `.eslintrc.json`. Project-level eslintrc files are recommended to be set as `root`, which prevents users' global configs from producing inconsistent results:

```json
{
    "extends": "fullstack",
    "root": true
}
```

### Note on Parsing

This config now uses `babel-eslint` as the parser by default. This enables linting some relatively modern code which ESLint's default parser does not handle, and was necessary for this project to lint itself. You still need to install `babel-eslint` manually as it is a peer dependency of this config.

## Extending

Any [rules](http://eslint.org/docs/rules/) added to your global or local `.eslintrc.json` files will override the rules defined by this package. For example:

```json
{
    "extends": "fullstack",
    "rules": {
        "semi": [1, "always"]
    }
}
```

This turns on enforcing the use of semicolons, a rule which is silenced by default in the current version of the `eslint-config-fullstack` package.

## Background

The [ESLint](http://http://eslint.org/) linting system is a popular one for its support of ES6 syntax, pluggable [rules](http://eslint.org/docs/rules/), automatic rule names in warning messages, and [shareable](http://eslint.org/docs/developer-guide/shareable-configs) / [extendable](http://eslint.org/docs/user-guide/configuring#extending-configuration-files) config files.

This npm package provides a thorough starting config file. It was developed at [Fullstack Academy of Code / Grace Hopper Academy](http://www.fullstackacademy.com/) to use in an educational setting, helping students to avoid definite errors but also pick up best practices.

Because it defaults to supporting multiple environments (e.g. Node, browsers, Jasmine, Mocha, etc.) it is probably not suitable for general production, where one might want a finer-grained and more restrictive config. However it is easy to override and extend this base config with custom rules, [as explained above and in the ESLint docs](http://eslint.org/docs/user-guide/configuring#using-a-shareable-configuration-package).

## License

MIT

eslint-config-fullstack

eslint-config-fullstack Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

eslint-config-fullstack

eslint-config-fullstack Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README