a structural diff that understands syntax 🟥🟩
 
 
 
 
 
Go to file
Wilfred Hughes d8cc1168b1 Make sample files naming consistent so they're all used in regression test 2022-02-13 17:21:20 +07:00
.github/workflows Update to latest mdbook 2021-12-17 09:25:34 +07:00
img Update screenshots to show new syntax highlighting 2022-01-29 17:54:36 +07:00
manual Remove Hack parser 2022-02-07 21:43:37 +07:00
sample_files Make sample files naming consistent so they're all used in regression test 2022-02-13 17:21:20 +07:00
scripts Add a helper script for doing releases 2022-01-30 18:04:03 +07:00
src Ensure --color is still respected 2022-02-13 16:54:57 +07:00
vendor Remove Hack parser 2022-02-07 21:43:37 +07:00
.codecov.yml Disable 'patch' test coverage in GitHub status 2021-09-13 00:44:08 +07:00
.gitattributes Ignore sample files for calculating GitHub code statistics 2022-01-16 20:27:11 +07:00
.gitignore Ignore temporary file from comparison tool 2022-02-13 17:16:30 +07:00
CHANGELOG.md Fix missing context on misaligned hunks 2022-02-12 12:26:00 +07:00
CITATION.cff Add citation information 2021-11-23 09:52:39 +07:00
Cargo.lock Ensure --color is still respected 2022-02-13 16:54:57 +07:00
Cargo.toml Ensure --color is still respected 2022-02-13 16:54:57 +07:00
LICENSE Roll year 2022-02-05 15:58:45 +07:00
README.md Remove Hack parser 2022-02-07 21:43:37 +07:00
build.rs Remove Hack parser 2022-02-07 21:43:37 +07:00
text_diff_notes.md Add notes on LCS weaknesses 2021-03-21 13:34:01 +07:00

README.md

it's difftastic!
crates.io codecov.io manual

Difftastic is an experimental structured diff tool that compares files based on their syntax.

See the manual to get started.

Demo 1: Wrapping Expressions

Difftastic understands expression nesting. If you wrap an expression in an if statement, difftastic understands that the inner values are unchanged.

Elisp screenshot

Compare this with git's default diff. It is confused by indentation changes, and doesn't know which closing parenthesis has been added.

Elisp comparison screenshot

Demo 2: Reflowing Code

Difftastic is robust to code formatting changes. If you change how many items appear on a single line, difftastic will only show you items which have changed.

Rust screenshot

In git's default diff, it's harder to see that iter and the curly braces are unchanged. It's also harder to see the affected line numbers.

Rust comparison screenshot

Languages

Difftastic supports the following languages:

  • Bash
  • C
  • C++
  • C#
  • Clojure
  • Common Lisp
  • CSS
  • Elixir
  • Emacs Lisp
  • Go
  • Haskell
  • Java
  • JavaScript (and JSX)
  • JSON
  • OCaml
  • Python
  • Ruby
  • Rust
  • Scala
  • TypeScript (and TSX)

If a file has an unrecognised extension, difftastic uses a line-oriented diff.

Known Issues

Performance. Difftastic scales relatively poorly on files with a large number of changes, and can use a lot of memory.

Display. Difftastic has a side-by-side display which usually works well, but can be confusing.

Robustness. Difftastic regularly has releases that fix crashes.

Diff accuracy. Some delimiter moves are currently ignored (see #30).

Non-goals

Patch files. If you want to create a patch that you can later apply, use diff. Difftastic ignores whitespace, so its output is lossy. (AST patching is also a hard problem.)

License

Difftastic is open source under the MIT license, see LICENSE for more details.

Files in sample_files/ are also under the MIT license unless stated otherwise in their header.