FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

doc: add doc for --loader option by SirR4T · Pull Request #22104 · nodejs/node · GitHub

/ node Public

doc: add doc for --loader option - #22104

Closed
SirR4T wants to merge 6 commits into
nodejs:masterfrom
SirR4T:addCliDocForLoader
Closed

doc: add doc for --loader option#22104
SirR4T wants to merge 6 commits into
nodejs:masterfrom
SirR4T:addCliDocForLoader

Conversation

SirR4T commented Aug 3, 2018

Copy link
Copy Markdown

Fixes #21230

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

nodejs-github-bot added cli Issues and PRs related to the Node.js command line interface. doc Issues and PRs related to the documentations. labels Aug 3, 2018
Comment thread doc/api/cli.md 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.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

s/customer/custom

Also, it should be noted that this is still an experimental feature.

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.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

I believe it's been brought up before but given that --loader is still experimental I think it would it be better if it were --experimental-loader in much the same way other experimental stuff is prefixed with --experimental-

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.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

@jdalton given you have to run node with --experimental-modules anyway to use this - why?

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

thanks @jasnell ! fixed the typo.
Should i mention here, that it needs to be used with --experimental-modules?

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.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

@benjamingr

given you have to run node with --experimental-modules anyway to use this - why?

I like the consistency of the --experimental- prefix for experimental things. The prefix makes it explicit that the feature/sub-feature is experimental.

Comment thread doc/api/cli.md 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.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

esm.html#esm_loader_hooks?

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

thanks! fixed now.

Copy link
Copy Markdown
Contributor

cc @nodejs/modules-active-members?

Copy link
Copy Markdown
Contributor

It seems doc/node.1 and PrintHelp() in src/node.cc should also be updated?

vsemozhetbyt added the esm Issues and PRs related to the ECMAScript Modules implementation. label Aug 3, 2018
SirR4T force-pushed the addCliDocForLoader branch from 2406e35 to 9d6356d Compare August 6, 2018 05:08

SirR4T commented Aug 6, 2018

Copy link
Copy Markdown
Author

@vsemozhetbyt Added docs for node.1 and src/node.cc, though I couldn't maintain consistency in the doc strings. Is that fine?

Copy link
Copy Markdown
Contributor

cc @nodejs/documentation for node.1 and src/node.cc changes.

Copy link
Copy Markdown
Contributor

Linter issue:

doc/api/cli.md
  1:1  warning  Missing newline character at end of file  final-newline  remark-lint

SirR4T commented Aug 6, 2018

Copy link
Copy Markdown
Author

@vsemozhetbyt thanks, installed markdown linter now. Will ensure i run this, before pushing any more doc updates.

Copy link
Copy Markdown
Contributor

cc @nodejs/build-infra re CI error:

not ok 2295 sequential/test-fs-watch
  ---
  duration_ms: 0.111
  severity: fail
  exitcode: 1
  stack: |-
    internal/fs/watchers.js:170
        throw error;
        ^
    
    Error: ENOSPC: no space left on device, watch '/home/travis/build/nodejs/node/test/.tmp.0/watch.txt'

This comment has been minimized.

SirR4T force-pushed the addCliDocForLoader branch from 0dea374 to 341d4b0 Compare August 8, 2018 06:03

This comment has been minimized.

Copy link
Copy Markdown
Contributor

@nodejs/documentation Can anybody confident enough look into node.1 and node.cc changes so we could have some more LGTM?

This comment has been minimized.

This comment has been minimized.

SirR4T force-pushed the addCliDocForLoader branch from 341d4b0 to a88503c Compare August 9, 2018 04:19

This comment has been minimized.

Copy link
Copy Markdown
Contributor

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

If CI is green, I will land this PR tomorrow if nobody objects.

SirR4T force-pushed the addCliDocForLoader branch from a88503c to b4d15f5 Compare August 10, 2018 05:14

sagirk left a comment

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.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

LGTM! 🎉

Copy link
Copy Markdown
Contributor

