Skip to content

Commit a2173cb

Browse files
committed
project initialization
0 parents  commit a2173cb

File tree

6 files changed

+398
-0
lines changed

6 files changed

+398
-0
lines changed

.gitignore

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
*~
2+
3+
# installed packages
4+
node_modules
5+
bower_components
6+
7+
# Logs and databases
8+
*.log
9+
*.sql
10+
*.sqlite
11+
12+
# OS-generated files
13+
.DS_Store
14+
.DS_Store?
15+
._*
16+
.Spotlight-V100
17+
.Trashes
18+
ehthumbs.db
19+
Thumbs.db
20+
21+
# Vim swap files
22+
*.sw?
23+
24+
# IDE files
25+
.idea

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) 2016 Fullstack Education Group
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in
13+
all copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21+
THE SOFTWARE.

README.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
[![Built at Fullstack Academy](https://img.shields.io/badge/built%20at-Fullstack%20Academy-green.svg)](http://www.fullstackacademy.com)
2+
3+
# `eslint-config-fullstack`
4+
5+
### An ESLint [Shareable Config](http://eslint.org/docs/developer-guide/shareable-configs) for [Fullstack Education Group](http://www.fullstackacademy.com/) Students
6+
7+
## Installation
8+
9+
### Global
10+
11+
Global installation is recommended for [Fullstack Education Group](http://www.fullstackacademy.com/) students:
12+
13+
```sh
14+
npm install -g eslint-config-fullstack
15+
```
16+
17+
In your global `~/.eslintrc.json` file:
18+
19+
```json
20+
{
21+
"extends": "fullstack"
22+
}
23+
```
24+
25+
Note that the `eslint-config-` portion of the module name is assumed by ESLint.
26+
27+
### Local
28+
29+
A specific project can extend this definition by including `eslint-config-fullstack` as a saved dependency, and a local `eslintrc.json` which `{ "extends": "fullstack" }`.
30+
31+
## Extending
32+
33+
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:
34+
35+
```json
36+
{
37+
"extends": "fullstack",
38+
"rules": {
39+
"semi": [1, "always"]
40+
}
41+
}
42+
```
43+
44+
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.
45+
46+
## Background
47+
48+
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.
49+
50+
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.
51+
52+
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).
53+
54+
## License
55+
56+
MIT

0 commit comments

Comments
 (0)