typedoc-plugin-replace-in-comments v3.2.0

typedoc-plugin-replace-in-comments

This is a plugin for TypeDoc that replaces text in comments. You can specify matching patterns and the text they should be replaced with.

This can be useful for:

• Creating links from ticket IDs (eg: replace "GH-12345" with a link to https://github.com/your-name/the-repo/issues/12345)
• Creating links from author names (eg: link "Your Name" to your GitHub or corporate profile page)
• Replacing internal URLs with external ones
• Replacing custom placeholders with anything you like (eg: images)
• Remove URLs or other text from comments
• etc.

Installation

This module can be installed using npm:

$ npm install typedoc-plugin-replace-in-comments --save-dev

TypeDoc automatically detects plugins installed via npm. After installation TypeDoc can be used normally and you can configure this plugin as described below.

Requirements

The plugin requires TypeDoc version 0.21.x or 0.22.x to be installed.

Configuration

This plugin adds a new option to TypeDoc: replace-in-comments-config

The option defines the regular expression matching patterns and the texts they should be replaced with. You can specify the config using one of the following methods:

• In your tsconfig.json file (within the typedocOptions object) OR
• In your typedoc.json file

Example of a typedoc.json configuration:

{
    "out": "docs",
    "replace-in-comments-config": [
        {
            "pattern": "(GH-(\\d+))",
            "replace": "[$1](https://github.com/your-name/the-repo/issues/$2)"
        },
        {
            "pattern": "The King Himself",
            "flags": "gi",
            "replace": "[The King Himself](https://github.com/the-king-himself)"
        }
    ]
}

The option must define an array of objects with the following properties:

The properties are passed to a call of String.replace as follows:

comment = comment.replace(new Regex(PATTERN, FLAGS), REPLACE);

Bugs

Please report bugs here. Thanks for your contribution!

Donate

If you find this piece of software helpful, please consider a donation. Any amount is greatly appreciated.