chore: Add sequential numbering to test scripts in markdown files

Author: PurpleBooth

README.md

@@ -13,7 +13,7 @@ practices something that happens without thinking about it.
 This works via git hooks, so you need these hooks to be present in the
 git repository you're using to use them.
 
-``` shell,script(name="1",expected_exit_code=0)
+``` shell,script(name="initialize-repository",expected_exit_code=0)
 git init .
 git mit-install
 ```
@@ -36,13 +36,13 @@ recursively from the home directory using this command.
 find "$HOME" -type d -name .git -exec sh -c 'git init "$1"/..' -- {} \;
 ```
 
-### Lint list
+### Listing Lints
 
-``` shell,script(name="lint-list",expected_exit_code=0)
+``` shell,script(name="list-available-lints",expected_exit_code=0)
 git mit-config lint available
 ```
 
-``` text,verify(script_name="lint-list",stream=stdout)
+``` text,verify(script_name="list-available-lints",stream=stdout)
 ╭───────────────────────────────────┬──────────╮
 │ Lint                              ┆ Status   │
 ╞═══════════════════════════════════╪══════════╡
@@ -72,11 +72,11 @@ git mit-config lint available
 
 With only lints that ensure git will work properly enabled by default
 
-``` shell,script(name="lint-list",expected_exit_code=0)
+``` shell,script(name="list-enabled-lints",expected_exit_code=0)
 git mit-config lint enabled
 ```
 
-``` text,verify(script_name="lint-list",stream=stdout)
+``` text,verify(script_name="list-enabled-lints",stream=stdout)
 ╭───────────────────────────────────┬─────────╮
 │ Lint                              ┆ Status  │
 ╞═══════════════════════════════════╪═════════╡
@@ -111,11 +111,11 @@ For example
 
 With this you can enable lints
 
-``` shell,script(name="7",expected_exit_code=0)
+``` shell,script(name="check-pivotal-lint-status",expected_exit_code=0)
 git mit-config lint status pivotal-tracker-id-missing
 ```
 
-``` text,verify(script_name="7",stream=stdout)
+``` text,verify(script_name="check-pivotal-lint-status",stream=stdout)
 ╭────────────────────────────┬─────────╮
 │ Lint                       ┆ Status  │
 ╞════════════════════════════╪═════════╡
@@ -144,27 +144,27 @@ This is the best readme
 
 If you run
 
-``` shell,script(name="2",expected_exit_code=0)
+``` shell,script(name="set-relates-to-trailer",expected_exit_code=0)
 git mit-relates-to "[#12321513]"
 ```
 
 Next time you commit
 
-``` shell,script(name="3",expected_exit_code=0)
+``` shell,script(name="stage-and-set-authors",expected_exit_code=0)
 git add README.md
 git mit bt
 git commit -m "Wrote a great README"
 ```
 
 the commit message will contain the ID
 
-``` shell,script(name="4",expected_exit_code=0)
+``` shell,script(name="show-commit-with-relates-to",expected_exit_code=0)
 git show --pretty='format:author: [%an %ae] signed-by: [%GS] 
 ---
 %B' -q
 ```
 
-``` text,verify(script_name="4",stream=stdout)
+``` text,verify(script_name="show-commit-with-relates-to",stream=stdout)
 author: [Billie Thompson [email protected]] signed-by: [] 
 ---
 Wrote a great README
