Add linting for manpages

ajeetdsouza · Sep 27, 2021 · 49f406e · 49f406e
1 parent 2f2f588
commit 49f406e
Show file tree

Hide file tree

Showing 11 changed files with 118 additions and 128 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -37,24 +37,7 @@ clap_generate = "=3.0.0-beta.4"
 
 [features]
 default = []
-# Adds tests for code generated by `zoxide init`.
-# This requires the following external programs available in $PATH:
-# - bash
-# - black: <https://github.com/psf/black>
-# - dash
-# - elvish: <https://github.com/elves/elvish>
-# - fish: <https://github.com/fish-shell/fish-shell>
-# - mypy: <https://github.com/python/mypy>
-# - nushell: <https://github.com/nushell/nushell>
-# - powershell: <https://github.com/PowerShell/PowerShell>
-# - pylint: <https://github.com/PyCQA/pylint>
-# - shellcheck: <https://github.com/koalaman/shellcheck>
-# - shfmt: <https://github.com/mvdan/sh>
-# - xonsh: <https://github.com/xonsh/xonsh>
-# - zsh: <https://github.com/zsh-users/zsh>
-# Since most users are unlikely to have installed all of the above, these tests
-# are disabled by default.
-shell_tests = []
+nix_tests = []
 
 [profile.release]
 codegen-units = 1

diff --git a/man/zoxide-add.1 b/man/zoxide-add.1
@@ -1,13 +1,13 @@
-.TH "zoxide-add" "1" "2021-04-12" "zoxide" "zoxide"
+.TH "ZOXIDE" "1" "2021-04-12" "" "zoxide"
 .SH NAME
-zoxide-add - add a new directory or increment its rank
+\fBzoxide-add\fR - add a new directory or increment its rank
 .SH SYNOPSIS
-.B zoxide add \fI[PATHS]\fR
+.B zoxide add [PATHS]
 .SH DESCRIPTION
 If the directory is not already in the database, this command creates a new
-entry for it with a default score of \fI1\fR, otherwise, it increments the
-existing score by \fI1\fR. It then sets the last updated field of the entry to the
-current time. After this, it runs the \fBAGING\fR algorithm on the database. See
+entry for it with a default score of 1, otherwise, it increments the existing
+score by 1. It then sets the last updated field of the entry to the current
+time. After this, it runs the \fBAGING\fR algorithm on the database. See
 \fBzoxide\fR(1) for more about the algorithm.
 .sp
 If you'd like to prevent a directory from being added to the database, see the
@@ -19,6 +19,6 @@ Print help information.
 .SH REPORTING BUGS
 For any issues, feature requests, or questions, please visit:
 .sp
-    \fIhttps://github.com/ajeetdsouza/zoxide/issues\fR
+\fBhttps://github.com/ajeetdsouza/zoxide/issues\fR.
 .SH AUTHOR
-Ajeet D'Souza <\fI98ajeet@gmail.com\fR>
+Ajeet D'Souza <\fB98ajeet@gmail.com\fR>
diff --git a/man/zoxide-import.1 b/man/zoxide-import.1
@@ -1,20 +1,20 @@
-.TH "zoxide-import" "1" "2021-04-12" "zoxide" "zoxide"
+.TH "ZOXIDE" "1" "2021-04-12" "" "zoxide"
 .SH NAME
-zoxide-import - import data from other tools
+\fBzoxide-import\fR - import data from other tools
 .SH SYNOPSIS
-.B zoxide import \fIPATH --from FORMAT [OPTIONS]\fR
+.B zoxide import PATH --from FORMAT [OPTIONS]
 .SH OPTIONS
 .TP
-.B --from \fIFORMAT\fR
+.B --from FORMAT
 The format of the database being imported:
 .TS
 tab(|);
 l l.
-    \fIautojump\fR
-    \fIz\fR|For \fIz\fR, \fIz.lua\fR, or \fIzsh-z\fR.
+    \fBautojump\fR
+    \fBz\fR|(for \fBz\fR, \fBz.lua\fR, or \fBzsh-z\fR)
 .TE
 .sp
-\fBNOTE\fR: zoxide only imports paths from autojump, since its matching
+Note: zoxide only imports paths from autojump, since its matching
 algorithm is too different to import the scores.
 .TP
 .B -h, --help
@@ -26,6 +26,6 @@ option merges imported data into the existing database.
 .SH REPORTING BUGS
 For any issues, feature requests, or questions, please visit:
 .sp
-    \fIhttps://github.com/ajeetdsouza/zoxide/issues\fR
+\fBhttps://github.com/ajeetdsouza/zoxide/issues\fR.
 .SH AUTHOR
-Ajeet D'Souza <\fI98ajeet@gmail.com\fR>
+Ajeet D'Souza <\fB98ajeet@gmail.com\fR>
diff --git a/man/zoxide-init.1 b/man/zoxide-init.1
@@ -1,28 +1,29 @@
-.TH "zoxide-init" "1" "2021-04-12" "zoxide" "zoxide"
+.TH "ZOXIDE" "1" "2021-04-12" "" "zoxide"
 .SH NAME
-zoxide-init - generate shell configuration for zoxide
+\fBzoxide-init\fR - generate shell configuration for zoxide
 .SH SYNOPSIS
-.B zoxide init \fISHELL [OPTIONS]\fR
+.B zoxide init SHELL [OPTIONS]
 .SH DESCRIPTION
 To initialize zoxide on your shell:
 .TP
 .B bash
-Add this to your configuration (usually \fI~/.bashrc\fR):
+Add this to your configuration (usually \fB~/.bashrc\fR):
 .sp
 .nf
     \fBeval "$(zoxide init bash)"\fR
 .fi
 .TP
 .B elvish
