Add display.indent config option (#471)

Fixes #394.

docs/src/config_display.md

@@ -37,3 +37,35 @@ show_title = true
 
 When enabled, the command name will be displayed at the top of the output,
 styled with the `command_name` style configuration.
+
+## `indent`
+
+Controls the indentation of the output via two sub-keys.
+
+### `indent.base`
+
+Specifies the number of spaces used to indent descriptions, example text, and titles (default `2`).
+
+```toml
+[display.indent]
+base = 2
+```
+
+### `indent.command`
+
+Specifies the number of spaces used to indent example code lines (default `6`).
+
+```toml
+[display.indent]
+command = 6
+```
+
+You can also configure both subkeys in a single line like this:
+
+```toml
+[display]
+indent = {
+  base = 2,
+  command = 6,
+}
+```

src/config.rs

@@ -43,6 +43,14 @@ fn default_underline() -> bool {
     false
 }
 
+const fn default_base_indent() -> usize {
+    2
+}
+
+const fn default_command_indent() -> usize {
+    6
+}
+
 fn default_bold() -> bool {
     false
 }
@@ -171,6 +179,25 @@ struct RawDisplayConfig {
     pub use_pager: bool,
     #[serde(default)]
     pub show_title: bool,
+    #[serde(default)]
+    pub indent: RawIndent,
+}
+
+#[derive(Copy, Clone, Debug, Serialize, Deserialize, PartialEq, Eq)]
+struct RawIndent {
+    #[serde(default = "default_base_indent")]
+    base: usize,
+    #[serde(default = "default_command_indent")]
+    command: usize,
+}
+
+impl Default for RawIndent {
+    fn default() -> Self {
+        Self {
+            base: 2,
+            command: 6,
+        }
+    }
 }
 
 impl From<&RawDisplayConfig> for DisplayConfig {
@@ -179,6 +206,10 @@ impl From<&RawDisplayConfig> for DisplayConfig {
             compact: raw_display_config.compact,
             use_pager: raw_display_config.use_pager,
             show_title: raw_display_config.show_title,
+            indent: Indent {
+                base: raw_display_config.indent.base,
+                command: raw_display_config.indent.command,
+            },
         }
     }
 }
@@ -331,6 +362,13 @@ pub struct DisplayConfig {
     pub compact: bool,
     pub use_pager: bool,
     pub show_title: bool,
+    pub indent: Indent,
+}
+
+#[derive(Copy, Clone, Debug, PartialEq, Eq)]
+pub struct Indent {
+    pub base: usize,
+    pub command: usize,
 }
 
 #[derive(Clone, Debug, PartialEq, Eq)]

src/formatter.rs

@@ -2,7 +2,7 @@
 
 use log::debug;
 
-use crate::{extensions::FindFrom, types::LineType};
+use crate::{config::Indent, extensions::FindFrom, types::LineType};
 
 #[derive(Debug, Clone, Copy, Eq)]
 /// Represents a snippet from a page of a specific highlighting class.
