Scripting #77

ligee · 2017-08-01T21:09:48Z

No description provided.

udalov · 2017-08-01T22:22:11Z

proposals/scripting-support.md

+
+`kotlinc -script myscript.kts`
+
+Or with some hypothetical dedicated runner, that we might want to include into the distribution:


There's already a non-hypothetical dedicated runner called kotlin that we include into the distribution today, let's use it.

udalov · 2017-08-01T22:22:27Z

proposals/scripting-support.md

+
+Or with some hypothetical dedicated runner, that we might want to include into the distribution:
+
+`kotlinsh myscrtipt.ktsh`


This would be

kotlin myscript.kts

udalov · 2017-08-01T22:26:05Z

proposals/scripting-support.md

+To be able to use the Kotlin scripts in a Unix shell environment, the *shebang* (`#!`) syntax should be supported 
+at the beginning of the script:
+```
+#! /path/to/kotlin/script/runner -some -params


As an aside, note that there may be problems with passing multiple arguments in the shebang line: https://stackoverflow.com/a/4304187/288456

Yes, thanks, I remember that. Therefore the syntax of passing params in the arguments to the annotations should be supported as well.

udalov · 2017-08-01T22:28:36Z

proposals/scripting-support.md

+parameters, e.g.:
+
+```
+@file:param("name", String::class)


With the ::class literal, you can only reference a class, not a type. For example, this way you can't specify a parameter with the type String?, or List<String>.

Is there a less restrictive way to do it? (besides the stringly typing)

No, there's no way to reference a type in an annotation, see #39

udalov · 2017-08-01T22:31:46Z

proposals/scripting-support.md

+**Script Definition** is a configuration entity that combines platform, preprocessor, and selector in one entity 
+for simplified discovery and configuration. 
+
+The definition is a kotlin class declaration annotated with specific annotations. The class should be defined in the SAM 


Can it be an interface?

I do not see the reason why not. I'll fix the description.

Does it have to be abstract? We could use an annotation like @ScriptBody so that the script is generated into an override, no matter whether the member was abstract or not. Must not be final though

Also, can it be a property, not a function?

@abreslav do you see it as an addition? I'm fine with the @ScriptBody annotation, but I think that using SAM notation by default is quite convenient.
And what would be the use of the non-abstract script body method?

udalov · 2017-08-01T22:32:42Z

proposals/scripting-support.md