-Add this to your configuration (usually \fI~/.elvish/rc.elv\fR):
+Add this to your configuration (usually \fB~/.elvish/rc.elv\fR):
 .sp
 .nf
     \fBeval $(zoxide init elvish | slurp)\fR
 .fi
+.sp
 Note: zoxide only supports elvish v0.16.0 and above.
 .TP
 .B fish
-Add this to your configuration (usually \fI~/.config/fish/config.fish\fR):
+Add this to your configuration (usually \fB~/.config/fish/config.fish\fR):
 .sp
 .nf
     \fBzoxide init fish | source\fR
@@ -50,14 +51,14 @@ PowerShell):
 .fi
 .TP
 .B xonsh
-Add this to your configuration (usually \fI~/.xonshrc\fR):
+Add this to your configuration (usually \fB~/.xonshrc\fR):
 .sp
 .nf
     \fBexecx($(zoxide init xonsh), 'exec', __xonsh__.ctx, filename='zoxide')\fR
 .fi
 .TP
 .B zsh
-Add this to your configuration (usually \fI~/.zshrc\fR):
+Add this to your configuration (usually \fB~/.zshrc\fR):
 .sp
 .nf
     \fBeval "$(zoxide init zsh)"\fR
@@ -80,14 +81,14 @@ e.g. --cmd j would change the aliases to j and ji respectively.
 .B -h, --help
 Print help information.
 .TP
-.B --hook \fIHOOK\fR
+.B --hook HOOK
 Changes how often zoxide increments a directory's score:
 .TS
 tab(|);
 l l.
-    \fInone\fR|Never
-    \fIprompt\fR|At every shell prompt
-    \fIpwd\fR|Whenever the directory is changed
+    \fBnone\fR|Never
+    \fBprompt\fR|At every shell prompt
+    \fBpwd\fR|Whenever the directory is changed
 .TE
 .TP
 .B --no-aliases
@@ -97,6 +98,6 @@ choose to redefine them.
 .SH REPORTING BUGS
 For any issues, feature requests, or questions, please visit:
 .sp
-    \fIhttps://github.com/ajeetdsouza/zoxide/issues\fR
+\fBhttps://github.com/ajeetdsouza/zoxide/issues\fR.
 .SH AUTHOR
-Ajeet D'Souza <\fI98ajeet@gmail.com\fR>
+Ajeet D'Souza <\fB98ajeet@gmail.com\fR>
diff --git a/man/zoxide-query.1 b/man/zoxide-query.1
@@ -1,8 +1,8 @@
-.TH "zoxide-query" "1" "2021-04-12" "zoxide" "zoxide"
+.TH "ZOXIDE" "1" "2021-04-12" "" "zoxide"
 .SH NAME
-zoxide-query - search for a directory in the database
+\fBzoxide-query\fR - search for a directory in the database
 .SH SYNOPSIS
-.B zoxide query \fI[KEYWORDS] [OPTIONS]\fR
+.B zoxide query [KEYWORDS] [OPTIONS]
 .SH DESCRIPTION
 Query the database for paths matching the keywords. The exact \fBMATCHING\fR
 algorithm is described in \fBzoxide\fR(1).
@@ -11,7 +11,7 @@ algorithm is described in \fBzoxide\fR(1).
 .B --all
 Show deleted directories.
 .TP
-.B --exclude \fIPATH\fR
+.B --exclude PATH
 Exclude a path from query results.
 .TP
 .B -h, --help
@@ -28,6 +28,6 @@ Print the calculated score as well as the matched path.
 .SH REPORTING BUGS
 For any issues, feature requests, or questions, please visit:
 .sp
-    \fIhttps://github.com/ajeetdsouza/zoxide/issues\fR
+\fBhttps://github.com/ajeetdsouza/zoxide/issues\fR.
 .SH AUTHOR
-Ajeet D'Souza <\fI98ajeet@gmail.com\fR>
+Ajeet D'Souza <\fB98ajeet@gmail.com\fR>
diff --git a/man/zoxide-remove.1 b/man/zoxide-remove.1
@@ -1,8 +1,8 @@
-.TH "zoxide-remove" "1" "2021-04-12" "zoxide" "zoxide"
+.TH "ZOXIDE" "1" "2021-04-12" "" "zoxide"
 .SH NAME
-zoxide-remove - remove a directory from the database
+\fBzoxide-remove\fR - remove a directory from the database
 .SH SYNOPSIS
-.B zoxide remove \fI[PATHS] [OPTIONS]\fR
+.B zoxide remove [PATHS] [OPTIONS]
 .SH DESCRIPTION
 If you'd like to permanently exclude a directory from the database, see the
 \fB_ZO_EXCLUDE_DIRS\fR environment variable in \fBzoxide\fR(1).
@@ -11,11 +11,11 @@ If you'd like to permanently exclude a directory from the database, see the
 .B -h, --help
 Print help information.
 .TP
-.B -i, --interactive \fI[KEYWORDS]\fR
+.B -i, --interactive [KEYWORDS]
 Use interactive selection. This option requires fzf.
 .SH REPORTING BUGS
 For any issues, feature requests, or questions, please visit:
 .sp
-    \fIhttps://github.com/ajeetdsouza/zoxide/issues\fR
+\fBhttps://github.com/ajeetdsouza/zoxide/issues\fR.
 .SH AUTHOR
-Ajeet D'Souza <\fI98ajeet@gmail.com\fR>
+Ajeet D'Souza <\fB98ajeet@gmail.com\fR>