chore: add commitlint and prettier

Author: liborjelinek

.github/workflows/lint.yaml

@@ -0,0 +1,36 @@
+name: Linting
+
+on: [push, pull_request]
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  # Example file at
+  # https://commitlint.js.org/guides/ci-setup.html
+  # doest work. Found a solution at
+  # https://github.com/conventional-changelog/commitlint/pull/4132
+  commitlint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Use Node.js
+        uses: actions/setup-node@v4
+      - name: Print versions
+        run: |
+          git --version
+          node --version
+          npm --version
+          npx commitlint --version
+      - name: Install commitlint
+        run: |
+          npm install conventional-changelog-conventionalcommits
+          npm install commitlint@latest
+
+      - name: Validate current commit (last commit) with commitlint
+        if: github.event_name == 'push'
+        run: npx commitlint --last --verbose
+
+      - name: Validate PR commits with commitlint
+        if: github.event_name == 'pull_request'
+        run: npx commitlint --from ${{ github.event.pull_request.head.sha }}~${{ github.event.pull_request.commits }} --to ${{ github.event.pull_request.head.sha }} --verbose

.husky/.gitignore

@@ -0,0 +1 @@
+_

.husky/commit-msg

@@ -0,0 +1 @@
+npx --no -- commitlint --edit $1

.husky/pre-commit

@@ -0,0 +1 @@
+npm run format:check

.prettierignore

@@ -0,0 +1,14 @@
+# Prettier ignore list
+# (everything from .gitignore is already excluded)
+
+tests/test_bake
+template/.prettierrc
+
+# Ugly preventing pass Prettier but just copy from Sphinx Basic theme
+template/src/{{ project_slug }}/domainindex.html
+template/src/{{ project_slug }}/genindex.html
+template/src/{{ project_slug }}/static/doctools.js
+template/src/{{ project_slug }}/static/documentation_options.js.jinja
+template/src/{{ project_slug }}/static/language_data.js.jinja
+template/src/{{ project_slug }}/static/searchtools.js
+template/src/{{ project_slug }}/static/sphinx_highlight.js

.prettierrc

@@ -0,0 +1,12 @@
+{
+  "plugins": ["prettier-plugin-jinja-template", "prettier-plugin-tailwindcss"],
+
+  "overrides": [
+    {
+      "files": ["*.html"],
+      "options": {
+        "parser": "jinja-template"
+      }
+    }
+  ]
+}

commitlint.config.ts

@@ -0,0 +1,7 @@
+import type { UserConfig } from "@commitlint/types";
+
+const Configuration: UserConfig = {
+  extends: ["@commitlint/config-conventional"],
+};
+
+export default Configuration;

docs/source/usage.md

@@ -28,8 +28,8 @@ The `package.json` must contain the following `scripts` tasks. They are called b
   "scripts": {
     "theme:build": "...",
     "theme:watch": "..."
-  },
-  ...
+  }
+}
 ```
 
 For example, if you want to build just Node.js assets, call `npm run theme:build`.