@@ -68,11 +68,14 @@ pub fn highlight_lines<L, F, E>(
     process_snippet: &mut F,
     keep_empty_lines: bool,
     show_title: bool,
+    indent: Indent,
 ) -> Result<(), E>
 where
     L: Iterator<Item = LineType>,
     F: for<'snip> FnMut(PageSnippet<&'snip str>) -> Result<(), E>,
 {
+    let base_indent = " ".repeat(indent.base);
+    let command_indent = " ".repeat(indent.command);
     let mut command = String::new();
     for line in lines {
         match line {
@@ -84,7 +87,9 @@ where
             LineType::Title(title) => {
                 if show_title {
                     process_snippet(PageSnippet::Linebreak)?;
+                    process_snippet(PageSnippet::Title(&base_indent))?;
                     process_snippet(PageSnippet::Title(&title))?;
+                    process_snippet(PageSnippet::Linebreak)?;
                 } else {
                     debug!("Ignoring title");
                 }
@@ -93,10 +98,18 @@ where
                 command = title;
                 debug!("Detected command name: {}", &command);
             }
-            LineType::Description(text) => process_snippet(PageSnippet::Description(&text))?,
-            LineType::ExampleText(text) => process_snippet(PageSnippet::Text(&text))?,
+            LineType::Description(text) => {
+                process_snippet(PageSnippet::Description(&base_indent))?;
+                process_snippet(PageSnippet::Description(&text))?;
+                process_snippet(PageSnippet::Linebreak)?;
+            }
+            LineType::ExampleText(text) => {
+                process_snippet(PageSnippet::Text(&base_indent))?;
+                process_snippet(PageSnippet::Text(&text))?;
+                process_snippet(PageSnippet::Linebreak)?;
+            }
             LineType::ExampleCode(text) => {
-                process_snippet(PageSnippet::NormalCode("      "))?;
+                process_snippet(PageSnippet::NormalCode(&command_indent))?;
                 highlight_code(&command, &text, process_snippet)?;
                 process_snippet(PageSnippet::Linebreak)?;
             }

src/output.rs

@@ -68,6 +68,7 @@ pub fn print_page(
             &mut process_snippet,
             !config.display.compact,
             config.display.show_title,
+            config.display.indent,
         )
         .context("Could not write to stdout")?;
     }
@@ -89,9 +90,9 @@ fn print_snippet(
         CommandName(s) => write!(writer, "{}", s.paint(style.command_name)),
         Variable(s) => write!(writer, "{}", s.paint(style.example_variable)),
         NormalCode(s) => write!(writer, "{}", s.paint(style.example_code)),
-        Description(s) => writeln!(writer, "  {}", s.paint(style.description)),
-        Text(s) => writeln!(writer, "  {}", s.paint(style.example_text)),
-        Title(s) => writeln!(writer, "  {}", s.paint(style.command_name)),
+        Description(s) => write!(writer, "{}", s.paint(style.description)),
+        Text(s) => write!(writer, "{}", s.paint(style.example_text)),
+        Title(s) => write!(writer, "{}", s.paint(style.command_name)),
         Linebreak => writeln!(writer),
     }
 }

tests/lib.rs

@@ -821,6 +821,24 @@ fn test_rendering_color_never() {
     );
 }
 
