apdev-rs 0.2.0

Shared development tools for Rust projects - character validation, release automation, and more
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109

# apdev-rs (Rust)

General-purpose development tools for Rust projects - character validation, release automation, and more.

## Installation

```bash
cargo install apdev-rs
```

Or install from local source:

```bash
cd rust
cargo install --path .
```

## Tools

### check-chars

Validate that files contain only allowed characters (ASCII, common emoji, and technical symbols like arrows and box-drawing characters). Flags dangerous invisible/bidirectional characters in code (Trojan Source - CVE-2021-42574) while allowing them in comments.

Supports comment-aware checking for `.rs`, `.py`, `.js`, `.ts`, `.tsx`, `.jsx` files.

```bash
# Check default project directories (src/, tests/, examples/) and config files
apdev-rs check-chars

# Check a directory recursively
apdev-rs check-chars src/

# Check specific files
apdev-rs check-chars src/lib.rs src/main.rs

# Enable extra charset (e.g. Chinese characters)
apdev-rs check-chars --charset chinese src/

# Use a custom charset JSON file
apdev-rs check-chars --charset-file custom.json src/
```

Options:

- `--charset <name>` — Enable a built-in charset preset (repeatable). Available: `chinese`, `japanese`, `korean`
- `--charset-file <path>` — Load a custom charset JSON file (repeatable)
- Environment variable `APDEV_EXTRA_CHARS` — Comma-separated list of charset names or file paths, used when no `--charset`/`--charset-file` is given

### release

Interactive release automation for publishing Rust crates to crates.io and GitHub. Auto-detects project name from `Cargo.toml` and GitHub repo from git remote.

```bash
# Run with auto-detected version from Cargo.toml
apdev-rs release

# Specify version explicitly
apdev-rs release 0.1.0

# Silent mode (auto-accept all defaults, for CI/CD)
apdev-rs release --yes
apdev-rs release --yes 0.1.0
```

The command provides an interactive menu with steps:

1. Version verification (checks `Cargo.toml`)
2. Status check (git tag, crates.io)
3. Run tests (`cargo test`)
4. Build release (`cargo build --release`)
5. Create git tag and push
6. Create GitHub release (via `gh` CLI)
7. Publish to crates.io (`cargo publish`)

Override auto-detection with environment variables:

```bash
PROJECT_NAME=mycrate GITHUB_REPO=owner/repo apdev-rs release
```

## Pre-commit Integration

Requires `apdev-rs` installed on the system (`cargo install apdev-rs`):

```yaml
repos:
  - repo: local
    hooks:
      - id: check-chars
        name: apdev-rs check-chars
        entry: apdev-rs check-chars
        language: system
        types_or: [text, rust]
```

## Development

Prerequisites: Rust >= 1.70.

```bash
cd rust
cargo build               # Build
cargo test                 # Run tests
cargo build --release      # Build release binary
```

## License

Apache-2.0