Update documentation

- Code format

Author: rainboyan

src/docs/guide/configuration.adoc

@@ -42,6 +42,7 @@ The configuration for this data source would be:
 grails.plugin.databasemigration.reports.updateOnStart = true
 grails.plugin.databasemigration.reports.changelogFileName = changelog-second.groovy
 ----
+
 The configuration for all data sources with same db schema would be:
 [source,groovy]
 ----

src/docs/guide/generalUsage.adoc

@@ -21,10 +21,8 @@ You have a few options with `dbm-gorm-diff`:
 
 Regardless of which approach you use, be sure to inspect generated changes and adjust as necessary.
 
-
 === Autorun on start
 
-
 Since Liquibase maintains a record of changes that have been applied, you can avoid manually updating the database by taking advantage of the plugin's auto-run feature. By default this is disabled, but you can enable it by adding
 
 [source,groovy]
@@ -67,17 +65,17 @@ import liquibase.database.Database
 
 class MigrationCallbacks {
 
-   void beforeStartMigration(Database Database) {
-      ...
-   }
+    void beforeStartMigration(Database Database) {
+        ...
+    }
 
-   void onStartMigration(Database database, Liquibase liquibase, String changelogName) {
-      ...
-   }
+    void onStartMigration(Database database, Liquibase liquibase, String changelogName) {
+        ...
+    }
 
-   void afterMigrations(Database Database) {
-      ...
-   }
+    void afterMigrations(Database Database) {
+        ...
+    }
 }
 ----
 
@@ -88,6 +86,6 @@ Register it in resources.groovy:
 import com.mycompany.myapp.MigrationCallbacks
 
 beans = {
-   migrationCallbacks(MigrationCallbacks)
+    migrationCallbacks(MigrationCallbacks)
 }
 ----

src/docs/guide/gettingStarted.adoc

@@ -3,15 +3,15 @@ The first step is to add a dependency for the plugin in `build.gradle`:
 [source,groovy,subs="attributes"]
 ----
 buildscript {
-   dependencies {
-      ...
-      classpath 'org.graceframework.plugins:database-migration:{version}'
-   }
+    dependencies {
+        ...
+        classpath 'org.graceframework.plugins:database-migration:{version}'
+    }
 }
 
 dependencies {
-   ...
-     implementation 'org.graceframework.plugins:database-migration:{version}'
+    ...
+    implementation 'org.graceframework.plugins:database-migration:{version}'
 }
 ----
 
@@ -20,8 +20,8 @@ It is also recommended to add a direct dependency to liquibase because Spring Bo
 [source,groovy,subs="attributes"]
 ----
 dependencies {
-   ...
-     implementation 'org.liquibase:liquibase-core'
+    ...
+    implementation 'org.liquibase:liquibase-core'
 }
 ----
 
@@ -46,16 +46,17 @@ Next you'll need to create an initial changelog. You can use Liquibase XML or th
 Depending on the state of your database and code, you have two options; either create a changelog from the database or create it from your domain classes. The decision tends to be based on whether you prefer to design the database and adjust the domain classes to work with it, or to design your domain classes and use Hibernate to create the corresponding database structure.
 
 To create a changelog from the database, use the link:../ref/Rollback%20Scripts/dbm-generate-changelog.html[dbm-generate-changelog] script:
-[source,groovy]
+
+[source,console]
 ----
-grace dbm-generate-changelog changelog.groovy
+$ grace dbm-generate-changelog changelog.groovy
 ----
 
 or
 
-[source,groovy]
+[source,console]
 ----
-grace dbm-generate-changelog changelog.xml
+$ grace dbm-generate-changelog changelog.xml
 ----
 
 depending on whether you prefer the Groovy DSL or XML. The filename is relative to the changelog base folder, which defaults to `app/migrations`.
@@ -67,39 +68,39 @@ grails.plugin.databasemigration.changelogFileName = 'changelog.xml'
 ----
 
 Since the database is already correct, run the link:../ref/Maintenance%20Scripts/dbm-changelog-sync.html[dbm-changelog-sync] script to record that the changes have already been applied:
-[source,groovy]
+[source,console]
 ----
-grace dbm-changelog-sync
+$ grace dbm-changelog-sync
 ----
 
 Running this script is primarily a no-op except that it records the execution(s) in the Liquibase DATABASECHANGELOG table.
 
 To create a changelog from your domain classes, use the link:../ref/Rollback%20Scripts/dbm-generate-gorm-changelog.html[dbm-generate-gorm-changelog] script:
 
-[source,groovy]
+[source,console]
 ----
-grace dbm-generate-gorm-changelog changelog.groovy
+$ grace dbm-generate-gorm-changelog changelog.groovy
 ----
 
 or
 
