a structural diff that understands syntax 🟥🟩
 
 
 
 
 
Go to file
Wilfred Hughes 4cffa098d1 Add patch version 2021-09-28 09:45:11 +07:00
.github/workflows Run `cargo package` as part of test suite 2021-09-14 00:11:19 +07:00
benches Remove regex parser 2021-09-19 12:17:25 +07:00
img Simplify screenshot to exclude window chrome 2021-09-06 00:15:50 +07:00
manual Document the main tricky cases with tree diffs 2021-09-24 23:33:25 +07:00
sample_files Add sample files showing a syntax error 2021-09-20 00:25:59 +07:00
src Store parent node in SyntaxInfo 2021-09-23 23:16:38 +07:00
vendor Add C# support 2021-09-22 22:37:53 +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 Document the main tricky cases with tree diffs 2021-09-24 23:33:25 +07:00
Cargo.lock Add patch version 2021-09-28 09:45:11 +07:00
Cargo.toml Add patch version 2021-09-28 09:45:11 +07:00
LICENSE Add LICENSE file 2021-07-04 11:41:39 +07:00
README.md Add C# support 2021-09-22 22:37:53 +07:00
build.rs Fix building of e.g., vendor/tree-sitter-haskell-src/scanner.cc 2021-09-28 09:41:57 +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.

screenshot

See the manual to get started.

Difftastic supports the following languages:

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

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

Known Issues

Robustness. Difftastic is young and each release has fixed several crashes.

Comprehensible display. Minimal diffs can be confusing: replacing one function with another may have a small amount of common punctuation even though they're completely unrelated. Alignment of slightly modified lines is a major challenge too.

Changes to long lines. Difftastic uses a side-by-side display by default, which is unhelpful if the only changes are near the end of a line.

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.

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.

Further Reading

The wiki includes a thorough overview of alternative diffing techniques and tools.