docs: add docs to require() by ErickWendel · Pull Request #23605 · nodejs/node · GitHub

Checklist

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

#23106

/cc @nodejs/documentation

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

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

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

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

squashed

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

fixed! :D

PR-URL: nodejs#23605 Reviewed-By: Denys Otrishko <shishugi@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>

LGTM

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

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

Nit: Importing a local module.

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

Addressing nits and clarifications

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

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?

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

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

Landed in 51cd971

PR-URL: nodejs#23605 Reviewed-By: Denys Otrishko <shishugi@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: James M Snell <jasnell@gmail.com>

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 <shishugi@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: James M Snell <jasnell@gmail.com>

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

Comment thread doc/api/modules.md Outdated

Comment thread doc/api/modules.md Outdated

vsemozhetbyt reviewed Oct 12, 2018

View reviewed changes

Comment thread doc/api/modules.md Outdated

Comment thread doc/api/modules.md Outdated

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 outstanding review comments, 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

-              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

               * {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 `'./'`.

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

docs: add docs to require() by ErickWendel · Pull Request #23605 · nodejs/node · GitHub

Uh oh!

Uh oh!

docs: add docs to require() - #23605

docs: add docs to require()#23605ErickWendel wants to merge 2 commits intonodejs:masternodejs/node:masterfrom ErickWendel:docs/requireErickWendel/node:docs/requireCopy head branch name to clipboard

Conversation

ErickWendel commented Oct 12, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Checklist

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ChALkeR commented Oct 12, 2018

Uh oh!

vsemozhetbyt commented Oct 12, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ChALkeR commented Oct 12, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ErickWendel commented Oct 12, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

a0viedo 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!

jasnell commented Oct 16, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

BridgeAR Oct 17, 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!

apapirovski commented Oct 18, 2018

Uh oh!

addaleax commented Oct 21, 2018

Uh oh!

Trott commented Oct 24, 2018

Uh oh!

Trott commented Oct 24, 2018

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

15 participants

docs: add docs to require()#23605
ErickWendel wants to merge 2 commits into
nodejs:masterfrom
ErickWendel:docs/require

ErickWendel commented Oct 12, 2018 •
edited
Loading

ChALkeR commented Oct 12, 2018 •
edited
Loading

BridgeAR Oct 17, 2018 •
edited
Loading