Simplify Gradle scripts that use AntlrKotlinTask

[lppedd]

No description provided.

[ftomassetti]

How do we specify such source directory? Do we use a standard path or should it be expressly defined by the user?

[lppedd]

@ftomassetti I've recently learnt that Gradle is able to infer the directory path automatically thanks to the @OutputDirectory-annotated property in the custom task. So inputting the task instance to srcDir is all what's needed.

[ftomassetti]

Ok, but the way in which it is phrased I interpreted to mean that when using the generateKotlinGrammarSource we will specify the source directory we want. While instead I think that what happens is that the generateKotlinGrammarSource target will generate Kotlin code for the lexer, parser, or combined grammars found under src/main/antlr and all the generated code will be produced in a certain directory (which is pre-defined in the gradle plugin and the user cannot pick). What the user needs to do is to instruct gradle to consider that directory where the code is generated as a source directory.

By the way, I wonder if we should do that automatically by default.

So instead of:

Use the generateKotlinGrammarSource task to provide an additional source directory to the commonMain source set. Gradle will then infer the task dependency automatically.

I would write:

Specify that the output directory of the `generateKotlinGrammarSource` task should be included as a source directory in the commonMain source set. In Gradle, you can do that by simply reference the task itself, and Gradle will automatically infer the associated output directory and include such directory in the source set.

What do you think?

[lppedd]

@ftomassetti makes sense to update that sentence in the readme. Your version sounds better, indeed.

[ftomassetti]

Thank you, then I will merge it and then change the sentence

[lppedd]

Perfect, thanks!

[ftomassetti]

It looks good to me, I have just a single comment on the README