Skip to content

Commit 6c4b87a

Browse files
committed
docs: add dedicated breaking change notices to changelog
1 parent b015b36 commit 6c4b87a

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

CHANGELOG.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,37 @@
22

33
## [0.16.0](https://github.com/amperser/proselint/compare/0.14.0..v0.16.0) - 2025-11-14
44

5+
### 💥 Breaking Changes
6+
7+
This release is not backwards compatible. The following breaking changes have been made.
8+
9+
#### As a program
10+
11+
- Python 3.9 is now end-of-life, and no longer supported
12+
- Different calling conventions. See `--help` for a full list of options
13+
- `proselint --version` is now `proselint version`, for consistency with other linters
14+
- `proselint` is now `proselint check`
15+
- `proselint --dump-config` and `--dump-default-config` are now `proselint dump-config` and `dump-config --default`
16+
- `--time` and `--clean` have been removed
17+
- `--debug` is now `--verbose`
18+
- `--json` and `--compact` are now `--output-format json` and `--output-format compact`
19+
- There is a new JSON output schema for `--output-format json`. This is [documented](https://github.com/amperser/proselint/blob/v0.16.0/docs/wire-schema.md), stable, and versioned. Plugins will require updates.
20+
- The on-disk cache has been removed
21+
22+
#### As a library
23+
24+
- The cache has been removed, along with all related features in `proselint.tools`
25+
- The `score` module has been removed
26+
- The build backend is now `uv_build`
27+
- The `topics` and `context` features of `proselint.tools` have been removed
28+
- The `_check` functions of `proselint.tools` have been replaced by classes in `proselint.registry.checks.types`
29+
- Checks are now specified with `Check` in `proselint.registry.checks`
30+
- Lint runs are executed with `LintFile` and return `LintResult`, both in `proselint.tools`
31+
- The `ppm_threshold` wrapper in `proselint.tools` has been replaced by `CheckFlags` in `proselint.registry.checks`
32+
- The `max_errors` wrapper in `proselint.tools` has been removed
33+
- `load_options` in `proselint.tools` has been replaced by the `proselint.config` module
34+
- `errors_to_json` in `proselint.tools` has been replaced by `LintResult.into_dict`
35+
536
### ⛰️ Features
637

738
- *(registry)* Add strict padding for checks ([#1428](https://github.com/amperser/proselint/issues/1428)) - ([f1894bc](https://github.com/amperser/proselint/commit/f1894bccf5cb9344eca5daba64ad0b3ec8577784))

0 commit comments

Comments
 (0)