Rules scripting #4887

sschuberth · 2021-12-21T20:35:55Z

Please have a look at the individual commit messages for the details.

sschuberth · 2021-12-22T15:00:07Z

@oss-review-toolkit/kotlin-devs, while this is still a draft, could some of you maybe confirm that this offers proper syntax hightlighting and auto-completion in IntelliJ for evaluator/src/main/resources/rules/no_gpl.rules.kts now (but not for examples/example.rules.kts; that is expected as that script is not part of any module)?

mnonnenmacher · 2021-12-22T15:34:34Z

README.md

-| Kotlin script (DSL) | Evaluator | `$ORT_CONFIG_DIR/rules.kts` | Empty (n/a) |
+| Format | Scope | Default location                | Default value |
+| ------ | ----- |---------------------------------| ------------- |
+| Kotlin script (DSL) | Evaluator | `$ORT_CONFIG_DIR/ort.rules.kts` | Empty (n/a) |


I have a tendency towards evaluator.rules.kts as the default name.

Fine with me, as "ort" is already part of the parent directory, and it opens the possibility to have more (non-evaluator) rules in the future.

mnonnenmacher · 2021-12-22T15:37:49Z

@oss-review-toolkit/kotlin-devs, while this is still a draft, could some of you maybe confirm that this offers proper syntax hightlighting and auto-completion in IntelliJ for evaluator/src/main/resources/rules/no_gpl.rules.kts now (but not for examples/example.rules.kts; that is expected as that script is not part of any module)?

Does not work for me. After Gradle sync I get this when opening no_gpl.rules.kts:
"No script runtime was found in the classpath: class 'kotlin.script.templates.standard.ScriptTemplateWithArgs' not found. Please add kotlin-script-runtime.jar to the module dependencies."

If I apply the suggested fix it adds implementation(kotlin("script-runtime")) to the evaluator module but then I get compilation errors like Unresolved reference: PackageRule.

sschuberth · 2021-12-22T15:47:33Z

Does not work for me.

Could you additionally try to build from the command line once (I usually do this via ./gradlew :cli:run --args="--version"), then do a Gradle sync from the IDE, and then open the script file again?

If I apply the suggested fix it adds implementation(kotlin("script-runtime")) to the evaluator module but then I get compilation errors like Unresolved reference: PackageRule.

That's an odd suggestion... none of the examples at https://github.com/Kotlin/kotlin-script-examples has that dependency.

MarcelBochtler · 2021-12-22T19:49:52Z

Could you additionally try to build from the command line once (I usually do this via ./gradlew :cli:run --args="--version"), then do a Gradle sync from the IDE, and then open the script file again?

Works very well for me after building it from command line.

mnonnenmacher · 2021-12-22T20:57:17Z

Could you additionally try to build from the command line once (I usually do this via ./gradlew :cli:run --args="--version"), then do a Gradle sync from the IDE, and then open the script file again?

Works very well for me after building it from command line.

Same here, very nice.

sschuberth · 2021-12-22T22:10:15Z

I'd like to move examples.rules.kts to a Kotlin module so that completion works. What do you guys think about simply replacing the overly simplistic no_gpl.rules.kts with examples.rules.kts as a resource? Should we then symlink this to the examples directory, even if that might break things for Windows users?

mnonnenmacher · 2021-12-29T09:39:24Z

I'd like to move examples.rules.kts to a Kotlin module so that completion works. What do you guys think about simply replacing the overly simplistic no_gpl.rules.kts with examples.rules.kts as a resource? Should we then symlink this to the examples directory, even if that might break things for Windows users?

Does this solution only work within this Gradle project, or is it possible to create a minimal Gradle project that depends on the evaluator to have working completion? If it is possible I would prefer such a project and put it in the examples folder.
And I would not like a symlink, I would rather have a file that contains something like "// See: path/to/evalutor.rules.kts".

sschuberth · 2022-01-03T11:49:30Z

is it possible to create a minimal Gradle project that depends on the evaluator to have working completion?

It should indeed be possible to create a "rules-only" project by depending on the scripting-utils artifact, and I like the idea to create such an example. However, I'll do that in a separate PR then.

Having a dedicated extension allows to associate script configurations to that extension. Signed-off-by: Sebastian Schuberth <[email protected]>

This is to align with other default filenames that already have constants. Signed-off-by: Sebastian Schuberth <[email protected]>

Modules that want to have support in IntelliJ IDEA for ORT Kotlin scripts need to depend on this module so that the script configurations are available in the compiler's classpath. For references that helped during the implementation see [1][2][3]. [1]: https://discuss.kotlinlang.org/t/make-auto-completion-work-in-kotlin-scripts-with-context [2]: https://github.com/Kotlin/kotlin-script-examples/tree/master/jvm/basic/jvm-maven-deps [3]: https://github.com/Kotlin/KEEP/blob/master/proposals/scripting-support.md Signed-off-by: Sebastian Schuberth <[email protected]>

