mcp-software-design 0.1.2 → 0.1.4

package/CHANGELOG.md

@@ -0,0 +1,68 @@
+# Changelog
+
+## 0.1.4
+
+### Patch Changes
+
+- b3fc1f0: Releases are now automated with Changesets and published from GitHub Actions with provenance.
+
+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).
+
+## [Unreleased]
+
+### Changed
+
+- Extracted an escape-aware `scanToUnescaped` scanner in the smell
+  tokenizer, collapsing three near-identical scan loops into one linear,
+  no-backtracking helper — internal refactor, no behavior change. (#13)
+
+## [0.1.3] - 2026-07-31
+
+### Added
+
+- `clean-code` umbrella concept in the catalog, tying the individual
+  cleanliness practices together. (#11)
+
+### Changed
+
+- README: added badges and moved the install guide to the top, then
+  de-duplicated the install instructions so they live in one place.
+  (#9, #10)
+
+## [0.1.2] - 2026-07-31
+
+### Added
+
+- `solid` and `oop` filters for the `list_catalog` tool. (#5)
+- `meaningful-names` concept to the catalog, with refreshed docs. (#6)
+
+### Changed
+
+- Expanded the npm keywords for discoverability. (#7)
+
+### Fixed
+
+- Derive the server version from `package.json` so the reported version
+  always matches the published one. (#4)
+
+## [0.1.1] - 2026-07-31
+
+### Fixed
+
+- Corrected the publish metadata so the package resolves cleanly on both
+  the npm and MCP registries. (#1)
+
+## [0.1.0] - 2026-07-31
+
+### Added
+
+- Initial release: the software-design MCP server — a language-agnostic
+  catalog of SOLID / OOP / DRY principles and the 23 GoF design patterns,
+  the `list_catalog`, `explain_concept`, `scaffold_pattern`, and
+  `check_smells` tools, and the `design://` resources.
+
+[Unreleased]: https://github.com/qwertymuzaffar/mcp-software-design/compare/v0.1.3...HEAD
+[0.1.3]: https://github.com/qwertymuzaffar/mcp-software-design/releases/tag/v0.1.3

package/README.md

@@ -7,11 +7,12 @@
 
 An [MCP](https://modelcontextprotocol.io) server that teaches and helps apply
 **software-design guidance** — the SOLID principles, the OOP pillars, DRY /
-KISS / YAGNI / meaningful naming, and the 23 Gang-of-Four design patterns —
+KISS / YAGNI / meaningful naming / clean code, and the 23 Gang-of-Four design
+patterns —
 plus pattern scaffolding and heuristic code-smell detection.
 
 It's the companion to
-[`mcp-udacity-commit`](../mcp-udacity-commit): same stack (TypeScript, the MCP
+[`mcp-udacity-commit`](https://github.com/qwertymuzaffar/mcp-udacity-commit): same stack (TypeScript, the MCP
 SDK, stdio transport), same shape (pure logic modules + thin server wiring).
 
 ## Install
@@ -101,25 +102,14 @@ npm test           # builds, then runs the unit tests
 npm run test:client  # end-to-end check against the built server
 ```
 
-Then register the local build with Claude Code:
+Then register it the same way as [Install](#install) above — both the
+`claude mcp add` command and the MCP-client-config form work — but point at
+your local build instead of `npx`:
 
 ```bash
 claude mcp add software-design -- node /absolute/path/to/mcp-software-design/build/index.js
 ```
 
-Or in an MCP client config:
-
-```json
-{
-  "mcpServers": {
-    "software-design": {
-      "command": "node",
-      "args": ["/absolute/path/to/mcp-software-design/build/index.js"]
-    }
-  }
-}
-```
-
 ## Layout
 
 ```

package/build/catalog.js

@@ -189,6 +189,29 @@ export const PRINCIPLES = [
         ],
         related: ["kiss", "single-responsibility", "separation-of-concerns"],
     },
+    {
+        slug: "clean-code",
+        name: "Clean Code",
+        category: "principle",
+        aka: ["readability", "craftsmanship"],
+        summary: "Code is read far more than it's written — optimize for the reader.",
+        intent: "Clean Code is an umbrella habit, not a single rule: write code a later " +
+            "reader (usually you) can understand quickly and change safely. It's the " +
+            "sum of the concrete principles here — intention-revealing names, small " +
+            "single-purpose units, no duplication, and the simplest thing that works — " +
+            "rather than a separate technique of its own.",
+        whenToUse: [
+            "You hesitate to touch a file because you don't understand it.",
+            "Reviewers keep asking 'what does this do?' about the same code.",
+            "Reading the change takes longer than making it.",
+        ],
+        tradeoffs: [
+            "'Clean' is contextual — a throwaway script and a core library deserve different bars.",
+            "Endless renaming/extracting has diminishing returns; stop once it reads clearly.",
+            "Cleanliness is not correctness — clean code can still be wrong; tests decide behavior.",
+        ],
+        related: ["meaningful-names", "single-responsibility", "dry", "kiss"],
+    },
     {
         slug: "composition-over-inheritance",
         name: "Composition Over Inheritance",

package/build/smells.js

@@ -31,6 +31,26 @@ const TYPE_KEYWORDS = new Set([
     "class", "interface", "enum", "struct", "namespace", "module", "record",
     "trait", "object", "protocol", "extension",
 ]);
+/**
+ * From `start`, scan `line` for the next unescaped `delimiter`, treating `\x`
+ * as an escape pair (so `\"` or `` \` `` don't close the literal). Returns the
+ * delimiter's index with `closed: true` when found, otherwise the line length
+ * with `closed: false`. Single left-to-right scan — no backtracking, linear.
+ */
+function scanToUnescaped(line, start, delimiter) {
+    let scanIndex = start;
+    while (scanIndex < line.length) {
+        const char = line[scanIndex];
+        if (char === "\\") {
+            scanIndex += 2;
+            continue;
+        }
+        if (char === delimiter)
+            return { end: scanIndex, closed: true };
+        scanIndex++;
+    }
+    return { end: line.length, closed: false };
+}
 /**
  * Blank out string literals, line comments, and block comments so structural
  * counters (braces, commas, numbers) don't trip over their contents. Returns
@@ -65,22 +85,9 @@ export function sanitize(lines) {
                 continue;
             }
             if (mode === "template") {
-                let scanIndex = cursor;
-                let closed = false;
-                while (scanIndex < lineLength) {
-                    const char = rawLine[scanIndex];
-                    if (char === "\\") {
-                        scanIndex += 2;
-                        continue;
-                    }
-                    if (char === "`") {
-                        closed = true;
-                        break;
-                    }
-                    scanIndex++;
-                }
+                const { end, closed } = scanToUnescaped(rawLine, cursor, "`");
                 if (closed) {
-                    cursor = scanIndex + 1;
+                    cursor = end + 1;
                     mode = "code";
                 }
                 else {
@@ -115,41 +122,14 @@ export function sanitize(lines) {
                 continue;
             }
             if (char === '"' || char === "'") {
-                const quote = char;
-                let scanIndex = cursor + 1;
-                let closed = false;
-                while (scanIndex < lineLength) {
-                    const stringChar = rawLine[scanIndex];
-                    if (stringChar === "\\") {
-                        scanIndex += 2;
-                        continue;
-                    }
-                    if (stringChar === quote) {
-                        closed = true;
-                        break;
-                    }
-                    scanIndex++;
-                }
-                cursor = closed ? scanIndex + 1 : lineLength; // drop the string content
+                const { end, closed } = scanToUnescaped(rawLine, cursor + 1, char);
+                cursor = closed ? end + 1 : lineLength; // drop the string content
                 continue;
             }
             if (char === "`") {
-                let scanIndex = cursor + 1;
-                let closed = false;
-                while (scanIndex < lineLength) {
-                    const stringChar = rawLine[scanIndex];
-                    if (stringChar === "\\") {
-                        scanIndex += 2;
-                        continue;
-                    }
-                    if (stringChar === "`") {
-                        closed = true;
-                        break;
-                    }
-                    scanIndex++;
-                }
+                const { end, closed } = scanToUnescaped(rawLine, cursor + 1, "`");
                 if (closed) {
-                    cursor = scanIndex + 1;
+                    cursor = end + 1;
                 }
                 else {
                     mode = "template";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mcp-software-design",
-  "version": "0.1.2",
+  "version": "0.1.4",
   "description": "MCP server that teaches and applies software-design guidance: SOLID/OOP/DRY principles, the 23 GoF design patterns, pattern scaffolding, and heuristic code-smell detection.",
   "type": "module",
   "license": "MIT",
@@ -33,7 +33,8 @@
   },
   "files": [
     "build",
-    "README.md"
+    "README.md",
+    "CHANGELOG.md"
   ],
   "engines": {
     "node": ">=18"
@@ -44,13 +45,17 @@
     "pretest": "npm run build",
     "test": "node --test test/*.test.mjs",
     "prepublishOnly": "npm test",
-    "test:client": "node test-client.mjs"
+    "test:client": "node test-client.mjs",
+    "changeset": "changeset",
+    "version-packages": "changeset version",
+    "release": "npm run build && changeset publish"
   },
   "dependencies": {
     "@modelcontextprotocol/sdk": "^1.30.0",
     "zod": "^3.25.76"
   },
   "devDependencies": {
+    "@changesets/cli": "^3.0.2",
     "@types/node": "^22.10.0",
     "typescript": "^5.7.2"
   }