yosql-models/yosql-models-generator/src/main/resources/configurationSetting.md

   1 ---
   2 title: {{setting.name}}
   3 date: {{currentDate}}
   4 menu:
   5   main:
   6     parent: {{group.name}}
   7 categories:
   8   - Configuration
   9 tags:
  10   - {{#lower}}{{group.name}}{{/lower}}
  11 {{#setting.tags}}
  12   - {{.}}
  13 {{/setting.tags}}
  14 generated: true
  15 ---
  16
  17 {{setting.description}}
  18
  19 {{#hasExplanation}}
  20 {{setting.explanation}}
  21
  22 {{/hasExplanation}}
  23 ## Configuration Options
  24
  25 {{#setting.examples}}
  26 ### Option: '{{value}}'
  27
  28 {{description}}
  29
  30 {{#result}}
  31 ```java
  32 {{{.}}}
  33 ```
  34
  35 {{/result}}
  36 {{/setting.examples}}
  37 {{#hasRelatedSettings}}
  38 ## Related Options
  39
  40 {{#relatedSettings}}
  41 - [{{name}}](../{{#lower}}{{name}}{{/lower}}/): {{description}}
  42 {{/relatedSettings}}
  43 {{/hasRelatedSettings}}
  44
  45 ## Tooling
  46
  47 ### Ant
  48
  49 In order to use `YoSQL` together with [Ant](https://ant.apache.org/), take a look at the tooling [documentation for Ant](/tooling/ant/).
  50
  51 ### Bazel
  52
  53 In order to use `YoSQL` together with [Bazel](https://bazel.build/), take a look at the tooling [documentation for Bazel](/tooling/bazel/).
  54
  55 ### CLI
  56
  57 In order to use `YoSQL` on the command line, take a look at the tooling [documentation for CLI](/tooling/cli/).
  58
  59 ```console
  60 $ yosql --{{#lower}}{{group.name}}{{/lower}}-{{#kebab}}{{setting.name}}{{/kebab}}=configValue
  61 ```
  62
  63 As long as the name of the config option is unique across all configuration groups, you can use the shorter form:
  64
  65 ```console
  66 $ yosql --{{#kebab}}{{setting.name}}{{/kebab}}=configValue
  67 ```
  68
  69 ### Gradle
  70
  71 In order to use `YoSQL` together with [Gradle](https://gradle.org/), take a look at the tooling [documentation for Gradle](/tooling/gradle/). The `{{setting.name}}` setting can be configured using Gradle in Kotlin syntax like this:
  72
  73 ```kotlin
  74 plugins {
  75   java
  76   id("wtf.metio.yosql") version "{{yosqlVersion}}"
  77 }
  78
  79 yosql {
  80   {{#lower}}{{group.name}}{{/lower}} {
  81     {{setting.name}}.set(configValue)
  82   }
  83 }
  84 ```
  85
  86 or in Groovy syntax like this:
  87
  88 ```groovy
  89 plugins {
  90   id "java"
  91   id "wtf.metio.yosql" version "{{yosqlVersion}}"
  92 }
  93
  94 yosql {
  95   {{#lower}}{{group.name}}{{/lower}} {
  96     {{setting.name}} = configValue
  97   }
  98 }
  99 ```
 100
 101 ### Maven
 102
 103 In order to use `YoSQL` together with [Maven](https://maven.apache.org/), take a look at the tooling [documentation for Maven](/tooling/maven/). The `{{setting.name}}` setting can be configured using Maven like this:
 104
 105 ```xml
 106 <build>
 107   <plugins>
 108     <plugin>
 109       <groupId>wtf.metio.yosql</groupId>
 110       <artifactId>yosql-tooling-maven</artifactId>
 111       <version>{{yosqlVersion}}</version>
 112       <configuration>
 113         <{{#lower}}{{group.name}}{{/lower}}>
 114           <{{setting.name}}>configValue</{{setting.name}}>
 115         </{{#lower}}{{group.name}}{{/lower}}>
 116       </configuration>
 117     </plugin>
 118   </plugins>
 119 </build>
 120 ```