Skip to content

doc: explain error message on missing main file - #5812

Closed
drywolf wants to merge 1 commit into
nodejs:masterfrom
drywolf:package-json-main-error-doc
Closed

doc: explain error message on missing main file#5812
drywolf wants to merge 1 commit into
nodejs:masterfrom
drywolf:package-json-main-error-doc

Conversation

@drywolf

Copy link
Copy Markdown
Contributor

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

@MylesBorins

Copy link
Copy Markdown
Contributor

LGTM

edit: added a nit regarding wrapping lines, if that is followed then LGTM stands

Comment threaddoc/api/modules.markdown Outdated

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can you wrap this at 80 characters. you will notice this is the longest line in the file

@drywolf

Copy link
Copy Markdown
ContributorAuthor

I realized it as well after I created the PR, I added another commit with properly wrapped lines. 😉

@MylesBorins

Copy link
Copy Markdown
Contributor

@drywolf would you be able to squash those into a single commit please.

@MylesBorinsMylesBorins added the doc Issues and PRs related to the documentations. label Mar 20, 2016
@drywolf
drywolfforce-pushed the package-json-main-error-doc branch from f806d26 to 85f9b40CompareMarch 20, 2016 21:40
@drywolf

Copy link
Copy Markdown
ContributorAuthor

@thealphanerd done.

@benjamingr

Copy link
Copy Markdown
Member

LGTM

@jasnell

Copy link
Copy Markdown
Member

LGTM with a nit

Comment threaddoc/api/modules.markdown Outdated

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Small nit: s/node/Node.js/

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
drywolfforce-pushed the package-json-main-error-doc branch from 85f9b40 to ba95e02CompareMarch 21, 2016 19:00
@drywolf

Copy link
Copy Markdown
ContributorAuthor

@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>
@jasnell

Copy link
Copy Markdown
Member

Landed in f70c71f

@jasnelljasnell closed this Mar 21, 2016
@Fishrock123Fishrock123 mentioned this pull request Mar 22, 2016
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 freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docIssues and PRs related to the documentations.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@drywolf@MylesBorins@benjamingr@jasnell