Skip to content

Commit e6b84f5

Browse files
lumirlumirlumirlumir
authored
docs: add missing punctuation in document (#19161)
* docs: add missing punctuation in `governance.md` * docs: update `governance.md` * docs: update `nodejs-api.md` * docs: update `core-rules.md` * docs: update `development-environment.md` * docs: update `package-json-conventions.md` * docs: update `rules.md` * docs: update `propose-new-rule.md` * docs: update `propose-rule-change.md` * docs: update `language-options.md` * docs: update `configuration-files.md` * docs: update `overview.md` * docs: update `manage-issues.md` * docs: update `review-pull-requests.md` * docs: update `pull-requests.md` * docs: update `manage-releases.md` * docs: add missing punctuation in `governance.md` * docs: update `governance.md` * docs: update `nodejs-api.md` * docs: update `core-rules.md` * docs: update `development-environment.md` * docs: update `package-json-conventions.md` * docs: update `rules.md` * docs: update `propose-new-rule.md` * docs: update `propose-rule-change.md` * docs: update `language-options.md` * docs: update `configuration-files.md` * docs: update `overview.md` * docs: update `manage-issues.md` * docs: update `review-pull-requests.md` * docs: update `pull-requests.md` * docs: update `manage-releases.md` * docs: update `ignore.md` * docs: update `migration-guide.md` * docs: update `no-cond-assign.md` * docs: update rest of the document
1 parent c88708e commit e6b84f5

34 files changed

+197
-197
lines changed

‎docs/src/about/index.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -18,24 +18,24 @@ ESLint is written using Node.js to provide a fast runtime environment and easy i
1818

1919
Everything is pluggable:
2020

21-
* Rule API is used both by bundled and custom rules
22-
* Formatter API is used both by bundled and custom formatters
23-
* Additional rules and formatters can be specified at runtime
24-
* Rules and formatters don't have to be bundled to be used
21+
* Rule API is used both by bundled and custom rules.
22+
* Formatter API is used both by bundled and custom formatters.
23+
* Additional rules and formatters can be specified at runtime.
24+
* Rules and formatters don't have to be bundled to be used.
2525

2626
Every rule:
2727

28-
* Is standalone
29-
* Can be turned off or on (nothing can be deemed "too important to turn off")
30-
* Can be set to a warning or error individually
28+
* Is standalone.
29+
* Can be turned off or on (nothing can be deemed "too important to turn off").
30+
* Can be set to a warning or error individually.
3131

3232
Additionally:
3333

34-
* Rules are "agenda free" - ESLint does not promote any particular coding style
35-
* Any bundled rules are generalizable
34+
* Rules are "agenda free" - ESLint does not promote any particular coding style.
35+
* Any bundled rules are generalizable.
3636

3737
The project:
3838

39-
* Values documentation and clear communication
40-
* Is as transparent as possible
41-
* Believes in the importance of testing
39+
* Values documentation and clear communication.
40+
* Is as transparent as possible.
41+
* Believes in the importance of testing.

‎docs/src/contribute/architecture/index.md

Lines changed: 31 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -30,17 +30,17 @@ The main method is `cli.execute()`, which accepts an array of strings that repre
3030

3131
This object's responsibilities include:
3232

33-
* Interpreting command line arguments
34-
* Reading from the file system
35-
* Outputting to the console
36-
* Outputting to the filesystem
37-
* Use a formatter
38-
* Returning the correct exit code
33+
* Interpreting command line arguments.
34+
* Reading from the file system.
35+
* Outputting to the console.
36+
* Outputting to the filesystem.
37+
* Use a formatter.
38+
* Returning the correct exit code.
3939

4040
This object may not:
4141

42-
* Call `process.exit()` directly
43-
* Perform any asynchronous operations
42+
* Call `process.exit()` directly.
43+
* Perform any asynchronous operations.
4444

4545
## The `CLIEngine` object
4646

@@ -50,16 +50,16 @@ The main method of the `CLIEngine` is `executeOnFiles()`, which accepts an array
5050

5151
This object's responsibilities include:
5252

53-
* Managing the execution environment for `Linter`
54-
* Reading from the file system
55-
* Reading configuration information from config files (including `.eslintrc` and `package.json`)
53+
* Managing the execution environment for `Linter`.
54+
* Reading from the file system.
55+
* Reading configuration information from config files (including `.eslintrc` and `package.json`).
5656

5757
This object may not:
5858

59-
* Call `process.exit()` directly
60-
* Perform any asynchronous operations
61-
* Output to the console
62-
* Use formatters
59+
* Call `process.exit()` directly.
60+
* Perform any asynchronous operations.
61+
* Output to the console.
62+
* Use formatters.
6363

6464
## The `Linter` object
6565

@@ -69,32 +69,32 @@ Once the AST is available, `estraverse` is used to traverse the AST from top to
6969

7070
This object's responsibilities include:
7171

72-
* Inspecting JavaScript code strings
73-
* Creating an AST for the code
74-
* Executing rules on the AST
75-
* Reporting back the results of the execution
72+
* Inspecting JavaScript code strings.
73+
* Creating an AST for the code.
74+
* Executing rules on the AST.
75+
* Reporting back the results of the execution.
7676

7777
This object may not:
7878

79-
* Call `process.exit()` directly
80-
* Perform any asynchronous operations
81-
* Use Node.js-specific features
82-
* Access the file system
83-
* Call `console.log()` or any other similar method
79+
* Call `process.exit()` directly.
80+
* Perform any asynchronous operations.
81+
* Use Node.js-specific features.
82+
* Access the file system.
83+
* Call `console.log()` or any other similar method.
8484

8585
## Rules
8686

8787
Individual rules are the most specialized part of the ESLint architecture. Rules can do very little, they are simply a set of instructions executed against an AST that is provided. They do get some context information passed in, but the primary responsibility of a rule is to inspect the AST and report warnings.
8888

8989
These objects' responsibilities are:
9090

91-
* Inspect the AST for specific patterns
92-
* Reporting warnings when certain patterns are found
91+
* Inspect the AST for specific patterns.
92+
* Reporting warnings when certain patterns are found.
9393

9494
These objects may not:
9595

96-
* Call `process.exit()` directly
97-
* Perform any asynchronous operations
98-
* Use Node.js-specific features
99-
* Access the file system
100-
* Call `console.log()` or any other similar method
96+
* Call `process.exit()` directly.
97+
* Perform any asynchronous operations.
98+
* Use Node.js-specific features.
99+
* Access the file system.
100+
* Call `console.log()` or any other similar method.

‎docs/src/contribute/core-rules.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,9 @@ For full reference information on writing rules, refer to [Custom Rules](../exte
2020

2121
Each core rule in ESLint has three files named with its identifier (for example, `no-extra-semi`).
2222

23-
* in the `lib/rules` directory: a source file (for example, `no-extra-semi.js`)
24-
* in the `tests/lib/rules` directory: a test file (for example, `no-extra-semi.js`)
25-
* in the `docs/src/rules` directory: a Markdown documentation file (for example, `no-extra-semi.md`)
23+
* in the `lib/rules` directory: a source file (for example, `no-extra-semi.js`).
24+
* in the `tests/lib/rules` directory: a test file (for example, `no-extra-semi.js`).
25+
* in the `docs/src/rules` directory: a Markdown documentation file (for example, `no-extra-semi.md`).
2626

2727
**Important:** If you submit a core rule to the ESLint repository, you **must** follow the conventions explained below.
2828

‎docs/src/contribute/development-environment.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -80,16 +80,16 @@ The testing takes a few minutes to complete. If any tests fail, that likely mean
8080

8181
The ESLint directory and file structure is as follows:
8282

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
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.
9393

9494
### Workflow
9595

@@ -103,11 +103,11 @@ ESLint has several build scripts that help with various parts of development.
103103

104104
The primary script to use is `npm test`, which does several things:
105105

106-
1. Lints all JavaScript (including tests) and JSON
107-
1. Runs all tests on Node.js
108-
1. Checks code coverage targets
109-
1. Generates `build/eslint.js` for use in a browser
110-
1. Runs a subset of tests in PhantomJS
106+
1. Lints all JavaScript (including tests) and JSON.
107+
1. Runs all tests on Node.js.
108+
1. Checks code coverage targets.
109+
1. Generates `build/eslint.js` for use in a browser.
110+
1. Runs a subset of tests in PhantomJS.
111111

112112
Be sure to run this after making changes and before sending a pull request with your changes.
113113

‎docs/src/contribute/governance.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,8 @@ Website Team Members are community members who have shown that they are committe
4040
* Are expected to delete their public branches when they are no longer necessary.
4141
* Must submit pull requests for all changes.
4242
* Have their work reviewed by Reviewers and TSC members before acceptance into the repository.
43-
* May label and close website-related issues (see [Manage Issues](../maintain/manage-issues))
44-
* May merge some pull requests (see [Review Pull Requests](../maintain/review-pull-requests))
43+
* May label and close website-related issues (see [Manage Issues](../maintain/manage-issues)).
44+
* May merge some pull requests (see [Review Pull Requests](../maintain/review-pull-requests)).
4545
* May take time off whenever they want, and are expected to post in the `#team` Discord channel when they will be away for more than a couple of days.
4646

4747
To become a Website Team Member:
@@ -70,8 +70,8 @@ Committers:
7070
* Are expected to work on at least one issue in the "Ready to Implement" column of the [Triage Board](https://github.com/orgs/eslint/projects/3/views/1) that they didn't create each month.
7171
* Must submit pull requests for all changes.
7272
* Have their work reviewed by TSC members before acceptance into the repository.
73-
* May label and close issues (see [Manage Issues](../maintain/manage-issues))
74-
* May merge some pull requests (see [Review Pull Requests](../maintain/review-pull-requests))
73+
* May label and close issues (see [Manage Issues](../maintain/manage-issues)).
74+
* May merge some pull requests (see [Review Pull Requests](../maintain/review-pull-requests)).
7575
* May take time off whenever they want, and are expected to post in the `#team` Discord channel when they will be away for more than a couple of days.
7676

7777
To become a Committer:

‎docs/src/contribute/package-json-conventions.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ A test script SHOULD report test coverage when possible.
7474

7575
## Modifiers
7676

77-
One or more of the following modifiers MAY be appended to the standard script names above. If a target has modifiers, they MUST be in the order in which they appear below (e.g. `lint:fix:js:watch` not `lint:watch:js:fix`)
77+
One or more of the following modifiers MAY be appended to the standard script names above. If a target has modifiers, they MUST be in the order in which they appear below (e.g. `lint:fix:js:watch` not `lint:watch:js:fix`).
7878

7979
### Fix
8080

@@ -86,7 +86,7 @@ The name of the target of the action being run. In the case of a `build` script,
8686

8787
A target MAY refer to a list of affected file extensions (such as `cjs` or `less`) delimited by a `+`. If there is more than one extension, the list SHOULD be alphabetized. When a file extension has variants (such as `cjs` for CommonJS and `mjs` for ESM), the common part of the extension MAY be used instead of explicitly listing out all of the variants (e.g. `js` instead of `cjs+jsx+mjs`).
8888

89-
The target SHOULD NOT refer to name of the name of the tool that's performing the action (`eleventy`, `webpack`, etc.)
89+
The target SHOULD NOT refer to name of the name of the tool that's performing the action (`eleventy`, `webpack`, etc.).
9090

9191
### Options
9292

‎docs/src/contribute/propose-new-rule.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,9 @@ We need all of this information in order to determine whether or not the rule is
3434

3535
In order for a rule to be accepted in the ESLint core, it must:
3636

37-
1. Fulfill all the criteria listed in the "Core Rule Guidelines" section
38-
1. Have an ESLint team member champion inclusion of the rule
39-
1. Be related to an ECMAScript feature that has reached stage 4 in the preceding 12 months
37+
1. Fulfill all the criteria listed in the "Core Rule Guidelines" section.
38+
1. Have an ESLint team member champion inclusion of the rule.
39+
1. Be related to an ECMAScript feature that has reached stage 4 in the preceding 12 months.
4040

4141
Keep in mind that we have over 200 rules, and that is daunting both for end users and the ESLint team (who has to maintain them). As such, any new rules must be deemed of high importance to be considered for inclusion in ESLint.
4242

‎docs/src/contribute/propose-rule-change.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@ We need all of this information in order to determine whether or not the change
1919

2020
In order for a rule change to be accepted into ESLint, it must:
2121

22-
1. Adhere to the [Core Rule Guidelines](propose-new-rule#core-rule-guidelines)
23-
1. Have an ESLint team member champion the change
24-
1. Be important enough that rule is deemed incomplete without this change
22+
1. Adhere to the [Core Rule Guidelines](propose-new-rule#core-rule-guidelines).
23+
1. Have an ESLint team member champion the change.
24+
1. Be important enough that rule is deemed incomplete without this change.
2525

2626
## Implementation is Your Responsibility
2727

‎docs/src/contribute/pull-requests.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -22,13 +22,13 @@ After that, you're ready to start working on code.
2222

2323
The process of submitting a pull request is fairly straightforward and generally follows the same pattern each time:
2424

25-
1. [Create a new branch](#step1)
26-
2. [Make your changes](#step2)
27-
3. [Rebase onto upstream](#step3)
28-
4. [Run the tests](#step4)
29-
5. [Double check your submission](#step5)
30-
6. [Push your changes](#step6)
31-
7. [Submit the pull request](#step7)
25+
1. [Create a new branch](#step1).
26+
2. [Make your changes](#step2).
27+
3. [Rebase onto upstream](#step3).
28+
4. [Run the tests](#step4).
29+
5. [Double check your submission](#step5).
30+
6. [Push your changes](#step6).
31+
7. [Submit the pull request](#step7).
3232

3333
Details about each step are found below.
3434

‎docs/src/extend/custom-rules.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -207,9 +207,9 @@ The node contains all the information necessary to figure out the line and colum
207207

208208
`messageId`s are the recommended approach to reporting messages in `context.report()` calls because of the following benefits:
209209

210-
* Rule violation messages can be stored in a central `meta.messages` object for convenient management
211-
* Rule violation messages do not need to be repeated in both the rule file and rule test file
212-
* As a result, the barrier for changing rule violation messages is lower, encouraging more frequent contributions to improve and optimize them for the greatest clarity and usefulness
210+
* Rule violation messages can be stored in a central `meta.messages` object for convenient management.
211+
* Rule violation messages do not need to be repeated in both the rule file and rule test file.
212+
* As a result, the barrier for changing rule violation messages is lower, encouraging more frequent contributions to improve and optimize them for the greatest clarity and usefulness.
213213

214214
Rule file:
215215

@@ -654,11 +654,11 @@ There are two formats for a rule's `schema`:
654654

655655
* An array of JSON Schema objects
656656
* Each element will be checked against the same position in the `context.options` array.
657-
* If the `context.options` array has fewer elements than there are schemas, then the unmatched schemas are ignored
658-
* If the `context.options` array has more elements than there are schemas, then the validation fails
657+
* If the `context.options` array has fewer elements than there are schemas, then the unmatched schemas are ignored.
658+
* If the `context.options` array has more elements than there are schemas, then the validation fails.
659659
* There are two important consequences to using this format:
660-
* It is _always valid_ for a user to provide no options to your rule (beyond severity)
661-
* If you specify an empty array, then it is _always an error_ for a user to provide any options to your rule (beyond severity)
660+
* It is _always valid_ for a user to provide no options to your rule (beyond severity).
661+
* If you specify an empty array, then it is _always an error_ for a user to provide any options to your rule (beyond severity).
662662
* A full JSON Schema object that will validate the `context.options` array
663663
* The schema should assume an array of options to validate even if your rule only accepts one option.
664664
* The schema can be arbitrarily complex, so you can validate completely different sets of potential options via `oneOf`, `anyOf` etc.

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy