typedoc-plugin-default-groups

Table of contents

• 🍵 Introduction
• 🚀 Get started
• ⚙️ Options
• 🧬 Types
  • PluginOptions
  • GroupByKindMap
• 🤝 Contribute
• 👑 Author
• ⚖️ License
• 📰 Changelog
• 🧱 Related packages

🍵 Introduction

This TypeDoc plugin allows you to automatically add default group (@group JSDoc tag) to your project reflections. By default, only exported members reflections are included but you can override it by passing plugin options. See Options section below.

🚀 Get started

npm install -D typedoc-plugin-default-groups

Add the plugin in your typedoc.config.js file:

// typedoc.config.js
import * as td from 'typedoc'

/** @type {td.TypeDocOptions & import('typedoc-plugin-default-groups').PluginOptions} */
export default {
  entryPoints: [
    './src/index.ts'
  ],
  plugin: [
    'typedoc-plugin-default-groups'
  ],
  defaultGroups: {
    groupByKind: {
      /**
       * All type reflections will have the
       * `@group Types` tag set by default
       */
      [td.ReflectionKind.SomeType]: 'Types'
    }
  }
}

Let's run the typedoc command!

⚙️ Options

This plugin supports some options. See PluginOptions type below.

For example, in your typedoc.config.js file:

// typedoc.config.js
import * as td from 'typedoc'

/** @type {td.TypeDocOptions & import('typedoc-plugin-default-groups').PluginOptions} */
export default {
  entryPoints: [
    './src/index.ts'
  ],
  plugin: [
    'typedoc-plugin-default-groups'
  ],
  /**
   * typedoc-plugin-default-groups options
   */
  defaultGroups: {
    // Only exported members reflections
    filter: 'exports',
    // Apply default group based on reflection kind
    groupByKind: {},
    // Disable warnings in case of missing default group
    disableWarnings: true
  }
}

🧬 Types

PluginOptions

export interface PluginOptions {
  /**
   * typedoc-plugin-default-groups specific options.
   */
  defaultGroups?: {
    /**
     * What reflection kind are included. It can be:
     *
     * - "exports"                   : to only target exported members reflections
     * - "*"                         : to target all reflections
     * - TypeDoc.ReflectionKind      : a typedoc ReflectionKind enum value
     * - TypeDoc.ReflectionKind[]    : an array of typedoc ReflectionKind enum values
     *
     * Default: "exports"
     */
    filter?: 'exports' | '*' | TypeDoc.ReflectionKind | TypeDoc.ReflectionKind[]
    /**
     * An object like:
     *
     * {
     *   [td.ReflectionKind.Function]: 'Functions',
     *   [td.ReflectionKind.SomeType]: 'Types',
     *   default: 'None'
     * }
     *
     * If you set the "default" key, it will try to auto-inject
     * a group tag to all included reflections.
     */
    groupByKind?: GroupByKindMap
    /**
     * To disable warnings about missing default group
     *
     * Default: false
     */
    disableWarnings?: boolean
  }
}

GroupByKindMap

export type GroupByKindMap = {
  [Kind in TypeDoc.ReflectionKind | 'default']?: string
}

🤝 Contribute

You would like to contribute to this project? You are welcome!

First, please check:

• the contribution guide
• the code of conduct

👑 Author

Made with ❤ by Hervé Perchec

⚖️ License

GPL-3.0-only

📰 Changelog

See all changes to this project in the CHANGELOG.md file.

🧱 Related packages

• typedoc

Made with ❤ by [object Object]

README.md - this file was auto generated with juisy README templater. Don't edit it.