Add pre-commit checks, change packages metadata, and fix READMEs

- Additional docs updated
- Stripped extra features from `tokio`
- Add `std-fs-impls` feature to conditionally implement traits for File

Author: afiffon

.github/ISSUE_TEMPLATE/bug_report.md

@@ -14,8 +14,9 @@ A clear and concise description of what the bug is.
 Contain a code snippet that uses the crate, and reproduces the bug.
 
 **Desktop (please complete the following information):**
- - OS, architecture & version: [e.g. macOS 15.2, arm64]
- - Version [e.g. 0.8.1]
+
+- OS, architecture & version: [e.g. macOS 15.2, arm64]
+- Version [e.g. 0.8.1]
 
 **Additional context**
 Add any other context about the problem here.

.github/workflows/build.yml

@@ -14,7 +14,7 @@ env:
 jobs:
   test:
     runs-on: ubuntu-latest
-    container: 
+    container:
       image: rustlang/rust:nightly
     timeout-minutes: 10
     strategy:
@@ -62,7 +62,7 @@ jobs:
         cargo test --verbose --no-default-features --features "${{ matrix.compile_features }},sign_hmac" -- --nocapture
     - name: Build/${{ matrix.compile_features }}
       run: cargo build --verbose --no-default-features --features "${{ matrix.compile_features }},${COMMON_FEATURES}"
-  
+
   build-msrv:
     runs-on: ubuntu-latest
     container:

.gitignore

@@ -2,4 +2,4 @@
 .DS_Store
 .vscode
 *.pcap
-.idea
+.idea

.markdownlint.jsonc

@@ -0,0 +1,3 @@
+{
+    "line-length": false
+}

.pre-commit-config.yaml

@@ -1,4 +1,10 @@
 repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.6.0
+    hooks:
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+
   - repo: local
     hooks:
       - id: rust-linting
@@ -16,3 +22,8 @@ repos:
         types: [file, rust]
         language: system
         verbose: true
+
+  - repo: https://github.com/DavidAnson/markdownlint-cli2
+    rev: v0.13.0
+    hooks:
+      - id: markdownlint-cli2-docker

Cargo.toml

@@ -28,7 +28,7 @@ rand = "0.8.5"
 log = "0.4.22"
 
 # Async
-tokio = { version = "1.43", features = ["full"] }
+tokio = { version = "1.43" }
 maybe-async = "0.2"
 futures-util = { version = "0.3" }
 futures-core = { version = "0.3" }

LICENSE.md

