Rich Trott
0991dfcece
doc: add blank line between comments
...
Upcoming remark-based formatting/linting will add a blank line between
comments in markdown. This is in preparation for that change.
PR-URL: https://github.com/nodejs/node/pull/40160
Reviewed-By: Michaël Zasso <targos@protonmail.com >
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Luigi Pinca <luigipinca@gmail.com >
2021-09-21 18:40:04 -07:00
foxxyz
6fdd5827f0
doc: anchor link parity between markdown and html-generated docs
...
Main changes:
- Replace current HTML anchor generation to match
header anchor generation in Github markdown.
- Remove unnecessary double namespacing on generated anchors/links (E.G.
`esm.md#loaders` instead of `esm.md#esm_loaders`).
- Anchors/links are automatically prefixed with their respective modules
when concatenated for usage in `all.html`.
Benefits:
- All anchor links within and between markdown API docs actually work.
- Adding new anchor links no longer requires contributors to generate
the HTML docs first to look up the correct anchors.
- Anchors are much shorter.
- All previous anchor links are preserved by generating hidden legacy
anchors.
PR-URL: https://github.com/nodejs/node/pull/39304
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com >
2021-08-30 00:40:20 +02:00
Antoine du Hamel
0afc8ac12e
tools: add support for mjs and cjs JS snippet linting
...
Refs: https://github.com/nodejs/node/pull/37162
Refs: https://github.com/nodejs/remark-preset-lint-node/pull/176
PR-URL: https://github.com/nodejs/node/pull/37311
Refs: https://github.com/eslint/eslint-plugin-markdown/pull/172
Reviewed-By: Rich Trott <rtrott@gmail.com >
2021-03-06 16:05:39 +01:00
Antoine du Hamel
674614b3f5
module: remove module.createRequireFromPath
...
PR-URL: https://github.com/nodejs/node/pull/37201
Reviewed-By: Myles Borins <myles.borins@gmail.com >
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com >
Reviewed-By: Geoffrey Booth <webmaster@geoffreybooth.com >
Reviewed-By: Michaël Zasso <targos@protonmail.com >
Reviewed-By: Rich Trott <rtrott@gmail.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
2021-02-15 07:03:08 -08:00
Antoine du Hamel
3b40893815
doc: fix 404 links in module.md
...
PR-URL: https://github.com/nodejs/node/pull/37202
Reviewed-By: Zijian Liu <lxxyxzj@gmail.com >
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com >
Reviewed-By: Beth Griggs <bgriggs@redhat.com >
Reviewed-By: Darshan Sen <raisinten@gmail.com >
2021-02-03 21:01:36 +08:00
Antoine du Hamel
9d7fb229db
doc: fix module.isPreloading documentation
...
Fixes: https://github.com/nodejs/node/issues/36775
PR-URL: https://github.com/nodejs/node/pull/36944
Refs: https://github.com/nodejs/node/pull/36263
Reviewed-By: Luigi Pinca <luigipinca@gmail.com >
Reviewed-By: Gerhard Stöbich <deb2001-github@yahoo.de >
Reviewed-By: James M Snell <jasnell@gmail.com >
2021-01-18 10:37:52 -08:00
Bruce A. MacNaughton
28e9c10003
doc: fix module syncBuiltinESMExports example
...
Fix failing code and add explanations of each assert.
PR-URL: https://github.com/nodejs/node/pull/34284
Reviewed-By: Guy Bedford <guybedford@gmail.com >
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com >
2021-01-10 10:37:11 +01:00
Danielle Adams
348b7a9606
2020-12-09, Version 15.4.0 (Current)
...
PR-URL: https://github.com/nodejs/node/pull/36435
Notable changes:
* child_processes:
* add AbortSignal support (Benjamin Gruenbaum) (https://github.com/nodejs/node/pull/36308 )
* deps:
* update ICU to 68.1 (Michaël Zasso) (https://github.com/nodejs/node/pull/36187 )
* events:
* support signal in EventTarget (Benjamin Gruenbaum) (https://github.com/nodejs/node/pull/36258 )
* graduate Event, EventTarget, AbortController (James M Snell) (https://github.com/nodejs/node/pull/35949 )
* http:
* enable call chaining with setHeader() (pooja d.p) (https://github.com/nodejs/node/pull/35924 )
* module:
* add isPreloading indicator (James M Snell) (https://github.com/nodejs/node/pull/36263 )
* stream:
* support abort signal (Benjamin Gruenbaum) (https://github.com/nodejs/node/pull/36061 )
* add FileHandle support to Read/WriteStream (Momtchil Momtchev) (https://github.com/nodejs/node/pull/35922 )
* worker:
* add experimental BroadcastChannel (James M Snell) (https://github.com/nodejs/node/pull/36271 )
2020-12-09 08:49:37 -05:00
bcoe
09fd8f13c8
errors: display original symbol name
...
If symbol names array has been populated in source map, include
original symbol name in error message.
Fixes https://github.com/nodejs/node/issues/35325
PR-URL: https://github.com/nodejs/node/pull/36042
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com >
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com >
2020-12-01 07:23:56 -08:00
James M Snell
8ff2501a04
module: add isPreloading indicator
...
Adds a `module.isPreloading` property that is `true` only during the
preload (`-r`) phase of Node.js bootstrap. This provides modules an
easy, non-hacky way of knowing if they are being loaded during preload.
Signed-off-by: James M Snell <jasnell@gmail.com >
PR-URL: https://github.com/nodejs/node/pull/36263
Reviewed-By: Gerhard Stöbich <deb2001-github@yahoo.de >
Reviewed-By: Rich Trott <rtrott@gmail.com >
2020-11-30 08:26:46 -08:00
bcoe
8fa90358d7
module: refactor to use iterable-weak-map
...
Using an iterable WeakMap (a data-structure that uses WeakRef and
WeakMap), we are able to: stop relying on Module._cache to
serialize source maps; stop requiring an error object when calling
findSourceMap().
PR-URL: https://github.com/nodejs/node/pull/35915
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com >
Reviewed-By: Matteo Collina <matteo.collina@gmail.com >
2020-11-06 12:47:23 -08:00
Antoine du Hamel
ecf5060a42
doc: use .md extension for internal links
...
This helps catch broken links as part of the test suite. This also
improves the user experience when browsing the markdown files.
PR-URL: https://github.com/nodejs/node/pull/35191
Fixes: https://github.com/nodejs/node/issues/35189
Reviewed-By: Derek Lewis <DerekNonGeneric@inf.is >
Reviewed-By: Jiawen Geng <technicalcute@gmail.com >
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com >
Reviewed-By: Richard Lau <riclau@uk.ibm.com >
Reviewed-By: Rich Trott <rtrott@gmail.com >
2020-10-01 06:19:12 -07:00
Rich Trott
665330134c
doc: make minor improvements to module.md
...
* sort references in ASCII order
* replace abbreviation
* split comma splice into two sentences and add appropriate punctuation
* replace future tense with present tense
PR-URL: https://github.com/nodejs/node/pull/35083
Reviewed-By: Geoffrey Booth <webmaster@geoffreybooth.com >
Reviewed-By: Derek Lewis <DerekNonGeneric@inf.is >
Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com >
2020-09-08 17:22:37 -07:00
Antoine du HAMEL
b0cc6572b0
doc: add ESM examples in module API doc page
...
PR-URL: https://github.com/nodejs/node/pull/34875
Reviewed-By: Myles Borins <myles.borins@gmail.com >
Reviewed-By: Guy Bedford <guybedford@gmail.com >
2020-09-06 16:39:11 -04:00
Antoine du HAMEL
22e3ada0c1
doc: rename module pages
...
Using a "Modules:" prefix groups all the related pages together when
using alphabetical order.
Refs: https://github.com/nodejs/modules/issues/539
PR-URL: https://github.com/nodejs/node/pull/34663
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Guy Bedford <guybedford@gmail.com >
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com >
Reviewed-By: Geoffrey Booth <webmaster@geoffreybooth.com >
Reviewed-By: Rich Trott <rtrott@gmail.com >
2020-08-23 04:59:42 -07:00
Rich Trott
9d81d1266c
doc: sort references lexically
...
Keep references sorted in ASCII order in module.md.
PR-URL: https://github.com/nodejs/node/pull/34848
Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Ricky Zhou <0x19951125@gmail.com >
2020-08-20 10:26:36 -07:00
Antoine du HAMEL
21abb2545f
doc: move module core module doc to separate page
...
The `module` core module is available for both CJS and ESM users, it
deserves its own page.
PR-URL: https://github.com/nodejs/node/pull/34747
Refs: https://github.com/nodejs/modules/issues/539
Reviewed-By: Anna Henningsen <anna@addaleax.net >
Reviewed-By: James M Snell <jasnell@gmail.com >
2020-08-19 10:44:06 -07:00