node: do not emit module JSDoc headers#74661
Open
Renegade334 wants to merge 1 commit intoDefinitelyTyped:masterfrom
Open
node: do not emit module JSDoc headers#74661Renegade334 wants to merge 1 commit intoDefinitelyTyped:masterfrom
Renegade334 wants to merge 1 commit intoDefinitelyTyped:masterfrom
Conversation
Renegade334
force-pushed
the
node-no-module-headers
branch
from
97c024f to
ea4775d
Compare
Contributor
|
@Renegade334 Thank you for submitting this PR! This is a live comment that I will keep updated. 1 package in this PRCode ReviewsBecause this is a widely-used package, a DT maintainer will need to review it before it can be merged. You can test the changes of this PR in the Playground. Status
Once every item on this list is checked, I'll ask you for permission to merge and publish the changes. Diagnostic Information: What the bot saw about this PR{
"type": "info",
"now": "-",
"pr_number": 74661,
"author": "Renegade334",
"headCommitOid": "ea4775d63b1343c8e73696b8a200bf22984d4dff",
"mergeBaseOid": "b3583674f902d59f3039d8395955e019d65f498d",
"lastPushDate": "2026-03-10T00:11:35.000Z",
"lastActivityDate": "2026-03-10T01:38:37.000Z",
"hasMergeConflict": false,
"isFirstContribution": false,
"tooManyFiles": false,
"hugeChange": false,
"popularityLevel": "Critical",
"pkgInfo": [
{
"name": "node",
"kind": "edit",
"files": [
{
"path": "types/node/assert.d.ts",
"kind": "definition"
},
{
"path": "types/node/assert/strict.d.ts",
"kind": "definition"
},
{
"path": "types/node/async_hooks.d.ts",
"kind": "definition"
},
{
"path": "types/node/buffer.d.ts",
"kind": "definition"
},
{
"path": "types/node/child_process.d.ts",
"kind": "definition"
},
{
"path": "types/node/cluster.d.ts",
"kind": "definition"
},
{
"path": "types/node/console.d.ts",
"kind": "definition"
},
{
"path": "types/node/constants.d.ts",
"kind": "definition"
},
{
"path": "types/node/crypto.d.ts",
"kind": "definition"
},
{
"path": "types/node/dgram.d.ts",
"kind": "definition"
},
{
"path": "types/node/diagnostics_channel.d.ts",
"kind": "definition"
},
{
"path": "types/node/dns.d.ts",
"kind": "definition"
},
{
"path": "types/node/dns/promises.d.ts",
"kind": "definition"
},
{
"path": "types/node/domain.d.ts",
"kind": "definition"
},
{
"path": "types/node/events.d.ts",
"kind": "definition"
},
{
"path": "types/node/fs.d.ts",
"kind": "definition"
},
{
"path": "types/node/fs/promises.d.ts",
"kind": "definition"
},
{
"path": "types/node/http.d.ts",
"kind": "definition"
},
{
"path": "types/node/http2.d.ts",
"kind": "definition"
},
{
"path": "types/node/https.d.ts",
"kind": "definition"
},
{
"path": "types/node/inspector.d.ts",
"kind": "definition"
},
{
"path": "types/node/inspector/promises.d.ts",
"kind": "definition"
},
{
"path": "types/node/module.d.ts",
"kind": "definition"
},
{
"path": "types/node/net.d.ts",
"kind": "definition"
},
{
"path": "types/node/os.d.ts",
"kind": "definition"
},
{
"path": "types/node/path.d.ts",
"kind": "definition"
},
{
"path": "types/node/perf_hooks.d.ts",
"kind": "definition"
},
{
"path": "types/node/punycode.d.ts",
"kind": "definition"
},
{
"path": "types/node/querystring.d.ts",
"kind": "definition"
},
{
"path": "types/node/quic.d.ts",
"kind": "definition"
},
{
"path": "types/node/readline.d.ts",
"kind": "definition"
},
{
"path": "types/node/readline/promises.d.ts",
"kind": "definition"
},
{
"path": "types/node/repl.d.ts",
"kind": "definition"
},
{
"path": "types/node/scripts/generate-docs/ast-processing.ts",
"kind": "test"
},
{
"path": "types/node/sea.d.ts",
"kind": "definition"
},
{
"path": "types/node/sqlite.d.ts",
"kind": "definition"
},
{
"path": "types/node/stream.d.ts",
"kind": "definition"
},
{
"path": "types/node/stream/consumers.d.ts",
"kind": "definition"
},
{
"path": "types/node/string_decoder.d.ts",
"kind": "definition"
},
{
"path": "types/node/test.d.ts",
"kind": "definition"
},
{
"path": "types/node/test/reporters.d.ts",
"kind": "definition"
},
{
"path": "types/node/timers.d.ts",
"kind": "definition"
},
{
"path": "types/node/timers/promises.d.ts",
"kind": "definition"
},
{
"path": "types/node/tls.d.ts",
"kind": "definition"
},
{
"path": "types/node/trace_events.d.ts",
"kind": "definition"
},
{
"path": "types/node/tty.d.ts",
"kind": "definition"
},
{
"path": "types/node/url.d.ts",
"kind": "definition"
},
{
"path": "types/node/util.d.ts",
"kind": "definition"
},
{
"path": "types/node/v8.d.ts",
"kind": "definition"
},
{
"path": "types/node/vm.d.ts",
"kind": "definition"
},
{
"path": "types/node/wasi.d.ts",
"kind": "definition"
},
{
"path": "types/node/worker_threads.d.ts",
"kind": "definition"
},
{
"path": "types/node/zlib.d.ts",
"kind": "definition"
}
],
"owners": [
"Microsoft",
"jkomyno",
"r3nya",
"btoueg",
"touffy",
"mohsen1",
"galkin",
"eps1lon",
"WilcoBakker",
"chyzwar",
"trivikr",
"yoursunny",
"qwelias",
"ExE-Boss",
"peterblazejewicz",
"addaleax",
"victorperin",
"NodeJS",
"LinusU",
"wafuwafu13",
"mcollina",
"Semigradsky",
"Renegade334",
"anonrig"
],
"addedOwners": [],
"deletedOwners": [],
"popularityLevel": "Critical"
}
],
"reviews": [],
"mainBotCommentID": 4028018947,
"ciResult": "pass"
} |
typescript-bot
added
Critical package
Author is Owner
Contributor
|
🔔 @microsoft @jkomyno @r3nya @btoueg @Touffy @mohsen1 @galkin @eps1lon @WilcoBakker @chyzwar @trivikr @yoursunny @qwelias @ExE-Boss @peterblazejewicz @addaleax @victorperin @nodejs @LinusU @wafuwafu13 @mcollina @Semigradsky @anonrig — please review this PR in the next few days. Be sure to explicitly select |
typescript-bot
moved this from Needs Author Action
to Needs Maintainer Review
in Pull Request Status Board
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
We always get a disproportionate number of requests to modify these. In reality, a) they often don't scan well in a @types/node context; b) it's pretty rare to be hovering an import specifier in an IDE; c) they're currently missing for half the import specifiers anyway; and d) they offer no meaningful information, unless you regularly find yourself needing to jump to the internal module source code on GitHub.
May as well save the package 50KiB instead.