microsoft / microsoft/tsdoc

Is there a plugin API?

Open
#314 2 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

I want to add new @tags to make functionality that I need for my use case, is there any plugin API for developing extensions?

My particular use case, for better understanding

In my particular use case, I need something like this:

/**
 * This function does foo
 */
const fooBar = (a, b) => ...

/**
 * {@curry fooBar}
 */
const curriedFoobar = a => b => ...

Where @curry would generate exactly this template (below) and add a Curried tag in the generated HTML

/**
 * Curried version of {@link fooBar.
 * {@inheritDoc fooBar}
 */

image

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

The issue names no files, tests, or existing entry points. Start by reviewing how TSDoc currently handles custom @tags, then define the requested extension mechanism and the expected generated HTML behavior for the @curry example; done should include a documented plugin API that supports this use case.

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
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.