fdiff

Um

fdiff ist ein Python -Befehlszeilen -Vergleichsinstrument zur Bewertung von detaillierten Unterschieden in den OpenType -Tabellendaten zwischen Schriftart Dateien. Das Tool bietet eine plattformübergreifende Unterstützung für lokale und remote-Schriftarten auf MacOS-, Windows- und GNU/Linux-Systemen mit einem Python V3.7+ -Dolmetschen.

Suchen Sie nach einem hochrangigen Überblick über OpenType-Tabellenunterschiede und nicht nach Veränderungen auf niedrigem Niveau? Schauen Sie sich nur das fbdiff -Tool von Van Rossum an.

Was es tut

• Nimmt zwei Argumente für Schriftart Dateipfad (oder URL für Remote -Schriftarten) für den Schriftartvergleich
• Dumps Opentyp -Tabellendaten im TTX -Format (XML) der Fonttools Library (XML)
• Vergleicht die OpenType -Tabellendaten über die beiden Dateien über das Unified Diff -Format mit 3 Zeilen des umgebenden Kontextes

Optionale Funktionen

• Filtertabellen mit den Optionen --include oder --exclude filtern
• Ändern Sie die Anzahl der im Diff angezeigten Kontextlinien mit der Option -l oder --lines
• Zeigen Sie die ersten n -Zeilen der Diff -Ausgabe mit der Option: --head
• Zeigen Sie die letzten N -Zeilen der Diff -Ausgabe mit der Option --tail an
• Führen Sie den Diff mit einem externen Diff -Tool mit der Option --external aus

fdiff --help FRAUEN, um alle verfügbaren Optionen anzuzeigen.

Inhalt

• Installation
• Verwendung
• Probleme
• Beitragen
• Anerkennung
• Lizenz

Installation

fdiff benötigt einen Dolmetscher von Python 3.7+.

Die Installation in einer virtuellen Python3 -Umgebung wird empfohlen.

Verwenden Sie eine der folgenden Installationsansätze:

PIP -Installation von PYPI

 $ pip3 install fdiff

PIP -Installation aus der Quelle

 $ git clone https://github.com/source-foundry/fdiff.git
$ cd fdiff
$ pip3 install -r requirements.txt .

Entwickler installieren aus der Quelle

Der folgende Ansatz installiert das Projekt und die zugehörigen optionalen Entwicklerabhängigkeiten, sodass Quellenänderungen ohne Neuinstallation verfügbar sind.

 $ git clone https://github.com/source-foundry/fdiff.git
$ cd fdiff
$ pip3 install --ignore-installed -r requirements.txt -e ".[dev]"

Verwendung

Lokale Schriftart Dateien

 $ fdiff [OPTIONS] [PRE-FONT FILE PATH] [POST-FONT FILE PATH]

Remote -Schriftart Dateien

fdiff unterstützt GET -Anfragen für öffentlich zugängliche Remote -Schriftart Dateien. Ersetzen Sie die Argumente der Dateipfad durch URL:

 $ fdiff [OPTIONS] [PRE-FONT FILE URL] [POST-FONT FILE URL]

fdiff arbeitet mit einer beliebigen Kombination aus lokalen und entfernten Schriftartdateien. Um beispielsweise eine lokale Post -Schriftart -Datei mit einer Remote -Pre -Schriftart -Datei zu vergleichen, um lokale Änderungen mit einer Schriftdatei zu bewerten, die zuvor in eine Remote gedrückt wurde, verwenden Sie die folgende Syntax:

 $ fdiff [OPTIONS] [PRE-FONT FILE URL] [POST-FONT FILE FILE PATH]

Tipp : Remote Git Repository Hosting Services (wie GitHub) Unterstützt den Zugriff auf Dateien in verschiedenen Git -Filialen per URL. Verwenden Sie diese Repository -Zweig -URL, um Schriftarten über Git -Zweige in Ihrem Repository zu vergleichen.

Optionen

Filter Openentyp -Tabellen

Verwenden Sie die Option --include mit einer von Kommas getrennten Liste der Tabellennamen:

 $ fdiff --include head,post [PRE-FONT FILE PATH] [POST-FONT FILE PATH]

Verwenden Sie die Option --exclude Option mit einer von Kommas getrennten Liste der Tabellennamen, um angegebene Tabellen in Ihrem Diff auszuschließen:

 $ fdiff --exclude glyf,OS/2 [PRE-FONT FILE PATH] [POST-FONT FILE PATH]

Fügen Sie keine Leerzeichen zwischen den von den Kommas getrennten Tabellennamenwerten ein !

Ändern Sie die Anzahl der Kontextlinien

Verwenden Sie die Option -l oder --lines -Option mit einem Ganzzahlwert für die gewünschte Anzahl von Zeilen, um die Anzahl der Kontextzeilen über/unterhalb von Zeilen zu ändern, die Unterschiede aufweisen. Der folgende Befehl reduziert die Kontextinformationen mit Unterschieden auf eine einzelne Zeile über und unteren Zeilen:

 $ fdiff -l 1 [PRE-FONT FILE PATH] [POST-FONT FILE PATH]

