Skip to content

Commit 33469a6

Browse files
committed
Add metadata and fix CI
1 parent ff0590d commit 33469a6

File tree

5 files changed

+47
-20
lines changed

5 files changed

+47
-20
lines changed

.github/workflows/ci.yml

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -18,14 +18,15 @@ jobs:
1818
- name: Setup Rust
1919
uses: hecrj/setup-rust-action@v2
2020
with:
21-
rust-version: stable
22-
profile: minimal
21+
rust-version: nightly
2322
- name: Set up Python
2423
uses: actions/setup-python@v5
2524
with:
2625
python-version: "3.12"
2726
- name: Install dependencies
2827
run: |
28+
ls -la
29+
ls -la ..
2930
pip install --upgrade pip
3031
pip install pre-commit
3132
- name: Cache dependencies
@@ -49,13 +50,13 @@ jobs:
4950
name: Build
5051
runs-on: ubuntu-latest
5152
steps:
53+
- uses: actions/checkout@v4
5254
- name: Setup Rust
5355
uses: hecrj/setup-rust-action@v2
5456
with:
55-
rust-version: stable
56-
profile: minimal
57+
rust-version: nightly
5758
- name: Build
58-
run: cargo build --release --workspace --all-features
59+
run: cargo build --release
5960

6061
unit-tests:
6162
name: Unit tests
@@ -68,11 +69,11 @@ jobs:
6869
- macos-latest
6970
- windows-latest
7071
steps:
72+
- uses: actions/checkout@v4
7173
- name: Setup Rust
7274
uses: hecrj/setup-rust-action@v2
7375
with:
74-
rust-version: stable
75-
profile: minimal
76+
rust-version: nightly
7677
- name: Cache dependencies
7778
uses: actions/cache@v4
7879
with:

.markdown-link-check.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"ignorePatterns": [
33
{
4-
"pattern": "^https://crates\\.io"
4+
"pattern": "^(#|(https://crates\\.io))"
55
}
66
]
77
}

Cargo.lock

Lines changed: 10 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Cargo.toml

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,18 @@ version = "0.1.0"
44
edition = "2021"
55
description = "An opinionated hledger's journal files formatter."
66
repository = "https://github.com/mondeja/hledger-fmt"
7-
keywords = [
8-
"hledger",
9-
"journal",
10-
"formatter",
11-
"accounting",
7+
authors = ["Álvaro Mondéjar Rubio"]
8+
license = "MIT"
9+
keywords = ["hledger", "journal", "formatter", "accounting"]
10+
categories = ["command-line-utilities", "finance", "value-formatting"]
11+
exclude = [
12+
".editorconfig",
13+
".github",
14+
"fuzz",
15+
".pre-commit-config.yaml",
16+
".pre-commit-hooks.yaml",
17+
".markdown-link-check.json",
18+
".gitignore"
1219
]
1320

1421
[lib]
@@ -26,3 +33,6 @@ colored = { version = "2", optional = true }
2633
[features]
2734
default = ["color"]
2835
color = ["dep:colored"]
36+
37+
[workspace]
38+
members = ["."]

README.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,17 @@
11
# hledger-fmt
22

33
[![Crates.io](https://img.shields.io/crates/v/hledger-fmt?logo=rust)](https://crates.io/crates/hledger-fmt)
4-
[![License](https://img.shields.io/crates/l/hledger-fmt)](https://github.com/mondeja/hledger-fmt/blob/master/LICENSE)
5-
[![Tests](https://img.shields.io/github/actions/workflow/status/mondeja/hledger-fmt/ci.yml?label=tests&logo=github)](https://github.com/mondeja/hledger-fmt/actions)
4+
[![License](https://img.shields.io/crates/l/hledger-fmt)][license-badge-link]
5+
[![Tests](https://img.shields.io/github/actions/workflow/status/mondeja/hledger-fmt/ci.yml?label=tests&logo=github)][tests-badge-link]
66
[![Crates.io downloads](https://img.shields.io/crates/d/hledger-fmt)](https://crates.io/crates/hledger-fmt)
77

8+
<!-- markdown-link-check-disable -->
9+
10+
[license-badge-link]: https://github.com/mondeja/hledger-fmt/blob/master/LICENSE
11+
[tests-badge-link]: https://github.com/mondeja/hledger-fmt/actions
12+
13+
<!-- markdown-link-check-enable -->
14+
815
An opinionated [hledger]'s journal files formatter.
916

1017
## Installation
@@ -30,20 +37,20 @@ the extensions `.journal`, `.hledger` and `.j` in the current directory
3037
and its subdirectories.
3138

3239
```bash
33-
hledger-fmt [files...]
40+
hledger-fmt [OPTIONS] [FILES]...
3441
```
3542

36-
To fix them, use the `--fix` option:
43+
To fix them in place, use the `--fix` option:
3744

3845
```bash
39-
hledger-fmt --fix [files...]
46+
hledger-fmt --fix [FILES]...
4047
```
4148

4249
See `hledger-fmt --help` for more information.
4350

4451
## Features
4552

46-
- **color** (enabled by default): Build with terminal color support.
53+
- **`color`** (enabled by default): Build with terminal color support.
4754

4855
## Roadmap
4956

0 commit comments

Comments
 (0)