nushell/benches/README.md

# Divan benchmarks

These are benchmarks using [Divan](https://github.com/nvzqz/divan), a microbenchmarking tool for Rust.

Run all benchmarks with `cargo bench`

Or run individual benchmarks like `cargo bench -- <regex>` e.g. `cargo bench -- parse`
replace Criterion with Divan (#12000) <!-- if this PR closes one or more issues, you can automatically link the PR with them by using one of the [linking keywords](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword), e.g. - this PR should close #xxxx - fixes #xxxx you can also mention related issues, PRs or discussions! --> # Description <!-- Thank you for improving Nushell. Please, check our [contributing guide](../CONTRIBUTING.md) and talk to the core team before making major changes. Description of your pull request goes here. Provide examples and/or screenshots if your changes affect the user experience. --> This is a test of changing out the current criterion microbenchmark tool to [Divan](https://nikolaivazquez.com/blog/divan/), a new and more straightforward microbenchmark suit. Itself states it is robust to noise, and even allow it to be used in CI settings. It by default has no external dependencies and is very fast to run, the sampling method allows it to be a lot faster compared to criterion requiring less samples. The output is also nicely displayed and easy to get a quick overview of the performance. ![image](https://github.com/nushell/nushell/assets/17986183/587a1fb1-1da3-402c-b668-a27fde9a0657) # User-Facing Changes <!-- List of all changes that impact the user experience here. This helps us keep track of breaking changes. --> # Tests + Formatting <!-- Don't forget to add tests that cover your changes. Make sure you've run and fixed any issues with these commands: - `cargo fmt --all -- --check` to check standard code formatting (`cargo fmt --all` applies these changes) - `cargo clippy --workspace -- -D warnings -D clippy::unwrap_used` to check that you're using the standard code style - `cargo test --workspace` to check that all tests pass (on Windows make sure to [enable developer mode](https://learn.microsoft.com/en-us/windows/apps/get-started/developer-mode-features-and-debugging)) - `cargo run -- -c "use std testing; testing run-tests --path crates/nu-std"` to run the tests for the standard library > Note > from `nushell` you can also use the `toolkit` as follows > ```bash > use toolkit.nu # or use an `env_change` hook to activate it automatically > toolkit check pr > ``` --> # After Submitting <!-- If your PR had any user-facing changes, update [the documentation](https://github.com/nushell/nushell.github.io) after the PR is merged, if necessary. This will help us keep the docs up to date. --> 2024-03-01 18:09:21 +00:00			`# Divan benchmarks`
Add Criterion benchmarks for parser (#7686) This PR sets up [Criterion](https://github.com/bheisler/criterion.rs) for benchmarking in the main `nu` crate, and adds some simple parser benchmarks. To run the benchmarks, just do `cargo bench` or `cargo bench -- <regex matching benchmark names>` in the repo root: ```bash 〉cargo bench -- parse ... Running benches/parser_benchmark.rs (target/release/deps/parser_benchmark-75d224bac82d5b0b) parse_default_env_file time: [221.17 µs 222.34 µs 223.61 µs] Found 8 outliers among 100 measurements (8.00%) 5 (5.00%) high mild 3 (3.00%) high severe parse_default_config_file time: [1.4935 ms 1.4993 ms 1.5059 ms] Found 11 outliers among 100 measurements (11.00%) 7 (7.00%) high mild 4 (4.00%) high severe ``` Existing benchmarks from `nu-plugin` have been moved into the main `nu` crate to keep all our benchmarks in one place. 2023-01-05 19:39:54 +00:00
replace Criterion with Divan (#12000) <!-- if this PR closes one or more issues, you can automatically link the PR with them by using one of the [linking keywords](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword), e.g. - this PR should close #xxxx - fixes #xxxx you can also mention related issues, PRs or discussions! --> # Description <!-- Thank you for improving Nushell. Please, check our [contributing guide](../CONTRIBUTING.md) and talk to the core team before making major changes. Description of your pull request goes here. Provide examples and/or screenshots if your changes affect the user experience. --> This is a test of changing out the current criterion microbenchmark tool to [Divan](https://nikolaivazquez.com/blog/divan/), a new and more straightforward microbenchmark suit. Itself states it is robust to noise, and even allow it to be used in CI settings. It by default has no external dependencies and is very fast to run, the sampling method allows it to be a lot faster compared to criterion requiring less samples. The output is also nicely displayed and easy to get a quick overview of the performance. ![image](https://github.com/nushell/nushell/assets/17986183/587a1fb1-1da3-402c-b668-a27fde9a0657) # User-Facing Changes <!-- List of all changes that impact the user experience here. This helps us keep track of breaking changes. --> # Tests + Formatting <!-- Don't forget to add tests that cover your changes. Make sure you've run and fixed any issues with these commands: - `cargo fmt --all -- --check` to check standard code formatting (`cargo fmt --all` applies these changes) - `cargo clippy --workspace -- -D warnings -D clippy::unwrap_used` to check that you're using the standard code style - `cargo test --workspace` to check that all tests pass (on Windows make sure to [enable developer mode](https://learn.microsoft.com/en-us/windows/apps/get-started/developer-mode-features-and-debugging)) - `cargo run -- -c "use std testing; testing run-tests --path crates/nu-std"` to run the tests for the standard library > Note > from `nushell` you can also use the `toolkit` as follows > ```bash > use toolkit.nu # or use an `env_change` hook to activate it automatically > toolkit check pr > ``` --> # After Submitting <!-- If your PR had any user-facing changes, update [the documentation](https://github.com/nushell/nushell.github.io) after the PR is merged, if necessary. This will help us keep the docs up to date. --> 2024-03-01 18:09:21 +00:00			`These are benchmarks using [Divan](https://github.com/nvzqz/divan), a microbenchmarking tool for Rust.`
Add Criterion benchmarks for parser (#7686) This PR sets up [Criterion](https://github.com/bheisler/criterion.rs) for benchmarking in the main `nu` crate, and adds some simple parser benchmarks. To run the benchmarks, just do `cargo bench` or `cargo bench -- <regex matching benchmark names>` in the repo root: ```bash 〉cargo bench -- parse ... Running benches/parser_benchmark.rs (target/release/deps/parser_benchmark-75d224bac82d5b0b) parse_default_env_file time: [221.17 µs 222.34 µs 223.61 µs] Found 8 outliers among 100 measurements (8.00%) 5 (5.00%) high mild 3 (3.00%) high severe parse_default_config_file time: [1.4935 ms 1.4993 ms 1.5059 ms] Found 11 outliers among 100 measurements (11.00%) 7 (7.00%) high mild 4 (4.00%) high severe ``` Existing benchmarks from `nu-plugin` have been moved into the main `nu` crate to keep all our benchmarks in one place. 2023-01-05 19:39:54 +00:00
			Run all benchmarks with `cargo bench`

			Or run individual benchmarks like `cargo bench -- <regex>` e.g. `cargo bench -- parse`