mcp-software-design 0.1.3 → 0.1.5

package/CHANGELOG.md

@@ -0,0 +1,74 @@
+# Changelog
+
+## 0.1.5
+
+### Patch Changes
+
+- 7f60e6c: `check_smells` no longer reports rows of multi-line object and array literals, or calls and throws whose arguments were all string literals, as duplicated logic. Lookup tables, message lines and state names used to account for a third of duplication findings on real code. A line that starts with a closing brace before a control keyword (`} else if (...) {`, `} catch (error) {`) is no longer mistaken for a method header, which produced phantom long-method and too-many-params findings measured from the middle of a function.
+
+## 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/build/index.js

@@ -31,6 +31,11 @@ braces, parentheses, and indentation, not a real parser).
 | large-file | > ${DEFAULTS.maxFileLines} lines | separation-of-concerns |
 
 All thresholds are overridable per call on the \`check_smells\` tool.
+
+Duplication skips members of multi-line object and array literals (rows of a
+lookup table are data) and calls or throws whose arguments were all string
+literals (\`lines.push('...')\`, \`throw new Error('...')\`), so message and
+state-name lines do not register.
 `;
 /** Render smells as a compact text report. */
 function renderSmells(smells) {

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";
@@ -193,9 +173,14 @@ function leadingIdentifier(trimmedLine) {
     const match = trimmedLine.match(/^([A-Za-z_$][\w$]*)/);
     return match ? match[1] : "";
 }
-/** True if the (possibly multi-line-joined) text is a function/method header opening a `{`. */
+/**
+ * True if the (possibly multi-line-joined) text is a function/method header
+ * opening a `{`. A closing brace that starts the line (`} else if (x) {`,
+ * `} catch (error) {`) is dropped first so the control keyword behind it is
+ * seen; otherwise such a line has no leading identifier and reads as a header.
+ */
 function isBraceMethodHeader(headerText) {
-    const trimmed = headerText.trim();
+    const trimmed = headerText.trim().replace(/^\}\s*/, "");
     if (!trimmed.endsWith("{"))
         return false;
     if (!trimmed.includes("("))
@@ -466,17 +451,76 @@ function detectLargeClass(sanitized, options) {
     }
     return findings;
 }
+/**
+ * Whether a `{` opens a block (function or control body, type declaration)
+ * rather than an object literal, judged from the sanitized text before it on
+ * its line. A header ends in `)` (optionally followed by a return type) or
+ * `=>`, a bare `else`/`try`/`do`/`finally`, or names a type; anything after
+ * `=`, `(`, `,`, `:`, `return` and the like is a literal. An empty prefix (a
+ * `{` opening the line) counts as a block.
+ */
+function opensBlock(prefix) {
+    const trimmed = prefix.trim();
+    if (trimmed === "")
+        return true;
+    if (/(=>|\belse|\btry|\bdo|\bfinally)$/.test(trimmed))
+        return true;
+    // A header keeps its `(...)` and may add a return type after it
+    // (`foo(): Promise<T | null> {`, `fn f() -> T {`, `func f() error {`);
+    // a literal after a call sits behind `=`, `,`, `(`, `?`, `:` or `||`.
+    const lastParen = trimmed.lastIndexOf(")");
+    if (lastParen !== -1) {
+        const tail = trimmed.slice(lastParen + 1).trim();
+        if (tail === "")
+            return true;
+        if (tail === ":")
+            return false; // `ok ? f(a) : {`
+        if (/^(:|->)\s*\S/.test(tail))
+            return true; // typed return
+        return /^[\w$<>\[\]*. ]*$/.test(tail); // `throws X`, `error`, `*T`
+    }
+    if (/^(case|default)\b/.test(trimmed))
+        return true;
+    const leadingWord = leadingIdentifier(trimmed);
+    if (CONTROL_KEYWORDS.has(leadingWord) || TYPE_KEYWORDS.has(leadingWord))
+        return true;
+    return /\b(class|interface|enum|struct|trait|impl|namespace|module|match)\s+[\w$<>:, ]*$/.test(trimmed);
+}
+/**
+ * A call or throw whose arguments were all string literals (blanked by
+ * `sanitize`): `lines.push(, );`, `throw new RangeError();`, `this.status.set();`.
+ * Such lines are messages and state names, not repeated logic.
+ */
+const TRIVIAL_CALL = /^(?:return\s+|await\s+|throw\s+new\s+)?[\w$.]+\s*\(\s*[,\s]*\)\s*;?$/;
 /** Detect duplicated non-trivial lines (a DRY proxy). */
 function detectDuplication(sanitized, options) {
     const lineCounts = new Map();
+    // Innermost open `{`/`[` per line, true when it opened an object/array
+    // literal: rows of a lookup table are data, not duplicated logic.
+    const bracketStack = [];
     for (let lineIndex = 0; lineIndex < sanitized.length; lineIndex++) {
-        const trimmed = sanitized[lineIndex].trim();
+        const line = sanitized[lineIndex];
+        const insideLiteral = bracketStack.length > 0 && bracketStack[bracketStack.length - 1];
+        for (let charIndex = 0; charIndex < line.length; charIndex++) {
+            const char = line[charIndex];
+            if (char === "{")
+                bracketStack.push(!opensBlock(line.slice(0, charIndex)));
+            else if (char === "[")
+                bracketStack.push(true);
+            else if (char === "}" || char === "]")
+                bracketStack.pop();
+        }
+        if (insideLiteral)
+            continue;
+        const trimmed = line.trim();
         if (trimmed.length < 15)
             continue; // too short to be meaningful
         if (/^[{}()\[\];,]+$/.test(trimmed))
             continue; // pure punctuation
         if (/^(import|from|export|package|using|#include|@)/.test(trimmed))
             continue;
+        if (TRIVIAL_CALL.test(trimmed))
+            continue;
         const record = lineCounts.get(trimmed) ?? { count: 0, firstLine: lineIndex + 1 };
         record.count++;
         lineCounts.set(trimmed, record);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mcp-software-design",
-  "version": "0.1.3",
+  "version": "0.1.5",
   "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"
   }