search

krisztianb / typedoc-plugin-merge-modules

Plugin for TypeDoc that merges the content of modules
ISC License
22 stars 4 forks source link

mode option to combine my module annotation or project #2

Closed sho-otani-icare closed 3 years ago

sho-otani-icare commented 3 years ago

add mergeModulesMergeMode option to set mode module to combine modules by @module annotation. it means you can set same @module name and all reflections will be combined by its declaration rather than project root

src/
├── index.ts         @module main
├── module1
│   └── index.ts     @module submodule
├── module2
│   └── index.ts     @module submodule
├── module3.ts       @module main
└── module4 
    └── module4-1
        └── index.ts @module main

this goes ⬇️

Screen Shot 2021-05-31 at 20 03 58

I made this pull request because I need this feature and feel typedoc-plugin-merge-modules matches to this idea. However I will understand this may be out of this plugins concept. I that case I will make this as a other plugin.

krisztianb commented 3 years ago

Osu. It very much makes sense to me to include such a functionality in this plugin. I haven't used the @module annotation yet. I'll probably have time later this week to take a look.

krisztianb commented 3 years ago

The code basically looks fine to me. I merged it into a feature branch and I will test it in the next days. I'll keep you posted.

krisztianb commented 3 years ago

I'm ready to publish a new release including your changes. Do you want to be mentioned in the credits section (Github, NPM)?

beijaflor commented 3 years ago

@krisztianb Thank you so much for your work. If you credit my name, @beijaflor is nice to me ( @sho-otani-icare is my current work account ). Anyway I'm looking forward to new release and we'll use our current product ;)

krisztianb commented 3 years ago

I've just released version 2.1.0 including your contribution. Should you find any bugs, please report them in the issues section here on Github. Thank you.

beijaflor commented 3 years ago

@krisztianb Just for F.Y.I.. I made example repository for my Japanese tach blog. https://github.com/beijaflor/typedoc-plugin-merge-modules-example

krisztianb commented 3 years ago

To be honest I'm amazed about how many people are using this plugin. I created it, because I needed the "old" TypeDoc behaviour for one of my projects. Looks like a lot of other people are having the same issue.