docs: add docs to require() #23605

ErickWendel · 2018-10-12T18:42:14Z

Checklist

make -j4 test (UNIX), or vcbuild test (Windows) passes
documentation is changed or added
commit message follows commit guidelines

#23106

doc/api/modules.md

ChALkeR · 2018-10-12T21:24:50Z

/cc @nodejs/documentation

vsemozhetbyt · 2018-10-12T21:28:54Z

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

lundibundi · 2018-10-12T21:30:50Z

doc/api/modules.md

@@ -552,7 +552,18 @@ added: v0.1.13

 * {Function}

-To require modules.
+Used to import modules, `JSON` and local files. Modules can be imported from `node_modules`. Local modules and JSON files can be imported using the pattern `'./`.


The general rule is to have lines be at most 80 chars, though this can be fixed at landing.

ChALkeR · 2018-10-12T21:33:09Z

This probably should be squashed (could be done at landing).

ErickWendel · 2018-10-12T22:11:53Z

This probably should be squashed (could be done at landing).

squashed

gireeshpunathil · 2018-10-13T04:56:49Z

doc/api/modules.md

@@ -552,7 +552,18 @@ added: v0.1.13

 * {Function}

-To require modules.
+Used to import modules, `JSON` and local files. Modules can be imported from `node_modules`. Local modules and JSON files can be imported using the pattern `'./`.


is there a single quote missing between the back-quotes?

PR-URL: nodejs#23605 Reviewed-By: Denys Otrishko <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: Gireesh Punathil <[email protected]>

a0viedo

LGTM

thefourtheye · 2018-10-15T13:09:30Z

doc/api/modules.md

@@ -552,7 +552,18 @@ added: v0.1.13

 * {Function}

-To require modules.
+Used to import modules, `JSON` and local files. Modules can be imported from `node_modules`. Local modules and JSON files can be imported using the pattern `'./'`.


Nit: This line is more than 80 characters I believe.

Nit: Also, mentioning "relative path" would be better here, maybe with ./ in the brackets.

thefourtheye · 2018-10-15T13:11:59Z

doc/api/modules.md

