Sylvestre Ledru
5c98e4d68f
Start an mdBook under docs/, laid out as in coreutils, and move the list of extensions and incompatibilities out of the README into it. The README keeps a pointer. A Documentation workflow builds the book with mdbook 0.5.0, the version the uutils website uses, whenever docs/ changes, and uploads it as an artifact. mdbook 0.5 rejects the `multilingual` field coreutils still carries (the website strips it before building), so the book leaves it out.
104 lines
3.7 KiB
Markdown
104 lines
3.7 KiB
Markdown
[](https://crates.io/crates/sed)
|
|
[](https://discord.gg/wQVJbvJ)
|
|
[](https://github.com/uutils/sed/blob/main/LICENSE)
|
|
[](https://deps.rs/repo/github/uutils/sed)
|
|
|
|
[](https://codecov.io/gh/uutils/sed)
|
|
|
|
# sed
|
|
|
|
Rust reimplementation of the [sed utility](https://pubs.opengroup.org/onlinepubs/9799919799/utilities/sed.html)
|
|
with some [GNU sed](https://www.gnu.org/software/sed/manual/sed.html),
|
|
[FreeBSD sed](https://man.freebsd.org/cgi/man.cgi?sed(1)),
|
|
and other extensions.
|
|
|
|
## Status
|
|
|
|
At this state _sed_ implements all [POSIX features](https://pubs.opengroup.org/onlinepubs/9799919799/)
|
|
and can run correctly the three complex scripts of its integration tests:
|
|
[hanoi.sed](https://github.com/uutils/sed/blob/main/tests/fixtures/sed/script/hanoi.sed) (solves the Towers of Hanoi puzzle),
|
|
[mandelbrot.sed](https://github.com/uutils/sed/blob/main/tests/fixtures/sed/script/mandelbrot.sed), (draws the Mandelbrot set) and
|
|
[math.sed](https://github.com/uutils/sed/blob/main/tests/fixtures/sed/script/math.sed) (implements an arbitrary precision integer math calculator).
|
|
|
|
The performance of this Rust implementation is now better than the GNU and FreeBSD implementations for most benchmarked cases.
|
|
|
|
Further work aims to:
|
|
* improve GNU _sed_ compatibility, especially on the regular expression front,
|
|
* implement more GNU extensions, and
|
|
* improve performance where possible.
|
|
|
|
## Installation and Use
|
|
|
|
We provide a Linux x86_64 binary archive from the main branch at
|
|
https://github.com/uutils/sed/releases/tag/latest-commit .
|
|
|
|
If you have [cargo-binstall](https://github.com/cargo-bins/cargo-binstall),
|
|
the released binaries can be installed directly with:
|
|
|
|
```bash
|
|
cargo binstall sed
|
|
```
|
|
|
|
For other platforms, ensure you have Rust installed on your system. You can install Rust through [rustup](https://rustup.rs/).
|
|
|
|
Clone the repository and build the project using Cargo:
|
|
|
|
```bash
|
|
git clone https://github.com/uutils/sed.git
|
|
cd sed
|
|
cargo build --release
|
|
cargo run --release
|
|
```
|
|
|
|
The binary is named `sed` in `target/release/sed`.
|
|
|
|
You can also try *sed* on the web
|
|
through the [uutils Playground](https://uutils.org//playground/)
|
|
by clicking on the `Load sed` button.
|
|
|
|
## Testing
|
|
|
|
### GNU sed Compatibility Testing
|
|
|
|
Test compatibility against GNU sed by running the upstream testsuite shell scripts
|
|
with a lightweight gnulib test-framework shim:
|
|
|
|
```bash
|
|
# Clone GNU sed testsuite (one time setup)
|
|
git clone https://github.com/mirror/sed.git ../gnu.sed
|
|
|
|
# Run compatibility tests
|
|
./util/run-gnu-testsuite.sh
|
|
|
|
# Verbose mode shows failure details
|
|
./util/run-gnu-testsuite.sh -v
|
|
|
|
# Generate JSON results for CI
|
|
./util/run-gnu-testsuite.sh --json-output results.json
|
|
```
|
|
|
|
The harness executes each `.sh` test from the GNU sed testsuite directly, injecting
|
|
our Rust sed binary via `PATH` and providing shim implementations of the gnulib test
|
|
framework functions (`compare_`, `returns_`, `skip_`, etc.).
|
|
|
|
### Unit Tests
|
|
|
|
```bash
|
|
cargo test
|
|
```
|
|
|
|
## Extensions and incompatibilities
|
|
The GNU, BSD and new extensions _sed_ supports, and where it differs from GNU
|
|
_sed_, are listed in [docs/src/extensions.md](docs/src/extensions.md).
|
|
|
|
## GNU test suite compatibility
|
|
|
|
Below is the evolution of how many GNU tests uutils passes.
|
|
|
|
|
|
|
|
|
|
## License
|
|
|
|
sed is licensed under the MIT License - see the `LICENSE` file for details
|