docs: move configuration section above completions (#408)

Author: hougesen

CHANGELOG.md

@@ -6,6 +6,8 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 
 #### [Unreleased](https://github.com/hougesen/mdsf/compare/v0.2.1...HEAD)
 
+- docs: move configuration section above completions [`#408`](https://github.com/hougesen/mdsf/pull/408)
+- build(deps): bump clap_complete to 4.5.8 [`#407`](https://github.com/hougesen/mdsf/pull/407)
 - build(deps): bump test-with to 0.13.0 [`#406`](https://github.com/hougesen/mdsf/pull/406)
 - docs: changelog for ureleased prs [`#405`](https://github.com/hougesen/mdsf/pull/405)
 - build(deps): bump clap to 4.5.9 [`#404`](https://github.com/hougesen/mdsf/pull/404)

README.md

@@ -106,67 +106,6 @@ Options:
 
 <!-- END_SECTION:verify-command-help -->
 
-### Shell completions
-
-Shell completions can be generated using `mdsf completions <SHELL>`.
-
-<!-- START_SECTION:completions-command-help -->
-
-```
-Generate shell completion
-
-Usage: mdsf completions <SHELL>
-
-Arguments:
-  <SHELL>  [possible values: bash, elvish, fish, powershell, zsh]
-
-Options:
-  -h, --help     Print help
-  -V, --version  Print version
-```
-
-<!-- END_SECTION:completions-command-help -->
-
-#### Bash
-
-Add the following to your `.bashrc`.
-
-```bash
-eval "$(mdsf completions bash)"
-```
-
-#### Bash
-
-Add the following to your `.zshrc`.
-
-```bash
-eval "$(mdsf completions zsh)"
-```
-
-#### Fish
-
-Add the following to `~/.config/fish/config.fish`.
-
-```fish
-mdsf completions fish | source
-```
-
-#### PowerShell
-
-Add the following to your PowerShell configuration (Can be found by running `$PROFILE`).
-
-```powershell
-Invoke-Expression (&mdsf completions powershell)
-```
-
-#### Elvish
-
-Add the following to `~/.elvish/rc.elv`.
-
-```elvish
-eval (mdsf completions elvish)
-```
-
 ## Configuration
 
 The default configuration of `mdsf` aims to as sane as possible. For that reason the default formatter for each language is the one most people have installed.
@@ -379,6 +318,67 @@ mdsf init
 
 <!-- END_SECTION:supported-tools -->
 
+## Shell completions
+
+Shell completions can be generated using `mdsf completions <SHELL>`.
+
+<!-- START_SECTION:completions-command-help -->
+
+```
+Generate shell completion
+
+Usage: mdsf completions <SHELL>
+
+Arguments:
+  <SHELL>  [possible values: bash, elvish, fish, powershell, zsh]
+
+Options:
+  -h, --help     Print help
+  -V, --version  Print version
+```
+
+<!-- END_SECTION:completions-command-help -->
+
+#### Bash
+
+Add the following to your `.bashrc`.
+
+```bash
+eval "$(mdsf completions bash)"
+```
+
+#### Bash
+
+Add the following to your `.zshrc`.
+
+```bash
+eval "$(mdsf completions zsh)"
+```
+
+#### Fish
+
+Add the following to `~/.config/fish/config.fish`.
+
+```fish
+mdsf completions fish | source
+```
+
+#### PowerShell
+
+Add the following to your PowerShell configuration (Can be found by running `$PROFILE`).
+
+```powershell
+Invoke-Expression (&mdsf completions powershell)
+```
+
+#### Elvish
+
+Add the following to `~/.elvish/rc.elv`.
+
+```elvish
+eval (mdsf completions elvish)
+```
+
 ## Acknowledgement
 
 mdsf was inspired by the amazing neovim formatting plugin [conform.nvim](https://github.com/stevearc/conform.nvim).

src/caching.rs

@@ -29,7 +29,7 @@ mod test_get_config_hash {
     use crate::{caching::get_config_hash, config::MdsfConfig};
 
     #[test]
-    fn it_shoud_be_deterministic() {
+    fn it_should_be_deterministic() {
         assert_eq!(
             get_config_hash(&MdsfConfig::default()),
             get_config_hash(&MdsfConfig::default()),
@@ -51,7 +51,7 @@ mod test_hash_text_block {
     use crate::caching::hash_text_block;
 
     #[test]
-    fn it_shoud_be_deterministic() {
+    fn it_should_be_deterministic() {
         assert_eq!(
             hash_text_block("mads was here"),
             hash_text_block("mads was here"),