Document MODULE_NOT_FOUND by DullReferenceException · Pull Request #21894 · nodejs/node

DullReferenceException · 2018-07-19T19:45:02Z

Document MODULE_NOT_FOUND

Checklist

documentation is changed or added
commit message follows commit guidelines

Document MODULE_NOT_FOUND as a possible code for errors.

Fixes: #21890

Document `MODULE_NOT_FOUND` as a possible `code` for errors.

mscdex · 2018-07-19T19:51:27Z

doc/api/modules.md

 [`module` object][]. In particular, `module.exports` is used for defining what
 a module exports and makes available through `require()`.

+<a id="require"></a>


This isn't necessary as the html generator for the markdown will create these id attributes automatically.

mscdex · 2018-07-19T19:51:51Z

doc/api/errors.md

 [try-catch]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/try...catch
 [vm]: vm.html
 [WHATWG Supported Encodings]: util.html#util_whatwg_supported_encodings
+[`require`]: modules.html#require


The right-hand side of this should be modules.html#modules_require instead.

vsemozhetbyt

Some nits)

vsemozhetbyt · 2018-07-19T19:56:13Z

doc/api/errors.md

 [try-catch]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/try...catch
 [vm]: vm.html
 [WHATWG Supported Encodings]: util.html#util_whatwg_supported_encodings
+[`require`]: modules.html#modules_require


It seems this should be:

[`require()`]: modules.html#modules_require

We usually sort bottom references ASCII-wise, so this need to be placed after the [`require('crypto').setEngine()`]: item.

vsemozhetbyt · 2018-07-19T19:59:08Z

doc/api/errors.md


 Creation of a [`zlib`][] object failed due to incorrect configuration.

+### MODULE_NOT_FOUND


Should not this be ### ERR_MODULE_NOT_FOUND and be placed in a sorted way?

It seems this doc does need <a id=... fragments.

I believe the actual error name is currently just MODULE_NOT_FOUND.

So this is the first error name out of the common name pattern?

vsemozhetbyt · 2018-07-19T20:00:15Z

doc/api/errors.md


+### MODULE_NOT_FOUND
+
+A module file could not be resolved while attempting a [`require`][] or 


[`require`][] -> [`require()`][]

mscdex · 2018-07-19T20:00:54Z

Leaving the added anchor in errors.md is fine for consistency, I honestly do not know why they are being explicitly added in that file, even after looking at the original PR where the first documented errors were added.

/cc @jasnell

jasnell · 2018-07-20T03:07:25Z

The anchors are added to explicitly ensure that the exact error code can be used as an anchor in the docs rather than the anchor generated by the markdown rendering...

e.g. https://nodejs.org/dist/latest-v10.x/docs/api/errors.html#ERR_AMBIGUOUS_ARGUMENT as opposed to https://nodejs.org/dist/latest-v10.x/docs/api/errors.html#errors_err_ambiguous_argument

jasnell · 2018-07-20T03:14:06Z

doc/api/errors.md

 Creation of a [`zlib`][] object failed due to incorrect configuration.

-[`'uncaughtException'`]: process.html#process_event_uncaughtexception
+### MODULE_NOT_FOUND


It is very unfortunate that this does not have the ERR_ prefix :-(

The code is 7 years old so we can't blame anyone for that : 3f987cd

jasnell · 2018-07-20T03:16:30Z

doc/api/errors.md

 Creation of a [`zlib`][] object failed due to incorrect configuration.

-[`'uncaughtException'`]: process.html#process_event_uncaughtexception
+### MODULE_NOT_FOUND


This definitely needs to include the <a id="#MODULE_NOT_FOUND"></a> anchor

vsemozhetbyt · 2018-07-22T22:29:25Z

CI-lite: https://ci.nodejs.org/job/node-test-pull-request-lite-pipeline/337/

Document `MODULE_NOT_FOUND` as a possible `code` for errors. Also, some missorting of bottom references was fixed in passing. PR-URL: #21894 Fixes: #21890 Reviewed-By: James M Snell <jasnell@gmail.com>

vsemozhetbyt · 2018-07-22T22:47:54Z

Landed in 87f7671
Thank you!

Document `MODULE_NOT_FOUND` as a possible `code` for errors. Also, some missorting of bottom references was fixed in passing. PR-URL: #21894 Fixes: #21890 Reviewed-By: James M Snell <jasnell@gmail.com>

Document MODULE_NOT_FOUND

69bfb9f

Document `MODULE_NOT_FOUND` as a possible `code` for errors.

mscdex reviewed Jul 19, 2018

View reviewed changes

jpage-godaddy added 3 commits July 19, 2018 12:54

Revert anchor

29b6b62

Link to modules.require instead of global require

4d07005

Remove another anchor (but why does everything else have one?)

4c6925e

vsemozhetbyt reviewed Jul 19, 2018

View reviewed changes

vsemozhetbyt added doc Issues and PRs related to the documentations. module Issues and PRs related to the module subsystem. errors Issues and PRs related to JavaScript errors originated in Node.js core. labels Jul 19, 2018

Sort mine (and others') references

53cb1c2

jasnell reviewed Jul 20, 2018

View reviewed changes

Revert anchor revert

ec9e432

jasnell approved these changes Jul 20, 2018

View reviewed changes

vsemozhetbyt closed this Jul 22, 2018

targos mentioned this pull request Jul 31, 2018

v10.8.0 proposal #22040

Merged


		Creation of a [`zlib`][] object failed due to incorrect configuration.

		### MODULE_NOT_FOUND


		### MODULE_NOT_FOUND

		A module file could not be resolved while attempting a [`require`][] or

Uh oh!

Conversation

DullReferenceException commented Jul 19, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Checklist

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mscdex Jul 19, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

vsemozhetbyt left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mscdex commented Jul 19, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jasnell commented Jul 20, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

vsemozhetbyt commented Jul 22, 2018

Uh oh!

vsemozhetbyt commented Jul 22, 2018

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

DullReferenceException commented Jul 19, 2018 •

edited

Loading

mscdex Jul 19, 2018 •

edited

Loading

mscdex commented Jul 19, 2018 •

edited

Loading