-[source,groovy]
+[source,console]
 ----
-grace dbm-generate-gorm-changelog changelog.xml
+$ grace dbm-generate-gorm-changelog changelog.xml
 ----
 
 If you haven't created the database yet, run the link:../ref/Update%20Scripts/dbm-update.html[dbm-update] script to create the corresponding tables:
 
-[source,groovy]
+[source,console]
 ----
-grace dbm-update
+$ grace dbm-update
 ----
 
 or the link:../ref/Maintenance%20Scripts/dbm-changelog-sync.html[dbm-changelog-sync] script if the database is already in sync with your code:
 
-[source,groovy]
+[source,console]
 ----
-grace dbm-changelog-sync
+$ grace dbm-changelog-sync
 ----
 
 *Source control*

src/docs/guide/groovyChanges.adoc

@@ -10,41 +10,41 @@ This is the general format of a Groovy-based change; all inner tags and methods
 ----
 databaseChangeLog = {
 
-   changeSet(author: '...', id: '...') {
+    changeSet(author: '...', id: '...') {
 
-      grailsChange {
-         init {
-             // arbitrary initialization code; note that no
-             // database or connection is available
-         }
+        grailsChange {
+            init {
+                // arbitrary initialization code; note that no
+                // database or connection is available
+            }
 
-         validate {
-            // can call warn(String message) to log a warning
-            // or error(String message) to stop processing
-         }
+            validate {
+                // can call warn(String message) to log a warning
+                // or error(String message) to stop processing
+            }
 
-         change {
-            // arbitrary code; make changes directly and/or return a
-            // SqlStatement using the sqlStatement(SqlStatement sqlStatement)
-            // method or multiple with sqlStatements(List sqlStatements)
+            change {
+                // arbitrary code; make changes directly and/or return a
+                // SqlStatement using the sqlStatement(SqlStatement sqlStatement)
+                // method or multiple with sqlStatements(List sqlStatements)
 
-            confirm 'change confirmation message'
-         }
+                confirm 'change confirmation message'
+            }
 
-         rollback {
-            // arbitrary code; make rollback changes directly and/or
-            // return a SqlStatement using the sqlStatement(SqlStatement sqlStatement)
-            // method or multiple with sqlStatements(List sqlStatements)
+            rollback {
+                // arbitrary code; make rollback changes directly and/or
+                // return a SqlStatement using the sqlStatement(SqlStatement sqlStatement)
+                // method or multiple with sqlStatements(List sqlStatements)
 
-            confirm 'rollback confirmation message'
-         }
+                confirm 'rollback confirmation message'
+            }
 
-         confirm 'confirmation message'
+            confirm 'confirmation message'
 
-         checkSum 'override value for checksum'
-      }
+            checkSum 'override value for checksum'
+        }
 
-   }
+    }
 }
 ----
 

src/docs/guide/groovyPreconditions.adoc

