[go: up one dir, main page]

uncomment 2.9.1

A CLI tool to remove comments from code using tree-sitter for accurate parsing
Documentation 
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

# Contributing to Uncomment

Thanks for helping improve `uncomment`! This guide keeps the local workflow and release process clear and to the point.

## Local Development

### Prerequisites

- Rust 1.70+ with `cargo`
- Node.js 18+ (for optional tooling and npm wrapper verification)
- `tree-sitter` grammars are bundled; no extra setup is required

### Bootstrap

```bash
git clone https://github.com/Goldziher/uncomment.git
cd uncomment
cargo check
cargo test
```

Run the usual hygiene commands before sending a change:

```bash
cargo fmt
cargo clippy --all-targets --all-features -- --deny warnings
cargo test --all-features
```

### Automation Hooks (Prek)

We use [prek](https://github.com/nikitonsky/prek), a Rust rewrite of `pre-commit`, to execute the hooks defined in `.pre-commit-config.yaml`. It is a drop-in replacement that runs the same checks faster.

```bash
cargo install prek            # or use your preferred binary installer
prek install
prek install --hook-type commit-msg
prek run --all-files          # run hooks on demand
```

## Distribution & Releases

`uncomment` ships through four channels: crates.io, npm, PyPI, and GitHub Releases. Keep versions in sync across all artifacts.

### Version Bump Checklist

1. Update versions:
   - `Cargo.toml`
   - `npm-package/package.json`
   - `pip-package/pyproject.toml`
   - `pip-package/uncomment/__init__.py`
2. Regenerate `Cargo.lock` if needed (`cargo update`).
3. Commit the changes with a descriptive message.

### Tagging

```bash
git tag vX.Y.Z
git push origin vX.Y.Z
```

Release candidates use `vX.Y.Z-rc.1` for Git/npm and `X.Y.Zrc1` for PyPI.

### Publishing

- **Cargo**: `cargo publish`
- **npm**: `cd npm-package && npm publish` (use `--tag beta` for RCs)
- **PyPI**:
  ```bash
  cd pip-package
  python -m build
  twine upload dist/*          # use --repository testpypi for RCs
  ```

### GitHub Release Workflow

Pushing the tag triggers `.github/workflows/release.yml`, which builds signed binaries for macOS (Intel/Apple Silicon), Linux (x86_64/aarch64), and Windows, attaches them to the GitHub release, and makes them available to the npm and PyPI shims.

### After Publishing

- Verify installs: `cargo install uncomment`, `npm view uncomment-cli`, `pip index versions uncomment`
- Announce the release and update any downstream docs if needed