+Used to import modules, `JSON` and local files. Modules can be imported from `node_modules`. Local modules and JSON files can be imported using the pattern `'./'`.
+
+```js
+// importing localModule


Nit: Importing a local module.

thefourtheye · 2018-10-15T13:12:59Z

doc/api/modules.md

+// importing JSON file
+const jsonData = require('./path/filename.json');
+
+// importing module from node_modules or Node.js internals


Nit: Node.js built-in module would be better I believe

Addressing nits and clarifications

jasnell · 2018-10-16T14:58:57Z

@ErickWendel .. certainly hope you don't mind, but I went ahead and pushed an additional commit that handled @thefourtheye's nits and added a further clarification.

lundibundi · 2018-10-16T16:38:19Z

doc/api/modules.md

-Used to import modules, `JSON` and local files. Modules can be imported from `node_modules`. Local modules and JSON files can be imported using the pattern `'./'`.
+Used to import modules, `JSON`, and local files. Modules can be imported
+from `node_modules`. Local modules and JSON files can be imported using
+a relative path (e.g. `./`, `./foo`, `./bar/baz`, `../foo`) that will be


Should we perhaps also note that path-resolution is OS independent (given that we are providing examples in Linux/Unix flavor)?

@lundibundi I think that would be a good addition but it could also land in a separate PR?

apapirovski · 2018-10-18T04:51:47Z

CI: https://ci.nodejs.org/job/node-test-pull-request/17966/

addaleax · 2018-10-21T04:07:39Z

Resume CI: https://ci.nodejs.org/job/node-test-pull-request/18019/

Trott · 2018-10-24T04:01:37Z

Landed in 51cd971

PR-URL: nodejs#23605 Reviewed-By: Denys Otrishko <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: Gireesh Punathil <[email protected]> Reviewed-By: Sakthipriyan Vairamani <[email protected]> Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: James M Snell <[email protected]>

Trott · 2018-10-24T04:01:56Z

Thanks for the contribution! 🎉

(If you're interested in other possible contributions to Node.js but don't have a good idea of where to start looking, some ideas are posted at https://www.nodetodo.org/next-steps/.)

PR-URL: #23605 Reviewed-By: Denys Otrishko <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: Gireesh Punathil <[email protected]> Reviewed-By: Sakthipriyan Vairamani <[email protected]> Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: James M Snell <[email protected]>

nodejs-github-bot added doc Issues and PRs related to the documentations. module Issues and PRs related to the module subsystem. labels Oct 12, 2018

jasnell added the code-and-learn Issues related to the Code-and-Learn events and PRs submitted during the events. label Oct 12, 2018

ErickWendel force-pushed the docs/require branch from a3c6917 to 7895992 Compare October 12, 2018 18:51

lundibundi reviewed Oct 12, 2018

View reviewed changes

doc/api/modules.md Outdated Show resolved Hide resolved

doc/api/modules.md Outdated Show resolved Hide resolved

vsemozhetbyt reviewed Oct 12, 2018

View reviewed changes

doc/api/modules.md Outdated Show resolved Hide resolved

doc/api/modules.md Outdated Show resolved Hide resolved

lundibundi approved these changes Oct 12, 2018

View reviewed changes

ErickWendel force-pushed the docs/require branch from a88cac9 to e908b9e Compare October 12, 2018 22:10

trivikr approved these changes Oct 12, 2018

View reviewed changes

gireeshpunathil reviewed Oct 13, 2018

View reviewed changes

gireeshpunathil approved these changes Oct 13, 2018

View reviewed changes

docs: add review suggestions to require()

18f6f8e

ErickWendel force-pushed the docs/require branch from e908b9e to 18f6f8e Compare October 13, 2018 23:43

a0viedo approved these changes Oct 15, 2018

View reviewed changes

thefourtheye approved these changes Oct 15, 2018

View reviewed changes

[Squash] nits and clarification

47ce291

Addressing nits and clarifications

vsemozhetbyt approved these changes Oct 16, 2018

View reviewed changes

lundibundi approved these changes Oct 16, 2018

View reviewed changes

BridgeAR approved these changes Oct 17, 2018

View reviewed changes

BridgeAR added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Oct 17, 2018

jasnell approved these changes Oct 18, 2018

View reviewed changes

Trott closed this Oct 24, 2018

targos mentioned this pull request Oct 27, 2018

Release proposal: v11.1.0 #23922

Merged

Trott mentioned this pull request Nov 18, 2018

Incomplete documentation require() #23106

Closed

MylesBorins added land-on-v8.x labels Nov 26, 2018

codebytere mentioned this pull request Nov 27, 2018

v10.13.1 proposal #24675

Closed

codebytere mentioned this pull request Nov 29, 2018

v10.14.2 proposal #24727

Merged

BethGriggs mentioned this pull request Dec 4, 2018

v8.14.1 proposal #24832

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: add docs to require() #23605

docs: add docs to require() #23605

ErickWendel commented Oct 12, 2018 •

edited

Loading

ChALkeR commented Oct 12, 2018

vsemozhetbyt commented Oct 12, 2018

lundibundi Oct 12, 2018

ChALkeR commented Oct 12, 2018 •

edited

Loading

ErickWendel commented Oct 12, 2018

gireeshpunathil Oct 13, 2018

ErickWendel Oct 13, 2018

a0viedo left a comment

thefourtheye Oct 15, 2018

thefourtheye Oct 15, 2018

thefourtheye Oct 15, 2018

thefourtheye Oct 15, 2018

jasnell commented Oct 16, 2018

lundibundi Oct 16, 2018

BridgeAR Oct 17, 2018 •

edited

Loading

apapirovski commented Oct 18, 2018

addaleax commented Oct 21, 2018

Trott commented Oct 24, 2018

Trott commented Oct 24, 2018

docs: add docs to require() #23605

docs: add docs to require() #23605

Conversation

ErickWendel commented Oct 12, 2018 • edited Loading

Checklist

ChALkeR commented Oct 12, 2018

vsemozhetbyt commented Oct 12, 2018

Choose a reason for hiding this comment

ChALkeR commented Oct 12, 2018 • edited Loading

ErickWendel commented Oct 12, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

a0viedo left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jasnell commented Oct 16, 2018

Choose a reason for hiding this comment

BridgeAR Oct 17, 2018 • edited Loading

Choose a reason for hiding this comment

apapirovski commented Oct 18, 2018

addaleax commented Oct 21, 2018

Trott commented Oct 24, 2018

Trott commented Oct 24, 2018

ErickWendel commented Oct 12, 2018 •

edited

Loading

ChALkeR commented Oct 12, 2018 •

edited

Loading

BridgeAR Oct 17, 2018 •

edited

Loading