Skip to content

Commit 853e5d8

Browse files
authored
Add .md support to the Apache License and Notice transformers (#1041)
Refs apache/maven-shade-plugin@ba0cc3c.
1 parent 28a6207 commit 853e5d8

File tree

5 files changed

+22
-2
lines changed

5 files changed

+22
-2
lines changed

src/docs/changes/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@
33

44
## [Unreleased]
55

6+
**Added**
7+
8+
- Add .md support to the Apache License and Notice transformers. ([#1041](https://github.com/GradleUp/shadow/pull/1041))
9+
610
**Changed**
711

812
- **BREAKING CHANGE:** Rewrite this plugin in Kotlin. ([#1012](https://github.com/GradleUp/shadow/pull/1012))

src/main/kotlin/com/github/jengelman/gradle/plugins/shadow/transformers/ApacheLicenseResourceTransformer.kt

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,13 @@ public open class ApacheLicenseResourceTransformer : Transformer by NoOpTransfor
1313
override fun canTransformResource(element: FileTreeElement): Boolean {
1414
val path = element.relativePath.pathString
1515
return LICENSE_PATH.equals(path, ignoreCase = true) ||
16-
LICENSE_TXT_PATH.regionMatches(0, path, 0, LICENSE_TXT_PATH.length, ignoreCase = true)
16+
LICENSE_TXT_PATH.regionMatches(0, path, 0, LICENSE_TXT_PATH.length, ignoreCase = true) ||
17+
LICENSE_MD_PATH.regionMatches(0, path, 0, LICENSE_MD_PATH.length, ignoreCase = true)
1718
}
1819

1920
private companion object {
2021
private const val LICENSE_PATH = "META-INF/LICENSE"
2122
private const val LICENSE_TXT_PATH = "META-INF/LICENSE.txt"
23+
private const val LICENSE_MD_PATH = "META-INF/LICENSE.md"
2224
}
2325
}

src/main/kotlin/com/github/jengelman/gradle/plugins/shadow/transformers/ApacheNoticeResourceTransformer.kt

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,9 @@ public open class ApacheNoticeResourceTransformer : Transformer {
6767

6868
override fun canTransformResource(element: FileTreeElement): Boolean {
6969
val path = element.relativePath.pathString
70-
return NOTICE_PATH.equals(path, ignoreCase = true) || NOTICE_TXT_PATH.equals(path, ignoreCase = true)
70+
return NOTICE_PATH.equals(path, ignoreCase = true) ||
71+
NOTICE_TXT_PATH.equals(path, ignoreCase = true) ||
72+
NOTICE_MD_PATH.equals(path, ignoreCase = true)
7173
}
7274

7375
override fun transform(context: TransformerContext) {
@@ -174,5 +176,6 @@ public open class ApacheNoticeResourceTransformer : Transformer {
174176
private companion object {
175177
private const val NOTICE_PATH = "META-INF/NOTICE"
176178
private const val NOTICE_TXT_PATH = "META-INF/NOTICE.txt"
179+
private const val NOTICE_MD_PATH = "META-INF/NOTICE.md"
177180
}
178181
}

src/test/groovy/com/github/jengelman/gradle/plugins/shadow/transformers/ApacheLicenseResourceTransformerTest.groovy

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,8 @@ class ApacheLicenseResourceTransformerTest extends TransformerTestSupport<Apache
5252
assertTrue(transformer.canTransformResource(getFileElement("META-INF/LICENSE")))
5353
assertTrue(transformer.canTransformResource(getFileElement("META-INF/LICENSE.TXT")))
5454
assertTrue(transformer.canTransformResource(getFileElement("META-INF/License.txt")))
55+
assertTrue(transformer.canTransformResource(getFileElement("META-INF/LICENSE.md")))
56+
assertTrue(transformer.canTransformResource(getFileElement("META-INF/License.md")))
5557
assertFalse(transformer.canTransformResource(getFileElement("META-INF/MANIFEST.MF")))
5658
}
5759

src/test/groovy/com/github/jengelman/gradle/plugins/shadow/transformers/ApacheNoticeResourceTransformerParameterTests.groovy

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,15 @@ class ApacheNoticeResourceTransformerParameterTests extends TransformerTestSuppo
4242
stats = new ShadowStats()
4343
}
4444

45+
@Test
46+
void testCanTransformResource() {
47+
assertTrue(transformer.canTransformResource(getFileElement("META-INF/NOTICE")))
48+
assertTrue(transformer.canTransformResource(getFileElement("META-INF/NOTICE.TXT")))
49+
assertTrue(transformer.canTransformResource(getFileElement("META-INF/Notice.txt")))
50+
assertTrue(transformer.canTransformResource(getFileElement("META-INF/NOTICE.md")))
51+
assertTrue(transformer.canTransformResource(getFileElement("META-INF/Notice.md")))
52+
}
53+
4554
@Test
4655
void testNoParametersShouldNotThrowNullPointerWhenNoInput() {
4756
processAndFailOnNullPointer("")

0 commit comments

Comments
 (0)