You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/src/contribute/development-environment.md
+26-3Lines changed: 26 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,10 +15,16 @@ Go to <https://nodejs.org/> to download and install the latest stable version fo
15
15
16
16
Most of the installers already come with [npm](https://www.npmjs.com/) but if for some reason npm doesn't work on your system, you can install it manually using the instructions on the site.
17
17
18
-
## Step 2: Fork and checkout your own ESLint repository
18
+
## Step 2: Fork and Checkout Your Own ESLint Repository
19
19
20
20
Go to <https://github.com/eslint/eslint> and click the "Fork" button. Follow the [GitHub documentation](https://help.github.com/articles/fork-a-repo) for forking and cloning.
Once you've cloned the repository, run `npm install` to get all the necessary dependencies:
23
29
24
30
```shell
@@ -28,7 +34,9 @@ npm install
28
34
29
35
You must be connected to the Internet for this step to work. You'll see a lot of utilities being downloaded.
30
36
31
-
## Step 3: Add the upstream source
37
+
**Note:** It's a good idea to re-run `npm install` whenever you pull from the main repository to ensure you have the latest development dependencies.
38
+
39
+
## Step 3: Add the Upstream Source
32
40
33
41
The *upstream source* is the main ESLint repository where active development happens. While you won't have push access to upstream, you will have pull access, allowing you to pull in the latest code whenever you want.
34
42
@@ -56,7 +64,7 @@ npm install -g generator-eslint
56
64
57
65
Please see the [generator documentation](https://github.com/eslint/generator-eslint) for instructions on how to use it.
58
66
59
-
## Step 5: Run the tests
67
+
## Step 5: Run the Tests
60
68
61
69
Running the tests is the best way to ensure you have correctly set up your development environment. Make sure you're in the `eslint` directory and run:
62
70
@@ -68,6 +76,21 @@ The testing takes a few minutes to complete. If any tests fail, that likely mean
68
76
69
77
## Reference Information
70
78
79
+
### Directory Structure
80
+
81
+
The ESLint directory and file structure is as follows:
82
+
83
+
*`bin` - executable files that are available when ESLint is installed
84
+
*`conf` - default configuration information
85
+
*`docs` - documentation for the project
86
+
*`lib` - contains the source code
87
+
*`formatters` - all source files defining formatters
88
+
*`rules` - all source files defining rules
89
+
*`tests` - the main unit test folder
90
+
*`lib` - tests for the source code
91
+
* `formatters` - tests for the formatters
92
+
* `rules` - tests for the rules
93
+
71
94
### Workflow
72
95
73
96
Once you have your development environment installed, you can make and submit changes to the ESLint source files. Doing this successfully requires careful adherence to our [pull-request submission workflow](./pull-requests).
Copy file name to clipboardExpand all lines: docs/src/contribute/index.md
-4Lines changed: 0 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -34,10 +34,6 @@ If you'd like to request a change other than a bug fix or new rule, this section
34
34
35
35
Learn about the architecture of the ESLint project.
36
36
37
-
## [Get the Source Code](source-code)
38
-
39
-
Before you can get started developing ESLint, you'll need to get a copy of the ESLint source code. This section explains how to do that and a little about the source code structure.
40
-
41
37
## [Set up a Development Environment](development-environment)
42
38
43
39
Developing for ESLint is a bit different than running it on the command line. This section shows you how to set up a development environment and get you ready to write code.
0 commit comments