+/// An end-to-end integration test for the indent config option
+#[test]
+fn test_rendering_with_indentation() {
+    let testenv = TestEnv::new().install_default_cache();
+    let expected_custom_indentation = include_str!("rendered/inkscape-compact-no-color.expected");
+
+    // Configure to set base and command indents
+    testenv.append_to_config("display.indent.base = 3\n");
+    testenv.append_to_config("display.indent.command = 1\n");
+
+    testenv
+        .command()
+        .args(["--color", "never", "inkscape-v2"])
+        .assert()
+        .success()
+        .stdout(diff(expected_custom_indentation));
+}
+
 #[test]
 fn test_rendering_i18n() {
     _test_correct_rendering(

tests/rendered/apt.ja.expected

@@ -3,35 +3,35 @@
   Ubuntuのバージョンが16.04か、それ以降で対話モードを使う場合`apt-get`の代わりとして使用します。
   詳しくはこちら: <https://manned.org/apt.8>
 
-  利用可能なパーケージとバージョンのリストの更新（他の`apt`コマンドの前での実行を推奨）:
+  利用可能なパーケージとバージョンのリストの更新（他の`apt`コマンドの前での実行を推奨）:
 
       sudo apt update
 
-  指定されたパッケージの検索:
+  指定されたパッケージの検索:
 
       apt search パッケージ
 
-  パッケージの情報を出力:
+  パッケージの情報を出力:
 
       apt show パッケージ
 
-  パッケージのインストール、または利用可能な最新バージョンに更新:
+  パッケージのインストール、または利用可能な最新バージョンに更新:
 
       sudo apt install パッケージ
 
-  パッケージの削除（`sudo apt remove --purge`の場合設定ファイルも削除）:
+  パッケージの削除（`sudo apt remove --purge`の場合設定ファイルも削除）:
 
       sudo apt remove パッケージ
 
-  インストールされている全てのパッケージを最新のバージョンにアップグレード:
+  インストールされている全てのパッケージを最新のバージョンにアップグレード:
 
       sudo apt upgrade
 
-  インストールできるすべてのパッケージを表示:
+  インストールできるすべてのパッケージを表示:
 
       apt list
 
-  インストールされた全てのパッケージを表示（依存関係も表示）:
+  インストールされた全てのパッケージを表示（依存関係も表示）:
 
       apt list --installed
 

tests/rendered/inkscape-compact-no-color.expected

@@ -0,0 +1,32 @@
+
+   An SVG (Scalable Vector Graphics) editing program.
+   Use -z to not open the GUI and only process files in the console.
+
+   Open an SVG file in the Inkscape GUI:
+
+ inkscape filename.svg
+
+   Export an SVG file into a bitmap with the default format (PNG) and the default resolution (90 DPI):
+
+ inkscape filename.svg -e filename.png
+
+   Export an SVG file into a bitmap of 600x400 pixels (aspect ratio distortion may occur):
+
+ inkscape filename.svg -e filename.png -w 600 -h 400
+
+   Export a single object, given its ID, into a bitmap:
+
+ inkscape filename.svg -i id -e object.png
+
+   Export an SVG document to PDF, converting all texts to paths:
+
+ inkscape filename.svg | inkscape | inkscape --export-pdf=inkscape.pdf | inkscape | inkscape --export-text-to-path
+
+   Duplicate the object with id="path123", rotate the duplicate 90 degrees, save the file, and quit Inkscape:
+
+ inkscape filename.svg --select=path123 --verb=EditDuplicate --verb=ObjectRotate90 --verb=FileSave --verb=FileQuit
+
+   Some invalid command just to test the correct highlighting of the command name:
+
+ inkscape --use-inkscape=v3.0 file
+

tests/rendered/inkscape-default.expected

@@ -2,31 +2,31 @@
   An SVG (Scalable Vector Graphics) editing program.
   Use -z to not open the GUI and only process files in the console.
 
-  Open an SVG file in the Inkscape GUI:
+  Open an SVG file in the Inkscape GUI:
 
       inkscape filename.svg
 
-  Export an SVG file into a bitmap with the default format (PNG) and the default resolution (90 DPI):
+  Export an SVG file into a bitmap with the default format (PNG) and the default resolution (90 DPI):
 
       inkscape filename.svg -e filename.png
 
-  Export an SVG file into a bitmap of 600x400 pixels (aspect ratio distortion may occur):
+  Export an SVG file into a bitmap of 600x400 pixels (aspect ratio distortion may occur):
 
       inkscape filename.svg -e filename.png -w 600 -h 400
 
-  Export a single object, given its ID, into a bitmap:
+  Export a single object, given its ID, into a bitmap:
 
       inkscape filename.svg -i id -e object.png
 
-  Export an SVG document to PDF, converting all texts to paths:
+  Export an SVG document to PDF, converting all texts to paths:
 
       inkscape filename.svg | inkscape | inkscape --export-pdf=inkscape.pdf | inkscape | inkscape --export-text-to-path
 
-  Duplicate the object with id="path123", rotate the duplicate 90 degrees, save the file, and quit Inkscape:
+  Duplicate the object with id="path123", rotate the duplicate 90 degrees, save the file, and quit Inkscape:
 
       inkscape filename.svg --select=path123 --verb=EditDuplicate --verb=ObjectRotate90 --verb=FileSave --verb=FileQuit
 
-  Some invalid command just to test the correct highlighting of the command name:
+  Some invalid command just to test the correct highlighting of the command name:
 
       inkscape --use-inkscape=v3.0 file
 

tests/rendered/inkscape-with-config.expected

@@ -2,31 +2,31 @@
   An SVG (Scalable Vector Graphics) editing program.
   Use -z to not open the GUI and only process files in the console.
 
-  Open an SVG file in the Inkscape GUI:
+  Open an SVG file in the Inkscape GUI:
 
       inkscape filename.svg
 
-  Export an SVG file into a bitmap with the default format (PNG) and the default resolution (90 DPI):
+  Export an SVG file into a bitmap with the default format (PNG) and the default resolution (90 DPI):
 
       inkscape filename.svg -e filename.png
 
-  Export an SVG file into a bitmap of 600x400 pixels (aspect ratio distortion may occur):
+  Export an SVG file into a bitmap of 600x400 pixels (aspect ratio distortion may occur):
 
       inkscape filename.svg -e filename.png -w 600 -h 400
 
-  Export a single object, given its ID, into a bitmap:
+  Export a single object, given its ID, into a bitmap:
 
       inkscape filename.svg -i id -e object.png
 
-  Export an SVG document to PDF, converting all texts to paths:
+  Export an SVG document to PDF, converting all texts to paths:
 
       inkscape filename.svg | inkscape | inkscape --export-pdf=inkscape.pdf | inkscape | inkscape --export-text-to-path
 
-  Duplicate the object with id="path123", rotate the duplicate 90 degrees, save the file, and quit Inkscape:
+  Duplicate the object with id="path123", rotate the duplicate 90 degrees, save the file, and quit Inkscape:
 
       inkscape filename.svg --select=path123 --verb=EditDuplicate --verb=ObjectRotate90 --verb=FileSave --verb=FileQuit
 
-  Some invalid command just to test the correct highlighting of the command name:
+  Some invalid command just to test the correct highlighting of the command name:
 
       inkscape --use-inkscape=v3.0 file
 

tests/rendered/inkscape-with-title.expected

@@ -1,34 +1,34 @@
 
-  inkscape
+  inkscape
 
   An SVG (Scalable Vector Graphics) editing program.
   Use -z to not open the GUI and only process files in the console.
 
-  Open an SVG file in the Inkscape GUI:
+  Open an SVG file in the Inkscape GUI:
 
       inkscape filename.svg
 
-  Export an SVG file into a bitmap with the default format (PNG) and the default resolution (90 DPI):
+  Export an SVG file into a bitmap with the default format (PNG) and the default resolution (90 DPI):
 
       inkscape filename.svg -e filename.png
 
-  Export an SVG file into a bitmap of 600x400 pixels (aspect ratio distortion may occur):
+  Export an SVG file into a bitmap of 600x400 pixels (aspect ratio distortion may occur):
 
       inkscape filename.svg -e filename.png -w 600 -h 400
 
-  Export a single object, given its ID, into a bitmap:
+  Export a single object, given its ID, into a bitmap:
 
       inkscape filename.svg -i id -e object.png
 
-  Export an SVG document to PDF, converting all texts to paths:
+  Export an SVG document to PDF, converting all texts to paths:
 
       inkscape filename.svg | inkscape | inkscape --export-pdf=inkscape.pdf | inkscape | inkscape --export-text-to-path
 
-  Duplicate the object with id="path123", rotate the duplicate 90 degrees, save the file, and quit Inkscape:
+  Duplicate the object with id="path123", rotate the duplicate 90 degrees, save the file, and quit Inkscape:
 
       inkscape filename.svg --select=path123 --verb=EditDuplicate --verb=ObjectRotate90 --verb=FileSave --verb=FileQuit
 
-  Some invalid command just to test the correct highlighting of the command name:
+  Some invalid command just to test the correct highlighting of the command name:
 
       inkscape --use-inkscape=v3.0 file