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