Merge pull request #3 from domdfcoding/formatter

Formatter

Author: domdfcoding

.github/workflows/flake8.yml

@@ -26,9 +26,8 @@ jobs:
           python -VV
           python -m site
           python -m pip install --upgrade pip setuptools wheel
+          python -m pip install flake8-prettycount
           python -m pip install .
 
       - name: "Run Flake8"
-        run: "python -m flake8_github_action flake8_github_action"
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: "python -m flake8_prettycount flake8_github_action --format github"

.isort.cfg

@@ -21,6 +21,7 @@ known_third_party =
     dulwich
     flake8
     flake8_json
+    flake8_prettycount
     github
     github3_py
     requests

README.rst

@@ -94,3 +94,45 @@ Installation
 
 .. start installation
 .. end installation
+
+
+Use with GitHub Actions
+----------------------------
+
+Example workflow:
+
+.. code-block:: yaml
+
+	---
+
+	name: Flake8
+
+	on:
+	  push:
+	  pull_request:
+	    branches: ["master"]
+
+	jobs:
+	  Run:
+	    name: "Flake8"
+	    runs-on: "ubuntu-18.04"
+
+	    steps:
+	      - name: Checkout 🛎️
+	        uses: "actions/checkout@v2"
+
+	      - name: Setup Python 🐍
+	        uses: "actions/setup-python@v2"
+	        with:
+	          python-version: "3.8"
+
+	      - name: Install dependencies 🔧
+	        run: |
+	          python -VV
+	          python -m site
+	          python -m pip install --upgrade pip setuptools wheel
+	          python -m pip install flake8
+	          python -m pip install git+https://github.com/domdfcoding/flake8-github-actions
+
+	      - name: "Run Flake8"
+	        run: "flake8 --format github"

flake8_github_action/__init__.py

@@ -2,7 +2,7 @@
 #
 #  __init__.py
 """
-GitHub Action to run flake8.
+GitHub Actions integration for flake8.
 """
 #
 #  Copyright © 2020 Dominic Davis-Foster <dominic@davis-foster.co.uk>
@@ -27,115 +27,62 @@
 #
 
 # stdlib
-import json
-from typing import List, Tuple, Union
+from functools import partial
+from gettext import ngettext
 
 # 3rd party
-import click
-import dulwich.errors
-from apeye import URL
-from domdf_python_tools.iterative import chunks
-from domdf_python_tools.secrets import Secret
-from dulwich.repo import Repo
-from requests import Response
-
-# this package
-from flake8_github_action.annotation import Annotation
-from flake8_github_action.checks import Checks
-from flake8_github_action.flake8_app import Application
+from flake8.formatting.base import BaseFormatter  # type: ignore
 
 __author__: str = "Dominic Davis-Foster"
 __copyright__: str = "2020 Dominic Davis-Foster"
 __license__: str = "MIT License"
 __version__: str = "0.0.0"
 __email__: str = "dominic@davis-foster.co.uk"
 
-__all__ = ["action"]
-
-
-def action(
-		token: Union[str, Secret],
-		repo: Union[str, URL, None] = None,
-		*args,
-		) -> Tuple[Response, int]:
-	r"""
-	Action!
-
-	:param token: The token to authenticate with the GitHub API.
-	:param repo: The repository name (in the format <username>/<repository>) or the complete GitHub URL.
-	:param \*args: flake8 command line arguments.
-	"""
-
-	if not isinstance(token, Secret):
-		token = Secret(token)
-
-	dulwich_repo = Repo('.')
-
-	if repo is None:
-		try:
-			config = dulwich_repo.get_config()
-			repo = URL(config.get(("remote", "origin"), "url").decode("UTF-8"))
-		except dulwich.errors.NotGitRepository as e:
-			raise click.UsageError(str(e))
-
-	elif not isinstance(repo, URL):
-		repo = URL(repo)
-
-	if repo.suffix == ".git":
-		repo = repo.with_suffix('')
-
-	repo_name = repo.name
-
-	# first case is for full url, second for github/hello_world
-	github_username = repo.parent.name or repo.domain.domain
-
-	check = Checks(
-			owner=github_username,
-			repository_name=repo_name,
-			check_name="Flake8",
-			head_sha=dulwich_repo.head().decode("UTF-8"),
-			token=token.value,
-			)
-
-	# check_run_id = check.create_check_run()
-	check_run_id = check.find_run_for_action()
-
-	flake8_app = Application()
-	flake8_app.run(args)
-	flake8_app.exit()
-
-	annotations: List[Annotation] = []
-
-	json_annotations = json.loads(flake8_app.formatter.output_fd.getvalue()).items()
-	for filename, raw_annotations in json_annotations:
-		annotations.extend(Annotation.from_flake8json(filename, ann) for ann in raw_annotations)
-
-	# Github limits updates to 50 annotations at a time
-	annotation_chunks = list(chunks(annotations, 50))
-
-	if flake8_app.result_count:
-		conclusion = "failure"
-		ret = 1
-	else:
-		conclusion = "success"
-		ret = 0
-
-	for chunk in annotation_chunks[:-1]:
-		check.update_check_run(
-				check_run_id,
-				conclusion=conclusion,
-				output={
-						"title": "Flake8 checks",
-						"summary": "Output from Flake8",
-						"annotations": [a.to_dict() for a in chunk],
-						},
-				)
-
-	output = {
-			"title": "Flake8 checks",
-			"summary": "Output from Flake8",
-			"annotations": [a.to_dict() for a in annotation_chunks[-1]],
-			}
-
-	# TODO: reflect flake8 output
-	return check.complete_check_run(check_run_id, conclusion="success", output=output), ret
+__all__ = ["GitHubFormatter"]
+
+_error = partial(ngettext, "error", "errors")
+_file = partial(ngettext, "file", "files")
+
+
+class GitHubFormatter(BaseFormatter):
+
+	def write_line(self, line):
+		"""
+		Override write for convenience.
+		"""
+		self.write(line, None)
+
+	def start(self):
+		super().start()
+		self.files_reported_count = 0
+
+	def beginning(self, filename):
+		"""
+		We're starting a new file.
+		"""
+
+		self.reported_errors_count = 0
+
+	def finished(self, filename):
+		"""
+		We've finished processing a file.
+		"""
+
+		self.files_reported_count += 1
+
+	def format(self, violation):
+		"""
+		Format a violation.
+		"""
+
+		if self.reported_errors_count == 0:
+			self.write_line(violation.filename)
+
+			self.write_line(
+					f"::warning "
+					f"file={violation.filename},line={violation.line_number},col={violation.column_number}"
+					f"::{violation.code}: {violation.text}"
+					)
+
+		self.reported_errors_count += 1