doc: explain error message on missing main file #5812
Closed
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
|
LGTM edit: added a nit regarding wrapping lines, if that is followed then LGTM stands |
| @@ -346,6 +346,12 @@ If this was in a folder at `./some-library`, then | |||
|
|
|||
| This is the extent of Node.js's awareness of package.json files. | |||
|
|
|||
| Note: If the file specified by the `"main"` entry of `package.json` is missing and can not be resolved, node will report the entire module as missing with the default error: | |||
There was a problem hiding this comment.
can you wrap this at 80 characters. you will notice this is the longest line in the file
|
I realized it as well after I created the PR, I added another commit with properly wrapped lines. 😉 |
|
@drywolf would you be able to squash those into a single commit please. |
drywolf
force-pushed
the
package-json-main-error-doc
branch
from
f806d26
to
85f9b40
Compare
|
@thealphanerd done. |
|
LGTM |
|
LGTM with a nit |
| @@ -346,6 +346,14 @@ If this was in a folder at `./some-library`, then | |||
|
|
|||
| This is the extent of Node.js's awareness of package.json files. | |||
|
|
|||
| Note: If the file specified by the `"main"` entry of `package.json` is missing | |||
| and can not be resolved, node will report the entire module as missing with | |||
Added a hint saying that node uses the default "Cannot find module" error when requiring a module for which the "main" file specified in the package.json is missing.
drywolf
force-pushed
the
package-json-main-error-doc
branch
from
85f9b40
to
ba95e02
Compare
|
@jasnell fixed s/node/Node.js/ |
jasnell
pushed a commit
that referenced
this pull request
Mar 21, 2016
Added a hint saying that node uses the default "Cannot find module" error when requiring a module for which the "main" file specified in the package.json is missing. PR-URL: #5812 Reviewed-By: Myles Borins <myles.borins@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
|
Landed in f70c71f |
Fishrock123
pushed a commit
that referenced
this pull request
Mar 22, 2016
Added a hint saying that node uses the default "Cannot find module" error when requiring a module for which the "main" file specified in the package.json is missing. PR-URL: #5812 Reviewed-By: Myles Borins <myles.borins@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
MylesBorins
pushed a commit
that referenced
this pull request
Mar 30, 2016
Added a hint saying that node uses the default "Cannot find module" error when requiring a module for which the "main" file specified in the package.json is missing. PR-URL: #5812 Reviewed-By: Myles Borins <myles.borins@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
MylesBorins
pushed a commit
that referenced
this pull request
Mar 30, 2016
Added a hint saying that node uses the default "Cannot find module" error when requiring a module for which the "main" file specified in the package.json is missing. PR-URL: #5812 Reviewed-By: Myles Borins <myles.borins@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
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.
Description of change
Added a hint to documentation saying that node uses the default "Cannot find module"
error when requiring a module for which the "main" file specified in
the package.json is missing.
for details see: #5758