Skip to content

Commit 6b25073

Browse files
sugardaveaarontam
sugardave
authored and
aarontam
committed
PLAT-29369: Add eslint guides into new docs app (#15)
* add docs dir for enact-docs inclusion * add repo link * reorganize some information * Create proper README, add license and update docs Enact-DCO-1.0-Signed-off-by: Roy Sutton roy.sutton@lge.com * Update docs Enact-DCO-1.0-Signed-off-by: Roy Sutton roy.sutton@lge.com * Add descriptive title Enact-DCO-1.0-Signed-off-by: Roy Sutton roy.sutton@lge.com * Fixes typo Issue: PLAT-29369 Enact-DCO-1.0-Signed-off-by Aaron Tam <aaron.tam@lge.com> Reviewed-By: Roy Sutton (roy.sutton@lge.com) Integrated-By: Aaron Tam (aaron.tam@lge.com)
1 parent ee25093 commit 6b25073

File tree

3 files changed

+332
-86
lines changed

3 files changed

+332
-86
lines changed

‎LICENSE

+201
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "{}"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright {yyyy} {name of copyright owner}
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎README.md

+26-86
Original file line numberDiff line numberDiff line change
@@ -1,102 +1,42 @@
1-
# Linting with ESLint
1+
# eslint-config-enact
22

3-
The Enact team recommends all developers use ESLint to statically analyze files for potential errors and to help enforce a common coding style. To that end, we developed an ESLint plugin that encapsulates Enact programming conventions. Most modern editors have support for displaying linter errors in-line with source code. This can be very helpful during development. This document describes how to set up ESLint with various editors.
3+
> A set of linting rules designed by the Enact team.
44
5-
## Installing Dependencies
5+
This module includes both a standard set of rules and a set of stricter rules that represent the Enact team style.
66

7-
ESLint, and some of the support modules, must be available globally for editors. Install these dependencies with the following command:
7+
## Usage
88

9-
```bash
10-
npm install -g eslint eslint-plugin-react eslint-plugin-babel babel-eslint enyojs/eslint-plugin-enact enyojs/eslint-config-enact
11-
```
12-
13-
Or alternatively:
14-
15-
```bash
16-
npm install -g eslint eslint-plugin-react eslint-plugin-babel babel-eslint enyojs/eslint-plugin-enact
17-
git clone git@github.com:enyojs/eslint-config-enact.git
18-
cd eslint-config-enact
19-
npm link
20-
```
21-
22-
> Some Linux installations may require the use of `sudo`, though we recommend updating your installation to not require this. If your Mac OS X installation requires this, you should definitely reinstall node. Consider using [nvm](https://github.com/creationix/nvm) or another similar tool to manage your node installation.
23-
24-
<!-- -->
25-
>NOTE: You may see the following warnings, which you can safely ignore:
26-
>
27-
>```npm WARN eslint-config-enact@1.0.0 requires a peer of eslint@^2.10.2 but none was installed.
28-
>npm WARN eslint-config-enact@1.0.0 requires a peer of eslint-plugin-react@^5.1.1 but none was installed.
29-
>npm WARN eslint-config-enact@1.0.0 requires a peer of eslint-plugin-babel@^3.2.0 but none was installed.```
30-
31-
32-
## Setting Up Your Editor
33-
34-
Each editor requires a slightly different setup. Jump to the section relevant to your editor.
35-
36-
>Note: If you happen to have linting set up already using JSHint or another tool, be sure to disable it as these linters sometimes get confused with newer ES6+ syntax and will not take advantage of the Enact linting rules.
37-
38-
### Atom
39-
40-
From the shell/command prompt, issue the following command to install [linter-eslint](https://github.com/AtomLinter/linter-eslint):
41-
42-
```
43-
apm install linter-eslint
44-
```
45-
46-
After the installation go to *Preferences*, then click on *Packages*. Navigate down to *linter-eslint* and click *Settings*. Make sure that the *Use global ESLint installation* option is checked and that you have correctly configured the path to the node installation within Atom.
47-
48-
### Sublime Text
9+
Reference this set of rules from your `.eslintrc` or `package.json` file and then use `eslint`. If you are using `enact-dev`, simply use `npm run lint` from your project directory.
4910

50-
Install the [SublimeLinter-eslint plugin](https://github.com/roadhump/SublimeLinter-eslint), which depends on [SublimeLinter 3](http://sublimelinter.readthedocs.org/en/latest/installation.html).
11+
For more information (including editor/IDE setup), please see the [docs](docs/index.md).
5112

52-
### Vim
13+
## Installation
5314

54-
First install [Syntastic](https://github.com/scrooloose/syntastic) and then enable the eslint option:
15+
`eslint-config-enact` can be installed locally or globally. The following command will install the config and all its dependencies globally:
5516

56-
```vimscript
57-
" syntastic
58-
let g:syntastic_javascript_checkers = ['eslint']
59-
let g:syntastic_always_populate_loc_list = 1
60-
let g:syntastic_auto_loc_list = 0
61-
let g:syntastic_check_on_open = 1
62-
let g:syntastic_check_on_wq = 0
63-
let g:syntastic_mode_map = {
64-
\ "mode": "active",
65-
\ "active_filetypes": ["javascript"]}
17+
```bash
18+
npm install -g eslint eslint-plugin-react eslint-plugin-babel babel-eslint enyojs/eslint-plugin-enact enyojs/eslint-config-enact
6619
```
6720

68-
Unfortunately, Syntastic does not support real-time linting and only lints on save/load.
69-
70-
> Note: You may also wish to install [vim-jsx](https://github.com/mxw/vim-jsx) as well.
71-
72-
### Visual Studio Code
21+
>**NOTE**: Using the [`enct-dev` tools](https://github.com/enyojs/enact-dev/) to create your projects eliminates the need to globally install these dependencies unless you wish editor integration.
7322
74-
Install the [vscode-eslint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) plugin. More information on linters and Visual Studio Code can be found [here](https://code.visualstudio.com/docs/languages/javascript#_linters).
23+
## Copyright and License Information
7524

76-
### WebStorm
25+
Unless otherwise specified, all content, including all source code files and
26+
documentation files in this repository are:
7727

78-
In either the default or per-project preferences, go to *Languages & Frameworks* > *JavaScript* > *Code Quality* > *ESLint*.
79-
Check the *Enable* checkbox. Ensure that the proper paths for `node` and `eslint` are configured.
28+
Copyright (c) 2012-2017 LG Electronics
8029

81-
## Next Steps
82-
83-
If in-editor linting is not working in your local project, you may need to add the following to your `package.json`:
84-
85-
```
86-
{
87-
// ...
88-
"eslintConfig": {
89-
"extends": "enact"
90-
}
91-
}
92-
```
93-
94-
If you like our linting rules and want to use them by default with your other projects, set up an `.eslintrc` file in your HOME directory as follows:
95-
96-
```
97-
{
98-
"extends": "enact"
99-
}
100-
```
30+
Unless otherwise specified or set forth in the NOTICE file, all content,
31+
including all source code files and documentation files in this repository are:
32+
Licensed under the Apache License, Version 2.0 (the "License");
33+
you may not use this content except in compliance with the License.
34+
You may obtain a copy of the License at
10135

36+
http://www.apache.org/licenses/LICENSE-2.0
10237

38+
Unless required by applicable law or agreed to in writing, software
39+
distributed under the License is distributed on an "AS IS" BASIS,
40+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
41+
See the License for the specific language governing permissions and
42+
limitations under the License.

0 commit comments

Comments
 (0)