Fix up pre-commit config to be useful, add djhtml (#217)

* Fix up pre-commit config to be useful

This ports some of the changes from the addons/etc repo here to match:

- Check assets are current using a script
- Run prettier via pre-commit
- Run black via pre-commit
- Run djhtml linter on templates to correct spacing
- Drops common submodule for now

* Whitespace corrections

* Prettier formatting

* Run djhtml on all template files to correct spacing

Author: agjohnson

.gitmodules

@@ -1,3 +0,0 @@
-[submodule "common"]
-	path = common
-	url = https://github.com/readthedocs/common

.pre-commit-config-local.yaml

@@ -0,0 +1,41 @@
+repos:
+  - repo: https://github.com/pre-commit/mirrors-prettier
+    rev: "v3.0.3"
+    hooks:
+      - id: prettier
+        args: ["--write", "."]
+        types_or: [css, javascript, json]
+
+  - repo: https://github.com/ambv/black
+    rev: "23.9.1"
+    hooks:
+      - id: black
+        language_version: python3
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0
+    hooks:
+      - id: trailing-whitespace
+      - id: check-added-large-files
+      - id: check-case-conflict
+      - id: check-executables-have-shebangs
+      - id: check-merge-conflict
+      - id: check-shebang-scripts-are-executable
+      - id: check-symlinks
+      - id: check-vcs-permalinks
+      - id: check-yaml
+      - id: destroyed-symlinks
+      - id: end-of-file-fixer
+        exclude: "^dist/.*$"
+  - repo: https://github.com/rtts/djhtml
+    rev: "3.0.6"
+    hooks:
+      - id: djhtml
+        files: '^readthedocsext/theme/templates/.*\.html'
+  - repo: local
+    hooks:
+      - id: check-build-assets
+        name: Ensure compiled assets are current
+        description: Ensure that `npm run build` was run before commiting.
+        language: script
+        types_or: [css, javascript, svg, json]
+        entry: .pre-commit/check-build-assets.sh

.pre-commit-config.yaml

@@ -0,0 +1,9 @@
+#!/bin/bash
+
+npm run build
+
+if [[ `git diff readthedocsext/` ]]
+then
+    echo "ERROR: assets are out of date. Make sure to run 'npm run build' on your branch."
+    exit 1
+fi

.pre-commit-config.yaml

@@ -10,7 +10,7 @@ Base
 .. js:autoclass:: ResponsiveView
     :members:
 
-.. js:autoclass:: HeaderView 
+.. js:autoclass:: HeaderView
     :members:
 
 .. js:autoclass:: CollapsingHeaderView

.pre-commit/check-build-assets.sh

@@ -99,7 +99,7 @@ How do I use icons?
 .. [1] https://fomantic-ui.com/elements/segment.html#padded
 .. [2] https://fomantic-ui.com/elements/segment.html#fitted
 .. [3] https://fomantic-ui.com/elements/segment.html#basic
-.. [4] https://fomantic-ui.com/collections/grid.html 
+.. [4] https://fomantic-ui.com/collections/grid.html
 
 
 Working with CSS

common

@@ -49,7 +49,7 @@
     "matchdep": "~1.0.1",
     "mini-css-extract-plugin": "^0.6.0",
     "optimize-css-assets-webpack-plugin": "^5.0.3",
-    "prettier": "^2.0.5",
+    "prettier": "^3.0.3",
     "resolve-url-loader": "^2.2.1",
     "rollup-plugin-lit-css": "^4.0.1",
     "sanitize-html": "^1.23.0",