a structural diff that understands syntax 🟥🟩
 
 
 
 
 
Go to file
Wilfred Hughes a11e3081b2 Roll version 2022-01-06 01:00:48 +07:00
.github/workflows Update to latest mdbook 2021-12-17 09:25:34 +07:00
img Improve README 2021-11-23 22:38:25 +07:00
manual Document the string literal problem 2021-12-30 09:58:56 +07:00
sample_files Expand text sample file 2022-01-02 19:18:19 +07:00
src Only split source code on newlines once 2022-01-06 00:54:52 +07:00
vendor Merge commit '111b07762e86efab9a918b7c721f720c37e76b0a' 2021-12-31 19:39:47 +07:00
.codecov.yml Disable 'patch' test coverage in GitHub status 2021-09-13 00:44:08 +07:00
.gitignore Ignore local notes 2021-07-27 23:49:31 +07:00
CHANGELOG.md Roll version 2022-01-06 01:00:48 +07:00
CITATION.cff Add citation information 2021-11-23 09:52:39 +07:00
Cargo.lock Roll version 2022-01-06 01:00:48 +07:00
Cargo.toml Roll version 2022-01-06 01:00:48 +07:00
LICENSE Add LICENSE file 2021-07-04 11:41:39 +07:00
README.md Note robustness in known issues 2021-12-11 14:49:26 +07:00
build.rs Prefer static strings in TreeSitterParser 2021-12-30 19:38:35 +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: 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: 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
  • 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. This might be solved by A* search.

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).

Integration. Difftastic only has limited support for git and mercurial today.

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.