From fb192aaa9f7772a0ad4d72b32c9245ce5134c4b6 Mon Sep 17 00:00:00 2001 From: Kerollmops Date: Mon, 25 Apr 2022 15:55:38 +0200 Subject: [PATCH] Update the list of milli's subcrates --- README.md | 7 +++++-- cli/Cargo.toml | 2 -- filter-parser/Cargo.toml | 3 +-- helpers/Cargo.toml | 1 + json-depth-checker/Cargo.toml | 3 +-- json-depth-checker/src/lib.rs | 2 +- 6 files changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 4bf6a0d70..31e71b603 100644 --- a/README.md +++ b/README.md @@ -15,10 +15,13 @@ to process one update at a time. This repository contains crates to quickly debug the engine: - There are benchmarks located in the `benchmarks` crate. + - The `cli` crate is a simple command-line interface that helps run [flamegraph] on top of it. + - The `filter-parser` crate contains the parser for the Meilisearch filter syntax. + - The `flatten-serde-json` crate contains the library that flattens serde-json `Value` objects like elastic search does. + - The `helpers` crate is only used to do operations on the database. - The `http-ui` crate is a simple HTTP dashboard to tests the features like for real! - The `infos` crate is used to dump the internal data-structure and ensure correctness. - - The `search` crate is a simple command-line that helps run [flamegraph] on top of it. - - The `helpers` crate is only used to modify the database inplace, sometimes. + - The `json-depth-checker` crate is used to indicate if a JSON must be flattened. ## How to use it? diff --git a/cli/Cargo.toml b/cli/Cargo.toml index 06ac4ddb5..de302b895 100644 --- a/cli/Cargo.toml +++ b/cli/Cargo.toml @@ -4,8 +4,6 @@ version = "0.26.1" edition = "2018" description = "A CLI to interact with a milli index" -# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html - [dependencies] indicatif = "0.16.2" serde = "1.0.136" diff --git a/filter-parser/Cargo.toml b/filter-parser/Cargo.toml index ea29404ed..fe069ccb2 100644 --- a/filter-parser/Cargo.toml +++ b/filter-parser/Cargo.toml @@ -2,8 +2,7 @@ name = "filter-parser" version = "0.1.0" edition = "2021" - -# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html +description = "The parser for the Meilisearch filter syntax" [dependencies] nom = "7.1.0" diff --git a/helpers/Cargo.toml b/helpers/Cargo.toml index ea58d874d..d71009c91 100644 --- a/helpers/Cargo.toml +++ b/helpers/Cargo.toml @@ -3,6 +3,7 @@ name = "helpers" version = "0.26.1" authors = ["Clément Renault "] edition = "2018" +description = "A small tool to do operations on the database" [dependencies] anyhow = "1.0.56" diff --git a/json-depth-checker/Cargo.toml b/json-depth-checker/Cargo.toml index d608a49dc..9d99a47d8 100644 --- a/json-depth-checker/Cargo.toml +++ b/json-depth-checker/Cargo.toml @@ -2,8 +2,7 @@ name = "json-depth-checker" version = "0.1.0" edition = "2021" - -# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html +description = "A library that indicates if a JSON must be flattened" [dependencies] serde_json = "1.0" diff --git a/json-depth-checker/src/lib.rs b/json-depth-checker/src/lib.rs index 3d0f28af8..d571a0ca5 100644 --- a/json-depth-checker/src/lib.rs +++ b/json-depth-checker/src/lib.rs @@ -1,6 +1,6 @@ use serde_json::Value; -/// Your json MUST BE valid and generated by `serde_json::to_vec` before being +/// Your json MUST BE valid and generated by `serde_json::to_vec` before being /// sent in this function. This function is DUMB and FAST but makes a lot of /// asumption about the way `serde_json` will generate its input. ///