Skip to content

doc: add doc for --loader option #22104

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
SirR4T wants to merge 6 commits into from
Closed

doc: add doc for --loader option #22104

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
a9e150b
doc: add doc for --loader option
Aug 3, 2018
1b930e2
doc: fix typos in doc for --loader option
Aug 6, 2018
1553d78
doc: add docs for --loader in man pages as well as ./node --help
Aug 6, 2018
d90e3ea
doc: fix linter issue in cli.md
Aug 6, 2018
188fb32
doc: mention that --loader option is experimental
Aug 16, 2018
6e6192b
doc: md references should be alphabetical
Aug 16, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
doc: mention that --loader option is experimental
  • Loading branch information
Sarat Addepalli committed Aug 16, 2018
commit 188fb32502989d8c40166d06c63c3c788b57543e
4 changes: 2 additions & 2 deletions doc/api/cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ tcp port and communicate using the [Chrome DevTools Protocol][].
added: v9.0.0
-->

Specify the `file` as a custom loader, to load [ECMAScript Modules][].
Specify the `file` of the custom [experimental ECMAScript Module][] loader.

### `--napi-modules`
<!-- YAML
Expand Down Expand Up @@ -694,4 +694,4 @@ greater than `4` (its current default value). For more information, see the
[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
[ECMAScript Modules]: esm.html#esm_loader_hooks
[experimental ECMAScript Module]: esm.html#esm_loader_hooks
Copy link
Copy Markdown
Contributor

@vsemozhetbyt vsemozhetbyt Aug 16, 2018 •
edited
Loading

Choose a reason for hiding this comment

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

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

Copy link
Copy Markdown
Author

@SirR4T SirR4T Aug 16, 2018 •
edited
Loading

Choose a reason for hiding this comment

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

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

Copy link
Copy Markdown
Contributor

@vsemozhetbyt vsemozhetbyt Aug 16, 2018

Choose a reason for hiding this comment

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

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

@SirR4T SirR4T Aug 17, 2018

Choose a reason for hiding this comment

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

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

@vsemozhetbyt vsemozhetbyt Aug 17, 2018

Choose a reason for hiding this comment

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

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

@rubys rubys Aug 17, 2018

Choose a reason for hiding this comment

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

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.