https://github.com/klinki/typedoc-plugin-regex-filter

https://github.com/klinki/typedoc-plugin-regex-filter

Last synced: 2 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/klinki/typedoc-plugin-regex-filter
• Owner: klinki
• License: mit
• Created: 2022-11-05T12:13:39.000Z (about 2 years ago)
• Default Branch: master
• Last Pushed: 2022-11-05T22:20:44.000Z (about 2 years ago)
• Last Synced: 2024-10-29T23:10:14.325Z (22 days ago)
• Language: TypeScript
• Size: 34.2 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# typedoc-plugin-regex-filter

TypeDoc plugin for filtering reflections based on regular expression.

## Usage

Install plugin:

```bash

npm install --save-dev typedoc-plugin-regex-filter

```

Use:

```bash

typedoc --removeRegex "^_(.*)" --removeRegexExclude

```

## Configuration

- removeRegex: string - regular expression used for filtering, default `^_(.*)`

- removeRegexExclude: boolean - exclude matching reflections from docs output, default `false`

- removeRegexMarkAsPrivate: boolean - mark matching reflections as private in docs output, default `true`

- removeRegexLogMatches: boolean - write matching reflections to log output, default `false`