Change to simpler xcode plugin

Author: Matt Boran

README.md

@@ -1,6 +1,6 @@
 # Selective (Swift) Linter
 
-This is a package to be used as a pre-commit git hook to lint changes in .swift files using [Swiftlint Installed via Homebrew](https://formulae.brew.sh/formula/swiftlint).
+This is a package to be used to lint changes in .swift files using [Swiftlint Installed via Homebrew](https://formulae.brew.sh/formula/swiftlint). It's meant to be used as a run script in Xcode.
 
 ### Installation and  Dependencies
 
@@ -14,16 +14,13 @@ To install this Python3 package
 $ pip3 install selective_linter
 ```
 
-To install the git hook to a repository, navigate to the root of that repository and run
+To install this into an Xcode project, add the following run script build phase in project settings:
 
+Shell: `/usr/bin/env bash`
 ```sh
-$ selective_linter -i
-```
-
-This also adds the `.lint_cache` file to your `.gitignore`. 
-
-To deactivate the script run
-
-```sh
-$ git config hooks.skipswiftlint true
+if [ "${CONFIGURATION}" == "Debug" ]; then
+    if which selective_linter >/dev/null; then
+      selective_linter
+    fi
+fi
 ```

selective_linter/git_diff.py

@@ -72,7 +72,7 @@ def _print_debug_info(self):
             print("Files staged: {}".format("\n\t".join(sorted(self.staged_files))))
 
     def _get_files_changed(self):
-        files = self._git('--no-pager', 'diff', '--staged', '--name-only')
+        files = self._git('--no-pager', 'diff', '--name-only')
         return [self._directory + '/' + filename 
                 for filename in files.split('\n')
                 if filename and filename.endswith(".swift") and os.path.isfile(filename)]

selective_linter/installer.py

@@ -2,14 +2,6 @@
 import hashlib
 import os
 
-from colorama import Fore, Style
-
-
-class Warning:
-
-    BYPASS_WARNING = Fore.YELLOW + "Committing warnings or errors." + Fore.RESET
-    
-
 class LintError:
 
     def __init__(self, error):
@@ -23,42 +15,4 @@ def __init__(self, error):
         self.code = error[aux_length:]
 
     def __str__(self):
-        where = self.file + ":" + self.line
-        if "warning" in self.error_type:
-            error_type = LintError._warning(self.description)
-        elif "error" in self.error_type:
-            error_type = LintError._error(self.description)
-        return where + '\n' + error_type + self.code
-
-    @staticmethod
-    def _warning(warning):
-        return Fore.YELLOW + "(warning)" + warning + ":" + Fore.RESET
-
-    @staticmethod
-    def _error(error):
-        return Fore.RED + "(error)" + error + ":" + Fore.RESET
-
-
-class ChangeVerifier:
-
-    CACHE_NAME = '.lint_cache'
-
-    def __init__(self, hunks):
-        hashes = [hashlib.md5(hunk.encode()).hexdigest() for hunk in hunks]
-        self.long_hash = "".join(hashes)
-    
-    def has_unchanged_cache(self):
-        if not os.path.isfile(self.CACHE_NAME):
-            return False
-        long_hash = None
-        with open(self.CACHE_NAME, 'r') as file:
-            long_hash = file.read()
-        return self.long_hash == long_hash
-
-    def write_cache(self): 
-        with open(self.CACHE_NAME, 'w+') as file:
-            file.write(self.long_hash)
-
-    def clear_cache(self):
-        if os.path.isfile(self.CACHE_NAME):
-            os.remove(self.CACHE_NAME)
+        return self.file + ":" + self.line + ": warning:" + self.description

selective_linter/output.py

@@ -9,56 +9,33 @@
                     action='store', 
                     type=str,
                     default=os.getcwd())
-parser.add_argument('-i', '--install',
-                    action='store_true')
-parser.set_defaults(install=False)
-
 running_as_script = False
 
 
 def main():
     # Imports for running locally and running as module
     if running_as_script:
-        from git_diff import GitDiff, GitHunk
+        from git_diff import GitDiff
         from linter import SwiftLint
-        from output import LintError, ChangeVerifier, Warning
-        from installer import Installer
+        from output import LintError
     else:
         from selective_linter.git_diff import GitDiff
         from selective_linter.linter import SwiftLint
-        from selective_linter.output import LintError, ChangeVerifier, Warning
-        from selective_linter.installer import Installer
+        from selective_linter.output import LintError
 
-    # Parse command line arguments and install if necessary
     args = parser.parse_args()
-    if args.install:
-        installer = Installer(args.dir)
-        if installer.is_repository():
-            installer.install()
-            return 0
-        else: 
-            print("Failed to install to directory")
-            return 1
-
+    
     # Process diffs and lint
     differ = GitDiff(args.dir)
     differ.diff(verbose=running_as_script)
     linter = SwiftLint(dir=args.dir, files=differ.staged_files)
     errors = linter.check_errors_against_diff(differ.diff_lines)
     exit_code = 0
-    cache = ChangeVerifier(differ.hunks)
     if errors:
-        # If the user made the same commit twice, bypass this check
-        # The cache is cleared by the pre commit hook
-        if cache.has_unchanged_cache():
-            print(Warning.BYPASS_WARNING)
-            return exit_code
-        cache.write_cache()
         for error in sorted(errors):
             print(LintError(error))
-        print("\nErrors found. Please fix errors and retry or make no changes and re-commit to bypass.")
-        exit_code = 1
-    return exit_code
+        return 0
+    return 0
 
 
 if __name__ == "__main__":

selective_linter/selective_linter.py

@@ -5,22 +5,21 @@
 
 setuptools.setup(
     name="selective_linter",
-    version="0.3.0",
+    version="1.0.0",
     author="Matt Boran",
     author_email="mattboran@gmail.com",
-    description="A script to be used as a pre-commit git hook for projects written in Swift",
+    description="A script to be run from Xcode to lint files as you make changes",
     long_description=long_description,
     long_description_content_type="text/markdown",
     url="https://github.com/mattboran/SelectiveSwiftLinter",
-    download_url="https://github.com/mattboran/SelectiveSwiftLinter/releases/download/0.3.0/selective_linter-0.3.0-py3-none-any.whl",
+    download_url="https://github.com/mattboran/SelectiveSwiftLinter/releases/download/1.0.0/selective_linter-1.0.0-py3-none-any.whl",
     packages=setuptools.find_packages(),
     classifiers=[
         "Programming Language :: Python :: 3",
         "License :: OSI Approved :: MIT License",
         "Operating System :: MacOS :: MacOS X",
     ],
     install_requires=[
-        'colorama',
         'sh'
     ],
     python_requires='>3.0.0',