feat: Run our own hooks on this repo (#67)

* Run `pre-commit try-repo . generate-renovate-annotations --all`

* Add dev section and script to generate table via cog

* Run `pre-commit try-repo . cog --file README.md`

* Remove custom class definition

* Add renovate annotation for cog

* We don't need the string replace since we're importing

* Small refactors for readability

README.md

@@ -76,3 +76,27 @@ If this is a new template, `pre-commit` will not fail and you may need to do an
 ```shell
 git commit --amend path/to/file.html
 ```
+
+## Dev setup
+
+We have a dev setup that uses `conda` for environment management.
+We also use `make` to automate common tasks.
+The targets are documented below:
+
+
+<!-- [[[cog
+import os, sys; sys.path.insert(0, os.path.join(os.getcwd(), "dev"))
+from generate_makefile_targets_table import main; main()
+]]] -->
+<!-- THE FOLLOWING CODE IS GENERATED BY COG VIA PRE-COMMIT. ANY MANUAL CHANGES WILL BE LOST. -->
+| Target          | Description                                   |
+|-----------------|-----------------------------------------------|
+| `help`          | Display help on all Makefile targets          |
+| `setup`         | Setup local conda environment for development |
+| `install-hooks` | Download + install all pre-commit hooks       |
+| `pre-commit`    | Run pre-commit against all files              |
+| `type-check`    | Run static type checks                        |
+| `test`          | Run all the unit tests                        |
+<!-- [[[end]]] -->
+
+> **Note:** Interestingly, the table above is generated by the `cog` hook defined in this repo :smile:

dev/generate_makefile_targets_table.py

@@ -0,0 +1,46 @@
+import subprocess
+from textwrap import dedent
+from typing import NamedTuple
+
+import cog
+
+
+class MakefileTarget(NamedTuple):
+    target: str
+    description: str
+
+
+def main():
+    raw_text = dedent(subprocess.check_output("make", text=True))
+
+    makefile_targets = []
+    for line in raw_text.splitlines():
+        target, _, description = line.partition(" ")
+        makefile_targets.append(
+            MakefileTarget(target=target.strip(), description=description.strip())
+        )
+
+    # Add two since we will surround with backticks
+    max_target_len = max(len(t.target) for t in makefile_targets) + 2
+    max_description_len = max(len(t.description) for t in makefile_targets)
+
+    cog.outl(
+        "<!-- THE FOLLOWING CODE IS GENERATED BY COG VIA PRE-COMMIT. ANY MANUAL CHANGES WILL BE LOST. -->"
+    )
+    cog.outl(
+        f"| {'Target':{max_target_len}s} | {'Description':{max_description_len}s} |"
+    )
+    cog.outl(
+        f"|{'-'*(max_target_len + 2)}|{'-'*(max_description_len + 2):{max_description_len}s}|"
+    )
+    for t in makefile_targets:
+        target_str = f"`{t.target}`"
+        cog.outl(
+            f"| {target_str:{max_target_len}s} | {t.description:{max_description_len}s} |"
+        )
+
+
+if __name__ == "__main__":
+    # If we run this file as a script, we just make `cog.outl` emit print statements for debugging purposes.
+    cog.outl = print
+    main()

environment-dev.yml

@@ -1,11 +1,19 @@
 channels:
 - defaults
 dependencies:
-- python=3.10
-- pytest
-- pytest-cov
-- pyyaml
-- pip
-- mypy
+# renovate: datasource=conda depName=main/python
+- python=3.10.14
+# renovate: datasource=conda depName=main/pip
+- pip=24.0
+# renovate: datasource=conda depName=main/pyyaml
+- pyyaml=6.0.1
+# renovate: datasource=conda depName=main/mypy
+- mypy=1.8.0
+# renovate: datasource=conda depName=main/pytest
+- pytest=7.4.0
+# renovate: datasource=conda depName=main/pytest-cov
+- pytest-cov=4.1.0
 - pip:
+  # renovate: datasource=pypi
+  - cog==0.9.7
   - -e .