In last CIs, it seems we have some repetitive fails in parallel/test-cli-node-print-help in node-test-commit-linux-containered that may be relative. Can anybody look into?

One more CI to be sure: https://ci.nodejs.org/job/node-test-pull-request/16332/

SirR4T commented Aug 10, 2018
edited
Loading

Copy link
Copy Markdown
Author

@vsemozhetbyt sorry, this maybe completely off topic, but why are --experimental-modules, --experimental-vm-modules, and --preserve-symlinks predicated on having i18n support?

Copy link
Copy Markdown
Contributor

Sorry, this also puzzled me and I thought that it was because I just did not know C++ :)

SirR4T force-pushed the addCliDocForLoader branch from b4d15f5 to b4897b6 Compare August 16, 2018 04:45

SirR4T commented Aug 16, 2018

Copy link
Copy Markdown
Author

@jdalton : updated the doc for --loader option. Sounds good? Open to other wordings / text as well, to put the "experimental" point across.

jdalton commented Aug 16, 2018

Copy link
Copy Markdown
Member

@SirR4T It's better. But --loader is also experimental. So maybe something like

Specify the file of the custom [experimental ECMAScript module][] loader.

SirR4T force-pushed the addCliDocForLoader branch from b4897b6 to 188fb32 Compare August 16, 2018 06:26

SirR4T commented Aug 16, 2018

Copy link
Copy Markdown
Author

thanks, @jdalton , fixed.

Comment thread doc/api/cli.md
[debugger]: debugger.html
[emit_warning]: process.html#process_process_emitwarning_warning_type_code_ctor
[libuv threadpool documentation]: http://docs.libuv.org/en/latest/threadpool.html
[experimental ECMAScript Module]: esm.html#esm_loader_hooks

vsemozhetbyt Aug 16, 2018
edited
Loading

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.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Nit: reference list is sorted in ASCII order, so this item needs to be placed before the [libuv threadpool documentation].

SirR4T Aug 16, 2018
edited
Loading

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Sure, will fix that. Any way we could add this as a rule to make lint?

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.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

It would be helpful to have it as a rule as we are already a bit messy in some docs in these sections,

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Would updating remark-preset-lint-node to also include remark-lint-alphabetize-lists work? I expect this would cause build failures, if remark-preset-lint-node was updated before fixes for that landed in master. How would the transition be handled?

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.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

I am not sure that remark-lint-alphabetize-lists can fix this case as reference lists are not common markdown lists. Maybe @rubys can tell if there is a ready easy solution for this?

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.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Remark calls those lines definitions. Looking at the source to remark-lint-alphabetize-lists
, if list where changed to definition on line 18, the code would do what you want.

vsemozhetbyt removed the blocked PRs that are blocked by other issues or PRs. label Aug 16, 2018

Copy link
Copy Markdown
Contributor

#22271 is merged, so let's unblock and run CI:
https://ci.nodejs.org/job/node-test-pull-request/16490/

vsemozhetbyt commented Aug 16, 2018
edited
Loading

Copy link
Copy Markdown
Contributor

Copy link
Copy Markdown
Contributor

Landed in 9d6619e
Thank you!

vsemozhetbyt pushed a commit that referenced this pull request Aug 18, 2018
PR-URL: #22104
Fixes: #21230
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: John-David Dalton <john.david.dalton@gmail.com>
targos pushed a commit that referenced this pull request Aug 19, 2018
PR-URL: #22104
Fixes: #21230
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: John-David Dalton <john.david.dalton@gmail.com>
SirR4T deleted the addCliDocForLoader branch August 22, 2018 05:31
targos pushed a commit that referenced this pull request Sep 3, 2018
PR-URL: #22104
Fixes: #21230
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: John-David Dalton <john.david.dalton@gmail.com>
This file contains hidden or 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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cli Issues and PRs related to the Node.js command line interface. doc Issues and PRs related to the documentations. esm Issues and PRs related to the ECMAScript Modules implementation.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

doc: missing cli options

9 participants


Back | FazBrowse Home | New Git URL