feat: generate all of the docs in a script

Author: nik-rev

.cargo/config.toml

@@ -1,3 +1,6 @@
+[alias]
+docgen = "run --package docgen --"
+
 [target.aarch64-apple-darwin]
 linker = "rust-lld"
 # NOTE: `rustdoc` doesn't currently respect the `linker` setting — keep an eye

CLI.md

@@ -0,0 +1,55 @@
+# Command-Line Help for `ferrishot`
+
+This document contains the help content for the `ferrishot` command-line program.
+
+**Command Overview:**
+
+- [`ferrishot`↴](#ferrishot)
+
+## `ferrishot`
+
+A cross-platform desktop screenshot app
+
+**Usage:** `ferrishot [OPTIONS]`
+
+###### **Arguments:**
+
+- `<FILE>` — Instead of taking a screenshot of the desktop, open this image instead
+
+###### **Options:**
+
+- `-r`, `--region <WxH+X+Y>` — Open with a region pre-selected
+
+  Format: `<width>x<height>+<top-left-x>+<top-left-y>`
+
+- `-l`, `--last-region` — Use last region
+- `-a`, `--accept-on-select <ACTION>` — Accept capture and perform the action as soon as a selection is made
+
+  If holding `ctrl` while you are releasing the left mouse button on the first selection,
+  the behavior is cancelled
+
+  It's quite useful to run ferrishot, select a region and have it instantly be copied to the
+  clipboard for example. In 90% of situations you won't want to do much post-processing of
+  the region and this makes that experience twice as fast. You can always opt-out with `ctrl`
+
+  Using this option with `--region` or `--last-region` will run ferrishot in 'headless mode',
+  without making a new window.
+
+  Possible values:
+
+  - `copy`:
+    Copy image to the clipboard
+  - `save`:
+    Save image to a file
+  - `upload`:
+    Upload image to the internet
+
+- `-d`, `--delay <MILLISECONDS>` — Wait this long before launch
+- `-s`, `--save-path <PATH>` — Instead of opening a file picker to save the screenshot, save it to this path instead
+- `-D`, `--dump-default-config` — Write contents of the default config to /home/e/.config/ferrishot.kdl
+- `-C`, `--config-file <file.kdl>` — Use the provided config file
+
+  Default value: `/home/e/.config/ferrishot.kdl`
+
+- `-S`, `--silent` — Run in silent mode. Do not print anything
+- `-j`, `--json` — Print in JSON format

Cargo.lock

@@ -10,6 +10,9 @@ keywords = ["screenshot", "screen-capture", "capture", "flameshot"]
 categories = ["visualization", "multimedia"]
 authors = ["Nik Revenco"]
 
+[workspace]
+members = [".", "docgen"]
+
 [package.metadata.wix]
 upgrade-guid = "338F87CB-7559-4755-9DC7-889308AFCC72"
 path-guid = "B2F84121-9832-457D-AD64-A5598BCD4AA7"
@@ -109,14 +112,8 @@ tap = "1.0.1"
 # dedents string literals
 indoc = "2.0.6"
 
-# `docgen` feature
-# generate markdown help for the ferrishot CLI (more details in CONTRIBUTING.md)
-clap-markdown = { version = "0.1.5", optional = true }
 anstyle = "1.0.10"
 
-[features]
-docgen = ["dep:clap-markdown"]
-
 [lints.rust]
 missing_docs = "warn"
 

Cargo.toml

@@ -75,7 +75,7 @@ For reference, see the [default config file (`default.kdl`)](./default.kdl) whic
 
 You can use `ferrishot` in scripts, too
 
-#### ferrishot
+#### `ferrishot`
 
 A cross-platform desktop screenshot app
 
@@ -87,30 +87,41 @@ A cross-platform desktop screenshot app
 
 ###### **Options:**
 
-- `--region <WxH+X+Y>` — Screenshot region to select
+- `-r`, `--region <WxH+X+Y>` — Open with a region pre-selected
 
   Format: `<width>x<height>+<top-left-x>+<top-left-y>`
 
-- `--delay <MILLISECONDS>` — Wait this long before launching
-- `--save-path <PATH>` — Instead of opening a file picker to save the screenshot, save it to this path instead
-- `-a`, `--accept-on-select <ACTION>` — Accept capture as soon as a selection is made
+- `-l`, `--last-region` — Use last region
+- `-a`, `--accept-on-select <ACTION>` — Accept capture and perform the action as soon as a selection is made
 
-  If holding `ctrl` while you are releasing the left mouse button on the
-  first selection, the behaviour is cancelled
+  If holding `ctrl` while you are releasing the left mouse button on the first selection,
+  the behavior is cancelled
+
+  It's quite useful to run ferrishot, select a region and have it instantly be copied to the
+  clipboard for example. In 90% of situations you won't want to do much post-processing of
+  the region and this makes that experience twice as fast. You can always opt-out with `ctrl`
+
+  Using this option with `--region` or `--last-region` will run ferrishot in 'headless mode',
+  without making a new window.
 
   Possible values:
 
   - `copy`:
-    Copy the selected region to the clipboard
+    Copy image to the clipboard
   - `save`:
-    Save the selected region as a file
+    Save image to a file
   - `upload`:
-    Upload the selected region to the internet
+    Upload image to the internet
+
+- `-d`, `--delay <MILLISECONDS>` — Wait this long before launch
+- `-s`, `--save-path <PATH>` — Instead of opening a file picker to save the screenshot, save it to this path instead
+- `-D`, `--dump-default-config` — Write contents of the default config to /home/e/.config/ferrishot.kdl
+- `-C`, `--config-file <file.kdl>` — Use the provided config file
 
-- `--dump-default-config` — Write the default config to ~/.config/ferrishot.kdl
-- `--config-file <file.kdl>` — Specifies the config file to use
+  Default value: `/home/e/.config/ferrishot.kdl`
 
-  Default value: `~/.config/ferrishot.kdl`
+- `-S`, `--silent` — Run in silent mode. Do not print anything
+- `-j`, `--json` — Print in JSON format
 
 ## Platform Support
 

README.md

@@ -0,0 +1,63 @@
+#compdef ferrishot
+
+autoload -U is-at-least
+
+_ferrishot() {
+    typeset -A opt_args
+    typeset -a _arguments_options
+    local ret=1
+
+    if is-at-least 5.2; then
+        _arguments_options=(-s -S -C)
+    else
+        _arguments_options=(-s -C)
+    fi
+
+    local context curcontext="$curcontext" state line
+    _arguments "${_arguments_options[@]}" : \
+'-r+[Open with a region pre-selected]:WxH+X+Y:_default' \
+'--region=[Open with a region pre-selected]:WxH+X+Y:_default' \
+'-a+[Accept on first selection]:ACTION:((copy\:"Copy image to the clipboard"
+save\:"Save image to a file"
+upload\:"Upload image to the internet"))' \
+'--accept-on-select=[Accept on first selection]:ACTION:((copy\:"Copy image to the clipboard"
+save\:"Save image to a file"
+upload\:"Upload image to the internet"))' \
+'-d+[Wait this long before launch]:MILLISECONDS:_default' \
+'--delay=[Wait this long before launch]:MILLISECONDS:_default' \
+'-s+[Save image to path]:PATH:_files' \
+'--save-path=[Save image to path]:PATH:_files' \
+'-C+[Use the provided config file]:file.kdl:_files' \
+'--config-file=[Use the provided config file]:file.kdl:_files' \
+'--log-level=[Choose a minumum level at which to log]:LOG_LEVEL:_default' \
+'--log-file=[Path to the log file]:LOG_FILE:_files' \
+'(-r --region)-l[Use last region]' \
+'(-r --region)--last-region[Use last region]' \
+'-D[Write the default config to /home/e/.config/ferrishot.kdl]' \
+'--dump-default-config[Write the default config to /home/e/.config/ferrishot.kdl]' \
+'-S[Run in silent mode]' \
+'--silent[Run in silent mode]' \
+'(-S --silent)-j[Print in JSON format]' \
+'(-S --silent)--json[Print in JSON format]' \
+'(-S --silent)--log-stdout[Log to stdout instead of file]' \
+'--debug[Launch ferrishot in debug mode (F12)]' \
+'(-S --silent)--print-log-file-path[Output the path to the log file]' \
+'-h[Print help (see more with '\''--help'\'')]' \
+'--help[Print help (see more with '\''--help'\'')]' \
+'-V[Print version]' \
+'--version[Print version]' \
+'::file -- Instead of taking a screenshot of the desktop, open this image instead:_files' \
+&& ret=0
+}
+
+(( $+functions[_ferrishot_commands] )) ||
+_ferrishot_commands() {
+    local commands; commands=()
+    _describe -t commands 'ferrishot commands' commands "$@"
+}
+
+if [ "$funcstack[1]" = "_ferrishot" ]; then
+    _ferrishot "$@"
+else
+    compdef _ferrishot ferrishot
+fi