Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support for configuring no inherit class names via a config file rather than comment tag #34

Open
loucadufault opened this issue Sep 9, 2023 · 3 comments · May be fixed by #35
Open

Comments

@loucadufault
Copy link

loucadufault commented Sep 9, 2023

Thanks for this project! One thing that is unfortunate is that the @noInheritDoc tags are kept in the source code and produced in the dist output (tsc with "removeComments": false) which shows up in intellisense.

Having looked through the source code, it would seem not so difficult to read from a configured list the names of class/interfaces to exclude always, and then simply check this additional list (Set<string>) by name in isNoInherit.

Another option I plan to add is to let the configured option accept either an array or a special string "builtins"

@JoshuaKGoldberg
Copy link

This would be fantastic. For context / a use case, I'm working on typescript-eslint/typescript-eslint#2726 -> typescript-eslint/typescript-eslint#9293, and would like to use this to stop every member of the AST from repeating the same 3-4 properties from the BaseNode and NodeOrTokenData interfaces.

👋 @jonchardy since it's been a while, do you have an opinion on this issue?

@jonchardy
Copy link
Owner

Unfortunately I don't have time to implement this. Open to PRs, though, including anything necessary to bring the plugin up to date with Typedoc.

@JoshuaKGoldberg JoshuaKGoldberg linked a pull request Jun 8, 2024 that will close this issue
@JoshuaKGoldberg
Copy link

Good to know, thanks! I'm not very TypeDoc-savvy myself, so sent #35 with the best I could get to locally.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants