esm: jsdoc for modules code by GeoffreyBooth · Pull Request #49523 · nodejs/node

GeoffreyBooth · 2023-09-07T05:27:08Z

This PR adds JSDoc annotations for all the files in lib/internal/modules/* as well as a lint rule to enforce keeping that code annotated.

nodejs-github-bot · 2023-09-07T05:27:13Z

Review requested:

@nodejs/loaders

.eslintrc.js

aduh95 · 2023-09-08T10:40:09Z

Adding https://github.com/nodejs/node/labels/backport-requested-v20.x because we probably don't want to land the lint rule there, it's likely going to cause conflicts.

lib/internal/dns/promises.js

GeoffreyBooth · 2023-09-14T06:34:20Z

Okay, all the functions have JSDoc comments. If the folks who have been around for a long time can kindly review this, I and GitHub Copilot would appreciate some double-checking of our work from the original authors of the modules code.

lib/internal/modules/esm/create_dynamic_module.js

lib/internal/modules/esm/fetch_module.js

lib/internal/modules/esm/formats.js

lib/internal/modules/esm/loader.js

nodejs-github-bot · 2023-09-17T05:03:21Z

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

nodejs-github-bot · 2023-09-17T05:15:45Z

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

nodejs-github-bot · 2023-09-18T03:40:08Z

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

nodejs-github-bot · 2023-09-18T04:46:12Z

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

nodejs-github-bot · 2023-09-18T12:59:38Z

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

nodejs-github-bot · 2023-09-18T14:23:18Z

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

nodejs-github-bot · 2023-09-19T02:48:26Z

Landed in 7517c9f

PR-URL: nodejs#49523 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>

PR-URL: #49523 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>

PR-URL: nodejs#49523 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>

PR-URL: #49523 Backport-PR-URL: #50669 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>

nodejs/node#49523

* chore: bump node in DEPS to v20.10.0 * chore: update feat_initialize_asar_support.patch no code changes; patch just needed an update due to nearby upstream changes Xref: nodejs/node#49986 * chore: update pass_all_globals_through_require.patch no manual changes; patch applied with fuzz Xref: nodejs/node#49657 * chore: update refactor_allow_embedder_overriding_of_internal_fs_calls Xref: nodejs/node#49912 no code changes; patch just needed an update due to nearby upstream changes * chore: update chore_allow_the_node_entrypoint_to_be_a_builtin_module.patch Xref: nodejs/node#49986 minor manual changes needed to sync with upstream change * update fix_expose_the_built-in_electron_module_via_the_esm_loader.patch Xref: nodejs/node#50096 Xref: nodejs/node#50314 in lib/internal/modules/esm/load.js, update the code that checks for `format === 'electron'`. I'd like 👀 on this Xref: nodejs/node#49657 add braces in lib/internal/modules/esm/translators.js to sync with upstream * fix: lazyload fs in esm loaders to apply asar patches * nodejs/node#50127 * nodejs/node#50096 * esm: jsdoc for modules code nodejs/node#49523 * test: set test-cli-node-options as flaky nodejs/node#50296 * deps: update c-ares to 1.20.1 nodejs/node#50082 * esm: bypass CommonJS loader under --default-type=module nodejs/node#49986 * deps: update uvwasi to 0.0.19 nodejs/node#49908 * lib,test: do not hardcode Buffer.kMaxLength nodejs/node#49876 * crypto: account for disabled SharedArrayBuffer nodejs/node#50034 * test: fix edge snapshot stack traces nodejs/node#49659 * src: generate snapshot with --predictable nodejs/node#48749 * chore: fixup patch indices * fs: throw errors from sync branches instead of separate implementations nodejs/node#49913 * crypto: ensure valid point on elliptic curve in SubtleCrypto.importKey nodejs/node#50234 * esm: detect ESM syntax in ambiguous JavaScrip nodejs/node#50096 * fixup! test: fix edge snapshot stack traces * esm: unflag extensionless ES module JavaScript and Wasm in module scope nodejs/node#49974 * [tagged-ptr] Arrowify objects https://chromium-review.googlesource.com/c/v8/v8/+/4705331 --------- Co-authored-by: electron-roller[bot] <84116207+electron-roller[bot]@users.noreply.github.com> Co-authored-by: Charles Kerr <charles@charleskerr.com> Co-authored-by: Shelley Vohr <shelley.vohr@gmail.com>

PR-URL: nodejs/node#49523 Backport-PR-URL: nodejs/node#50669 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>

GeoffreyBooth added the esm Issues and PRs related to the ECMAScript Modules implementation. label Sep 7, 2023

nodejs-github-bot added lib / src Issues and PRs related to general changes in the lib or src directory. needs-ci PRs that need a full CI run. labels Sep 7, 2023

anonrig reviewed Sep 7, 2023

View reviewed changes

.eslintrc.js Outdated Show resolved Hide resolved

aduh95 added dont-land-on-v18.x backport-requested-v20.x PRs awaiting manual backport to the v20.x-staging branch. labels Sep 8, 2023

GeoffreyBooth force-pushed the tidy-modules-code branch from 1c78689 to aea0d64 Compare September 10, 2023 05:23

GeoffreyBooth commented Sep 10, 2023

View reviewed changes

lib/internal/dns/promises.js Outdated Show resolved Hide resolved

JakobJingleheimer force-pushed the tidy-modules-code branch from 9504d58 to 2f48a32 Compare September 10, 2023 15:37

GeoffreyBooth force-pushed the tidy-modules-code branch from c8be6a5 to 9fe5fde Compare September 14, 2023 06:30

GeoffreyBooth marked this pull request as ready for review September 14, 2023 06:31

aduh95 reviewed Sep 14, 2023

View reviewed changes

GeoffreyBooth force-pushed the tidy-modules-code branch from 3e7fdb4 to e564349 Compare September 14, 2023 22:02

GeoffreyBooth mentioned this pull request Sep 14, 2023

esm: require braces for modules code #49657

Merged

GeoffreyBooth force-pushed the tidy-modules-code branch from e564349 to 9cd82da Compare September 15, 2023 19:32

jasnell approved these changes Sep 16, 2023

View reviewed changes

GeoffreyBooth force-pushed the tidy-modules-code branch from ca693a7 to 418feec Compare September 17, 2023 05:02

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

GeoffreyBooth force-pushed the tidy-modules-code branch from 9bd2493 to 81baff7 Compare September 18, 2023 03:24

GeoffreyBooth changed the title ~~esm: jsdoc, style for modules code~~ esm: jsdoc for modules code Sep 18, 2023

GeoffreyBooth added the commit-queue Add this label to land a pull request using GitHub Actions. label Sep 18, 2023

GeoffreyBooth added the commit-queue Add this label to land a pull request using GitHub Actions. label Sep 19, 2023

nodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Sep 19, 2023

nodejs-github-bot merged commit 7517c9f into nodejs:main Sep 19, 2023

GeoffreyBooth deleted the tidy-modules-code branch September 19, 2023 02:55

This was referenced Sep 20, 2023

CI Reliability 2023-09-20 nodejs/reliability#671

Open

CI Reliability 2023-09-21 nodejs/reliability#672

Open

CI Reliability 2023-09-22 nodejs/reliability#673

Open

RafaelGSS mentioned this pull request Oct 9, 2023

2023-10-17, Version 21.0.0 (Current) #49870

Merged

aduh95 pushed a commit to aduh95/node that referenced this pull request Oct 14, 2023

module, esm: jsdoc for modules files

39f107f

PR-URL: nodejs#49523 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>

aduh95 mentioned this pull request Oct 14, 2023

[v20.x backport] esm: use import attributes instead of import assertions #50183

Closed

aduh95 added backport-open-v20.x Indicate that the PR has an open backport and removed backport-requested-v20.x PRs awaiting manual backport to the v20.x-staging branch. labels Oct 14, 2023

alexfernandez pushed a commit to alexfernandez/node that referenced this pull request Nov 1, 2023

module, esm: jsdoc for modules files

4ab2771

PR-URL: nodejs#49523 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>

targos pushed a commit to targos/node that referenced this pull request Nov 11, 2023

module, esm: jsdoc for modules files

b5ff670

PR-URL: nodejs#49523 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>

targos mentioned this pull request Nov 11, 2023

[v18.x] Backport most ESM and customization hook changes #50669

Closed

targos pushed a commit that referenced this pull request Nov 11, 2023

module, esm: jsdoc for modules files

142ac3f

PR-URL: #49523 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>

targos pushed a commit to targos/node that referenced this pull request Nov 11, 2023

module, esm: jsdoc for modules files

bd4eda0

PR-URL: nodejs#49523 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>

targos mentioned this pull request Nov 12, 2023

v20.10.0 release proposal #50682

Merged

targos added backported-to-v20.x PRs backported to the v20.x-staging branch. and removed backport-open-v20.x Indicate that the PR has an open backport labels Nov 12, 2023

targos added backported-to-v18.x and removed dont-land-on-v18.x labels Nov 23, 2023

targos pushed a commit that referenced this pull request Nov 23, 2023

module, esm: jsdoc for modules files

9757989

PR-URL: #49523 Backport-PR-URL: #50669 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>

targos mentioned this pull request Nov 28, 2023

v18.19.0 release proposal #50953

Merged

juanarbol mentioned this pull request Dec 6, 2023

2023-12-06, N|Solid v5.0.1 Iron Release nodesource/nsolid#41

Merged

codebytere added a commit to electron/electron that referenced this pull request Dec 8, 2023

esm: jsdoc for modules code

9ad8073

nodejs/node#49523

sercher added a commit to sercher/graaljs that referenced this pull request Apr 25, 2024

module, esm: jsdoc for modules files

fbbf593

PR-URL: nodejs/node#49523 Backport-PR-URL: nodejs/node#50669 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>

sercher added a commit to sercher/graaljs that referenced this pull request Apr 25, 2024

module, esm: jsdoc for modules files

ec2279a

PR-URL: nodejs/node#49523 Backport-PR-URL: nodejs/node#50669 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>

Uh oh!

Conversation

GeoffreyBooth commented Sep 7, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

nodejs-github-bot commented Sep 7, 2023

Uh oh!

Uh oh!

aduh95 commented Sep 8, 2023 • edited by anonrig Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

GeoffreyBooth commented Sep 14, 2023

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

nodejs-github-bot commented Sep 17, 2023

Uh oh!

nodejs-github-bot commented Sep 17, 2023

Uh oh!

nodejs-github-bot commented Sep 18, 2023

Uh oh!

nodejs-github-bot commented Sep 18, 2023

Uh oh!

nodejs-github-bot commented Sep 18, 2023

Uh oh!

nodejs-github-bot commented Sep 18, 2023

Uh oh!

nodejs-github-bot commented Sep 19, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

GeoffreyBooth commented Sep 7, 2023 •

edited

Loading

aduh95 commented Sep 8, 2023 •

edited by anonrig

Loading