designmd-forge 1.2.0

package/dist/tools/lint.js

@@ -0,0 +1,104 @@
+import { z } from 'zod';
+import { getEntryBySlug, readDesignMdContent } from '../services/designStore.js';
+import { lintDesignMdContent } from '../services/linter.js';
+const LintInputSchema = z
+    .object({
+    content: z
+        .string()
+        .min(1)
+        .optional()
+        .describe("Raw DESIGN.md markdown content to lint (e.g. a file you're drafting for your own product). Provide this OR slug, not both."),
+    slug: z
+        .string()
+        .min(1)
+        .max(100)
+        .optional()
+        .describe("Slug of a bundled reference design to lint instead of arbitrary content (e.g. 'stripe'). Provide this OR content, not both."),
+})
+    .strict();
+export function registerLintTool(server) {
+    server.registerTool('designmd_lint', {
+        title: 'Lint a DESIGN.md File',
+        description: `Validate a DESIGN.md file for structural correctness using the official @google/design.md linter (the same tool the format's spec maintainers publish).
+
+Checks include: YAML frontmatter presence and shape, orphaned tokens (colors/typography/etc. defined but never referenced by any component), and other structural issues. This validates STRUCTURE only — it cannot tell you whether your prose is specific enough or whether your Do's and Don'ts section actually covers your product's real failure modes. Pair this with designmd_get_authoring_guide for that.
+
+Use this on a DESIGN.md you're drafting for your OWN product before committing it — not on the bundled reference files (those are just for structural inspiration), though either works as input.
+
+Args:
+  - content (string): Raw DESIGN.md markdown to lint. Use this for a file you're actively drafting.
+  - slug (string): Instead of content, lint one of the bundled reference designs by slug (mainly useful for sanity-checking the linter itself, or seeing what a clean/complete file scores).
+  Exactly one of content or slug must be provided.
+
+Returns:
+  JSON with schema:
+  {
+    "summary": { "errors": number, "warnings": number, "infos": number },
+    "findings": [
+      { "severity": "error"|"warning"|"info", "message": string, "path"?: string, "rule"?: string }
+    ]
+  }
+
+Error Handling:
+  - Returns "Error: Provide exactly one of 'content' or 'slug'" if both or neither are given.
+  - Returns "Error: No design found for slug '<slug>'" if the slug doesn't exist.
+  - Returns "Error: designmd lint CLI failed: ..." if the underlying CLI process fails to run (e.g. Node/npm environment issue) — this is an infrastructure error, not a lint finding.
+
+Examples:
+  - Use when: "check my draft DESIGN.md before I commit it" -> content=<the draft markdown>
+  - Use when: "is the bundled Stripe file clean?" -> slug="stripe"
+  - Don't use when: you want writing/prose guidance rather than structural validation (use designmd_get_authoring_guide)`,
+        inputSchema: LintInputSchema.shape,
+        annotations: {
+            readOnlyHint: true,
+            destructiveHint: false,
+            idempotentHint: true,
+            openWorldHint: false,
+        },
+    }, async (params) => {
+        if ((params.content && params.slug) || (!params.content && !params.slug)) {
+            return {
+                content: [
+                    {
+                        type: 'text',
+                        text: "Error: Provide exactly one of 'content' or 'slug', not both and not neither.",
+                    },
+                ],
+                isError: true,
+            };
+        }
+        let content;
+        if (params.slug) {
+            const entry = getEntryBySlug(params.slug);
+            if (!entry) {
+                return {
+                    content: [
+                        {
+                            type: 'text',
+                            text: `Error: No design found for slug '${params.slug}'. Call designmd_search_designs or designmd_list_designs to find the correct slug.`,
+                        },
+                    ],
+                    isError: true,
+                };
+            }
+            content = readDesignMdContent(entry.slug);
+        }
+        else {
+            content = params.content;
+        }
+        try {
+            const result = await lintDesignMdContent(content);
+            return {
+                content: [{ type: 'text', text: JSON.stringify(result, null, 2) }],
+                structuredContent: result,
+            };
+        }
+        catch (err) {
+            const message = err instanceof Error ? err.message : String(err);
+            return {
+                content: [{ type: 'text', text: `Error: ${message}` }],
+                isError: true,
+            };
+        }
+    });
+}

package/dist/types.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -0,0 +1,65 @@
+{
+  "name": "designmd-forge",
+  "version": "1.2.0",
+  "description": "Free, offline MCP server for browsing/searching/fetching DESIGN.md design-system specs (colors, typography, components) across web, mobile and iOS sources, with lint/diff/scaffold authoring tools.",
+  "type": "module",
+  "main": "dist/index.js",
+  "bin": "dist/index.js",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc && node scripts/copy-data.mjs",
+    "start": "node dist/index.js",
+    "dev": "tsc --watch",
+    "prepare": "npm run build",
+    "refresh-data:web": "rm -rf .repo-tmp && git clone --depth 1 https://github.com/VoltAgent/awesome-design-md.git .repo-tmp && node scripts/build-index-web.mjs .repo-tmp && rm -rf .repo-tmp",
+    "refresh-data:mobile": "rm -rf .repo-tmp-mobile && git clone --depth 1 https://github.com/TrustOtc/awesome-mobile-design-md.git .repo-tmp-mobile && node scripts/build-index-mobile.mjs .repo-tmp-mobile && rm -rf .repo-tmp-mobile",
+    "refresh-data:ios": "rm -rf .repo-tmp-ios && git clone --depth 1 https://github.com/meliwat/awesome-ios-design-md.git .repo-tmp-ios && node scripts/build-index-ios.mjs .repo-tmp-ios && rm -rf .repo-tmp-ios",
+    "refresh-data": "npm run refresh-data:web && npm run refresh-data:mobile && npm run refresh-data:ios && npm run load-data",
+    "load-data": "node scripts/load-data.mjs",
+    "start:http": "node dist/httpServer.js",
+    "test": "node --test dist/__tests__/*.test.js",
+    "pretest": "npm run build",
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix",
+    "format": "prettier --write .",
+    "format:check": "prettier --check ."
+  },
+  "keywords": [
+    "mcp",
+    "design",
+    "design-system",
+    "design-tokens"
+  ],
+  "license": "MIT",
+  "dependencies": {
+    "@google/design.md": "^0.4.0",
+    "@modelcontextprotocol/sdk": "^1.25.0",
+    "express": "^4.21.2",
+    "zod": "^3.24.1"
+  },
+  "devDependencies": {
+    "@eslint/js": "^10.0.1",
+    "@types/express": "^4.17.21",
+    "@types/node": "^22.10.5",
+    "eslint": "^10.9.1",
+    "eslint-config-prettier": "^10.1.8",
+    "globals": "^17.11.0",
+    "prettier": "^3.9.6",
+    "typescript": "^5.7.3",
+    "typescript-eslint": "^8.68.0"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/adelpro/designmd-forge.git"
+  },
+  "bugs": {
+    "url": "https://github.com/adelpro/designmd-forge/issues"
+  },
+  "homepage": "https://github.com/adelpro/designmd-forge#readme",
+  "author": "adelpro"
+}