feat: cli output shortcode

Author: ldez

docs/content/docs/configuration/cli.md

@@ -3,10 +3,7 @@ title: Command-Line
 weight: 1
 ---
 
-```console
-$ golangci-lint -h
-{.CmdRootHelpText}
-```
+{{% cli-output %}}
 
 ## `run`
 
@@ -16,10 +13,7 @@ $ golangci-lint -h
     {{< card link="/docs/linters/configuration/" title="Linter Settings" icon="adjustments" >}}
 {{< /cards >}}
 
-```console
-$ golangci-lint run -h
-{.CmdRunHelpText}
-```
+{{% cli-output cmd="run" %}}
 
 When the `--cpu-profile-path` or `--mem-profile-path` arguments are specified,
 golangci-lint writes runtime profiling data in the format expected by the [pprof](https://github.com/google/pprof) visualization tool.
@@ -35,38 +29,23 @@ the `go tool trace` command and visualization tool.
 {{< card link="/docs/formatters/configuration/" title="Formatter Settings" icon="adjustments" >}}
 {{< /cards >}}
 
-```console
-$ golangci-lint fmt -h
-{.CmdFmtHelpText}
-```
+{{% cli-output cmd="fmt" %}}
 
 ## `migrate`
 
-```console
-$ golangci-lint migrate -h
-{.CmdMigrateHelpText}
-```
+{{% cli-output cmd="migrate" %}}
 
 ## `formatters`
 
-```console
-$ golangci-lint formatters -h
-{.CmdFormattersHelpText}
-```
+{{% cli-output cmd="formatters" %}}
 
 ## `help`
 
-```console
-$ golangci-lint help -h
-{.CmdHelpText}
-```
+{{% cli-output cmd="help" %}}
 
 ## `linters`
 
-```console
-$ golangci-lint linters -h
-{.CmdLintersHelpText}
-```
+{{% cli-output cmd="linters" %}}
 
 ## `cache`
 
@@ -76,35 +55,20 @@ You can override the default cache directory with the environment variable `GOLA
 
 The cache is only used by `golangci-lint run` (linters).
 
-```console
-$ golangci-lint cache -h
-{.CmdCacheHelpText}
-```
+{{% cli-output cmd="cache" %}}
 
 ## `config`
 
-```console
-$ golangci-lint config -h
-{.CmdConfigHelpText}
-```
+{{% cli-output cmd="config" %}}
 
 ## `custom`
 
-```console
-$ golangci-lint custom -h
-{.CmdCustomHelpText}
-```
+{{% cli-output cmd="custom" %}}
 
 ## `version`
 
-```console
-$ golangci-lint version -h
-{.CmdVersionHelpText}
-```
+{{% cli-output cmd="version" %}}
 
 ## `completion`
 
-```console
-$ golangci-lint completion -h
-{.CmdCompletionHelpText}
-```
+{{% cli-output cmd="completion" %}}

docs/content/docs/product/migration-guide.md

@@ -46,24 +46,7 @@ Other fields explicitly defined in the configuration file are migrated even if t
 
 The `migrate` command automatically migrates `linters.presets` in individual linters to `linters.enable`.
 
-```txt
-Migrate configuration file from v1 to v2
-
-Usage:
-  golangci-lint migrate [flags]
-
-Flags:
-  -c, --config PATH       Read config from file path PATH
-      --no-config         Don't read config file
-      --format string     Output file format.
-                          By default, the format of the input configuration file is used.
-                          It can be 'yml', 'yaml', 'toml', or 'json'.
-      --skip-validation   Skip validation of the configuration file against the JSON Schema for v1.
-
-Global Flags:
-  -h, --help           Help for a command
-
-```
+{{% cli-output cmd="migrate" %}}
 
 ## Changes
 

docs/content/docs/welcome/quick-start.md

@@ -30,10 +30,7 @@ It's not possible to mix files and packages/directories, and files must come fro
 
 Golangci-lint can be used with zero configuration. By default, the following linters are enabled:
 
-```console
-$ golangci-lint help linters
-{.LintersCommandOutputEnabledOnly}
-```
+{{% cli-output section="defaultEnabledLinters" cmd="help linters" %}}
 
 Pass `-E/--enable` to enable linter and `-D/--disable` to disable:
 

docs/layouts/_shortcodes/cli-output.html

@@ -0,0 +1,29 @@
+{{- /*
+Creates a code block with the output of the CLI.
+
+@param {string} cmd The name of the command.
+@param {string} section The name of the section inside the data file.
+
+@example {{% cli-output %}}
+@example {{% cli-output cmd="foo" %}}
+@example {{% cli-output section="sectionName" cmd="foo bar" %}}
+*/ -}}
+
+{{- $cmdName := .Get "cmd" -}}
+{{- $section := .Get "section" -}}
+
+{{- $cliData := index $.Site.Data.cli_help -}}
+
+```console
+{{ if $section -}}
+
+$ golangci-lint {{ $cmdName }}
+
+{{- else -}}
+    {{- $section = print (or $cmdName "root") "Output" -}}
+
+$ golangci-lint{{ if $cmdName }} {{ $cmdName }}{{ end }} -h
+
+{{- end }}
+{{ index $cliData $section | safeHTML }}
+```