Add filtering option for excluding specific configuration name #25

omuomugin · 2024-02-06T02:01:03Z

🚀 Description

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

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 #21 .
I know @iurysza is writing POC with Regex seeing https://github.com/iurysza/module-graph/tree/regex-filter .
However as #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

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)

✅ Checklist

My code follows the code style of this project.
My change requires a change to the documentation.
I have updated the documentation accordingly.

omuomugin · 2024-02-06T02:23:36Z

sample/alpha/build.gradle.kts

@@ -7,4 +7,6 @@ dependencies {
    implementation(project(":sample:beta"))
    implementation(project(":sample:container:gama"))
    implementation(project(":sample:container:delta"))
+
+    testImplementation(project(":sample:test"))


Added for checking ignoring option.
I executed command below and checked README.md hasn't changed.

./gradlew :sample:createModuleGraph

omuomugin · 2024-03-01T01:46:04Z

@iurysza Is there any chance to get reviewed ??

iurysza · 2024-03-22T18:41:38Z

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

omuomugin · 2024-03-26T11:37:03Z

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

iurysza · 2024-03-27T10:57:42Z

README.md

@@ -166,6 +166,8 @@ Optional settings:
    - `NONE`: No text added. (Default.)
    - `CONFIGURATION`: The name of the configuration which the dependency belongs to (e.g. "
      implementation", "compileOnly", "jsMain").
+- **excludeConfigurationNames**:
+  - List of configuration name which should be ignored. e.g. "implementation", "testImplementation". Default is emptyList().


Suggested change

- List of configuration name which should be ignored. e.g. "implementation", "testImplementation". Default is emptyList().

- List of configurations to be ignored. e.g. "implementation", "testImplementation". Default is emptyList().

As #25 (comment), #25 (comment) says
Maybe it should be "List of configuration names to be ignored" ?

fixed 73b5e93

iurysza · 2024-03-27T11:57:29Z

...-build/modulegraph/src/main/kotlin/dev/iurysouza/modulegraph/gradle/CreateModuleGraphTask.kt

@@ -47,6 +48,11 @@ abstract class CreateModuleGraphTask : DefaultTask() {
    @get:Optional
    abstract val linkText: Property<LinkText>

+    @get:Input
+    @get:Option(option = "excludeConfigurationNames", description = "List of configuration name which should be ignored")


Suggested change

@get:Option(option = "excludeConfigurationNames", description = "List of configuration name which should be ignored")

@get:Option(option = "excludeConfigurationNames", description = "List of configurations names to be ignored")

fixed 73b5e93

iurysza · 2024-03-27T11:58:03Z

...n-build/modulegraph/src/main/kotlin/dev/iurysouza/modulegraph/gradle/ModuleGraphExtension.kt

@@ -44,6 +45,13 @@ open class ModuleGraphExtension @Inject constructor(project: Project) {
     */
    val linkText: Property<LinkText> = objects.property(LinkText::class.java)

+    /**
+     * List of configuration name which should be ignored.


Suggested change

* List of configuration name which should be ignored.

* Configuration names to be ignored.

As #25 (comment), #25 (comment) says,
Maybe it should be "List of configurations to be ignored" ?

fixed 73b5e93

iurysza

Hey @omuomugin , this looks fine by me. Just some wording nitpicks.
Cheers

iurysza · 2024-03-27T12:01:57Z

README.md

@@ -166,6 +166,8 @@ Optional settings:
    - `NONE`: No text added. (Default.)
    - `CONFIGURATION`: The name of the configuration which the dependency belongs to (e.g. "
      implementation", "compileOnly", "jsMain").
+- **excludeConfigurationNames**:


Please add an example of usage in the code blocks above. Like here

added 2587876

omuomugin · 2024-03-27T20:06:46Z

@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.

73b5e93
2587876

iurysza · 2024-03-28T20:58:41Z

This will be part of the v0.6.0 release.

omuomugin · 2024-03-28T22:24:07Z

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

Add filtering option for excluding specific configuration name

5f3117b

omuomugin mentioned this pull request Feb 6, 2024

Ignore certain modules #21

Closed

omuomugin commented Feb 6, 2024

View reviewed changes

iurysza reviewed Mar 27, 2024

View reviewed changes

iurysza requested changes Mar 27, 2024

View reviewed changes

omuomugin added 2 commits March 28, 2024 05:02

fix: wording

73b5e93

fix: added useage example

2587876

iurysza merged commit 327280c into iurysza:main Mar 28, 2024
1 of 4 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add filtering option for excluding specific configuration name #25

Add filtering option for excluding specific configuration name #25

omuomugin commented Feb 6, 2024

omuomugin Feb 6, 2024 •

edited

omuomugin commented Mar 1, 2024

iurysza commented Mar 22, 2024 •

edited

omuomugin commented Mar 26, 2024

iurysza Mar 27, 2024

omuomugin Mar 27, 2024 •

edited

omuomugin Mar 27, 2024

iurysza Mar 27, 2024

omuomugin Mar 27, 2024

iurysza Mar 27, 2024

omuomugin Mar 27, 2024 •

edited

omuomugin Mar 27, 2024

iurysza left a comment

iurysza Mar 27, 2024

omuomugin Mar 27, 2024

omuomugin commented Mar 27, 2024 •

edited

iurysza commented Mar 28, 2024 •

edited

omuomugin commented Mar 28, 2024 •

edited

	- List of configuration name which should be ignored. e.g. "implementation", "testImplementation". Default is emptyList().
	- List of configurations to be ignored. e.g. "implementation", "testImplementation". Default is emptyList().

	@get:Option(option = "excludeConfigurationNames", description = "List of configuration name which should be ignored")
	@get:Option(option = "excludeConfigurationNames", description = "List of configurations names to be ignored")

	* List of configuration name which should be ignored.
	* Configuration names to be ignored.

Add filtering option for excluding specific configuration name #25

Add filtering option for excluding specific configuration name #25

Conversation

omuomugin commented Feb 6, 2024

🚀 Description

📄 Motivation and Context

🧪 How Has This Been Tested?

📦 Types of changes

✅ Checklist

omuomugin Feb 6, 2024 • edited

Choose a reason for hiding this comment

omuomugin commented Mar 1, 2024

iurysza commented Mar 22, 2024 • edited

omuomugin commented Mar 26, 2024

Choose a reason for hiding this comment

omuomugin Mar 27, 2024 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

omuomugin Mar 27, 2024 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

iurysza left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

omuomugin commented Mar 27, 2024 • edited

iurysza commented Mar 28, 2024 • edited

omuomugin commented Mar 28, 2024 • edited

omuomugin Feb 6, 2024 •

edited

iurysza commented Mar 22, 2024 •

edited

omuomugin Mar 27, 2024 •

edited

omuomugin Mar 27, 2024 •

edited

omuomugin commented Mar 27, 2024 •

edited

iurysza commented Mar 28, 2024 •

edited

omuomugin commented Mar 28, 2024 •

edited