Merge pull request #35 from haplo/pre-commit

pre-commit hooks

Author: haplo

.pre-commit-config.yaml

@@ -0,0 +1,29 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: trailing-whitespace
+      - id: check-json
+        exclude: ^package-lock\.json$
+      - id: check-yaml
+      - id: check-case-conflict
+      - id: check-merge-conflict
+
+  - repo: https://github.com/djlint/djLint
+    rev: v1.36.4
+    hooks:
+      - id: djlint-reformat
+        files: \.html$
+        types: [file]
+      - id: djlint
+        files: \.html$
+        types: [file]
+
+  - repo: local
+    hooks:
+      - id: npm-build-check
+        name: Check compiled assets
+        entry: bash -c 'npm run build && git diff --exit-code static/stylesheet/*.min.css static/dark-theme/*.min.js static/pygments/*.min.css'
+        language: system
+        files: ^(gulpfile\.js|static/stylesheet/.*\.less|static/dark-theme/.*\.js|static/pygments/.*\.css)$
+        pass_filenames: false

AGENTS.md

@@ -121,6 +121,25 @@ make publish
 └── package.json               # Node.js dependencies
 ```
 
+## Pre-commit Hooks
+
+Pre-commit hooks run automatically on `git commit` to ensure code quality:
+
+```bash
+# Install pre-commit (one-time setup)
+pip install pre-commit
+pre-commit install
+
+# Run manually on all files
+pre-commit run --all-files
+```
+
+Hooks configured:
+- **trailing-whitespace** - File hygiene
+- **check-json / check-yaml** - Validate config files
+- **djlint** - Format and lint Jinja2 templates
+- **npm-build-check** - Verify compiled assets are up to date (runs only when source files change)
+
 ## Testing
 
 - Tests build the example/ site as a smoke test
@@ -181,9 +200,8 @@ PyPI publishing is automated via the `pypi-publish.yml` workflow when a `v*` tag
 
 ## Notes
 
-- Always rebuild assets (`npm run build`) before committing
+- Pre-commit hooks enforce code style and verify compiled assets
 - A PR check (`check-npm-build.yml`) verifies that built assets are up to date; PRs with stale assets cannot be merged
 - The theme supports both light and dark modes
 - Font Awesome is copied from node_modules to static/
 - Pygments styles are minified but kept as separate files
-- No linting tools are configured - follow existing code style

LICENSE

@@ -20,4 +20,3 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
-

docs/developing.md

@@ -4,7 +4,11 @@ Reflex uses gulp to compile LESS files into CSS and optimize the final build.
 
 ## Setup
 
-`npm install`
+```bash
+npm install
+pip install pre-commit  # or install system-wide
+pre-commit install
+```
 
 ## Compilation
 
@@ -32,3 +36,18 @@ To deploy to Github Pages:
 ```shell
 make github
 ```
+
+## Pre-commit Hooks
+
+[Pre-commit](https://pre-commit.com/) hooks run automatically on each commit to enforce code style and verify compiled assets:
+
+```bash
+# Run manually on all files
+pre-commit run --all-files
+```
+
+Hooks include:
+- File hygiene (trailing whitespace, EOF fixes)
+- JSON/YAML validation
+- Template formatting and linting with [djlint](https://djlint.com/)
+- Asset build verification (when LESS source files change)

example/content/articles/reflex-pelican-theme.md

@@ -6,7 +6,7 @@ Slug: reflex-pelican-theme
 Cover: images/reflex-screenshot.png
 
 When I started [my blog](https://blog.fidelramos.net) I looked all the options in the [Pelican theme
-gallery](http://www.pelicanthemes.com/), and decided on the [Flex theme by Alexandre
+gallery](https://pelicanthemes.com/), and decided on the [Flex theme by Alexandre
 Vizenzi](https://github.com/alexandrevicenzi/Flex) as the best one for my needs:
 
 - Minimalistic and beautiful.
@@ -44,7 +44,7 @@ Mem:          5866       4674       1192        386          0       2404
 Swap:        20480       1267      19213
 </samp>
 
-If you like to share code snippets, you can take advantage of [Pygments](http://pygments.org/) syntax highlighting:
+If you like to share code snippets, you can take advantage of [Pygments](https://pygments.org/) syntax highlighting:
 
 ```js
 // Javascript

pyproject.toml

@@ -41,3 +41,8 @@ excludes = [
     "**/.DS_Store",
     "**/__pycache__/**",
 ]
+
+[tool.djlint]
+indent = 2
+profile = "jinja"
+ignore = "H006,H013,H019,H021,H022,H023,H031,T002,T028,T032"

templates/archives.html

@@ -1,27 +1,25 @@
 {% extends "base.html" %}
-
-{% block title %} – {{ _('Archives') }}{% endblock %}
-
+{% block title %}
+  – {{ _("Archives") }}
+{% endblock title %}
 {% block content %}
-<article class="single">
-  <header>
-    <h1 id="archives">{{ _('Archives') }}</h1>
-  </header>
-  <div>
-    <dl>
-      {% set previous_date = False %}
-
-      {% for article in dates %}
-        {% if article.locale_date != previous_date %}
-          {% set previous_date = article.locale_date %}
-          <dt>{{ article.locale_date }}</dt>
-        {% endif %}
-
-        <dd>
-          <a href="{{ SITEURL }}/{{ article.url }}">{{ article.title }}</a>
-        </dd>
-      {% endfor %}
-    </dl>
-  </div>
-</article>
-{% endblock %}
+  <article class="single">
+    <header>
+      <h1 id="archives">{{ _("Archives") }}</h1>
+    </header>
+    <div>
+      <dl>
+        {% set previous_date = False %}
+        {% for article in dates %}
+          {% if article.locale_date != previous_date %}
+            {% set previous_date = article.locale_date %}
+            <dt>{{ article.locale_date }}</dt>
+          {% endif %}
+          <dd>
+            <a href="{{ SITEURL }}/{{ article.url }}">{{ article.title }}</a>
+          </dd>
+        {% endfor %}
+      </dl>
+    </div>
+  </article>
+{% endblock content %}