Skip to content

Commit 44efbe7

Browse files
committed
build(gradle)!: Move script definitions to script-utils
Modules that contain custom scripts, for example as resources, must depend on a module with the script definitions for IDE auto-completion to work. Definitions and scripts cannot reside in the same module for that purpose. After this change, do the following in IntelliJ IDEA: - Gradle sync - Go to global settings - Search the "kotlin SCripting" section - Expand "Custom Definitions" at the bottom - Click on "Search Definitions" That should make auto-completion for custom scripts work. BREAKING CHANGE: Programmatic users of script definitions have to adapt to the new artifact names. Signed-off-by: Sebastian Schuberth <sebastian@doubleopen.io>
1 parent 99bd156 commit 44efbe7

13 files changed

Lines changed: 15 additions & 12 deletions

evaluator/build.gradle.kts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,6 @@ plugins {
3232
}
3333

3434
dependencies {
35-
api("org.jetbrains.kotlin:kotlin-scripting-common")
3635
api(libs.kotlinx.serialization.core)
3736
api(projects.model)
3837
api(projects.utils.scriptUtils)
@@ -50,6 +49,8 @@ dependencies {
5049

5150
testImplementation(libs.mockk)
5251
testImplementation(projects.utils.testUtils)
52+
53+
kotlinScriptDef(projects.utils.scriptUtils)
5354
}
5455

5556
tasks.register<Download>("updateOsadlMatrix") {

evaluator/src/main/kotlin/Evaluator.kt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ import org.ossreviewtoolkit.model.utils.DefaultResolutionProvider
3535
import org.ossreviewtoolkit.model.utils.ResolutionProvider
3636
import org.ossreviewtoolkit.model.utils.createLicenseInfoResolver
3737
import org.ossreviewtoolkit.utils.ort.Environment
38+
import org.ossreviewtoolkit.utils.script.RulesScriptTemplate
3839
import org.ossreviewtoolkit.utils.script.ScriptRunner
3940

4041
class Evaluator(

notifier/build.gradle.kts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,23 +23,23 @@ plugins {
2323
}
2424

2525
dependencies {
26-
api("org.jetbrains.kotlin:kotlin-scripting-common")
2726
api(libs.jiraRestClient.api)
2827
api(projects.model)
2928
api(projects.utils.scriptUtils)
3029

3130
implementation("org.jetbrains.kotlin:kotlin-scripting-jvm-host")
3231
implementation(libs.jakartaMail)
33-
implementation(libs.jerseyCommon)
34-
3532
implementation(libs.jiraRestClient.app) {
3633
exclude("org.apache.logging.log4j", "log4j-slf4j2-impl")
3734
.because("the SLF4J implementation from Log4j 2 is used")
3835
}
39-
4036
implementation(projects.utils.commonUtils)
4137

38+
runtimeOnly(libs.jerseyCommon)
39+
4240
testImplementation(libs.greenmail)
4341
testImplementation(libs.mockk)
4442
testImplementation(libs.wiremock)
43+
44+
kotlinScriptDef(projects.utils.scriptUtils)
4545
}

notifier/src/main/kotlin/Notifier.kt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ import org.ossreviewtoolkit.model.utils.DefaultResolutionProvider
3636
import org.ossreviewtoolkit.model.utils.ResolutionProvider
3737
import org.ossreviewtoolkit.notifier.modules.JiraNotifier
3838
import org.ossreviewtoolkit.notifier.modules.MailNotifier
39+
import org.ossreviewtoolkit.utils.script.NotificationsScriptTemplate
3940
import org.ossreviewtoolkit.utils.script.ScriptRunner
4041

4142
class Notifier(

reporter/build.gradle.kts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,6 @@ plugins {
2626
}
2727

2828
dependencies {
29-
api("org.jetbrains.kotlin:kotlin-scripting-common")
3029
api(projects.model)
3130
api(projects.plugins.api)
3231
api(projects.plugins.licenseFactProviders.licenseFactProviderApi)
@@ -37,4 +36,6 @@ dependencies {
3736
funTestImplementation(testFixtures(project))
3837

3938
testFixturesImplementation(projects.utils.testUtils)
39+
40+
kotlinScriptDef(projects.utils.scriptUtils)
4041
}

reporter/src/main/kotlin/HowToFixTextProvider.kt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ import kotlin.script.experimental.jvmhost.createJvmCompilationConfigurationFromT
2828

2929
import org.ossreviewtoolkit.model.Issue
3030
import org.ossreviewtoolkit.model.OrtResult
31+
import org.ossreviewtoolkit.utils.script.HowToFixTextProviderScriptTemplate
3132
import org.ossreviewtoolkit.utils.script.ScriptRunner
3233

3334
/**

utils/script/build.gradle.kts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ plugins {
2424

2525
dependencies {
2626
api("org.jetbrains.kotlin:kotlin-scripting-common")
27+
api(projects.model)
2728

2829
implementation("org.jetbrains.kotlin:kotlin-scripting-jvm")
2930
implementation("org.jetbrains.kotlin:kotlin-scripting-jvm-host")

reporter/src/main/kotlin/HowToFixTextProviderScriptTemplate.kt renamed to utils/script/src/main/kotlin/HowToFixTextProviderScriptTemplate.kt

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,14 +17,13 @@
1717
* License-Filename: LICENSE
1818
*/
1919

20-
package org.ossreviewtoolkit.reporter
20+
package org.ossreviewtoolkit.utils.script
2121

2222
import kotlin.script.experimental.annotations.KotlinScript
2323
import kotlin.script.experimental.api.ScriptCompilationConfiguration
2424
import kotlin.script.experimental.api.defaultImports
2525

2626
import org.ossreviewtoolkit.model.OrtResult
27-
import org.ossreviewtoolkit.utils.script.OrtScriptCompilationConfiguration
2827

2928
@KotlinScript(
3029
displayName = "ORT How-To-Fix-Text-Provider Script",

notifier/src/main/kotlin/NotificationsScriptTemplate.kt renamed to utils/script/src/main/kotlin/NotificationsScriptTemplate.kt

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,14 +17,13 @@
1717
* License-Filename: LICENSE
1818
*/
1919

20-
package org.ossreviewtoolkit.notifier
20+
package org.ossreviewtoolkit.utils.script
2121

2222
import kotlin.script.experimental.annotations.KotlinScript
2323
import kotlin.script.experimental.api.ScriptCompilationConfiguration
2424
import kotlin.script.experimental.api.defaultImports
2525

2626
import org.ossreviewtoolkit.model.OrtResult
27-
import org.ossreviewtoolkit.utils.script.OrtScriptCompilationConfiguration
2827

2928
@KotlinScript(
3029
displayName = "ORT Notifications Script",

evaluator/src/main/kotlin/RulesScriptTemplate.kt renamed to utils/script/src/main/kotlin/RulesScriptTemplate.kt

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
* License-Filename: LICENSE
1818
*/
1919

20-
package org.ossreviewtoolkit.evaluator
20+
package org.ossreviewtoolkit.utils.script
2121

2222
import java.time.Instant
2323

@@ -30,7 +30,6 @@ import org.ossreviewtoolkit.model.RuleViolation
3030
import org.ossreviewtoolkit.model.licenses.LicenseClassifications
3131
import org.ossreviewtoolkit.model.licenses.LicenseInfoResolver
3232
import org.ossreviewtoolkit.model.utils.ResolutionProvider
33-
import org.ossreviewtoolkit.utils.script.OrtScriptCompilationConfiguration
3433

3534
@KotlinScript(
3635
displayName = "ORT Evaluator Rules Script",

0 commit comments

Comments
 (0)