Zeigen Sie die ersten N -Ausgangszeilen an

Verwenden Sie die Option --head , gefolgt von einer Ganzzahl für die Anzahl der Zeilen am Anfang der Ausgabe. Der folgende Befehl zeigt beispielsweise die ersten 20 Zeilen des Diffs an:

 $ fdiff --head 20 [PRE-FONT FILE PATH] [POST-FONT FILE PATH]

Zeigen Sie die letzten N -Zeilen der Ausgabe an

Verwenden Sie die Option --tail , gefolgt von einer Ganzzahl für die Anzahl der Zeilen am Ende der Ausgabe. Der folgende Befehl zeigt beispielsweise die letzten 20 Zeilen des Diffs an:

 $ fdiff --tail 20 [PRE-FONT FILE PATH] [POST-FONT FILE PATH]

Verwenden Sie ein externes Diff -Tool

Bitte beachten Sie : Diese Funktion wurde nicht auf allen unterstützten Plattformen getestet. Bitte melden Sie alle Probleme, auf die Sie auf dem Project Issue Tracker stoßen.

Standardmäßig führt der FDIFF Diffs mit Python -Quelle durch. Wenn Sie mit diesem Ansatz auf Leistungsprobleme stoßen, können Sie kompilierte Diff -Executables verwenden, die auf Ihrer Plattform verfügbar sind. FDIFF wird die TTX -Dateien abgelassen und den Befehl ausführen, den Sie in der Befehlszeile angeben, die die Pre- und Post -Schriftart -TTX -Dump -Dateipfade als erste und zweite Position für Ihren Befehl übergeben.

Beispielsweise können Sie den Befehl diff -u auf GNU/Linux oder macOS wie folgt ausführen:

 $ fdiff --external="diff -u" [PRE-FONT FILE PATH] [POST-FONT FILE PATH]

Der FDIFF unterstützt die integrierte Farbformatierung und Openentyp-Tabellenfilterung, wenn sie mit externen Diff-Werkzeugen verwendet werden. Die Kontextlinien-, Kopf- und Schwanzoptionen werden bei der Verwendung externer Differo -Tools nicht unterstützt.

Deaktivieren Sie Farbdiffs

Der ANSI Escape Code COFEED Diffs werden standardmäßig in Terminalumgebungen durchgeführt.

Um einen Diff ohne ANSI -Escape -Codes in Ihrem Terminal anzuzeigen, geben Sie die Option --nocolor -Option in Ihren Befehl ein:

 $ fdiff --nocolor [PRE-FONT FILE PATH] [POST-FONT FILE PATH]

Andere Optionen

Verwenden Sie fdiff -h um alle verfügbaren Optionen anzuzeigen.

Probleme

Bitte melden Sie Probleme im Project Issue Tracker.

Beitragen

Beiträge werden herzlich begrüßt. Eine Entwicklungsabhängigkeitsumgebung kann im bearbeitbaren Modus mit der obigen Entwicklerinstallationsdokumentation installiert werden.

Bitte verwenden Sie den Standard -GitHub Pull Request -Ansatz, um Quelländerungen vorzuschlagen.

Quelldatei -Linie

Python -Quelldateien sind mit flake8 abgegeben. Weitere Informationen finden Sie im Ziel von Makefile test-lint .

Testen

Das Projekt führt kontinuierliche Integrationstests im GitHub Action -Service mit der pytest Toolchain durch. Die Testmodule befinden sich im tests des Repositorys.

Lokale Tests durch Python Interpreter -Version können mit dem folgenden Befehl durchgeführt werden, der aus der Stammin des Repositorys ausgeführt wird:

 $ tox -e [PYTHON INTERPRETER VERSION]

Weitere Informationen finden Sie in der tox -Dokumentation.

Testabdeckung

Die Abdeckung der Unit -Tests wird mit dem coverage ausgeführt. Einzelheiten finden Sie im Ziel von Makefile test-coverage .

Anerkennung

fdiff ist mit der fantastischen FontTools Free Software Library erstellt und führt Textdifferenz von Binär -Schriftartdateien mit Mülldeponie des TTX -OpenType -Tabellen -Datenserialisierungsformats aus, wie in der FontTools -Bibliothek definiert.

Lizenz

Copyright 2019 Source Foundry Autoren und Mitwirkende

Lizenziert unter der Apache -Lizenz, Version 2.0 (der "Lizenz"); Sie dürfen diese Datei nur in Übereinstimmung mit der Lizenz verwenden. Sie können eine Kopie der Lizenz bei erhalten

http://www.apache.org/licenses/license-2.0

Sofern nicht nach geltendem Recht oder schriftlich zu vereinbart wird, wird die im Rahmen der Lizenz verteilte Software auf "As is" -Basis ohne Gewährleistung oder Bedingungen jeglicher Art ausdrücklich oder impliziert verteilt. Siehe die Lizenz für die spezifischen Sprachberechtigungen und Einschränkungen im Rahmen der Lizenz.