search

krisztianb / typedoc-plugin-replace-text

Plugin for TypeDoc that replaces text in the documentation
ISC License
5 stars 2 forks source link

Option inIncludedFiles is too greedy #5

Closed krisztianb closed 1 year ago

krisztianb commented 1 year ago

Using a plugin config like this doesn't produce the expected results:

"replaceText": {
    "inCodeCommentText": false,
    "inCodeCommentTags": false,
    "inIncludedFiles": true,
    "replacements": [
        {
            "pattern": "A",
            "replace": "B"
        }
    ]
}

Expected

Once would expect that A is replaced by B only in the README and other included markdown files as suggested by the plugin's README.

Actual

With the config above A is replaced everywhere by B even in code comment text and code comment tags.

krisztianb commented 1 year ago

Requires a change in TypeDoc to be fixed: https://github.com/TypeStrong/typedoc/pull/2284

krisztianb commented 1 year ago

Fixed in 3.0.0