GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — esm: jsdoc for modules code by GeoffreyBooth · Pull Request #49523 · nodejs/node

Conversation

@GeoffreyBooth

@GeoffreyBooth GeoffreyBooth commented Sep 7, 2023 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Member

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.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

JakobJingleheimer and aduh95 reacted with heart emoji
All reactions
  • ❤️ 2 reactions
@GeoffreyBooth GeoffreyBooth added the esm Issues and PRs related to the ECMAScript Modules implementation. label Sep 7, 2023
@nodejs-github-bot

nodejs-github-bot commented Sep 7, 2023

Copy link
Copy Markdown
Collaborator

Review requested:

  • @nodejs/loaders
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@nodejs-github-bot nodejs-github-bot added lib / src Issues and PRs involving general changes in the lib/ or src/ directories. needs-ci PRs that need a full CI run. labels Sep 7, 2023
anonrig
anonrig reviewed Sep 7, 2023
View reviewed changes
Comment thread .eslintrc.js Resolved

Uh oh!

There was an error while loading. Please reload this page.

@aduh95 aduh95 added dont-land-on-v18.x labels Sep 8, 2023
@aduh95

aduh95 commented Sep 8, 2023 •
edited by anonrig
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Contributor

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.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@GeoffreyBooth
GeoffreyBooth force-pushed the tidy-modules-code branch from 1c78689 to aea0d64 Compare September 10, 2023 05:23
GeoffreyBooth
GeoffreyBooth commented Sep 10, 2023
View reviewed changes
Comment thread lib/internal/dns/promises.js Resolved

Uh oh!

There was an error while loading. Please reload this page.

@JakobJingleheimer
JakobJingleheimer force-pushed the tidy-modules-code branch from 9504d58 to 2f48a32 Compare September 10, 2023 15:37
@GeoffreyBooth
GeoffreyBooth force-pushed the tidy-modules-code branch from c8be6a5 to 9fe5fde Compare September 14, 2023 06:30
@GeoffreyBooth
GeoffreyBooth marked this pull request as ready for review September 14, 2023 06:31
@GeoffreyBooth

GeoffreyBooth commented Sep 14, 2023

Copy link
Copy Markdown
Member Author

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.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

aduh95
aduh95 reviewed Sep 14, 2023
View reviewed changes
Comment thread lib/internal/modules/esm/create_dynamic_module.js Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread lib/internal/modules/esm/create_dynamic_module.js Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread lib/internal/modules/esm/fetch_module.js Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread lib/internal/modules/esm/fetch_module.js Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread lib/internal/modules/esm/fetch_module.js Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread lib/internal/modules/esm/formats.js Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread lib/internal/modules/esm/loader.js Resolved

Uh oh!

There was an error while loading. Please reload this page.

@GeoffreyBooth
GeoffreyBooth force-pushed the tidy-modules-code branch from 3e7fdb4 to e564349 Compare September 14, 2023 22:02
@GeoffreyBooth GeoffreyBooth mentioned this pull request Sep 14, 2023
esm: require braces for modules code #49657
Merged
@GeoffreyBooth
GeoffreyBooth force-pushed the tidy-modules-code branch from e564349 to 9cd82da Compare September 15, 2023 19:32
jasnell
jasnell approved these changes Sep 16, 2023
View reviewed changes
@GeoffreyBooth
GeoffreyBooth force-pushed the tidy-modules-code branch from ca693a7 to 418feec Compare September 17, 2023 05:02
@nodejs-github-bot

nodejs-github-bot commented Sep 17, 2023

Copy link
Copy Markdown
Collaborator

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

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@GeoffreyBooth GeoffreyBooth added the author ready PRs with CI started, the required approvals, and no outstanding review comments. label Sep 17, 2023
@nodejs-github-bot

nodejs-github-bot commented Sep 17, 2023

Copy link
Copy Markdown
Collaborator

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

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

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

nodejs-github-bot commented Sep 18, 2023

Copy link
Copy Markdown
Collaborator

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

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@GeoffreyBooth GeoffreyBooth changed the title esm: jsdoc, style for modules code esm: jsdoc for modules code Sep 18, 2023
@nodejs-github-bot