This adds proper syntax highlighting and auto-completion support for Rules Scripts inside IntelliJ IDEA, like for example for the evaluator/src/main/resources/rules/no_gpl.rules.kts resource. Resolves #2950. Signed-off-by: Sebastian Schuberth <[email protected]>

Even for small scripts, this can reduce compile time to about an eighth. The code has been partly taken from [1]. [1]: https://github.com/Kotlin/kotlin-script-examples/blob/852c835/jvm/simple-main-kts/simple-main-kts/src/main/kotlin/org/jetbrains/kotlin/script/examples/simpleMainKts/scriptDef.kt#L151-L161 Signed-off-by: Sebastian Schuberth <[email protected]>

sschuberth force-pushed the rules-scripting branch 2 times, most recently from 6ac13fc to 3c043c2 Compare December 22, 2021 14:58

sschuberth force-pushed the rules-scripting branch from 3c043c2 to 707c432 Compare December 22, 2021 15:14

mnonnenmacher reviewed Dec 22, 2021

View reviewed changes

sschuberth force-pushed the rules-scripting branch 2 times, most recently from 9134381 to e83f82c Compare December 22, 2021 16:56

sschuberth force-pushed the rules-scripting branch from e83f82c to 9b2506f Compare December 22, 2021 22:06

sschuberth force-pushed the rules-scripting branch 5 times, most recently from 72f8962 to dbe19c6 Compare December 24, 2021 14:39

sschuberth marked this pull request as ready for review January 3, 2022 11:52

sschuberth requested review from a team as code owners January 3, 2022 11:52

sschuberth requested a review from mnonnenmacher January 3, 2022 11:52

mnonnenmacher added evaluator About the evaluator tool breaking change labels Jan 3, 2022

Use the dedicated rules.kts extension for rules files

59ba1a2

Having a dedicated extension allows to associate script configurations to that extension. Signed-off-by: Sebastian Schuberth <[email protected]>

sschuberth force-pushed the rules-scripting branch from dbe19c6 to 8e15b0f Compare January 3, 2022 15:19

Move the default evaluator rules filename to a constant

70bea4d

This is to align with other default filenames that already have constants. Signed-off-by: Sebastian Schuberth <[email protected]>

sschuberth added 3 commits January 3, 2022 16:44

sschuberth force-pushed the rules-scripting branch from 8e15b0f to e0f282d Compare January 3, 2022 15:45

mnonnenmacher approved these changes Jan 5, 2022

View reviewed changes

sschuberth merged commit 5efc50c into master Jan 5, 2022

sschuberth deleted the rules-scripting branch January 5, 2022 11:27

sschuberth mentioned this pull request Jan 10, 2022

Show how to configure auto-completion in IntelliJ Kotlin/kotlin-script-examples#12

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Rules scripting #4887

Rules scripting #4887

Uh oh!

sschuberth commented Dec 21, 2021

Uh oh!

sschuberth commented Dec 22, 2021

Uh oh!

mnonnenmacher Dec 22, 2021

Uh oh!

sschuberth Dec 22, 2021

Uh oh!

mnonnenmacher commented Dec 22, 2021 •

edited

Loading

Uh oh!

sschuberth commented Dec 22, 2021 •

edited

Loading

Uh oh!

MarcelBochtler commented Dec 22, 2021

Uh oh!

mnonnenmacher commented Dec 22, 2021

Uh oh!

sschuberth commented Dec 22, 2021

Uh oh!

mnonnenmacher commented Dec 29, 2021

Uh oh!

sschuberth commented Jan 3, 2022

Uh oh!

Uh oh!

Rules scripting #4887

Rules scripting #4887

Uh oh!

Conversation

sschuberth commented Dec 21, 2021

Uh oh!

sschuberth commented Dec 22, 2021

Uh oh!

mnonnenmacher Dec 22, 2021

Choose a reason for hiding this comment

Uh oh!

sschuberth Dec 22, 2021

Choose a reason for hiding this comment

Uh oh!

mnonnenmacher commented Dec 22, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

sschuberth commented Dec 22, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

MarcelBochtler commented Dec 22, 2021

Uh oh!

mnonnenmacher commented Dec 22, 2021

Uh oh!

sschuberth commented Dec 22, 2021

Uh oh!

mnonnenmacher commented Dec 29, 2021

Uh oh!

sschuberth commented Jan 3, 2022

Uh oh!

Uh oh!

mnonnenmacher commented Dec 22, 2021 •

edited

Loading

sschuberth commented Dec 22, 2021 •

edited

Loading