chore: add config / docs for 'pre-commit' support (googleapis#103)

yoshi-automation · web-flow · commit ec08e66e35dd · 2020-12-02T14:25:55.000-05:00
Source-Author: Tres Seaver <tseaver@palladion.com> Source-Date: Tue Dec 1 16:01:20 2020 -0500 Source-Repo: googleapis/synthtool Source-Sha: 32af6da519a6b042e3da62008e2a75e991efb6b4 Source-Link: googleapis/synthtool@32af6da
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -0,0 +1,17 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v3.2.0
+    hooks:
+    -   id: trailing-whitespace
+    -   id: end-of-file-fixer
+    -   id: check-yaml
+-   repo: https://github.com/psf/black
+    rev: 19.10b0
+    hooks:
+    - id: black
+-   repo: https://gitlab.com/pycqa/flake8
+    rev: 3.8.4
+    hooks:
+    - id: flake8
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
@@ -111,6 +111,16 @@ Coding Style
   should point to the official ``googleapis`` checkout and the
   the branch should be the main branch on that remote (``master``).
 
+- This repository contains configuration for the
+  `pre-commit <https://pre-commit.com/>`__ tool, which automates checking
+  our linters during a commit.  If you have it installed on your ``$PATH``,
+  you can enable enforcing those checks via:
+
+.. code-block:: bash
+
+   $ pre-commit install
+   pre-commit installed at .git/hooks/pre-commit
+
 Exceptions to PEP8:
 
 - Many unit tests use a helper method, ``_call_fut`` ("FUT" is short for
diff --git a/synth.metadata b/synth.metadata
@@ -4,14 +4,14 @@
       "git": {
         "name": ".",
         "remote": "https://github.com/googleapis/python-api-core.git",
-        "sha": "fcf261fc3c4c1f28f2fa13d055716cf70d21f6f5"
+        "sha": "93976931f231da6b42304bd117d8481067c55f6a"
       }
     },
     {
       "git": {
         "name": "synthtool",
         "remote": "https://github.com/googleapis/synthtool.git",
-        "sha": "a073c873f3928c561bdf87fdfbf1d081d1998984"
+        "sha": "32af6da519a6b042e3da62008e2a75e991efb6b4"
       }
     }
   ],
@@ -58,6 +58,7 @@
     ".kokoro/test-samples.sh",
     ".kokoro/trampoline.sh",
     ".kokoro/trampoline_v2.sh",
+    ".pre-commit-config.yaml",
     ".trampolinerc",
     "CODE_OF_CONDUCT.md",
     "CONTRIBUTING.rst",

Original file line number	Diff line number	Diff line change
`@@ -4,14 +4,14 @@`
`4`	`4`	`"git": {`
`5`	`5`	`"name": ".",`
`6`	`6`	`"remote": "https://github.com/googleapis/python-api-core.git",`
`7`		`- "sha": "fcf261fc3c4c1f28f2fa13d055716cf70d21f6f5"`
	`7`	`+ "sha": "93976931f231da6b42304bd117d8481067c55f6a"`
`8`	`8`	`}`
`9`	`9`	`},`
`10`	`10`	`{`
`11`	`11`	`"git": {`
`12`	`12`	`"name": "synthtool",`
`13`	`13`	`"remote": "https://github.com/googleapis/synthtool.git",`
`14`		`- "sha": "a073c873f3928c561bdf87fdfbf1d081d1998984"`
	`14`	`+ "sha": "32af6da519a6b042e3da62008e2a75e991efb6b4"`
`15`	`15`	`}`
`16`	`16`	`}`
`17`	`17`	`],`
`@@ -58,6 +58,7 @@`
`58`	`58`	`".kokoro/test-samples.sh",`
`59`	`59`	`".kokoro/trampoline.sh",`
`60`	`60`	`".kokoro/trampoline_v2.sh",`
	`61`	`+ ".pre-commit-config.yaml",`
`61`	`62`	`".trampolinerc",`
`62`	`63`	`"CODE_OF_CONDUCT.md",`
`63`	`64`	`"CONTRIBUTING.rst",`