microsoft / microsoft/tsdoc

Need a way to document module namespace objects

Open
#447 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
5k
Forks
162
Avg merge
17h 24m
Merged PRs (30d)
8

Description

Problem

API-Extractor and TSDoc support adding a documentation comment to the entry point module, but not to individual re-exported modules. Modern bundlers and other tooling vastly prefer module namespace objects over static classes because they can be fully statically analyzed and tree-shaken. However, the current model does not provide a way to apply a documentation comment to an individual module that gets applied to the module namespace object (the result of import * as ... or export * as ... expressions).

functions/foo.ts
export function foo();
functions/index.ts
export { foo } from './foo';
Functions.ts
import * as Functions from './functions/index';
// How do I put a comment on this export?
export { Functions };

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by comparing the namespace-object examples in functions/foo.ts, functions/index.ts, and Functions.ts, then review how API-Extractor and TSDoc currently attach comments to entry point modules. Done means the model provides a documented way to attach a comment to the re-exported Functions module namespace object.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.