@@ -8,35 +8,34 @@ This is the general format of a Groovy-based precondition:
 ----
 databaseChangeLog = {
 
-   changeSet(author: '...', id: '...') {
+    changeSet(author: '...', id: '...') {
 
-      preConditions {
+        preConditions {
 
-         grailsPrecondition {
+            grailsPrecondition {
 
-            check {
+                check {
+                    // use an assertion
+                    assert x == x
 
-               // use an assertion
-               assert x == x
+                    // use an assertion with an error message
+                    assert y == y : 'value cannot be 237'
 
-               // use an assertion with an error message
-               assert y == y : 'value cannot be 237'
+                    // call the fail method
+                    if (x != x) {
+                        fail 'x != x'
+                    }
 
-               // call the fail method
-               if (x != x) {
-                  fail 'x != x'
-               }
+                    // throw an exception (the fail method is preferred)
+                    if (y != y) {
+                        throw new RuntimeException('y != y')
+                    }
+                }
 
-               // throw an exception (the fail method is preferred)
-               if (y != y) {
-                  throw new RuntimeException('y != y')
-               }
             }
 
-         }
-
-      }
-   }
+        }
+    }
 }
 ----
 

src/docs/ref/Diff Scripts/dbm-diff.adoc

@@ -13,9 +13,9 @@ If a filename parameter is specified then the output will be written to the name
 File are written to the migrations folder, so specify the filename relative to the migrations folder (`app/migrations` by default).
 
 Usage:
-[source,java]
+[source,console]
 ----
-grace <<environment>> dbm-diff <<otherEnv>> <<filename>> --defaultSchema=<<defaultSchema>> --dataSource=<<dataSource>> --add
+$ grace <<environment>> dbm-diff <<otherEnv>> <<filename>> --defaultSchema=<<defaultSchema>> --dataSource=<<dataSource>> --add
 ----
 
 Required arguments:
@@ -30,14 +30,14 @@ Optional arguments:
 * `dataSource` - If provided will run the script for the specified dataSource. Not needed for the default dataSource.
 
 NOTE: Note that the `defaultSchema` and `dataSource` parameter name and value must be quoted if executed in Windows, e.g.
-[source,groovy]
+[source,console]
 ----
-grace dbm-diff "--defaultSchema=<<defaultSchema>>" "--dataSource=<<dataSource>>"
+$ grace dbm-diff "--defaultSchema=<<defaultSchema>>" "--dataSource=<<dataSource>>"
 ----
 
 NOTE: For the `dataSource` parameter, if the data source is configured as `reports` underneath the `dataSources` key in `application.[yml|groovy]`, the value should be `reports`.
 
-[source,groovy]
+[source,console]
 ----
 --dataSource=reports
 ----

src/docs/ref/Diff Scripts/dbm-gorm-diff.adoc

@@ -17,9 +17,9 @@ Doesn't modify any existing files - you need to manually merge the output into t
 You can configure database objects to be ignored by this script - either in the GORM classes or in the target database. For example you may want domain objects that are transient, or you may have externally-managed tables, keys, etc. that you want left alone by the diff script. The configuration name for these ignored objects is `grails.plugin.databasemigration.ignoredObjects`, whose value is a list of strings.
 
 Usage:
-[source,java]
+[source,console]
 ----
-grace <<environment>> dbm-gorm-diff <<filename>> --defaultSchema=<<defaultSchema>> --dataSource=<<dataSource>> --add
+$ grace <<environment>> dbm-gorm-diff <<filename>> --defaultSchema=<<defaultSchema>> --dataSource=<<dataSource>> --add
 ----
 
 Required arguments: _none_ .
@@ -32,14 +32,14 @@ Optional arguments:
 * `dataSource` - if provided will run the script for the specified dataSource.  Not needed for the default dataSource.
 
 NOTE: Note that the `defaultSchema` and `dataSource` parameter name and value must be quoted if executed in Windows, e.g.
-[source,groovy]
+[source,console]
 ----
-grace dbm-gorm-diff "--defaultSchema=<<defaultSchema>>" "--dataSource=<<dataSource>>"
+$ grace dbm-gorm-diff "--defaultSchema=<<defaultSchema>>" "--dataSource=<<dataSource>>"
 ----
 
 NOTE: For the `dataSource` parameter, if the data source is configured as `reports` underneath the `dataSources` key in `application.[yml|groovy]`, the value should be `reports`.
 
-[source,groovy]
+[source,console]
 ----
 --dataSource=reports
 ----

src/docs/ref/Documentation Scripts/dbm-db-doc.adoc

@@ -9,9 +9,9 @@ Generates Javadoc-like documentation based on current database and change log.
 Writes to the folder specified by the `destination` parameter, or to the `grails.plugin.databasemigration.dbDocLocation` configuration option (defaults to `target/dbdoc`).
 
 Usage:
-[source,java]
+[source,console]
 ----
-grace <<environment>> dbm-db-doc <<destination>> --contexts=<<contexts>> --dataSource=<<dataSource>>
+$ grace <<environment>> dbm-db-doc <<destination>> --contexts=<<contexts>> --dataSource=<<dataSource>>
 ----
 
 Required arguments: _none_ .
@@ -23,14 +23,14 @@ Optional arguments:
 * `dataSource` - if provided will run the script for the specified dataSource.  Not needed for the default dataSource.
 
 NOTE: Note that the `contexts` and `dataSource` parameter name and value must be quoted if executed in Windows, e.g.
-[source,groovy]
+[source,console]
 ----
-grace dbm-db-doc "--contexts=<<contexts>>" "--dataSource=<<dataSource>>"
+$ grace dbm-db-doc "--contexts=<<contexts>>" "--dataSource=<<dataSource>>"
 ----
 
 NOTE: For the `dataSource` parameter, if the data source is configured as `reports` underneath the `dataSources` key in `application.[yml|groovy]`, the value should be `reports`.
 
-[source,groovy]
+[source,console]
 ----
 --dataSource=reports
 ----

src/docs/ref/Maintenance Scripts/dbm-add-migration.adoc

@@ -10,9 +10,9 @@ This script provides a template in which to place your migration behaviour code,
 Grace code or raw SQL.
 
 Usage:
-[source,java]
+[source,console]
 ----
-grace <<environment>> dbm-add-migration <<migrationName>>
+$ grace <<environment>> dbm-add-migration <<migrationName>>
 ----
 
 Required arguments: