https://github.com/fullstackacademy/eslint-config-fullstack
A complete ESLint config file to help students avoid errors and learn best practices
https://github.com/fullstackacademy/eslint-config-fullstack
best-practices eslint eslint-config eslint-rules eslint-shareable-configs eslintconfig eslintrc fullstack-academy students
Last synced: 8 months ago
JSON representation
A complete ESLint config file to help students avoid errors and learn best practices
- Host: GitHub
- URL: https://github.com/fullstackacademy/eslint-config-fullstack
- Owner: FullstackAcademy
- License: mit
- Created: 2016-06-13T19:01:40.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2020-05-29T04:48:49.000Z (over 5 years ago)
- Last Synced: 2025-02-01T13:34:56.351Z (8 months ago)
- Topics: best-practices, eslint, eslint-config, eslint-rules, eslint-shareable-configs, eslintconfig, eslintrc, fullstack-academy, students
- Language: JavaScript
- Size: 2.61 MB
- Stars: 16
- Watchers: 19
- Forks: 26
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# `eslint-config-fullstack`
[](http://www.fullstackacademy.com)
[](https://www.npmjs.com/package/eslint-config-fullstack)
[](https://travis-ci.org/FullstackAcademy/eslint-config-fullstack)
[](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