Skip to content

Commit 42fde56

Browse files
committed
1 parent a06b0e5 commit 42fde56

File tree

2 files changed

+51
-0
lines changed

2 files changed

+51
-0
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
/target/

README.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# java-diff-utils
2+
Diff Utils library is an OpenSource library for performing the comparison operations between texts: computing diffs, applying patches, generating unified diffs or parsing them, generating diff output for easy future displaying (like side-by-side view) and so on.
3+
4+
Main reason to build this library was the lack of easy-to-use libraries with all the usual stuff you need while working with diff files. Originally it was inspired by JRCS library and it's nice design of diff module.
5+
6+
## Main Features ##
7+
8+
* computing the difference between two texts.
9+
* capable to hand more than plain ascci. Arrays or List of any type that implements hashCode() and equals() correctly can be subject to differencing using this library
10+
* patch and unpatch the text with the given patch
11+
* parsing the unified diff format
12+
* producing human-readable differences
13+
14+
### Algoritms ###
15+
16+
This library implements Myer's diff algorithm. But it can easily replaced by any other which is better for handing your texts. I have plan to add implementation of some in future.
17+
18+
### Changelog ###
19+
20+
* Version 1.2
21+
* JDK 1.5 compatibility
22+
* Ant build script
23+
* Generate output in unified diff format (thanks for Bill James)
24+
25+
### To Install ###
26+
27+
Just add the code below to your maven dependencies:
28+
```
29+
<dependency>
30+
<groupId>com.googlecode.java-diff-utils</groupId>
31+
<artifactId>diffutils</artifactId>
32+
<version>1.2.1</version>
33+
</dependency>
34+
```
35+
36+
And for Ivy:
37+
```
38+
<dependency org="com.googlecode.java-diff-utils" name="diffutils" rev="1.2.1"/>
39+
```
40+
41+
## Coming eventually ##
42+
43+
* support for inline diffs in output
44+
* helpers for showing side-by-side, line-by-line diffs or text with inter-line and intra-line change highlights
45+
* customization of diff algorithm for better experience while computing diffs between strings (ignoring blank lines or spaces, etc)
46+
* generating output in other formats (not only unified). E.g. CVS.
47+
48+
### Tutorials ###
49+
50+
http://www.adictosaltrabajo.com/tutoriales/tutoriales.php?pagina=CompararFicherosJavaDiffUtils (in Spanish). Thanks Miguel

0 commit comments

Comments
 (0)