mcp-udacity-commit 1.2.0 → 1.2.2

package/CHANGELOG.md

@@ -0,0 +1,65 @@
+# Changelog
+
+All notable changes to this project are documented here.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.2.2] - 2026-07-31
+
+### Changed
+
+- Include `CHANGELOG.md` in the published npm package so the release
+  history ships alongside the code.
+
+## [1.2.1] - 2026-07-31
+
+### Changed
+
+- Renamed terse single-letter locals across the server and lint core to
+  descriptive names — a pure readability pass with functionally identical
+  compiled output. (#4)
+
+### Security
+
+- Ignore `.mcpregistry_*` so the MCP publisher's GitHub token can never be
+  committed; also ignore `.idea/` project settings and `*.tgz` pack
+  artifacts. (#5)
+
+## [1.2.0] - 2026-07-28
+
+### Added
+
+- `validate_branch_name` tool and `udacity://branch-naming` resource
+  enforcing the companion `type/kebab-case` branch-naming convention. (#2)
+- `release/` recognized as a typed branch that accepts version-style
+  descriptions (e.g. `release/1.2.0`, `release/2024-q1`). (#3)
+
+## [1.0.2] - 2026-07-28
+
+### Fixed
+
+- Hardened the commit linter — CRLF handling, code-point length counting,
+  imperative-mood hints, and footer issue-reference checks — and added a
+  unit-test suite plus CI. (#1)
+- Pointed `node --test` at explicit test files so CI runs the suite
+  reliably. (#1)
+
+## [1.0.1] - 2026-07-28
+
+### Changed
+
+- Synced the published npm README and dropped maintainer-only publish
+  steps from it.
+
+## [1.0.0] - 2026-07-28
+
+### Added
+
+- Initial release: the Udacity commit-message MCP server with the
+  `validate_commit_message` and `format_commit_message` tools and the
+  `udacity://commit-styleguide` resource.
+
+[1.2.2]: https://github.com/qwertymuzaffar/mcp-udacity-commit/compare/v1.2.1...v1.2.2
+[1.2.1]: https://github.com/qwertymuzaffar/mcp-udacity-commit/compare/v1.2.0...v1.2.1
+[1.2.0]: https://github.com/qwertymuzaffar/mcp-udacity-commit/releases/tag/v1.2.0

package/build/index.js

@@ -3,7 +3,7 @@ import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
 import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
 import { z } from "zod";
 import { STYLE_GUIDE, BRANCH_GUIDE, validate, formatMessage, validateBranch } from "./lint.js";
-const VERSION = "1.2.0";
+const VERSION = "1.2.2";
 export function createServer() {
     const server = new McpServer({ name: "udacity-commit", version: VERSION });
     server.registerResource("styleguide", "udacity://commit-styleguide", {
@@ -27,16 +27,16 @@ export function createServer() {
             warnings: z.array(z.string()),
         },
     }, async ({ message }) => {
-        const r = validate(message);
+        const report = validate(message);
         const text = [
-            r.valid ? "✅ Compliant with the Udacity style guide." : "❌ Not compliant.",
-            ...r.problems.map((p) => `  • ${p}`),
-            ...r.warnings.map((w) => `  ⚠ ${w}`),
+            report.valid ? "✅ Compliant with the Udacity style guide." : "❌ Not compliant.",
+            ...report.problems.map((problem) => `  • ${problem}`),
+            ...report.warnings.map((warning) => `  ⚠ ${warning}`),
         ].join("\n");
         const structuredContent = {
-            valid: r.valid,
-            problems: r.problems,
-            warnings: r.warnings,
+            valid: report.valid,
+            problems: report.problems,
+            warnings: report.warnings,
         };
         return { content: [{ type: "text", text }], structuredContent };
     });
@@ -86,16 +86,16 @@ export function createServer() {
             warnings: z.array(z.string()),
         },
     }, async ({ name }) => {
-        const r = validateBranch(name);
+        const report = validateBranch(name);
         const text = [
-            r.valid ? "✅ Compliant branch name." : "❌ Not compliant.",
-            ...r.problems.map((p) => `  • ${p}`),
-            ...r.warnings.map((w) => `  ⚠ ${w}`),
+            report.valid ? "✅ Compliant branch name." : "❌ Not compliant.",
+            ...report.problems.map((problem) => `  • ${problem}`),
+            ...report.warnings.map((warning) => `  ⚠ ${warning}`),
         ].join("\n");
         const structuredContent = {
-            valid: r.valid,
-            problems: r.problems,
-            warnings: r.warnings,
+            valid: report.valid,
+            problems: report.problems,
+            warnings: report.warnings,
         };
         return { content: [{ type: "text", text }], structuredContent };
     });
@@ -105,7 +105,7 @@ async function main() {
     const server = createServer();
     await server.connect(new StdioServerTransport());
 }
-main().catch((err) => {
-    console.error(err);
+main().catch((error) => {
+    console.error(error);
     process.exit(1);
 });

package/build/lint.js

@@ -78,7 +78,7 @@ A commit message has three parts separated by blank lines: **subject**, optional
 
 ## Types
 ${Object.entries(TYPES)
-    .map(([t, d]) => `- **${t}**: ${d}`)
+    .map(([typeName, typeDescription]) => `- **${typeName}**: ${typeDescription}`)
     .join("\n")}
 
 ## Subject
@@ -126,14 +126,14 @@ same commit \`type\` set.
 Base branches (${[...BASE_BRANCHES].join(", ")}) are exempt.
 `;
 /** Length in Unicode code points (not UTF-16 code units). */
-export function width(s) {
-    return [...s].length;
+export function width(text) {
+    return [...text].length;
 }
 /** Uppercase the first code point of a string (astral-safe). */
-function capitalizeFirst(s) {
-    const chars = [...s];
+function capitalizeFirst(text) {
+    const chars = [...text];
     if (chars.length === 0)
-        return s;
+        return text;
     return chars[0].toUpperCase() + chars.slice(1).join("");
 }
 /**
@@ -187,23 +187,23 @@ export function validate(message) {
         lines.pop();
     const rawSubject = lines[0] ?? "";
     const subject = rawSubject.replace(/\s+$/, "");
-    const m = subject.match(/^(\w+): (.*)$/);
-    if (!m) {
+    const subjectMatch = subject.match(/^(\w+): (.*)$/);
+    if (!subjectMatch) {
         problems.push(`Subject must follow "type: Subject". Got: "${subject}".`);
     }
     else {
-        const [, type, rest] = m;
+        const [, type, subjectText] = subjectMatch;
         if (!TYPES[type]) {
             problems.push(`Unknown type "${type}". Use one of: ${Object.keys(TYPES).join(", ")}.`);
         }
-        if (!rest) {
+        if (!subjectText) {
             problems.push("Subject text is empty after the type.");
         }
         else {
-            if (/^\p{Ll}/u.test(rest)) {
-                problems.push(`Subject should begin with a capital letter (got "${[...rest][0]}").`);
+            if (/^\p{Ll}/u.test(subjectText)) {
+                problems.push(`Subject should begin with a capital letter (got "${[...subjectText][0]}").`);
             }
-            const firstWord = rest.split(/\s+/)[0];
+            const firstWord = subjectText.split(/\s+/)[0];
             if (NON_IMPERATIVE.has(firstWord.toLowerCase())) {
                 warnings.push(`"${firstWord}" looks past-tense/gerund — use the imperative mood ("Add", not "Added").`);
             }
@@ -219,15 +219,15 @@ export function validate(message) {
     if (lines.length > 1 && lines[1].trim() !== "") {
         problems.push("Leave a blank line between the subject and the body.");
     }
-    for (let i = 2; i < lines.length; i++) {
-        const line = lines[i];
+    for (let lineIndex = 2; lineIndex < lines.length; lineIndex++) {
+        const line = lines[lineIndex];
         if (width(line) > BODY_WRAP) {
-            problems.push(`Line ${i + 1} is ${width(line)} chars; wrap body/footer at ${BODY_WRAP}.`);
+            problems.push(`Line ${lineIndex + 1} is ${width(line)} chars; wrap body/footer at ${BODY_WRAP}.`);
         }
-        const fm = line.match(/^([A-Za-z][A-Za-z ]*?):\s*(.*)$/);
-        if (fm && FOOTER_KEYS.some((k) => k.toLowerCase() === fm[1].toLowerCase())) {
-            if (!/#\d+/.test(fm[2])) {
-                warnings.push(`Footer "${fm[1]}" should reference an issue, e.g. "${fm[1]}: #123".`);
+        const footerMatch = line.match(/^([A-Za-z][A-Za-z ]*?):\s*(.*)$/);
+        if (footerMatch && FOOTER_KEYS.some((footerKey) => footerKey.toLowerCase() === footerMatch[1].toLowerCase())) {
+            if (!/#\d+/.test(footerMatch[2])) {
+                warnings.push(`Footer "${footerMatch[1]}" should reference an issue, e.g. "${footerMatch[1]}: #123".`);
             }
         }
     }
@@ -277,13 +277,13 @@ export function validateBranch(name) {
         warnings.push(`"${branch}" is a base branch — feature-branch naming rules don't apply.`);
         return { valid: problems.length === 0, problems, warnings };
     }
-    const slash = branch.indexOf("/");
-    if (slash === -1) {
+    const slashIndex = branch.indexOf("/");
+    if (slashIndex === -1) {
         problems.push(`Branch must follow "type/description". Got: "${branch}".`);
         return { valid: false, problems, warnings };
     }
-    const type = branch.slice(0, slash);
-    const description = branch.slice(slash + 1);
+    const type = branch.slice(0, slashIndex);
+    const description = branch.slice(slashIndex + 1);
     if (!BRANCH_TYPES.includes(type)) {
         problems.push(`Unknown type "${type}". Use one of: ${BRANCH_TYPES.join(", ")}.`);
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mcp-udacity-commit",
-  "version": "1.2.0",
+  "version": "1.2.2",
   "description": "MCP server that validates and formats git commit messages per the Udacity Git Commit Message Style Guide.",
   "type": "module",
   "license": "MIT",
@@ -23,7 +23,8 @@
   },
   "files": [
     "build",
-    "README.md"
+    "README.md",
+    "CHANGELOG.md"
   ],
   "engines": {
     "node": ">=18"