Skip to content

Commit

Permalink
Logger constants refactored, format argument added, better formatti…
Browse files Browse the repository at this point in the history
…ng of failed (non) equality assertions (nushell#9315)

# Description
I have (hopefully) simplified the `log.nu` internal structure and added
customizable log format for all `log` commands

# User-Facing Changes
- [x] Replaced constants with env records for: 
    - ansi (newly added)
    - log level
    - prefix
    - short prefix
- [x] Added `format` argument to all log commands
- [x] Assertions for (not) equality (equal, not equal, greater,
lesser...) now put left and right values inside `'` quotes, so the
assertions for strings are more meaningful
- [x] Documented the %-formatting of log messages

# 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 -A
clippy::needless_collect -A clippy::result_large_err` to check that
you're using the standard code style
- `cargo test --workspace` to check that all tests pass
- `cargo run -- crates/nu-std/tests/run.nu` 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.
-->

---------

Co-authored-by: amtoine <[email protected]>
  • Loading branch information
skelly37 and amtoine committed Jun 4, 2023
1 parent 7ca62b7 commit df15fc2
Show file tree
Hide file tree
Showing 9 changed files with 440 additions and 325 deletions.
12 changes: 6 additions & 6 deletions crates/nu-std/std/assert.nu
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ export def equal [left: any, right: any, message?: string] {
main ($left == $right) $message --error-label {
start: (metadata $left).span.start
end: (metadata $right).span.end
text: $"They are not equal. Left = ($left). Right = ($right)."
text: $"They are not equal. Left = '($left)'. Right = '($right)'."
}
}

Expand All @@ -160,7 +160,7 @@ export def "not equal" [left: any, right: any, message?: string] {
main ($left != $right) $message --error-label {
start: (metadata $left).span.start
end: (metadata $right).span.end
text: $"They both are ($left)."
text: $"They both are '($left)'."
}
}

Expand All @@ -177,7 +177,7 @@ export def "less or equal" [left: any, right: any, message?: string] {
main ($left <= $right) $message --error-label {
start: (metadata $left).span.start
end: (metadata $right).span.end
text: $"Left: ($left), Right: ($right)"
text: $"Left: '($left)', Right: '($right)'"
}
}

Expand All @@ -193,7 +193,7 @@ export def less [left: any, right: any, message?: string] {
main ($left < $right) $message --error-label {
start: (metadata $left).span.start
end: (metadata $right).span.end
text: $"Left: ($left), Right: ($right)"
text: $"Left: '($left)', Right: '($right)'"
}
}

Expand All @@ -209,7 +209,7 @@ export def greater [left: any, right: any, message?: string] {
main ($left > $right) $message --error-label {
start: (metadata $left).span.start
end: (metadata $right).span.end
text: $"Left: ($left), Right: ($right)"
text: $"Left: '($left)', Right: '($right)'"
}
}

Expand All @@ -226,7 +226,7 @@ export def "greater or equal" [left: any, right: any, message?: string] {
main ($left >= $right) $message --error-label {
start: (metadata $left).span.start
end: (metadata $right).span.end
text: $"Left: ($left), Right: ($right)"
text: $"Left: '($left)', Right: '($right)'"
}
}

Expand Down
Loading

0 comments on commit df15fc2

Please sign in to comment.