refactor: assume utf-8 encoding

Author: thekaveman

README.md

@@ -17,16 +17,14 @@ Add a new repo entry to your configuration file:
 
 ```yaml
 repos:
-
-# - repo: ...
+  # - repo: ...
 
   - repo: https://github.com/compilerla/conventional-pre-commit
     rev: <git sha or tag>
     hooks:
       - id: conventional-pre-commit
         stages: [commit-msg]
         args: [] # optional: list of Conventional Commits types to allow e.g. [feat, fix, ci, chore, test]
-                 # if you want to set encoding, use --encoding=<encoding>, before types
 ```
 
 Install the `pre-commit` script:
@@ -80,22 +78,6 @@ Conventional Commit......................................................Passed
 - duration: 0.05s
 ```
 
-### Configure encoding
-
-**For Windows user**, if you want to use `conventional-pre-commit` with non-ascii characters, you can set encoding with `--encoding=<encoding>`.
-
-```yaml
-args: [--encoding=<encoding>]
-```
-
-or
-
-```yaml
-args: [--encoding=<encoding>, feat, ...(other custom types)]
-```
-
-**The encoding argument must be in front of types.**
-
 ## Install with pip
 
 `conventional-pre-commit` can also be installed and used from the command line:
@@ -107,17 +89,15 @@ pip install conventional-pre-commit
 Then run the command line script:
 
 ```shell
-conventional-pre-commit [--encoding] [types] input
+conventional-pre-commit [types] input
 ```
 
-- `--encoding` is an optional encoding to use (e.g. `--encoding=utf-8`)
-
 - `[types]` is an optional list of Conventional Commit types to allow (e.g. `feat fix chore`)
 
 - `input` is a file containing the commit message to check:
 
 ```shell
-conventional-pre-commit --encoding=utf-8 feat fix chore ci test .git/COMMIT_MSG
+conventional-pre-commit feat fix chore ci test .git/COMMIT_MSG
 ```
 
 Or from a Python program:

conventional_pre_commit/hook.py

@@ -18,7 +18,6 @@ def main(argv=[]):
     parser = argparse.ArgumentParser(
         prog="conventional-pre-commit", description="Check a git commit message for Conventional Commits formatting."
     )
-    parser.add_argument("--encoding", type=str, default=None, help="Optional encoding to use when reading the commit message")
     parser.add_argument("types", type=str, nargs="*", default=format.DEFAULT_TYPES, help="Optional list of types to support")
     parser.add_argument("input", type=str, help="A file containing a git commit message")
 
@@ -31,25 +30,16 @@ def main(argv=[]):
         return RESULT_FAIL
 
     try:
-        with open(args.input, encoding=args.encoding) as f:
+        with open(args.input, encoding="utf-8") as f:
             message = f.read()
     except UnicodeDecodeError:
         print(
             f"""
 {Colors.LRED}[Bad Commit message encoding] {Colors.RESTORE}
 
-{Colors.YELLOW}It looks like we couldn't decode your commit message using the encoding you or your system specified.
-You can specify an encoding using the --encoding flag.{Colors.RESTORE}
-
-For example, if your commit message is encoded in {Colors.YELLOW}UTF-8{Colors.RESTORE},
-you can add this to your .pre-commit-config.yaml file:
-
-  - repo: https://github.com/compilerla/conventional-pre-commit
-    rev: xxx
-    hooks:
-      - id: conventional-pre-commit
-        stages: [ commit-msg ]
-        args: [ {Colors.YELLOW}--encoding=utf-8, {Colors.RESTORE}custom-types, ... ]
+{Colors.YELLOW}conventional-pre-commit couldn't decode your commit message.{Colors.RESTORE}
+{Colors.YELLOW}UTF-8{Colors.RESTORE} encoding is assumed, please configure git to write commit messages in UTF-8.
+See {Colors.LBLUE}https://git-scm.com/docs/git-commit/#_discussion{Colors.RESTORE} for more.
         """
         )
         return RESULT_FAIL

tests/test_hook.py

@@ -83,25 +83,12 @@ def test_subprocess_success__custom_conventional(cmd, conventional_commit_path):
 
 
 def test_main_success__conventional_utf8(conventional_utf8_commit_path):
-    result = main(["--encoding=utf-8", conventional_utf8_commit_path])
-
-    assert result == RESULT_SUCCESS
-
-
-@pytest.mark.skip(reason="read utf-8 file with gbk encoding will cause mojibake instead of raising UnicodeDecodeError")
-def test_main_fail__conventional_utf8(conventional_utf8_commit_path):
-    result = main(["--encoding=gbk", conventional_utf8_commit_path])
-
-    assert result == RESULT_FAIL
-
-
-def test_main_success__conventional_gbk(conventional_gbk_commit_path):
-    result = main(["--encoding=gbk", conventional_gbk_commit_path])
+    result = main([conventional_utf8_commit_path])
 
     assert result == RESULT_SUCCESS
 
 
 def test_main_fail__conventional_gbk(conventional_gbk_commit_path):
-    result = main(["--encoding=utf-8", conventional_gbk_commit_path])
+    result = main([conventional_gbk_commit_path])
 
     assert result == RESULT_FAIL