Skip to content

Commit 9b8e04b

Browse files
committed
Docs: Replace all node references to Node.js which is the official name
1 parent bb8f470 commit 9b8e04b

File tree

7 files changed

+13
-13
lines changed

7 files changed

+13
-13
lines changed

docs/rules/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -140,8 +140,8 @@ These rules are specific to JavaScript running on Node.js or using CommonJS in t
140140
* [no-new-require](no-new-require.md) - disallow use of `new` operator with the `require` function
141141
* [no-path-concat](no-path-concat.md) - disallow string concatenation with `__dirname` and `__filename`
142142
* [no-process-exit](no-process-exit.md) - disallow `process.exit()`
143-
* [no-restricted-imports](no-restricted-imports.md) - restrict usage of specified node imports
144-
* [no-restricted-modules](no-restricted-modules.md) - restrict usage of specified node modules
143+
* [no-restricted-imports](no-restricted-imports.md) - restrict usage of specified Node.js imports
144+
* [no-restricted-modules](no-restricted-modules.md) - restrict usage of specified Node.js modules
145145
* [no-sync](no-sync.md) - disallow use of synchronous methods
146146

147147
## Stylistic Issues

docs/rules/callback-return.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ function doSomething(err, callback) {
1414

1515
To prevent calling the callback multiple times it is important to `return` anytime the callback is triggered outside
1616
of the main function body. Neglecting this technique often leads to issues where you do something more than once.
17-
For example, in the case of an HTTP request, you may try to send HTTP headers more than once leading node.js to `throw`
17+
For example, in the case of an HTTP request, you may try to send HTTP headers more than once leading Node.js to `throw`
1818
a `Can't render headers after they are sent to the client.` error.
1919

2020
## Rule Details

docs/rules/handle-callback-err.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Enforce Callback Error Handling (handle-callback-err)
22

3-
In node, a common pattern for dealing with asynchronous behavior is called the callback pattern.
3+
In Node.js, a common pattern for dealing with asynchronous behavior is called the callback pattern.
44
This pattern expects an `Error` object or `null` as the first argument of the callback.
55
Forgetting to handle these errors can lead to some really strange behavior in your application.
66

@@ -12,7 +12,7 @@ function loadData (err, data) {
1212

1313
## Rule Details
1414

15-
This rule expects that when you're using the callback pattern in node you'll handle the error and
15+
This rule expects that when you're using the callback pattern in Node.js you'll handle the error and
1616
requires that you specify the name of your error object. The name of the argument will default to `err`.
1717

1818
The following are considered problems:

docs/rules/no-comma-dangle.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,4 +49,4 @@ foo({
4949

5050
## When Not To Use It
5151

52-
If your code will not be run in IE8 or below (a NodeJS application, for example) and you'd prefer to allow trailing commas, turn this rule off.
52+
If your code will not be run in IE8 or below (a Node.js application, for example) and you'd prefer to allow trailing commas, turn this rule off.

docs/rules/no-mixed-requires.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Disallow Mixed Requires (no-mixed-requires)
22

3-
In the Node.JS community it is often customary to separate the `require`d modules from other variable declarations, sometimes also grouping them by their type. This rule helps you enforce this convention.
3+
In the Node.js community it is often customary to separate the `require`d modules from other variable declarations, sometimes also grouping them by their type. This rule helps you enforce this convention.
44

55
## Rule Details
66

@@ -115,10 +115,10 @@ var async = require('async'),
115115

116116
## Known Limitations
117117

118-
* The implementation is not aware of any local functions with the name `require` that may shadow Node's global `require`.
118+
* The implementation is not aware of any local functions with the name `require` that may shadow Node.js' global `require`.
119119

120-
* Internally, the list of core modules is retrieved via `require("repl")._builtinLibs`. If you use different versions of Node.JS for ESLint and your application, the list of core modules for each version may be different.
121-
The above mentioned `_builtinLibs` property became available in 0.8, for earlier versions a hardcoded list of module names is used as a fallback. If your version of Node is older than 0.6 that list may be inaccurate.
120+
* Internally, the list of core modules is retrieved via `require("repl")._builtinLibs`. If you use different versions of Node.js for ESLint and your application, the list of core modules for each version may be different.
121+
The above mentioned `_builtinLibs` property became available in 0.8, for earlier versions a hardcoded list of module names is used as a fallback. If your version of Node.js is older than 0.6 that list may be inaccurate.
122122

123123
## When Not To Use It
124124

docs/rules/no-restricted-imports.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Imports are an ES6/ES2015 standard for making the functionality of other modules
44

55
Why would you want to restrict imports?
66

7-
* Some imports might not make sense in a particular environment. For example, Node's `fs` module would not make sense in an environment that didn't have a file system.
7+
* Some imports might not make sense in a particular environment. For example, Node.js' `fs` module would not make sense in an environment that didn't have a file system.
88

99
* Some modules provide similar or identical functionality, think `lodash` and `underscore`. Your project may have standardized on a module. You want to make sure that the other alternatives are not being used as this would unnecessarily bloat the project and provide a higher maintenance cost of two dependencies when one would suffice.
1010

docs/rules/no-restricted-modules.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Disallow Node modules (no-restricted-modules)
1+
# Disallow Node.js modules (no-restricted-modules)
22

3-
Disallowing usage of specific node modules can be useful if you want to control the available methods, a developer can
3+
Disallowing usage of specific Node.js modules can be useful if you want to control the available methods, a developer can
44
use, to implement a feature.
55

66
This way you can block usage of the `fs` module if you want disallow file system access.

0 commit comments

Comments
 (0)