+```
+interface ScriptingPlatform<CompilationConfig> {
+    fun compile(scriptSource, scriptBaseClass: KClass<Scritpt>, compilationConfig: CompilationConfig): KClass<out Script>
+    fun <getIdeData>(scriptSource, scriptBaseClass: KClass<Script>, compilationConfig: CompilationConfig): <IdeData>


What does this notation mean?

If you mean angle brackets - it means that I cannot figure out names yet. Something I need to discuss with Pavel yet.

OK, maybe it should be explained in the document because I was really confused. Maybe just use some names, and explain that those are tentative

udalov · 2017-08-01T22:34:53Z

proposals/scripting-support.md

+The `CompilationConfig` for the JVM platform may look like:
+```
+interface KotlinJVMScriptAdditionalParameters {
+    val classpath: Iterable<File> // dependencies classpath


Should we also have module path + names of modules to load, for Java 9+?

Yes, anything that platform needs, this is just an example. The actual definition of the CompilationConfig should not be specified, but rather taken from the platform definition.

abreslav · 2017-08-07T09:55:45Z

proposals/scripting-support.md

+
+- **Script** - a text file written in Kotlin language but allowing top-level statements and having access to some 
+  implicit (not directly mentioned in the script text) properties, as if the whole script body is a body of an implicit
+  function


Why just properties?

I meant parameters in fact. But the statement is ambiguous since we assume some implicit imports that are not referenced in the body as well.

abreslav · 2017-08-07T09:56:56Z

proposals/scripting-support.md

+  function
+- **(Scripting) Host** - an application or a component which handles script execution   
+- **REPL line** - a group of script text lines, executed in a single REPL eval call (*confusingly - a line == many text 
+  lines, so maybe another term is needed.*)


Terminology option:

REPL statement

abreslav · 2017-08-07T09:59:15Z

proposals/scripting-support.md

+### Project-level scripting
+
+Applications: test definition scripts (Spek), ktor routing scripts, project-level REPL, build scripts, type safe 
+config files, etc.


Why is Ktor privileged here?

abreslav · 2017-08-07T10:01:34Z

proposals/scripting-support.md

+  environment, supplying any arguments that the script requires:
+  - `(compiledScript, compilationConfig, environment) -> scriptObject`
+  - `(scriptObject, compilationConfig, environment) -> Unit`
+  - uses `compilationConfig` and `environment` for "feeding" the script with the arguments


If "feeding" is not a specially coined term, replace it with "passing arguments to the script"

It is more like "to compute arguments for the script"

Well, this means that I misunderstood the purpose of this, because of this terminonlgy

abreslav · 2017-08-07T10:04:00Z

proposals/scripting-support.md

+    scripting host
+- **Selector** - receives the script file and/or text before further analysis to determine whether the script belongs
+  to this scripting host and the particular set of components
+  - `(scriptSource) -> Boolean`


Does the file name belong to scriptSource?

yes, I meant that scriptSource (as ScriptContent class now) references the script either by file path or by contents or both.

abreslav · 2017-08-07T10:09:50Z

proposals/scripting-support.md

+```
+interface ScriptingPlatform<CompilationConfig> {
+    fun compile(scriptSource, scriptBaseClass: KClass<Scritpt>, compilationConfig: CompilationConfig): KClass<out Script>
+    fun <getIdeData>(scriptSource, scriptBaseClass: KClass<Script>, compilationConfig: CompilationConfig): <IdeData>


abreslav · 2017-08-07T10:11:34Z

proposals/scripting-support.md

+
+```
+interface ScriptPreprocessor<CompilationConfig> {
+    fun preprocess(scriptSource): CompilationConfig 


We have to clarify what "scriptSource" is here. Bot the file name and file contents should be available through it, IMO, but maybe something else too

abreslav · 2017-08-07T10:13:15Z

proposals/scripting-support.md

+
+```
+interface ScriptSelector {
+    fun isScript(scriptSource): boolean 


Most like likely a bad name. Is it really checking whether this is a script or not? I thought that it was checking whether this script can be processed by something (what is it, btw: platform, host, definition?)

I agree. I was playing with isKnownScript name as well, but it looked cumbersome. May be it is the better one anyway.

abreslav · 2017-08-07T10:13:58Z

proposals/scripting-support.md

+   - choose appropriate preprocessor or implement custom
+   - choose/implement selector
+   - define script class with the `@ScriptDefinition` annotation
+   - implement executor for the script class


What do I do with all these implementations?

They are used in the parts 2) and 3)

abreslav · 2017-08-07T10:14:40Z

proposals/scripting-support.md

+     - call platform to compile script
+     - call execute to get an instance
+     - call executor to run the script instance
+   - *(the base host may implement most of the boilerplate)*


Not clear which APIs I can use while doing this

It would be best to have a sample that does all this to refer to

plus some formatting and rearranging

udalov reviewed Aug 1, 2017

View reviewed changes

abreslav suggested changes Aug 7, 2017

View reviewed changes

ligee and others added 6 commits June 13, 2018 19:02

New proposal for updated scripting support

ec5592a

Add Selector class, some wording fixes

609b642

Fixed typo

59df717

Update text after review

222afb4

plus some formatting and rearranging

Update text after review and prototyping (up to interfaces definitions)

c784df5

Update scripting KEEP

8b5878c

ligee force-pushed the scripting branch from 3d2ebd2 to 8b5878c Compare June 13, 2018 17:03

ligee merged commit 8b5878c into master Jun 13, 2018

sdfgsdfgd mentioned this pull request Feb 27, 2025

[ Kotlin Scripting ] Proposal: Relax the *.main.kts Filename Requirement for Kotlin Script Execution #411

Open


		`kotlinc -script myscript.kts`

		Or with some hypothetical dedicated runner, that we might want to include into the distribution:


		Or with some hypothetical dedicated runner, that we might want to include into the distribution:

		`kotlinsh myscrtipt.ktsh`

Scripting #77

Scripting #77

Conversation

ligee commented Aug 1, 2017

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

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

Choose a reason for hiding this comment

ligee Aug 7, 2017 • edited Loading

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

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

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

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

Choose a reason for hiding this comment

ligee Aug 8, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ligee Aug 7, 2017 •

edited

Loading

ligee Aug 8, 2017 •

edited

Loading