@rheged-studio/commitlint-config 1.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Rob Easthope
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+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.

package/README.md

@@ -0,0 +1,106 @@
+# @acme-skunkworks/commitlint-config
+
+Shared [commitlint](https://commitlint.js.org) configuration for Rheged Studio packages.
+
+It **single-sources** the estate's allowed [Conventional Commit](https://www.conventionalcommits.org) types into one published package, consumed by both layers of the commit gate so the ruleset can never drift between them:
+
+- the reusable CI workflow (`reusable-validate-commits.yml`) that validates a PR's `base..head` commit range, and
+- the local husky `pre-push` hook that runs the same range check before a push ever reaches CI.
+
+It extends [`@commitlint/config-conventional`](https://www.npmjs.com/package/@commitlint/config-conventional) and retains all of its defaults — only the list of allowed commit types is pinned to the estate's set.
+
+## Install
+
+```sh
+pnpm add -D @acme-skunkworks/commitlint-config @commitlint/cli
+```
+
+`@commitlint/config-conventional` is a runtime dependency of this package, so installing this config pulls it in automatically — you do not need to add it yourself.
+
+## Usage
+
+Point your commitlint config at this package:
+
+```js
+// commitlint.config.mjs
+export default {
+  extends: ["@acme-skunkworks/commitlint-config"],
+};
+```
+
+The example uses `.mjs` so the `export default` works regardless of the consuming project's module type. In an ESM project (`"type": "module"`) a plain `commitlint.config.js` works too; in a CommonJS project use `.mjs` (as above) or `module.exports` in a `.js`/`.cjs` file.
+
+Then validate a commit-message range — exactly what the CI workflow and the pre-push hook do:
+
+```sh
+# lint every commit on the branch that isn't on the base
+pnpm exec commitlint --from "origin/main" --to "HEAD"
+```
+
+## Allowed commit types
+
+The `type-enum` rule is set explicitly and is aligned to the estate's release-please bump rules:
+
+| Type       | Release bump | Notes                                  |
+| ---------- | ------------ | -------------------------------------- |
+| `feat`     | minor        | A new feature                          |
+| `fix`      | patch        | A bug fix                              |
+| `perf`     | patch        | A performance improvement              |
+| `revert`   | patch        | Reverts a previous commit              |
+| `chore`    | none         | Tooling / housekeeping                 |
+| `docs`     | none         | Documentation only                     |
+| `ci`       | none         | CI configuration and pipelines         |
+| `build`    | none         | Build system or external dependencies  |
+| `refactor` | none         | Neither fixes a bug nor adds a feature |
+| `test`     | none         | Adding or correcting tests             |
+| `style`    | none         | Formatting; no code-behaviour change   |
+
+A `!` marker or a `BREAKING CHANGE:` footer promotes any type to a **major** bump.
+
+Everything else is inherited from `@commitlint/config-conventional` unchanged, including:
+
+- a non-empty commit type and subject,
+- the header max-length limit, and
+- `defaultIgnores` — merge (`Merge …`), revert (`Revert …`), `fixup!` and `squash!` messages are skipped automatically, so this config never needs to blanket-ignore them by author identity.
+
+## Bot-authored commits
+
+**There is no identity denylist.** Bots are validated exactly like everyone else — the config has no `ignores` entry, and none should be added. Every automated commit producer in the estate already emits a Conventional subject, verified against this ruleset:
+
+| Producer                        | Subject                                           |
+| ------------------------------- | ------------------------------------------------- |
+| Dependabot (`github-actions`)   | `ci(deps): bump the actions group with 3 updates` |
+| Dependabot (npm)                | `chore(deps): …` / `chore(deps-dev): …`           |
+| release-please                  | `chore: release main`                             |
+| `reusable-changelog-enrich.yml` | `chore(changelog): enrich post-merge metadata`    |
+
+Dependabot's subjects come from a `commit-message` template in each repo's `.github/dependabot.yml`, which sets `prefix` (plus `prefix-development` for the npm ecosystem) and `include: scope`. Without that template Dependabot falls back to inferring a prefix from recent commit history — which may yield a Conventional subject, but is not guaranteed to, and can leave a bare `Bump …` that would fail the gate. The explicit template is what makes the output deterministic, which is why it is a prerequisite for making the gate a required check rather than an optional nicety ([A-980](https://linear.app/rheged-studio/issue/A-980)).
+
+Two inherited rules are worth knowing when reading a bot commit:
+
+- **`header-max-length` (100) is the one real ceiling.** This is why Dependabot bumps are grouped — a grouped subject stays short (`bump the actions group with 3 updates`), whereas an ungrouped multi-package subject can run past 100 characters and fail.
+- **`body-max-line-length` (100) ignores unbreakable lines.** Dependabot bodies contain compare URLs well over 100 characters; those pass, because the rule only trips on over-long lines that could have been wrapped. A long prose line still fails.
+
+Should a bot ever need an exception, prefer fixing its commit template. A per-identity `ignores` entry is a documented last resort, not a first move.
+
+## Versioning: float on latest
+
+The gate is designed to track this config's **latest published version** rather than pinning it, mirroring how the estate floats on its shared GitHub workflows (`@v1`). The reusable CI workflow installs the config fresh on each run, so a caret range with no committed lockfile resolves to the latest published version — a ruleset change reaches the gate on its next run, with no per-repo bump PR.
+
+Where a consumer instead commits a lockfile (for example the local pre-push hook running in a repo that pins its dev-dependencies), the resolved version stays put until it is updated: the package is Dependabot-versioned like the estate's other shared packages, so those consumers get update PRs. The trade-off is deliberate — because a ruleset change reaches the floating consumers immediately, edits must be made carefully.
+
+## Development
+
+```sh
+pnpm install
+pnpm build   # tsc → dist/ (the published artifact)
+pnpm test    # vitest — behavioural tests over the resolved ruleset
+pnpm tsc     # type-check
+pnpm lint    # eslint
+```
+
+The ruleset itself is `src/index.ts`; `src/index.test.ts` exercises the _effective_ config by resolving `extends` through `@commitlint/load` and linting sample messages with `@commitlint/lint`.
+
+## Licence
+
+MIT

package/dist/index.d.ts

@@ -0,0 +1,23 @@
+import type { UserConfig } from "@commitlint/types";
+/**
+ * `@acme-skunkworks/commitlint-config` — the estate's shared commitlint ruleset.
+ *
+ * It single-sources the allowed Conventional-Commit types into one published
+ * package so that both consumers of the commit gate — the reusable CI workflow
+ * (`reusable-validate-commits.yml`) and the local husky `pre-push` range check —
+ * float on the *same* list with zero drift (A-823 / A-979).
+ *
+ * The config extends `@commitlint/config-conventional` and deliberately retains
+ * all of its defaults (header max length, non-empty type/subject, and the
+ * `defaultIgnores` for `Merge …` / `Revert …` / `fixup!` / `squash!` messages).
+ * Only `type-enum` is overridden.
+ *
+ * `type-enum` is set *explicitly* — even though the list currently mirrors
+ * config-conventional's own default — so that an upstream change to
+ * config-conventional's default type set can never silently move the estate's
+ * gate. The list is aligned to the release-please bump rules: `feat` → minor;
+ * `fix`/`perf`/`revert` → patch; the remaining types cut no release.
+ */
+declare const config: UserConfig;
+export default config;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAEpD;;;;;;;;;;;;;;;;;;GAkBG;AACH,QAAA,MAAM,MAAM,EAAE,UAqBb,CAAC;AAEF,eAAe,MAAM,CAAC"}

package/dist/index.js

@@ -0,0 +1,42 @@
+/**
+ * `@acme-skunkworks/commitlint-config` — the estate's shared commitlint ruleset.
+ *
+ * It single-sources the allowed Conventional-Commit types into one published
+ * package so that both consumers of the commit gate — the reusable CI workflow
+ * (`reusable-validate-commits.yml`) and the local husky `pre-push` range check —
+ * float on the *same* list with zero drift (A-823 / A-979).
+ *
+ * The config extends `@commitlint/config-conventional` and deliberately retains
+ * all of its defaults (header max length, non-empty type/subject, and the
+ * `defaultIgnores` for `Merge …` / `Revert …` / `fixup!` / `squash!` messages).
+ * Only `type-enum` is overridden.
+ *
+ * `type-enum` is set *explicitly* — even though the list currently mirrors
+ * config-conventional's own default — so that an upstream change to
+ * config-conventional's default type set can never silently move the estate's
+ * gate. The list is aligned to the release-please bump rules: `feat` → minor;
+ * `fix`/`perf`/`revert` → patch; the remaining types cut no release.
+ */
+const config = {
+    extends: ["@commitlint/config-conventional"],
+    rules: {
+        "type-enum": [
+            2, // error
+            "always",
+            [
+                "feat",
+                "fix",
+                "perf",
+                "revert",
+                "chore",
+                "docs",
+                "ci",
+                "build",
+                "refactor",
+                "test",
+                "style",
+            ],
+        ],
+    },
+};
+export default config;

package/package.json

@@ -0,0 +1,121 @@
+{
+  "name": "@rheged-studio/commitlint-config",
+  "version": "1.0.1",
+  "description": "Shared commitlint configuration for ACME Skunkworks packages.",
+  "keywords": [
+    "commitlint",
+    "conventional-commits",
+    "config",
+    "rheged-studio"
+  ],
+  "homepage": "https://github.com/rheged-studio/commitlint-config#readme",
+  "bugs": {
+    "url": "https://github.com/rheged-studio/commitlint-config/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/rheged-studio/commitlint-config.git"
+  },
+  "license": "MIT",
+  "author": {
+    "name": "Rob Easthope",
+    "url": "https://github.com/RobEasthope"
+  },
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    }
+  },
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "act:ci": "act pull_request -W .github/workflows/ci.yml --eventpath .github/act-events/pull_request.json",
+    "act:list": "act --list",
+    "act:release:dry": "act push -W .github/workflows/pkg-release.yml",
+    "build": "tsc",
+    "ci:list": "gh run list --limit 10",
+    "ci:view": "gh run view",
+    "ci:watch": "gh run watch $(gh run list -L 1 --json databaseId -q '.[0].databaseId // empty')",
+    "clean": "rimraf node_modules dist",
+    "format": "prettier --write .",
+    "lint": "eslint 'src/**/*.ts' --cache --cache-location ./.eslintcache",
+    "lint:fix": "eslint 'src/**/*.ts' --fix --cache --cache-location ./.eslintcache",
+    "lint:md": "markdownlint-cli2 '**/*.{md,mdx}' '!**/node_modules/**' '!**/dist/**' '!**/.turbo/**' '!**/.astro/**' '!**/.claude/skills/**' '!**/.agents/skills/**' '!AGENTS.md'",
+    "lint:md:fix": "markdownlint-cli2 --fix '**/*.{md,mdx}' '!**/node_modules/**' '!**/dist/**' '!**/.turbo/**' '!**/.astro/**' '!**/.claude/skills/**' '!**/.agents/skills/**' '!AGENTS.md'",
+    "lint:sh": "bash -c 'if command -v shellcheck >/dev/null 2>&1; then shellcheck infrastructure/scripts/*.sh .husky/pre-commit .husky/pre-push .husky/commit-msg; elif [ \"$(uname -s)\" = \"Darwin\" ]; then echo \"⚠️  shellcheck not installed — skipping. Install: brew install shellcheck\"; else echo \"⚠️  shellcheck not installed — skipping. Install: apt-get install shellcheck\"; fi'",
+    "lint:workflows": "actionlint",
+    "lint:yaml": "yamllint .",
+    "prepare": "husky",
+    "prepublishOnly": "pnpm run build",
+    "release:manual": "pnpm run build && npm publish --access public --provenance=false",
+    "release:manual:dry": "pnpm run build && npm publish --access public --provenance=false --dry-run",
+    "sort-pkg-json": "sort-package-json",
+    "test": "vitest run",
+    "test:sh": "bash -c 'if command -v bats >/dev/null 2>&1; then bats infrastructure/tests/*.bats; elif [ \"$(uname -s)\" = \"Darwin\" ]; then echo \"⚠️  bats not installed — skipping. Install: brew install bats-core\"; else echo \"⚠️  bats not installed — skipping. Install: apt-get install bats\"; fi'",
+    "test:watch": "vitest",
+    "tsc": "tsc --noEmit && tsc -p tsconfig.tools.json",
+    "validate:changelog": "pnpm exec changelog-core validate"
+  },
+  "lint-staged": {
+    "**/*": [
+      "prettier --write --ignore-unknown"
+    ],
+    "**/*.{ts,tsx,js,mjs,cjs}": [
+      "bash -c 'pnpm exec eslint --fix --cache --cache-location ./.eslintcache \"$@\" || true' --"
+    ],
+    "**/package.json": [
+      "bash -c 'sort-package-json \"$@\" || true' --",
+      "bash -c 'pnpm exec eslint --fix --cache --cache-location ./.eslintcache \"$@\" || true' --"
+    ],
+    "**/*.{md,mdx}": [
+      "bash -c 'markdownlint-cli2 --fix --config ./.markdownlint-cli2.jsonc \"$@\" || true' --"
+    ],
+    "**/*.{yml,yaml}": [
+      "bash -c 'if command -v yamllint >/dev/null 2>&1; then yamllint \"$@\"; elif [ \"$(uname -s)\" = \"Darwin\" ]; then echo \"⚠️  yamllint not installed — skipping. Install with: brew install yamllint\"; else echo \"⚠️  yamllint not installed — skipping. Install with: pip install --user yamllint==1.37.1\"; fi' --"
+    ],
+    ".github/workflows/*.{yml,yaml}": [
+      "bash -c 'if command -v actionlint >/dev/null 2>&1; then actionlint \"$@\"; elif [ \"$(uname -s)\" = \"Darwin\" ]; then echo \"⚠️  actionlint not installed — skipping. Install with: brew install actionlint\"; else echo \"⚠️  actionlint not installed — skipping. Install via: bash <(curl -fsSL https://raw.githubusercontent.com/rhysd/actionlint/v1.7.5/scripts/download-actionlint.bash)\"; fi' --"
+    ]
+  },
+  "dependencies": {
+    "@commitlint/config-conventional": "^21.2.0",
+    "@commitlint/types": "^21.2.0"
+  },
+  "devDependencies": {
+    "@acme-skunkworks/changelog-core": "^1.1.1",
+    "@acme-skunkworks/eslint-config": "^1.1.3",
+    "@acme-skunkworks/markdownlint-config": "^3.0.0",
+    "@commitlint/cli": "^21.2.1",
+    "@commitlint/lint": "^21.2.0",
+    "@commitlint/load": "^21.2.0",
+    "@types/node": "^25.6.0",
+    "bats": "1.13.0",
+    "eslint": "^9.0.0",
+    "husky": "^9.1.7",
+    "jiti": "^2.7.0",
+    "lint-staged": "^16.3.2",
+    "markdownlint-cli2": "^0.18.1",
+    "prettier": "^3.0.0",
+    "prettier-plugin-tailwindcss": "^0.8.0",
+    "rimraf": "^6.0.1",
+    "sort-package-json": "^3.6.1",
+    "tsx": "^4.21.1",
+    "typescript": "^6.0.3",
+    "vitest": "^4.1.6"
+  },
+  "packageManager": "pnpm@10.33.0",
+  "engines": {
+    "node": ">=22"
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  }
+}