feat: add support for Windows

Previously, there was no support for Windows systems due to the usage of scripts instead of console_scripts.
jumanjihouse · Sep 14, 2022 · 71af855 · 71af855
1 parent d0cf8a7
commit 71af855
Show file tree

Hide file tree

Showing 5 changed files with 47 additions and 40 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -16,7 +16,7 @@ repos:
           - id: yamlfmt
             name: Format YAML files
             description: Format YAML files
-            entry: pre_commit_hooks/yamlfmt
+            entry: python3 -m pre_commit_hooks.yamlfmt
             language: python
             types: [yaml]
             additional_dependencies:
@@ -28,7 +28,7 @@ repos:
           - id: yamlfmt
             name: Format YAML files with overrides
             description: Format YAML files with overrides
-            entry: pre_commit_hooks/yamlfmt
+            entry: python3 -m pre_commit_hooks.yamlfmt
             language: python
             files: .pre-commit-hooks.yaml
             additional_dependencies:

diff --git a/ci/test b/ci/test
@@ -8,45 +8,45 @@ set -o pipefail
 ################################################################################
 . ci/functions.sh
 
-run pre_commit_hooks/yamlfmt --help
+run python3 pre_commit_hooks/yamlfmt.py --help
 echo
 
 run pre-commit try-repo . --files .pre-commit-config.yaml
 
 while read -r file; do
-    run pre_commit_hooks/yamlfmt --mapping 4 --sequence 6 --offset 4 "${file}"
+    run python3 pre_commit_hooks/yamlfmt.py --mapping 4 --sequence 6 --offset 4 "${file}"
 done < <(find . -regex '.*\.yaml')
 
 echo "[INFO] Use with xargs"
 find . -regex '.*\.yaml' -print0 |
-    xargs -0 pre_commit_hooks/yamlfmt -m 4 -s 6 -o 4
+    xargs -0 python3 pre_commit_hooks/yamlfmt.py -m 4 -s 6 -o 4
 echo
 
-run pre_commit_hooks/yamlfmt -m 2 -s 2 -o 0 .pre-commit-hooks.yaml
+run python3 pre_commit_hooks/yamlfmt.py -m 2 -s 2 -o 0 .pre-commit-hooks.yaml
 
 # Ensure we never break multidoc.
 TMP_FILE="$(mktemp pre-commit-hook-yamlfmt-test.XXXXXXXXXXXXXXXXXXXX)"
 run cp -f ci/multidoc-before.txt "${TMP_FILE}"
-run pre_commit_hooks/yamlfmt --mapping 4 --sequence 6 --offset 4 "${TMP_FILE}"
+run python3 pre_commit_hooks/yamlfmt.py --mapping 4 --sequence 6 --offset 4 "${TMP_FILE}"
 run diff ci/multidoc-after.yaml "${TMP_FILE}"
 # If the diff fails, the temp file is still there to inspect.
 run rm -f "${TMP_FILE}"
 
 # Test preserve quotes
 TMP_FILE="$(mktemp pre-commit-hook-yamlfmt-test.XXXXXXXXXXXXXXXXXXXX)"
 run cp -f ci/quotes-before.txt "${TMP_FILE}"
-run pre_commit_hooks/yamlfmt --mapping 4 --sequence 6 --offset 4 --preserve-quotes "${TMP_FILE}"
+run python3 pre_commit_hooks/yamlfmt.py --mapping 4 --sequence 6 --offset 4 --preserve-quotes "${TMP_FILE}"
 run diff ci/quotes-after.txt "${TMP_FILE}"
 # If the diff fails, the temp file is still there to inspect.
 run rm -f "${TMP_FILE}"
 
 # Test width setting
 TMP_FILE="$(mktemp pre-commit-hook-yamlfmt-test.XXXXXXXXXXXXXXXXXXXX)"
 run cp -f ci/test-long.txt "${TMP_FILE}"
-run pre_commit_hooks/yamlfmt --width 250 "${TMP_FILE}"
+run python3 pre_commit_hooks/yamlfmt.py --width 250 "${TMP_FILE}"
 # Width=250, no change
 run diff ci/test-long.txt "${TMP_FILE}"
-run pre_commit_hooks/yamlfmt --width 79 "${TMP_FILE}"
+run python3 pre_commit_hooks/yamlfmt.py --width 79 "${TMP_FILE}"
 # Now we should see no lines > 81 (it has some offset in ruamel)
 run grep -v -q '.\{82\}' "${TMP_FILE}"
 run rm -f "${TMP_FILE}"

