core: Add branch-name-lint

Add branch-name-lint to enforce a Git branch naming convention.

Add a Husky pre-push hook to run the linter before pushing a branch.

To manually run the linter:
    pnpm run lint:branch

Branches must consist of a valid prefix (see below), a forward-slash
(`/`), and a name that begins with a letter and contains only letters,
digits, hyphens (`-`) and periods (`.`). E.g. `feat/implement-thing`.

Valid branch prefixes are:

- `chore` For miscellaneous changes that do not fall into any other
   category.
- `ci` For changes to CI configuration files and scripts.
- `core` For changes to build processes, tooling, dependencies or
   general project structure.
- `doc` For changes to documentation.
- `experiment` For temporary experiments/spikes. These branches will
   not be merged.
- `feat` For new features.
- `fix` For bug fixes.
- `hotfix` For critical bug fixes that will need to be merged directly
   into the production environment.
- `release` For preparing releases to production.
- `test` For changes to tests.

The (case-insensitive) validation regex is:

    ^[a-z]+/[a-z][a-z0-9.-]*$

NOTES:

- Using a fork of the official branch-name-lint repo in which we have
  implemented our own fix for misleading error messages
  (barzik/branch-name-lint#55) and merged a
  community fix for general mishandling of errors
  (barzik/branch-name-lint#45).

LINKS:

- https://github.com/barzik/branch-name-lint
- https://github.com/al/branch-name-lint/tree/integration/error-handling-issues

.branch-name-lint.json

@@ -0,0 +1,40 @@
+{
+  "branchNameLinter": {
+    "banned": ["bak", "tmp", "wip"],
+    "disallowed": ["develop", "gh-pages", "main", "master", "staging"],
+    "msgBranchBanned": "Branches with the name \"%s\" are not allowed.",
+    "msgBranchDisallowed": "Pushing to \"%s\" is not allowed, use git-flow.",
+    "msgDoesNotMatchRegex": "Branch \"%s\" does not conform to the naming pattern: \"%s\"",
+    "msgPrefixNotAllowed": "Branch prefix \"%s\" is not allowed.",
+    "msgPrefixSuggestion": "Instead of \"%s\" try \"%s\".",
+    "msgseparatorRequired": "Branch name \"%s\" must contain a separator \"%s\".",
+    "prefixes": [
+      "chore",
+      "ci",
+      "core",
+      "doc",
+      "experiment",
+      "feat",
+      "fix",
+      "hotfix",
+      "release",
+      "test"
+    ],
+    "regex": "^[a-z]+/[a-z][a-z0-9.-]*$",
+    "regexOptions": "i",
+    "separator": "/",
+    "skip": [],
+    "suggestions": {
+      "backup": "bak",
+      "build": "ci",
+      "docs": "doc",
+      "feat": "feature",
+      "features": "feature",
+      "releases": "release",
+      "spec": "test",
+      "temp": "tmp",
+      "tests": "test",
+      "wip": "experiment"
+    }
+  }
+}

.husky/pre-push

@@ -0,0 +1 @@
+pnpm run lint:branch

package.json

@@ -1,8 +1,8 @@
 {
   "dependencies": {
+    "@gtm-support/vue-gtm": "^3.0.1",
     "@headlessui/vue": "^1.7.22",
     "@heroicons/vue": "^2.1.3",
-    "@gtm-support/vue-gtm": "^3.0.1",
     "@unhead/vue": "^1.9.14",
     "@vueuse/core": "^10.11.0",
     "dotenv": "^16.4.5",
@@ -18,6 +18,7 @@
     "@vitejs/plugin-vue": "^5.0.4",
     "@vue/eslint-config-prettier": "^9.0.0",
     "autoprefixer": "^10.4.19",
+    "branch-name-lint": "al/branch-name-lint#integration/error-handling-issues",
     "cspell": "^8.12.1",
     "eslint": "^8.57.0",
     "eslint-config-prettier": "^9.1.0",
@@ -27,8 +28,8 @@
     "eslint-plugin-stylelint": "^0.1.1",
     "eslint-plugin-vue": "^9.23.0",
     "eslint-plugin-yml": "^1.14.0",
-    "globals": "^15.8.0",
     "gh-pages": "^6.1.1",
+    "globals": "^15.8.0",
     "husky": "^9.1.1",
     "lint-staged": "^15.2.7",
     "postcss": "^8.4.38",
@@ -53,6 +54,7 @@
     "dev": "vite",
     "format": "prettier --check --ignore-unknown .",
     "format:fix": "prettier --ignore-unknown --write .",
+    "lint:branch": "branch-name-lint .branch-name-lint.json",
     "lint:css": "stylelint --allow-empty-input --formatter verbose src/**/*.{css,scss,vue}",
     "lint:css:fix": "stylelint --allow-empty-input --fix src/**/*.{css,scss,vue}",
     "lint:js": "eslint .",