Skip to content
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

Jump to bottom

esm: jsdoc for modules code #49523

Merged
merged 15 commits into from
Sep 19, 2023
Merged

esm: jsdoc for modules code #49523

merged 15 commits into from
Sep 19, 2023

Conversation

GeoffreyBooth
Copy link
Member

@GeoffreyBooth GeoffreyBooth commented Sep 7, 2023 •
edited

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.

@GeoffreyBooth GeoffreyBooth added the esm Issues and PRs related to the ECMAScript Modules implementation. label Sep 7, 2023
@nodejs-github-bot
Copy link
Collaborator

Review requested:

  • @nodejs/loaders

@nodejs-github-bot 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
anonrig reviewed Sep 7, 2023
View reviewed changes
.eslintrc.js Outdated Show resolved Hide resolved
@aduh95 aduh95 added dont-land-on-v18.x PRs that should not land on the v18.x-staging branch and should not be released in v18.x. backport-requested-v20.x PRs awaiting manual backport to the v20.x-staging branch. labels Sep 8, 2023
@aduh95
Copy link
Contributor

aduh95 commented Sep 8, 2023 •
edited by anonrig

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.

@GeoffreyBooth GeoffreyBooth marked this pull request as ready for review September 14, 2023 06:31
@GeoffreyBooth
Copy link
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.

aduh95
aduh95 reviewed Sep 14, 2023
View reviewed changes
lib/internal/modules/esm/create_dynamic_module.js Show resolved Hide resolved
lib/internal/modules/esm/create_dynamic_module.js Show resolved Hide resolved
lib/internal/modules/esm/fetch_module.js Outdated Show resolved Hide resolved
lib/internal/modules/esm/fetch_module.js Outdated Show resolved Hide resolved
lib/internal/modules/esm/fetch_module.js Outdated Show resolved Hide resolved
lib/internal/modules/esm/formats.js Outdated Show resolved Hide resolved
lib/internal/modules/esm/loader.js Outdated Show resolved Hide resolved
@GeoffreyBooth GeoffreyBooth mentioned this pull request Sep 14, 2023
Merged
@nodejs-github-bot
Copy link
Collaborator

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

@GeoffreyBooth 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
@nodejs-github-bot
Copy link
Collaborator

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

@nodejs-github-bot
Copy link
Collaborator

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

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

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

@nodejs-github-bot
Copy link
Collaborator

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

@nodejs-github-bot
Copy link
Collaborator

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

@GeoffreyBooth GeoffreyBooth added the commit-queue Add this label to land a pull request using GitHub Actions. label Sep 18, 2023
@GeoffreyBooth GeoffreyBooth added the commit-queue Add this label to land a pull request using GitHub Actions. label Sep 19, 2023
@nodejs-github-bot 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 nodejs-github-bot merged commit 7517c9f into nodejs:main Sep 19, 2023
52 checks passed
@nodejs-github-bot
Copy link
Collaborator

Landed in 7517c9f

@GeoffreyBooth GeoffreyBooth deleted the tidy-modules-code branch September 19, 2023 02:55
This was referenced Sep 20, 2023
Open
Open
Open
@RafaelGSS RafaelGSS mentioned this pull request Oct 9, 2023
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 <jasnell@gmail.com>
Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>
@aduh95 aduh95 mentioned this pull request Oct 14, 2023
Closed
@aduh95 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
@GeoffreyBooth @alexfernandez
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
@GeoffreyBooth @targos
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 targos mentioned this pull request Nov 11, 2023
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 <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
@GeoffreyBooth @targos
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 targos mentioned this pull request Nov 12, 2023
Merged
@targos 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 targos added backported-to-v18.x PRs backported to the v18.x-staging branch. and removed dont-land-on-v18.x PRs that should not land on the v18.x-staging branch and should not be released in 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 <jasnell@gmail.com>
Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>
@targos targos mentioned this pull request Nov 28, 2023
Merged
@juanarbol juanarbol mentioned this pull request Dec 6, 2023
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 <charles@charleskerr.com>
Co-authored-by: Shelley Vohr <shelley.vohr@gmail.com>
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 <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
@sercher
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>
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

Assignees
No one assigned
Labels
author ready PRs that have at least one approval, no pending requests for changes, and a CI started. backported-to-v18.x PRs backported to the v18.x-staging branch. backported-to-v20.x PRs backported to the v20.x-staging branch. commit-queue-squash Add this label to instruct the Commit Queue to squash all the PR commits into the first one. esm Issues and PRs related to the ECMAScript Modules implementation. lib / src Issues and PRs related to general changes in the lib or src directory. 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.

None yet
7 participants
@GeoffreyBooth @nodejs-github-bot @aduh95 @jasnell @anonrig @targos @JakobJingleheimer