diff --git a/pre_commit_hooks/__init__.py b/pre_commit_hooks/__init__.py
@@ -0,0 +1 @@
+"""Init to import yamlfmt."""
diff --git a/pre_commit_hooks/yamlfmt → pre_commit_hooks/yamlfmt.py b/pre_commit_hooks/yamlfmt → pre_commit_hooks/yamlfmt.py
@@ -1,8 +1,7 @@
-#!/usr/bin/env python3
 """Format YAML files."""
 
-import argparse
 import sys
+import argparse
 from ruamel.yaml import YAML  # pylint: disable=import-error
 
 DEFAULT_INDENT = {
@@ -14,10 +13,10 @@
 
 class Cli:
     # pylint: disable=too-few-public-methods
-    """ command-line-interface """
+    """Command-line-interface."""
 
     def __init__(self):
-        """ initialize the CLI """
+        """Initialize the CLI."""
         parser = argparse.ArgumentParser(
             description="Format YAML files",
             formatter_class=argparse.ArgumentDefaultsHelpFormatter,
@@ -116,9 +115,12 @@ def __init__(self):
 class Formatter:
     """
     Reformat a yaml file with proper indentation.
+
     Preserve comments.
     """
+
     def __init__(self, **kwargs):
+        """Initialize the formatter."""
         yaml = YAML()
         yaml.indent(
             mapping=kwargs.get("mapping", DEFAULT_INDENT["mapping"]),
@@ -141,16 +143,16 @@ def represent_none(self, _data):
         self.content = list({})
 
     def format(self, path=None):
-        """ Read file and write it out to same path """
+        """Read file and write it out to same path."""
         if not path:
             path = self.path
         print(path, end="")
-        FORMATTER.parse_file(path)
-        FORMATTER.write_file(path)
+        self.parse_file(path)
+        self.write_file(path)
         print("  Done")
 
     def parse_file(self, path=None):
-        """ Read the file """
+        """Read the file."""
         if not path:
             path = self.path
         try:
@@ -160,7 +162,7 @@ def parse_file(self, path=None):
             self.fail(f"Unable to read {path}")
 
     def write_file(self, path=None):
-        """ Write the file """
+        """Write the file."""
         if not path:
             path = self.path
         try:
@@ -171,23 +173,28 @@ def write_file(self, path=None):
 
     @staticmethod
     def fail(msg):
-        """ Abort """
+        """Abort."""
         sys.stderr.write(msg)
         sys.exit(1)
 
 
-if __name__ == "__main__":
-    ARGS = Cli().parser.parse_args()
-    FORMATTER = Formatter(
-        mapping=ARGS.mapping,
-        sequence=ARGS.sequence,
-        offset=ARGS.offset,
-        colons=ARGS.colons,
-        width=ARGS.width,
-        preserve_quotes=ARGS.preserve_quotes,
-        preserve_null=ARGS.preserve_null,
-        explicit_start=ARGS.explicit_start,
-        explicit_end=ARGS.explicit_end
+def main():
+    """Fit formatter."""
+    args = Cli().parser.parse_args()
+    formatter = Formatter(
+        mapping=args.mapping,
+        sequence=args.sequence,
+        offset=args.offset,
+        colons=args.colons,
+        width=args.width,
+        preserve_quotes=args.preserve_quotes,
+        preserve_null=args.preserve_null,
+        explicit_start=args.explicit_start,
+        explicit_end=args.explicit_end
         )
-    for file_name in ARGS.file_names:
-        FORMATTER.format(file_name)
+    for file_name in args.file_names:
+        formatter.format(file_name)
+
+
+if __name__ == "__main__":
+    main()
diff --git a/setup.py b/setup.py
@@ -1,6 +1,7 @@
 """Fake setup for pre-commit hook."""
 
 from setuptools import setup
+from setuptools import find_packages
 
 setup(
     name='yamlfmt',
@@ -12,11 +13,9 @@
         'ruamel.yaml>=0.16.10',
     ],
 
-    scripts=[
-        'pre_commit_hooks/yamlfmt',
-    ],
+    packages=find_packages(),
 
-    # explicitly declare packages so setuptools does not attempt auto discovery
-    # taken from https://github.com/pypa/setuptools/issues/3197
-    packages=[],
+    entry_points={
+        'console_scripts':
+            ['yamlfmt = pre_commit_hooks.yamlfmt:main']},
 )