@gitlode/plugin-conventional-commits 0.2.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 tomo-waka
+
+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,101 @@
+# @gitlode/plugin-conventional-commits
+
+Parse commit messages with [conventional-commits-parser](https://www.npmjs.com/package/conventional-commits-parser) and write the parsed result under
+`extensions["conventional-commits"]` in every gitlode output record.
+
+The plugin uses the commit message from the source commit for both commit facts and file-change
+facts, so the same parsed payload is available on both record types.
+
+## Installation
+
+```bash
+npm install -g @gitlode/plugin-conventional-commits
+```
+
+## Usage
+
+Configure gitlode with `--config`:
+
+```json
+{
+  "version": 1,
+  "extensions": {
+    "conventional-commits": {
+      "entrypoint": "@gitlode/plugin-conventional-commits"
+    }
+  }
+}
+```
+
+Run gitlode:
+
+```bash
+gitlode -r main --config ./gitlode.config.json ./my-repo
+```
+
+Each emitted record will include:
+
+```json
+{
+  "extensions": {
+    "conventional-commits": {
+      "merge": null,
+      "revert": null,
+      "header": "feat(parser): add plugin docs",
+      "body": "Expand README and CHANGELOG.",
+      "footer": "Refs: #123",
+      "notes": [],
+      "mentions": [],
+      "references": [
+        {
+          "raw": "Refs: #123",
+          "action": null,
+          "owner": null,
+          "repository": null,
+          "prefix": "#",
+          "issue": "123"
+        }
+      ],
+      "type": "feat",
+      "scope": "parser",
+      "subject": "add plugin docs"
+    }
+  }
+}
+```
+
+The exact payload shape follows the upstream `conventional-commits-parser` result. Common fields
+include `type`, `scope`, `subject`, `body`, `footer`, `notes`, `mentions`, and `references`.
+
+## Configuration
+
+This plugin does not define any plugin-specific configuration.
+
+You can omit `config` entirely:
+
+```json
+{
+  "version": 1,
+  "extensions": {
+    "conventional-commits": {
+      "entrypoint": "@gitlode/plugin-conventional-commits"
+    }
+  }
+}
+```
+
+## Compatibility
+
+This package declares:
+
+```json
+"peerDependencies": {
+	"gitlode": "^0.7.0"
+}
+```
+
+If the running gitlode version does not satisfy this range, gitlode emits a warning and continues.
+
+## License
+
+[MIT](LICENSE)

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+import type { PluginFactory } from "gitlode/plugin-api";
+declare const factory: PluginFactory;
+export default factory;
+//# 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":"AACA,OAAO,KAAK,EAAE,aAAa,EAAqB,MAAM,oBAAoB,CAAC;AAE3E,QAAA,MAAM,OAAO,EAAE,aAed,CAAC;AAEF,eAAe,OAAO,CAAC"}

package/dist/index.js

@@ -0,0 +1,18 @@
+import { CommitParser } from "conventional-commits-parser";
+const factory = async () => {
+    let parser;
+    return {
+        async init() {
+            parser = new CommitParser();
+            return { type: "ready" };
+        },
+        async project(context) {
+            const { fact } = context;
+            const commit = fact.type === "commit" ? fact : fact.commit;
+            const parsedCommit = parser.parse(commit.message);
+            return { type: "success", data: parsedCommit };
+        },
+    };
+};
+export default factory;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAG3D,MAAM,OAAO,GAAkB,KAAK,IAAI,EAAE;IACxC,IAAI,MAAgC,CAAC;IACrC,OAAO;QACL,KAAK,CAAC,IAAI;YACR,MAAM,GAAG,IAAI,YAAY,EAAE,CAAC;YAC5B,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;QAC3B,CAAC;QACD,KAAK,CAAC,OAAO,CAAC,OAA0B;YACtC,MAAM,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC;YACzB,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC;YAC3D,MAAM,YAAY,GAAG,MAAO,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;YAEnD,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC;QACjD,CAAC;KACF,CAAC;AACJ,CAAC,CAAC;AAEF,eAAe,OAAO,CAAC"}

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@gitlode/plugin-conventional-commits",
+  "version": "0.2.0",
+  "description": "Official gitlode plugin for parsing conventional commits",
+  "keywords": [
+    "gitlode",
+    "gitlode-plugin",
+    "plugin"
+  ],
+  "homepage": "https://github.com/gitlode/gitlode#readme",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/gitlode/gitlode.git"
+  },
+  "files": [
+    "dist"
+  ],
+  "type": "module",
+  "exports": {
+    ".": "./dist/index.js"
+  },
+  "scripts": {
+    "build": "tsc",
+    "build:watch": "tsc --watch",
+    "format:check": "oxfmt --check",
+    "format:write": "oxfmt",
+    "lint": "oxlint",
+    "lint:fix": "oxlint --fix",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage"
+  },
+  "dependencies": {
+    "conventional-commits-parser": "^6.4.0"
+  },
+  "devDependencies": {
+    "gitlode": "^0.7.0"
+  },
+  "peerDependencies": {
+    "gitlode": "^0.7.0"
+  },
+  "engines": {
+    "node": ">=22.0.0"
+  }
+}