Skip to content

Commit e31e7c2

Browse files
committed
prepare for release v3.0.4
1 parent 38c1fee commit e31e7c2

File tree

10 files changed

+472
-483
lines changed

10 files changed

+472
-483
lines changed

CHANGELOG.md

+23
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,29 @@ All notable changes to this project will be documented in this file. The format
44

55
## [Released]
66

7+
## [3.0.4] - 2025-01-01
8+
- Refactoring
9+
- Update dependencies
10+
- improve user error messages
11+
12+
### Fixed
13+
- report handler crashed(panicked) on windows if `RUST_BACKTRACE` set to full
14+
- `download` command
15+
- parsing `Content-Range` header was incorrect
16+
- if the header specifies an unknown content size (e.g. Content-Range: bytes 0-1023/*), this was not taken into account
17+
- now a streamed download is initiated in this case
18+
19+
### Added
20+
- `info` log level to write only necessary information to the log file
21+
- `download` command
22+
- set connection time out to 25 sec
23+
- display user info during the connection establishment
24+
- improve logging behavior by using the debug log level
25+
- in case of an successfully request, the response headers will be logged
26+
- in case of an failed request, the response headers and the response body will be logged
27+
<br>
28+
29+
730
## [3.0.3] - 2024-12-16
831
- Performance optimizations
932
- Refactoring

Cargo.lock

+23-37
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Cargo.toml

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "hashguard"
3-
version = "3.0.3"
3+
version = "3.0.4"
44
edition = "2021"
55
description = "Command-Line tool for ensuring the integrity of files using hash sums"
66
authors = ["javaLux"]
@@ -19,9 +19,9 @@ chrono = { version = "0.4.39", default-features = false, features = ["clock"] }
1919
clap = { version = "4.5.23", features = ["derive", "cargo", "string"] }
2020
color-eyre = "0.6.3"
2121
ctrlc = "3.4.5"
22-
indicatif = "0.17.9"
22+
indicatif = { version = "0.17.9", default-features = false }
2323
log = "0.4.22"
24-
os_info = { version = "3.9.0", default-features = false }
24+
os_info = { version = "3.9.1", default-features = false }
2525
output-coloring = "0.1.0"
2626
path-absolutize = "3.1.1"
2727
percent-encoding = "2.3.1"

README.md

+15-14
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ HashGuard is a lean and efficient command-line tool designed to simplify the pro
3232
Because by enclosing the URL in double quotation marks, you tell the shell to treat the entire string as a single argument, even if it contains spaces or other special characters. This can prevent errors and unexpected behavior in your shell.
3333

3434
* ### Local-Command
35-
* Allows to hash local files, directories or any byte-buffer (futhermore you can also compare with a specific hash sum)
35+
* Allows to hash local files, directories or any byte-buffer (furthermore you can also compare with a specific hash sum)
3636
* **Options**
3737
* _path_
3838
* Calculate a hash sum from a file/dir
@@ -48,10 +48,11 @@ HashGuard is a lean and efficient command-line tool designed to simplify the pro
4848
* **Hash Verification:** Verify the authenticity of downloaded or local files by comparing their hash sum with a provided hash value.
4949
* **Support for Various Hash Algorithms:** HashGuard supports different hash algorithms, including SHA-1, SHA2-256, and more. The default Hash-Algorithm is SHA2-256.
5050
* **Intuitive Command-Line Interface:** The simple and user-friendly CLI lets you easily calculate and compare hash sums.
51-
* **Log-Level**
52-
* You can enable the application debug mode
53-
* This provides additional functionality such as logging all relevant operations in a log file.
54-
* Furthermore, the debug mode can be useful to get detailed information about an error (e.g. display a full backtrace)
51+
* **Logging**
52+
* To enable logging, set one of the following log level options: [ `-l=debug|info`, `--log-level=debug|info` ]
53+
* `info` log level: write only necessary information to a log file (e.g. common application operations and error messages)
54+
* `debug` log level: write all information to the log file and display a backtrace in the event of an error
55+
* For example, if you use the `download` command, the whole server response is logged
5556

5657
## Supported OS
5758
* Linux [All common distributions]
@@ -135,20 +136,20 @@ cargo build --release
135136
hashguard local -p /path/to/test_dir
136137
````
137138

138-
**Debug-Option**
139-
* Enable the debug log level:
139+
**Use Logging**
140+
* Enable `debug` log level:
140141
````shell
141142
hashguard -l debug download "https://example.com/file.zip" a1b2c3d4e5f6
142143
````
144+
* Enable `info` log level
143145
````shell
144-
hashguard -l debug local -p /path/to/local_file.txt
146+
hashguard -l info local -p /path/to/local_file.txt
145147
````
146-
* In the event of an error, a full backtrace is displayed
147-
* In addition, all log outputs are saved in a log file in the application's data directory.
148-
* You can find out the application data directory with the [--version] command
149-
* Please note that the application data directory is created as a hidden directory.
150-
To see it, you must activate the property for displaying hidden files and folders for your operating system,
151-
if you have not already done so
148+
* All logs are written to a log file stored in the application's data directory.
149+
* You can find out the application data directory with the [ `-V`, `--version` ] command
150+
* Please note that the application data directory is created as a hidden directory.
151+
To see it, you must activate the property for displaying hidden files and folders for your operating system,
152+
if you have not already done so
152153
153154
**Common-Options**
154155
* Get version info:

0 commit comments

Comments
 (0)