Skip to content

Latest commit

 

History

History
81 lines (54 loc) · 3.37 KB

README.md

File metadata and controls

81 lines (54 loc) · 3.37 KB
Raw

✨ Gradle Intellij Run Generator Plugin ✨

KtLint Gradle Plugin License

A Gradle plugin that generates Intellij Run configurations from a YAML definition file, written in Kotlin.

💡 Introduction

This plugin allows to specify Intellij Run configurations with YAML!

For now, the scope of the plugin is quite simplistic, but over time new use cases or improvements may be added!

Originally, this plugin was developed for our Besu plugin: Exflo as a way of sharing complex configurations easily.

🙈 Usage

To apply the plugin, use the gradle plugin syntax:

plugins {
  id("dev.north.fortyone.intellij.run.generator") version "0.2.0"
}

Once the plugin is applied, you can configure it with the following options (default values are displayed below):

intellijRunGenerator {
  tasksDefinitionsFile.set(File("./intellij-run-configs.yaml"))
  tasksDefinitionsFileExtension = FilenameFilter { _, name -> name.toLowerCase().endsWith(".yaml") || name.toLowerCase().endsWith(".yml") }
  tasksDefinitionOutputDir.set(File(".idea/runConfigurations"))
}

Also you can specify a folder instead of a single definition file, just like this (by default it will load all *.yaml, *.yml files):

intellijRunGenerator {
  tasksDefinitionsFile.set(File("./intellij-run-configs/"))
}

If you want to see how the definition file looks like, there're some examples inside samples/intellij-run-configs.yaml.

💻 Contribute

We welcome any kind of contribution or support to this project but before to do so:

  • Make sure you have read the contribution guide for more details on how to submit a good PR (pull request).

Also, we are not only limited to technical contributions. Things that make us happy are:

  • Add a GitHub Star to the project.
  • Tweet about this project.
  • Write a review or tutorial.

Other Gradle plugins

We have published other gradle plugins:

📬 Get in touch

Gradle Intellij Run Generator Plugin has been developed initially by °41North.

If you think this project would be useful for your use case and want to talk more about it you can reach out to us via our contact form or by sending an email to [email protected]. We try to respond within 48 hours and look forward to hearing from you.

✍️ License

Gradle Intellij Run Generator Plugin is free and open-source software licensed under the Apache 2.0 License.