iurysza / module-graph

A Gradle Plugin for visualizing your project's structure, powered by mermaidjs
https://plugins.gradle.org/plugin/dev.iurysouza.modulegraph
MIT License
345 stars 13 forks source link

Add filtering option for excluding specific configuration name #25

Closed omuomugin closed 8 months ago

omuomugin commented 9 months ago

๐Ÿš€ Description

Try to add excludeConfigurationNames option which you can ignore specific configuration names.

Fix https://github.com/iurysza/module-graph/issues/21

example usage is below

moduleGraphConfig {
    heading.set("# Module Graph")
    readmePath.set("./README.md")

    // optional configs
    excludeConfigurationNames.set(listOf("testImplementation"))
}

๐Ÿ“„ Motivation and Context

I have same situation as https://github.com/iurysza/module-graph/issues/21 . I know @iurysza is writing POC with Regex seeing https://github.com/iurysza/module-graph/tree/regex-filter . However as https://github.com/iurysza/module-graph/issues/21 stated, I think there is a major case that want to ignore specific configuration (especially testImplementation ) for document use.

I'm open to discuss about this feature so just let me know your opinion.

๐Ÿงช How Has This Been Tested?

Added some test cases for ModuleGraphPluginFunctionalTest And also tested with sample project.

๐Ÿ“ฆ Types of changes

โœ… Checklist

omuomugin commented 9 months ago

@iurysza Is there any chance to get reviewed ??

iurysza commented 8 months ago

Hey @omuomugin, thanks for the PR. Sorry for the delay, I just noticed this now. I'll check it out over the weekend.

omuomugin commented 8 months ago

@iurysza Have you got time for review? I'm open for discussion, so let me know your thoughts.

omuomugin commented 8 months ago

@iurysza Thank you for reviews. I've fixed it.

Please re-review when you have time.

I'll be fixing up these additional commits when review is done.

https://github.com/iurysza/module-graph/pull/25/commits/73b5e936e23403336309bc043e887c3c0bd3aa7d https://github.com/iurysza/module-graph/pull/25/commits/2587876249e8e69e50a4ae7b586605d790a79ae9

iurysza commented 8 months ago

This will be part of the v0.6.0 release.

omuomugin commented 8 months ago

@iurysza Thanks for taking time! Looking forward to be released.