Compare ANY markup documents.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
comparer
.gitignore
.travis.yml
CODE_OF_CONDUCT.md
Contributing.md
LICENSE
README.md
_config.yml
main.go

README.md

LICENSE GoDoc Go Report Card codebeat badge

Top Level Coverage Travis Build Status DOI

Awesome

Donate

Menu

  1. What is XML-Comp?
  2. Features
  3. Installing
  4. Running
  5. How this works?
  6. Comparing any kind of document
  7. Contributing
  8. To Do
  9. Using only the comparer package

What is XML-Comp

This is a command line tool and a package that together they provide the capability of comparing two directories and appending to files the differences between the directories, also creates possible files or folders that are missing. It was made to help RimWorld's community translators(1) to know what was modified on the last XML updates and to let them keep in track of what they need to add/remove from what has been done.

(1) and maybe other indie games that uses XML

Features

Installing

$ go get github.com/XML-Comp/XML-Comp

Running

$ XML-Comp -translation /path/to/language/translation

How this works?

You need the path that is called "translation", which are described bellow:

  • "translation": Full path directory of your RimWorld Language folder cloned from GitHub.

My "translation" path: /Users/arthur/Github/RimWorld-PortugueseBrazilian

With this path in hand, running xml-comp -translation your/path/to/translation will let you know in every file of your project what is missing by adding lines to it with what is needed to translate! That simple!

[RIMWORLD not installed in standard path]

If by any reason you did not install the game on Steam's standard path or want to use a different one, It's possible to use the original flag that exposes your customized path to the game as shows:

  • "original": Full path directory of your RimWorld English folder (optional). My "original" path (optional): /Users/arthur/Library/Application Support/Steam/steamapps/common/RimWorld/RimWorldMac.app/Mods/Core/Languages/English

In order to use this flag you'll need to parse it with the translation flag as in: xml-comp -original path/... -translation path/...

Comparing any kind of document

To compare any kind of files, all you need is to use the flag -doc <type name>, eg -doc html. This will use the paths that you gave only to compare the specified type of document. Another example:

$ XML-Comp -doc html -original path/to/It -translation path/to/It

OBS: This is not required, by default It's comparing all .xml files that are encountered.

Contributing

Join our Gitter

To Do - Check our Issues & Milestones

Using only the comparer package

// Import the package
import "github.com/XML-Comp/XML-Comp/comparer"
// Set document type variable to the desired document
// without the "." | eg: "xml" or "html"
comparer.DocType = "html"
// Start the main function with the full paths to compare
// the firstPath is always what will be used as model
func main() {
    err := comparer.Compare(firstPath, comparingPath)
    if err != nil {
        log.Fatal(err)
    }
}