v3.0.0

docs
source-foundry · Oct 28, 2021 · b5ab32f · b5ab32f
1 parent 514cfce
commit b5ab32f
Show file tree

Hide file tree

Showing 3 changed files with 32 additions and 13 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,25 @@
 # Changelog
 
+## v3.0.0
+
+- Remove Python 3.6 support
+- Convert to default ANSI escape code colored diff output in terminal environments only (this is a change in behavior from previous default that required `-c` / `--color` option to toggle colored output on)
+- Add new `--nocolor` option to disable colored diff output in terminals
+- Maintain `-c` / `--color` option to toggle ANSI escape code colored diff output on in non-terminal environments and avoid breakage in existing workflows
+- Modify user notice on no OpenTable diff from "There is no difference between the files" to "There is no difference in the tested OpenType tables"
+- Stabilize external executable diffs with the `--external` option
+- Add Python 3.10 testing, drop Python 3.6 testing
+- Bump aiofiles dependency to v0.7.0
+- Bump cffi dependency to v1.15.0
+- Bump fonttools dependency to v4.27.1
+- Bump idna dependency to v3.3
+- Bump multidict dependency to v5.2.0
+- Bump pycares dependency to v4.1.2
+- Bump pygments dependency to v2.10.0
+- Bump rich dependency to 10.12.0
+- Bump typing-extensions dependency to v3.10.0.2
+- Bump yarl dependency to v1.7.0
+
 ## v2.2.0
 
 - Add indeterminate progress indicators during processing

diff --git a/README.md b/README.md
@@ -30,7 +30,6 @@ Looking for a high-level overview of OpenType table differences rather than low-
 
 ## Optional Features
 
-- View colored diffs in the terminal with the `-c` or `--color` flag
 - Filter OpenType tables with the `--include` or `--exclude` options
 - Modify the number of context lines displayed in the diff with the `-l` or `--lines` option
 - Display the first n lines of the diff output with the `--head` option
@@ -106,16 +105,6 @@ $ fdiff [OPTIONS] [PRE-FONT FILE URL] [POST-FONT FILE FILE PATH]
 
 ### Options
 
-#### Color diffs
-
-Uncolored diffs are performed by default.
-
-To view a colored diff in your terminal, include either the `-c` or `--color` option in your command:
-
-```
-$ fdiff --color [PRE-FONT FILE PATH] [POST-FONT FILE PATH]
-```
-
 #### Filter OpenType tables
 
 To include only specified tables in your diff, use the `--include` option with a comma-separated list of table names:
@@ -156,7 +145,7 @@ Use the `--tail` option followed by an integer for the number of lines at the en
 $ fdiff --tail 20 [PRE-FONT FILE PATH] [POST-FONT FILE PATH]
 ```
 
-#### Use an external diff tool <img src="https://img.shields.io/badge/beta-feature-orange" />
+#### Use an external diff tool
 
 **Please Note**: This feature has not been tested across all supported platforms.  Please report any issues that you come across on the project issue tracker.  
 
@@ -170,6 +159,16 @@ $ fdiff --external="diff -u" [PRE-FONT FILE PATH] [POST-FONT FILE PATH]
 
 fdiff supports built-in color formatting and OpenType table filtering when used with external diff tools.  The context line, head, and tail options are not supported with the use of external diff tools.
 
+#### Disable color diffs
+
+ANSI escape code colored diffs are performed by default in terminal environments.
+
+To view a diff without ANSI escape codes in your terminal, include the `--nocolor` option in your command:
+
+```
+$ fdiff --nocolor [PRE-FONT FILE PATH] [POST-FONT FILE PATH]
+```
+
 
 ### Other Options
 

diff --git a/lib/fdiff/__init__.py b/lib/fdiff/__init__.py
@@ -1,3 +1,3 @@
 #!/usr/bin/env python3
 
-version = __version__ = "2.2.1-dev0"
+version = __version__ = "3.0.0"