Fix bug and document pre-commit usage

Author: mondeja

.github/workflows/ci.yml

@@ -18,7 +18,8 @@ jobs:
       - name: Setup Rust
         uses: hecrj/setup-rust-action@v2
         with:
-          rust-version: nightly
+          rust-version: stable
+          profile: minimal
       - name: Set up Python
         uses: actions/setup-python@v5
         with:
@@ -54,7 +55,8 @@ jobs:
       - name: Setup Rust
         uses: hecrj/setup-rust-action@v2
         with:
-          rust-version: nightly
+          rust-version: stable
+          profile: minimal
       - name: Build
         run: cargo build --release
 
@@ -73,7 +75,8 @@ jobs:
       - name: Setup Rust
         uses: hecrj/setup-rust-action@v2
         with:
-          rust-version: nightly
+          rust-version: stable
+          profile: minimal
       - name: Cache dependencies
         uses: actions/cache@v4
         with:
@@ -100,6 +103,9 @@ jobs:
       - uses: actions/checkout@v4
       - name: Setup Rust
         uses: hecrj/setup-rust-action@v2
+        with:
+          rust-version: stable
+          profile: minimal
       - name: Publish
         run: |
           cargo login ${{ secrets.CRATES_TOKEN }}
@@ -115,6 +121,9 @@ jobs:
       - uses: actions/checkout@v4
       - name: Setup Rust
         uses: hecrj/setup-rust-action@v2
+        with:
+          rust-version: stable
+          profile: minimal
       - name: Publish
         run: |
           cargo login ${{ secrets.CRATES_TOKEN }}

.markdownlint-cli2.yaml

@@ -0,0 +1,3 @@
+config:
+  no-duplicate-heading: false
+  first-line-heading: false

CHANGELOG.md

@@ -1,5 +1,11 @@
 # CHANGELOG
 
+## 2024-09-27 - [0.1.2]
+
+### Bug fixes
+
+- Exit code 1 when files formatted.
+
 ## 2024-09-27 - [0.1.1]
 
 ### Bug fixes
@@ -10,4 +16,5 @@
 
 First beta release
 
+[0.1.2]: https://github.com/mondeja/hledger-fmt/compare/v0.1.1...v0.1.2
 [0.1.1]: https://github.com/mondeja/hledger-fmt/compare/v0.1.0...v0.1.1

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "hledger-fmt"
-version = "0.1.1"
+version = "0.1.2"
 edition = "2021"
 description = "An opinionated hledger's journal files formatter."
 repository = "https://github.com/mondeja/hledger-fmt"

Cargo.toml

@@ -30,6 +30,19 @@ cargo binstall hledger-fmt
 
 We don't currently provide standalone pre-built binaries.
 
+### pre-commit
+
+Use it with [pre-commit] by adding the hook to your _.pre-commit-config.yaml_:
+
+```yaml
+repos:
+  - repo: https://github.com/mondeja/hledger-fmt
+    rev: vX.Y.Z
+    hooks:
+      # id: hledger-fmt        # Use this id to format files in place
+      - id: hledger-fmt-check # Use this id to check files without formatting
+```
+
 ## Usage
 
 When you don't pass files to format, it reads all the files with
@@ -61,3 +74,4 @@ accepted to make it more flexible. Send a PR if you want to help.
 [cargo-binstall]: https://github.com/cargo-bins/cargo-binstall
 [hledger]: https://hledger.org
 [cargo]: https://doc.rust-lang.org/cargo/
+[pre-commit]: https://pre-commit.com

README.md

@@ -125,6 +125,8 @@ fn main() {
             continue;
         }
 
+        exitcode = 1;
+
         if args.fix {
             match std::fs::write(&file, &formatted) {
                 Ok(_) => {}
@@ -135,7 +137,6 @@ fn main() {
                         eprintln!();
                     }
                     eprintln!("Error writing file {file}: {e}");
-                    exitcode = 1;
                 }
             }
         } else {