nodejs-github-bot commented Sep 18, 2023

Copy link
Copy Markdown
Collaborator

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

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@nodejs-github-bot

nodejs-github-bot commented Sep 18, 2023

Copy link
Copy Markdown
Collaborator

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

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@nodejs-github-bot

nodejs-github-bot commented Sep 18, 2023

Copy link
Copy Markdown
Collaborator

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

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@GeoffreyBooth GeoffreyBooth added the commit-queue PRs queued for automated landing through the Commit Queue. label Sep 18, 2023
@GeoffreyBooth GeoffreyBooth added the commit-queue PRs queued for automated landing through the Commit Queue. label Sep 19, 2023
@nodejs-github-bot nodejs-github-bot removed the commit-queue PRs queued for automated landing through the Commit Queue. label Sep 19, 2023
@nodejs-github-bot
nodejs-github-bot merged commit 7517c9f into nodejs:main Sep 19, 2023
@nodejs-github-bot

nodejs-github-bot commented Sep 19, 2023

Copy link
Copy Markdown
Collaborator

Landed in 7517c9f

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@GeoffreyBooth
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 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
@GeoffreyBooth @aduh95
module, esm: jsdoc for modules files
39f107f
PR-URL: nodejs#49523
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Yagiz Nizipli <[email protected]>
@aduh95 aduh95 mentioned this pull request Oct 14, 2023
[v20.x backport] esm: use import attributes instead of import assertions #50183
Closed
@aduh95 aduh95 added backport-open-v20.x and removed backport-requested-v20.x labels Oct 14, 2023
@targos 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
@GeoffreyBooth @targos
module, esm: jsdoc for modules files
142ac3f
PR-URL: #49523
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Yagiz Nizipli <[email protected]>
targos pushed a commit to targos/node that referenced this pull request Nov 11, 2023
@GeoffreyBooth @targos
module, esm: jsdoc for modules files
bd4eda0
PR-URL: nodejs#49523
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Yagiz Nizipli <[email protected]>
@targos targos mentioned this pull request Nov 12, 2023
v20.10.0 release proposal #50682
Merged
@targos targos added backported-to-v20.x and removed backport-open-v20.x labels Nov 12, 2023
@targos 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
@GeoffreyBooth @targos
module, esm: jsdoc for modules files
9757989
PR-URL: #49523
Backport-PR-URL: #50669
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Yagiz Nizipli <[email protected]>
@targos targos mentioned this pull request Nov 28, 2023
v18.19.0 release proposal #50953
Merged
@juanarbol 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
@codebytere
esm: jsdoc for modules code
9ad8073
nodejs/node#49523
codebytere added a commit to electron/electron that referenced this pull request Dec 11, 2023
@electron-roller @ckerr @codebytere
chore: bump node to v20.10.0 (main) (#40675)
890a557
* 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 <[email protected]>
Co-authored-by: Shelley Vohr <[email protected]>
sercher added a commit to sercher/graaljs that referenced this pull request Apr 25, 2024
@sercher
module, esm: jsdoc for modules files
fbbf593
PR-URL: nodejs/node#49523
Backport-PR-URL: nodejs/node#50669
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Yagiz Nizipli <[email protected]>
sercher added a commit to sercher/graaljs that referenced this pull request Apr 25, 2024
@sercher
module, esm: jsdoc for modules files
ec2279a
PR-URL: nodejs/node#49523
Backport-PR-URL: nodejs/node#50669
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Yagiz Nizipli <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@aduh95 aduh95 aduh95 left review comments
@jasnell jasnell jasnell approved these changes
@anonrig anonrig anonrig approved these changes

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

author ready PRs with CI started, the required approvals, and no outstanding review comments. commit-queue-squash PRs the Commit Queue should land as one squashed commit. esm Issues and PRs related to the ECMAScript Modules implementation. lib / src Issues and PRs involving general changes in the lib/ or src/ directories. needs-ci PRs that need a full CI run.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

7 participants

@GeoffreyBooth @nodejs-github-bot @aduh95 @jasnell @anonrig @targos @JakobJingleheimer
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.