Add documentation for no-use-before-define rule under hoisting section #2773
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ujwalkumar1995
force-pushed
the
issue-2708-documentation-for-no-use-before-define
branch
from
6575d9b
to
b79b5eb
Compare
ljharb
requested changes
May 20, 2023
There was a problem hiding this comment.
Let's please add a "why" section. It can reference and link to http://johnkpaul.com/blog/2013/02/11/what-is-hoisting-really/ and https://snek.dev/blag/2019-07_js_hoisting, for example
README.md
Outdated
| @@ -1961,6 +1961,39 @@ Other Style Guides | |||
| } | |||
| ``` | |||
|
|
|||
| <a name="no-use-before-define"></a><a name="14.5"></a> | |||
| - [14.5](#no-use-before-define) Variables, classes and functions should be defined before they can be used. | |||
There was a problem hiding this comment.
Suggested change
| - [14.5](#no-use-before-define) Variables, classes and functions should be defined before they can be used. | |
| - [14.5](#no-use-before-define) Variables, classes, and functions should be defined before they can be used. |
This comment was marked as spam.
This comment was marked as spam.
Sorry, something went wrong.
|
Hey @ljharb |
ljharb
requested changes
May 24, 2023
README.md
Outdated
| <a name="no-use-before-define"></a> | ||
| - [14.5](#no-use-before-define) Variables, classes, and functions should be defined before they can be used. eslint: [`no-use-before-define`](https://eslint.org/docs/latest/rules/no-use-before-define) | ||
|
|
||
| > Why? When variables, classes, or functions are declared before being used, it can lead to unexpected errors. As they are hoisted, it can also slow down the application as they are read before any code is executed. |
There was a problem hiding this comment.
Suggested change
| > Why? When variables, classes, or functions are declared before being used, it can lead to unexpected errors. As they are hoisted, it can also slow down the application as they are read before any code is executed. | |
| > Why? When variables, classes, or functions are declared before being used, it can harm readability since a reader won't know what a thing that's referenced _is_. It's much clearer for a reader to first encounter the source of a thing (whether imported from another module, or defined in the file) before encountering a use of the thing. |
the latter isn't true, since the hoisting pass happens anyways. maybe this:
ljharb
reviewed
May 24, 2023
ljharb
reviewed
May 24, 2023
ljharb
approved these changes
May 30, 2023
ljharb
force-pushed
the
issue-2708-documentation-for-no-use-before-define
branch
2 times, most recently
from
40d3e3d
to
7916d6f
Compare
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hey @ljharb
I have submitted a PR for the issue #2708
Could you please review this?
Fixes #2708.