Skip to content

Commit bf11284

Browse files
forumone-angular: Add README
1 parent 0953039 commit bf11284

File tree

1 file changed

+35
-0
lines changed
  • packages/eslint-config-forumone-angular

1 file changed

+35
-0
lines changed
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
ForumOne JavaScript Coding Style (Angular Edition)
2+
==================================================
3+
4+
See [forumone/javascript](https://github.com/forumone/javascript) on Github for a longer intro.
5+
6+
For best results, mix with a base style guide of your choice. We recommend `eslint-config-forumone-es5`:
7+
8+
```js
9+
exports.extends = [
10+
'forumone-es5',
11+
'forumone-angular',
12+
];
13+
```
14+
15+
Requirements
16+
------------
17+
18+
This package depends on both `eslint` and `eslint-plugin-angular`.
19+
20+
Entry Points
21+
------------
22+
23+
### `forumone-angular/legacy`
24+
25+
For retrofitting existing Angular apps. This config adds some simple lints around DI injection style, unused parameters, and holding on to the return of `angular.module()`.
26+
27+
### `forumone-angular`
28+
29+
The default configuration. This builds on the legacy config and bans deprecated Angular functionality.
30+
31+
It also warns about patterns that go against best practices, such as scope event typos, naming conventions, and having more than one component per file.
32+
33+
### `forumone-angular/strict`
34+
35+
Like the default, but all warnings are hard errors.

0 commit comments

Comments
 (0)