A bit of housekeeping

Author: omid

.code-samples.meilisearch.yaml

@@ -1,7 +1,7 @@
 # This code-samples file is used by the Meilisearch documentation
 # Every example written here will be automatically fetched by
 # the documentation on build
-# You can read more on https://github.com/meilisearch/documentation/tree/master/.vuepress/code-samples
+# You can read more on https://github.com/meilisearch/documentation/tree/main/learn
 ---
 synonyms_guide_1: |-
   let mut synonyms = std::collections::HashMap::new();

.github/scripts/check-release.sh

@@ -1,9 +1,7 @@
 #!/bin/sh
 
 # Checking if current tag matches the package version
-current_tag=$(echo $GITHUB_REF | cut -d '/' -f 3 | sed -r 's/^v//')
-major=$(echo $current_tag | cut -d '.' -f1)
-minor=$(echo $current_tag | cut -d '.' -f2)
+current_tag=$(echo "$GITHUB_REF" | cut -d '/' -f 3 | sed -r 's/^v//')
 
 file1='Cargo.toml'
 file2='README.tpl'

CONTRIBUTING.md

@@ -53,7 +53,7 @@ curl -L https://install.meilisearch.com | sh # download Meilisearch
 cargo test
 ```
 
-There is two kind of tests, documentation tests and unit tests.
+There are two kinds of tests, documentation tests and unit tests.
 If you need to write or read the unit tests you should consider reading this
 [readme](meilisearch-test-macro/README.md) about our custom testing macro.
 
@@ -91,13 +91,13 @@ rustup update
 
 Each PR should pass the format test to be accepted.
 
-Run the following to fix the formating errors:
+Run the following to fix the formatting errors:
 
 ```
 cargo fmt
 ```
 
-and the following to test if the formating is correct:
+and the following to test if the formatting is correct:
 ```
 cargo fmt --all -- --check
 ```
@@ -139,7 +139,7 @@ We do not enforce any branch naming style, but please use something descriptive
 
 As minimal requirements, your commit message should:
 - be capitalized
-- not finish by a dot or any other punctuation character (!,?)
+- not finished by a dot or any other punctuation character (!,?)
 - start with a verb so that we can read your commit message this way: "This commit will ...", where "..." is the commit message.
   e.g.: "Fix the home page button" or "Add more tests for create_index method"
 
@@ -171,7 +171,7 @@ _[Read more about this](https://github.com/meilisearch/integration-guides/blob/m
 
 ### How to Publish the Release <!-- omit in toc -->
 
-⚠️ Before doing anything, make sure you got through the guide about [Releasing an Integration](https://github.com/meilisearch/integration-guides/blob/main/resources/integration-release.md).
+⚠️ Before doing anything, make sure you get through the guide about [Releasing an Integration](https://github.com/meilisearch/integration-guides/blob/main/resources/integration-release.md).
 
 Make a PR modifying the file [`Cargo.toml`](/Cargo.toml):
 
@@ -212,4 +212,4 @@ GitHub Actions will be triggered and push the package to [crates.io](https://cra
 
 <hr>
 
-Thank you again for reading this through. We can not wait to begin to work with you if you make your way through this contributing guide ❤️
+Thank you again for reading this through. We cannot wait to begin to work with you if you make your way through this contributing guide ❤️

README.md

@@ -38,9 +38,9 @@
 - [⚡ Supercharge your Meilisearch experience](#-supercharge-your-meilisearch-experience)
 - [🔧 Installation](#-installation)
 - [🚀 Getting started](#-getting-started)
-- [🌐 Running in the Browser with WASM](#-running-in-the-browser-with-wasm)
+- [🌐 Running in the Browser with WASM](#-running-in-the-browser-with-wasm-)
 - [🤖 Compatibility with Meilisearch](#-compatibility-with-meilisearch)
-- [⚙️ Contributing](#️-contributing)
+- [⚙️ Contributing](#-contributing)
 
 ## 📖 Documentation
 

examples/cli-app/assets/clothes.json

@@ -1,74 +1,74 @@
 [
     {
     "id": 1,
-    "seaon": "winter",
+    "season": "winter",
     "article": "sweater",
     "cost": 63.40,
     "size":"L",
     "pattern":"striped"
   },
   {
     "id": 2,
-    "seaon": "spring",
+    "season": "spring",
     "article": "sweat pants",
     "cost": 18.00,
     "size":"XXXL",
     "pattern":"floral"
   },
   {
     "id": 3,
-    "seaon": "fall",
+    "season": "fall",
     "article": "t-shirt",
     "cost": 1634.90,
     "size":"M",
     "pattern":"solid black"
   },
   {
     "id": 4,
-    "seaon": "summer",
+    "season": "summer",
     "article": "tank top",
     "cost": 3.40,
     "size":"L",
     "pattern":"diagonal"
   },
   {
     "id": 5,
-    "seaon": "winter",
+    "season": "winter",
     "article": "jeans",
     "cost": 4.20,
     "size":"XL",
     "pattern":"striped"
   },
   {
     "id": 6,
-    "seaon": "spring",
+    "season": "spring",
     "article": "sun dress",
     "cost": 12634.56,
     "size":"L",
     "pattern":"floral"
   },
   {
     "id": 7,
-    "seaon": "fall",
+    "season": "fall",
     "article": "sweatshirt",
     "cost": 90.80,
     "size":"M",
     "pattern":"checker"
   },
   {
     "id": 8,
-    "seaon": "summer",
+    "season": "summer",
     "article": "shorts",
     "cost": 16.34,
     "size":"XS",
     "pattern":"solid beige"
   },
   {
     "id": 9,
-    "seaon": "winter",
+    "season": "winter",
     "article": "jacket",
     "cost": 634,
     "size":"L",
     "pattern":"camo"
   }
-]
+]

examples/cli-app/src/main.rs

@@ -38,7 +38,7 @@ fn main() {
 }
 
 async fn search(query: &str) {
-    // make the search query, which excutes and serializes hits into the
+    // make the search query, which executes and serializes hits into the
     // ClothesDisplay struct
     let query_results = CLIENT
         .index("clothes")
@@ -74,7 +74,7 @@ async fn build_index() {
     let ranking_rules = ["words", "typo", "attribute", "exactness", "cost:asc"];
 
     // create searchable attributes
-    let searchable_attributes = ["seaon", "article", "size", "pattern"];
+    let searchable_attributes = ["season", "article", "size", "pattern"];
 
     // create the synonyms hashmap
     let mut synonyms = std::collections::HashMap::new();
@@ -128,7 +128,7 @@ async fn build_index() {
 #[derive(Serialize, Deserialize, Debug)]
 pub struct Clothes {
     id: usize,
-    seaon: String,
+    season: String,
     article: String,
     cost: f32,
     size: String,

examples/web_app/src/lib.rs

@@ -147,7 +147,7 @@ fn header_content(processing_time_ms: usize, link: &Scope<Model>) -> Html {
                 {"We wrote a blog post about "}<a href="https://blog.meilisearch.com/meili-finds-rust-crates/">{"how we made this search engine available for you"}</a>{"."}<br/>
                 {"What you are currently using is not the original front end, but a clone using "}<a href="https://github.com/meilisearch/meilisearch-rust">{"the Meilisearch Rust SDK"}</a>{" and "}<a href="https://yew.rs">{"Yew"}</a>{". The code is available "}<a href="https://github.com/meilisearch/meilisearch-rust/tree/main/examples/web_app">{"here"}</a>{"."}<br/>
                 {"The whole design was taken from "}<a href="https://lib.rs">{"lib.rs"}</a>{" because we love it."}<br/>
-                <br/>{"We pull new crates and crates updates every "}<em>{"10 minutes"}</em>{" from "}<a href="https://docs.rs/releases">{"docs.rs"}</a>{" and all the downloads counts "}<em>{"every day at 3:30 PM UTC"}</em>{" from "}<a href="https://crates.io/data-access">{"crates.io"}</a>{". Currently we have something like "}<em>{" 31 729 crates"}</em>{"."}<br/>
+                <br/>{"We pull new crates and crates update every "}<em>{"10 minutes"}</em>{" from "}<a href="https://docs.rs/releases">{"docs.rs"}</a>{" and all the downloads count "}<em>{"every day at 3:30 PM UTC"}</em>{" from "}<a href="https://crates.io/data-access">{"crates.io"}</a>{". Currently we have something like "}<em>{" 31 729 crates"}</em>{"."}<br/>
                 <br/>{"Have fun using it "}<img draggable="false" class="emoji" alt="⌨️" src="moz-extension://57a82bfe-3134-4c34-bdb1-bc4ada430e6c/data/components/twemoji/svg/2328.svg"/>{" "}<img draggable="false" class="emoji" alt="💨" src="moz-extension://57a82bfe-3134-4c34-bdb1-bc4ada430e6c/data/components/twemoji/svg/1f4a8.svg"/><br/>
             </p>
             <form role="search" id="search">

meilisearch-index-setting-macro/Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "meilisearch-index-setting-macro"
 version = "0.24.3"
-description = "Helper tool to generate settings of an Meilisearch index"
+description = "Helper tool to generate settings of a Meilisearch index"
 edition = "2021"
 license = "MIT"
 

meilisearch-index-setting-macro/src/lib.rs

@@ -1,10 +1,8 @@
 use convert_case::{Case, Casing};
 use proc_macro2::Ident;
 use quote::quote;
-use structmeta::Flag;
-use structmeta::StructMeta;
-use syn::parse_macro_input;
-use syn::spanned::Spanned;
+use structmeta::{Flag, StructMeta};
+use syn::{parse_macro_input, spanned::Spanned};
 
 #[derive(Clone, StructMeta, Default)]
 struct FieldAttrs {
@@ -162,7 +160,7 @@ fn get_settings_token_for_list(
             #attr
         }
     });
-    let method_ident = syn::Ident::new(method_name, proc_macro2::Span::call_site());
+    let method_ident = Ident::new(method_name, proc_macro2::Span::call_site());
 
     if !field_name_list.is_empty() {
         quote! {
@@ -179,7 +177,7 @@ fn get_settings_token_for_string(
     field_name: &String,
     method_name: &str,
 ) -> proc_macro2::TokenStream {
-    let method_ident = syn::Ident::new(method_name, proc_macro2::Span::call_site());
+    let method_ident = Ident::new(method_name, proc_macro2::Span::call_site());
 
     if !field_name.is_empty() {
         quote! {

meilisearch-test-macro/src/lib.rs

@@ -96,15 +96,15 @@ pub fn meilisearch_test(params: TokenStream, input: TokenStream) -> TokenStream
         // Now we do the same for the index name
         if use_name {
             let fn_name = &outer_fn.sig.ident;
-            // the name we're going to return is the complete path to the function ie something like that;
+            // the name we're going to return is the complete path to the function i.e., something like that;
             // `indexes::tests::test_fetch_info` but since the `::` are not allowed by meilisearch as an index
             // name we're going to rename that to `indexes-tests-test_fetch_info`.
             outer_block.push(parse_quote!(
                 let name = format!("{}::{}", std::module_path!(), stringify!(#fn_name)).replace("::", "-");
             ));
         }
 
-        // And finally if an index was asked we delete it, and we (re)create it and wait until meilisearch confirm its creation.
+        // And finally if an index was asked, we delete it, and we (re)create it and wait until meilisearch confirm its creation.
         if use_index {
             outer_block.push(parse_quote!({
                 let res = client
@@ -160,7 +160,7 @@ pub fn meilisearch_test(params: TokenStream, input: TokenStream) -> TokenStream
                     .delete()
                     .await
                     .expect("Network issue while sending the last delete index task");
-                // we early exit the test here and let meilisearch handle the deletion asynchonously
+                // we early exit the test here and let meilisearch handle the deletion asynchronously
             ));
         }
 

scripts/check-readme.sh

@@ -12,13 +12,13 @@ fi
 cargo install cargo-readme
 
 # Comparing the generated README and the current one
-curent_readme="README.md"
+current_readme="README.md"
 generated_readme="README.md_tmp"
 cargo readme > "$generated_readme"
 
 # Exiting with the right message
 echo ''
-diff "$curent_readme" "$generated_readme" > /dev/null 2>&1
+diff "$current_readme" "$generated_readme" > /dev/null 2>&1
 if [ "$?" = 0 ]; then
     echo "OK"
     rm -f "$generated_readme"
@@ -29,7 +29,7 @@ else
     # Displaying the diff if the --diff flag is activated
     if [ "$1" = '--diff' ]; then
         echo 'Diff found:'
-        diff "$curent_readme" "$generated_readme"
+        diff "$current_readme" "$generated_readme"
     else
         echo 'To see the diff, run:'
         echo '  $ sh scripts/check-readme.sh --diff'

scripts/update_macro_versions.sh

@@ -1,10 +1,10 @@
 #!/bin/sh
-new_version=$(cat Cargo.toml | grep '^version = ')
+new_version=$(grep '^version = ' Cargo.toml)
 
 # Updates the versions in meilisearch-rust and meilisearch-index-setting-macro of the latter, with the latest meilisearch-rust version.
 
-old_index_macro_version=$(cat ./meilisearch-index-setting-macro/Cargo.toml | grep '^version = ')
-old_macro_in_sdk_version=$(cat ./Cargo.toml | grep '{ path = "meilisearch-index-setting-macro", version =')
+old_index_macro_version=$(grep '^version = ' ./meilisearch-index-setting-macro/Cargo.toml)
+old_macro_in_sdk_version=$(grep '{ path = "meilisearch-index-setting-macro", version =' ./Cargo.toml)
 
 sed -i '' -e "s/^$old_index_macro_version/$new_version/g" './meilisearch-index-setting-macro/Cargo.toml'
 sed -i '' -e "s/$old_macro_in_sdk_version/meilisearch-index-setting-macro = { path = \"meilisearch-index-setting-macro\", $new_version }/g" './Cargo.toml'

src/client.rs

@@ -41,7 +41,7 @@ impl Client {
     pub fn new(host: impl Into<String>, api_key: Option<impl Into<String>>) -> Client {
         Client {
             host: host.into(),
-            api_key: api_key.map(std::convert::Into::into),
+            api_key: api_key.map(Into::into),
         }
     }
 
@@ -150,7 +150,7 @@ impl Client {
         self.api_key.as_deref()
     }
 
-    /// List all [Indexes](Index) with query parameters and returns values as instances of [Index].
+    /// List all [Indexes](Index) with query parameters and return values as instances of [Index].
     ///
     /// # Example
     ///
@@ -1021,18 +1021,18 @@ impl Client {
     /// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey");
     /// #
     /// # futures::executor::block_on(async move {
-    /// # let client = client::Client::new(MEILISEARCH_URL, Some(MEILISEARCH_API_KEY));
+    /// # let client = Client::new(MEILISEARCH_URL, Some(MEILISEARCH_API_KEY));
     /// let api_key_uid = "76cf8b87-fd12-4688-ad34-260d930ca4f4".to_string();
     /// let token = client.generate_tenant_token(api_key_uid, serde_json::json!(["*"]), None, None).unwrap();
     ///
-    /// let client = client::Client::new(MEILISEARCH_URL, Some(token));
+    /// let client = Client::new(MEILISEARCH_URL, Some(token));
     /// # });
     /// ```
     #[cfg(not(target_arch = "wasm32"))]
     pub fn generate_tenant_token(
         &self,
         api_key_uid: String,
-        search_rules: serde_json::Value,
+        search_rules: Value,
         api_key: Option<&str>,
         expires_at: Option<OffsetDateTime>,
     ) -> Result<String, Error> {
@@ -1235,15 +1235,15 @@ mod tests {
     #[meilisearch_test]
     async fn test_get_tasks(client: Client) {
         let tasks = client.get_tasks().await.unwrap();
-        assert!(tasks.limit == 20);
+        assert_eq!(tasks.limit, 20);
     }
 
     #[meilisearch_test]
     async fn test_get_tasks_with_params(client: Client) {
         let query = TasksSearchQuery::new(&client);
         let tasks = client.get_tasks_with(&query).await.unwrap();
 
-        assert!(tasks.limit == 20);
+        assert_eq!(tasks.limit, 20);
     }
 
     #[meilisearch_test]
@@ -1329,7 +1329,7 @@ mod tests {
 
         assert_eq!(key.actions, vec![Action::DocumentsAdd]);
         assert_eq!(&key.name, &Some(name));
-        // We can't compare the two timestamp directly because of some nanoseconds imprecision with the floats
+        // We can't compare the two timestamps directly because of some nanoseconds imprecision with the floats
         assert_eq!(
             key.expires_at.unwrap().unix_timestamp(),
             expires_at.unix_timestamp()