@@ -1,7 +1,9 @@
+<!-- markdownlint-disable -->
+
 Copyright 2025 AVIV NAAMAN
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 
 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -4,19 +4,25 @@
 [![Crates.io](https://img.shields.io/crates/v/smb)](https://crates.io/crates/smb)
 [![docs.rs](https://img.shields.io/docsrs/smb/latest?link=https%3A%2F%2Fdocs.rs%2Fsmb%2Flatest%2Fsmb%2Findex.html)](https://docs.rs/smb/latest/smb/index.html)
 
-This project is the first rust implementation of [SMB2 & 3](https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-smb2/5606ad47-5ee0-437a-817e-70c366052962) client -- the protocol that powers Windows file sharing and remote services. The project is designed to be used as a crate, but also includes a CLI tool for basic operations.
+This project is the first rust implementation of
+[SMB2 & 3](https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-smb2/5606ad47-5ee0-437a-817e-70c366052962) client --
+the protocol that powers Windows file sharing and remote services.
+The project is designed to be used as a crate, but also includes a CLI tool for basic operations.
 
 While most current implementations are mostly bindings to C libraries (such as libsmb2, samba, or windows' own libraries), this project is a full implementation in Rust, with no dependencies on C libraries!
 
 ## Getting started
+
 Running the project's CLI is as simple as executing:
+
 ```sh
 cargo run -- --help
 ```
+
 Check out the `info` and the `copy` sub-commands for more information.
 
-For advanced usage, and crate usage, see the [Advanced Usage](#advanced-usage) section.
 ## Features
+
 - ✅ SMB 2.X & 3.X support.
 - ✅ Async (`tokio`), Multi-threaded, or Single-threaded client.
 - ✅ Compression & Encryption support.
@@ -27,6 +33,7 @@ For advanced usage, and crate usage, see the [Advanced Usage](#advanced-usage) s
 You are welcome to see the project's roadmap in the [GitHub Project](https://github.com/users/AvivNaaman/projects/2).
 
 ## Using the crate
+
 Check out the `Client` struct, exported from the `smb` crate, to initiate a connection to an SMB server:
 
 ```rust,no_run
@@ -37,11 +44,11 @@ use std::str::FromStr;
 async fn main() -> Result<(), Box<dyn std::error::Error>> {
     // instantiate the client
     let client = Client::new(ClientConfig::default());
-    
+
     // Connect to a share
     let target_path = UncPath::from_str(r"\\server\share").unwrap();
     client.share_connect(&target_path, "username", "password".to_string()).await?;
-    
+
     // And open a file on the server
     let file_to_open = target_path.with_path("file.txt");
     let file_open_args = FileCreateArgs::make_open_existing(FileAccessMask::new().with_generic_read(true));
@@ -61,8 +68,9 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
 Check out the [docs.rs](https://docs.rs/smb/latest/smb/index.html) for more information regarding usage.
 
 ## Development
+
 To set up a development environment, you may use any supported rust version.
 
-* It is highly recommended to use rust nightly, and install pre-commit hooks (using `pip install pre-commit && pre-commit install`)
-* Before committing your changes, run `cargo fmt` to format the code, and `cargo clippy` to check for linting issues.
-* Run crate tests once you are ready to commit. Read tests' README.md before proceeding!
+- It is highly recommended to use rust nightly, and install pre-commit hooks (using `pip install pre-commit && pre-commit install`)
+- Before committing your changes, run `cargo fmt` to format the code, and `cargo clippy` to check for linting issues.
+- Run crate tests once you are ready to commit. Read tests' README.md before proceeding!

crates/smb-cli/Cargo.toml

@@ -1,14 +1,16 @@
 [package]
 name = "smb-cli"
+description = "SMB Command Line Interface using `smb-rs`"
+readme = "README.md"
 version.workspace = true
 edition.workspace = true
 rust-version.workspace = true
 
 [dependencies]
-smb = { path = "../smb", default-features = false }
+smb = { path = "../smb", default-features = false, features = ["std-fs-impls"] }
 
 maybe-async = { workspace = true }
-tokio = { workspace = true, optional = true }
+tokio = { workspace = true, optional = true, features = ["rt-multi-thread"] }
 futures-util = { workspace = true, optional = true }
 
 # CLI & logging
@@ -18,15 +20,11 @@ env_logger = "0.11.6"
 log = { workspace = true }
 
 [features]
-default = ["async", "smb/default"]
+default = ["async"]
 
-async = ["smb/async", "dep:tokio", "dep:futures-util"]
-single_threaded = ["smb/single_threaded", "maybe-async/is_sync"]
-multi_threaded = ["smb/multi_threaded", "maybe-async/is_sync"]
-
-sign = ["smb/sign"]
-encrypt = ["smb/encrypt"]
-compress = ["smb/compress"]
+async = ["dep:tokio", "dep:futures-util"]
+single_threaded = ["maybe-async/is_sync"]
+multi_threaded = ["maybe-async/is_sync"]
 
 quic = ["smb/quic"]
 rdma = ["smb/rdma"]

crates/smb-cli/README.md

@@ -1,21 +1,30 @@
 # SMB-CLI
+
 this is a sample-ish program that uses the `smb` crate to build a command line utility.
+
 ## Usage
+
 ```sh
 cargo run -- --help
 ```
+
 Check out the subcommands `info` and `copy` for more details.
+
 ## Profiling
+
 From the project's root, build with:
+
 ```sh
 cargo build --profile profiling --features profiling
 ```
+
 ### macOS
+
 - Build the program as described above.
 - Install `instruments` from Xcode.
 - Launch the program from command line.
 - Open `instruments` and attach, using the right profiler.
 - Enter in the command line to actually begin the execution of the program.
 
 >[!note]
-> Launching the program from within `instruments` doesn't work properly, since local network connections are blocked. This also happens when using `lldb` to attach to the process. The program must be launched from the command line, and then `instruments` can attach to it.
+> Launching the program from within `instruments` doesn't work properly, since local network connections are blocked. This also happens when using `lldb` to attach to the process. The program must be launched from the command line, and then `instruments` can attach to it.