@@ -174,19 +174,19 @@ Relates-to: [#12321513]
 
 Read more about this at the [relates to page](docs/mit-relates-to.md)
 
-### Setting Authors and Co-Authors
+### Setting Authors and Co-authors
 
 Pairing is a great way to program, and it's even better when you give
 credit, you can give credit with the mit command
 
 Configure your authors like the example by creating a config at
 `$HOME/.config/git-mit/mit.toml`
 
-``` shell,script(name="3")
+``` shell,script(name="generate-example-config",expected_exit_code=0)
 git-mit-config mit example
 ```
 
-``` toml,verify(script_name="3",stream=stdout)
+``` toml,verify(script_name="generate-example-config",stream=stdout)
 [ae]
 name = "Anyone Else"
 email = "[email protected]"
@@ -203,14 +203,14 @@ email = "[email protected]"
 
 And you can run
 
-``` shell,script(name="6",expected_exit_code=0)
+``` shell,script(name="set-multiple-coauthors",expected_exit_code=0)
 git mit ae bt se
 ```
 
 Then next when you make a commit the `Co-authored-by` trailers will be
 set of the author initials you selected.
 
-``` shell,script(name="7",expected_exit_code=0)
+``` shell,script(name="show-coauthored-commit",expected_exit_code=0)
 echo "# Hello, world!" > README.md
 
 git add .
@@ -220,7 +220,7 @@ git show --pretty='format:author: [%an %ae] signed-by: [%GS]
 %B' -q
 ```
 
-``` text,verify(script_name="7",stream=stdout)
+``` text,verify(script_name="show-coauthored-commit",stream=stdout)
 author: [Anyone Else [email protected]] signed-by: [] 
 ---
 Initial Commit

docs/binaries/git-mit-config.md

@@ -2,11 +2,11 @@
 
 Generic usage
 
-``` shell,script(expected_exit_code=0)
+``` shell,script(name="show-main-help",expected_exit_code=0)
 git-mit-config --help
 ```
 
-``` shell,verify(stream=stdout)
+``` shell,verify(script_name="show-main-help",stream=stdout)
 A command for enabling and disabling git lints
 
 Usage: git-mit-config [OPTIONS] [COMMAND]
@@ -23,11 +23,11 @@ Options:
   -V, --version                  Print version
 ```
 
-``` shell,script(expected_exit_code=0)
+``` shell,script(name="show-lint-help",expected_exit_code=0)
 git-mit-config lint --help
 ```
 
-``` shell,verify(stream=stdout)
+``` shell,verify(script_name="show-lint-help",stream=stdout)
 Manage active lints
 
 Usage: git-mit-config lint <COMMAND>
@@ -45,11 +45,11 @@ Options:
   -h, --help  Print help
 ```
 
-``` shell,script(expected_exit_code=0)
+``` shell,script(name="show-mit-help",expected_exit_code=0)
 git-mit-config mit --help
 ```
 
-``` shell,verify(stream=stdout)
+``` shell,verify(script_name="show-mit-help",stream=stdout)
 Manage mit configuration
 
 Usage: git-mit-config mit <COMMAND>
@@ -67,11 +67,11 @@ Options:
   -h, --help  Print help
 ```
 
-``` shell,script(expected_exit_code=0)
+``` shell,script(name="show-relates-to-help",expected_exit_code=0)
 git-mit-config relates-to --help
 ```
 
-``` shell,verify(stream=stdout)
+``` shell,verify(script_name="show-relates-to-help",stream=stdout)
 Manage relates-to settings
 
 Usage: git-mit-config relates-to <COMMAND>
@@ -86,16 +86,16 @@ Options:
 
 You can generate completion with
 
-``` shell,script(expected_exit_code=0)
+``` shell,script(name="generate-bash-completion",expected_exit_code=0)
 git-mit-config --completion bash
 ```
 
 Otherwise an error will be generated
 
-``` shell,script(expected_exit_code=1)
+``` shell,script(name="missing-subcommand-error",expected_exit_code=1)
 git-mit-config
 ```
-``` shell,verify(stream=stderr)
+``` shell,verify(script_name="missing-subcommand-error",stream=stderr)
 Error: git_mit_config::errors::unrecognised_lint_command
 
   × unrecognised subcommand

docs/binaries/git-mit-install.md

@@ -2,13 +2,13 @@
 
 Generic usage
 
-``` shell,script(name="run_help",expected_exit_code=0)
+``` shell,script(name="run-help",expected_exit_code=0)
 export HOME="/example/home/dir"
 export USERPROFILE="F:\\some\\userprofile"
 git-mit-install --help
 ```
 
-```text,verify(script_name="run_help",target_os="!windows")
+```text,verify(script_name="run-help",target_os="!windows")
 Install git-mit into a repository
 
 Usage: git-mit-install [OPTIONS]
@@ -36,7 +36,7 @@ Options:
 
 On windows the home directory is different
 
-```text,verify(script_name="run_help",target_os="windows")
+```text,verify(script_name="run-help",target_os="windows")
 Install git-mit into a repository
 
 Usage: git-mit-install [OPTIONS]
@@ -64,6 +64,6 @@ Options:
 
 You can generate completion with
 
-```shell,script(name="completion",expected_exit_code=0)
+```shell,script(name="generate-bash-completion",expected_exit_code=0)
 git-mit-install --completion bash
 ```

docs/binaries/git-mit-relates-to.md

@@ -2,11 +2,11 @@
 
 Generic usage
 
-``` shell,script(expected_exit_code=0)
+``` shell,script(name="show-help",expected_exit_code=0)
 git-mit-relates-to --help
 ```
 
-``` shell,verify(stream=stdout)
+``` shell,verify(script_name="show-help",stream=stdout)
 Set Relates-to trailer.
 
 Usage: git-mit-relates-to [OPTIONS] [ISSUE_NUMBER]
@@ -24,17 +24,17 @@ Options:
 
 You can generate completion with
 
-``` shell,script(expected_exit_code=0)
+``` shell,script(name="generate-bash-completion",expected_exit_code=0)
 git-mit-relates-to --completion bash
 ```
 
 Otherwise you need an issue number
 
-``` shell,script(expected_exit_code=2)
+``` shell,script(name="missing-issue-number-error",expected_exit_code=2)
 git-mit-relates-to
 ```
 
-``` shell,verify(stream=stderr)
+``` shell,verify(script_name="missing-issue-number-error",stream=stderr)
 error: the following required arguments were not provided:
   <ISSUE_NUMBER>
 

docs/binaries/git-mit.md

@@ -2,11 +2,11 @@
 
 Generic usage
 
-``` shell,script(expected_exit_code=0)
+``` shell,script(name="show-help",expected_exit_code=0)
 git-mit --help
 ```
 
-``` shell,verify(stream=stdout)
+``` shell,verify(script_name="show-help",stream=stdout)
 Set author and Co-authored trailer.
 
 Usage: git-mit [OPTIONS] [INITIALS]...
@@ -61,16 +61,16 @@ COMMON TASKS:
 
 You can generate completion with
 
-``` shell,script(expected_exit_code=0)
+``` shell,script(name="generate-bash-completion",expected_exit_code=0)
 git-mit --completion bash
 ```
 
 Otherwise you must provide an author initial
 
-``` shell,script(expected_exit_code=2)
+``` shell,script(name="missing-initials-error",expected_exit_code=2)
 git-mit
 ```
-``` shell,verify(stream=stderr)
+``` shell,verify(script_name="missing-initials-error",stream=stderr)
 error: the following required arguments were not provided:
   <INITIALS>...
 

docs/binaries/mit-commit-msg.md

@@ -4,11 +4,11 @@
 
 Generic usage
 
-``` shell,script(expected_exit_code=0)
+``` shell,script(name="show-help",expected_exit_code=0)
 mit-commit-msg --help
 ```
 
-``` shell,verify(stream=stdout)
+``` shell,verify(script_name="show-help",stream=stdout)
 Validate the commit message that a user has input
 
 Usage: mit-commit-msg [OPTIONS] [COMMIT_FILE_PATH]
@@ -27,17 +27,17 @@ Options:
 
 You can generate completion with
 
-``` shell,script(expected_exit_code=0)
+``` shell,script(name="generate-bash-completion",expected_exit_code=0)
 mit-commit-msg --completion bash
 ```
 
 Otherwise you need an the commit file path
 
-``` shell,script(expected_exit_code=2)
+``` shell,script(name="missing-commit-path-error",expected_exit_code=2)
 mit-commit-msg
 ```
 
-``` shell,verify(stream=stderr)
+``` shell,verify(script_name="missing-commit-path-error",stream=stderr)
 error: the following required arguments were not provided:
   <COMMIT_FILE_PATH>
 

docs/binaries/mit-pre-commit.md

@@ -4,11 +4,11 @@
 
 Generic usage
 
-``` shell,script(expected_exit_code=0)
+``` shell,script(name="show-help",expected_exit_code=0)
 mit-pre-commit --help
 ```
 
-``` shell,verify(stream=stdout)
+``` shell,verify(script_name="show-help",stream=stdout)
 Run first, before you even type in a commit message. It's used to inspect the snapshot that's about
 to be committed.
 
@@ -22,17 +22,17 @@ Options:
 
 You can generate completion with
 
-``` shell,script(expected_exit_code=0)
+``` shell,script(name="generate-bash-completion",expected_exit_code=0)
 mit-pre-commit --completion bash
 ```
 
 Otherwise you need to have configured some authors
 
-``` shell,script(expected_exit_code=1)
+``` shell,script(name="no-authors-configured-error",expected_exit_code=1)
 mit-pre-commit
 ```
 
-``` shell,verify(stream=stderr)
+``` shell,verify(script_name="no-authors-configured-error",stream=stderr)
 Error: mit_pre_commit::errors::stale_author_error
 
   × No authors set