@schilling.mark.a/atdd-guardian 1.0.0

package/SHARING.md

@@ -0,0 +1,223 @@
+# Sharing the ATDD Guardian MCP Server
+
+## Overview
+
+This document provides recommendations on how to share this MCP server with others. Multiple distribution methods are available, each suited for different use cases.
+
+## Quick Decision Guide
+
+**Choose the right distribution method:**
+
+| If you want to... | Use this method | See |
+|-------------------|-----------------|-----|
+| Share with the public, make it easy to install | **npm package** | [DISTRIBUTION.md - npm](DISTRIBUTION.md#publishing-to-npm) |
+| Enable open source collaboration | **GitHub repository** | [DISTRIBUTION.md - GitHub](DISTRIBUTION.md#sharing-via-github) |
+| Share internally or in air-gapped environments | **Tarball distribution** | [DISTRIBUTION.md - Direct](DISTRIBUTION.md#direct-distribution) |
+| Help others get started quickly | **Quick start guide** | [QUICKSTART.md](QUICKSTART.md) |
+
+## Recommended Distribution Steps
+
+### 1. Prepare for Distribution ✅ (Done)
+
+- [x] Add proper npm package configuration
+- [x] Create LICENSE file (MIT)
+- [x] Create comprehensive README
+- [x] Add CONTRIBUTING guidelines
+- [x] Add CHANGELOG
+- [x] Create example configurations
+- [x] Add .npmignore to exclude dev files
+- [x] Test package build
+
+### 2. Publish to npm (When Ready)
+
+```bash
+# 1. Login to npm
+npm login
+
+# 2. Build the project
+npm run build
+
+# 3. Test locally
+npm pack
+# Install the .tgz in a test project
+
+# 4. Publish
+npm publish
+```
+
+See [DISTRIBUTION.md](DISTRIBUTION.md) for detailed publishing instructions.
+
+### 3. Create GitHub Release
+
+```bash
+# 1. Tag the version
+git tag -a v1.0.0 -m "Release version 1.0.0"
+git push origin v1.0.0
+
+# 2. Create release on GitHub
+# Go to: https://github.com/MarkSchilling/atdd-guardian/releases
+# Create new release, add changelog notes
+```
+
+### 4. Share with Users
+
+Provide users with:
+
+1. **Installation instructions** from [QUICKSTART.md](QUICKSTART.md)
+2. **Configuration examples** from [examples/](examples/)
+3. **Full documentation** from [README.md](README.md)
+4. **Contribution guide** from [CONTRIBUTING.md](CONTRIBUTING.md)
+
+## Distribution Files Reference
+
+This repository now includes everything needed for distribution:
+
+### Core Files
+- `package.json` - npm package configuration with all metadata
+- `README.md` - Comprehensive documentation
+- `LICENSE` - MIT license
+
+### Distribution Documentation
+- `DISTRIBUTION.md` - Detailed guide for all distribution methods
+- `QUICKSTART.md` - Quick start guide for new users
+- `CONTRIBUTING.md` - Guidelines for contributors
+- `CHANGELOG.md` - Version history
+
+### Configuration Examples
+- `examples/mcp-config.json` - VS Code MCP configuration
+- `examples/test-config.json` - Test framework configuration
+- `examples/README.md` - Example usage guide
+
+### Package Control
+- `.npmignore` - Files to exclude from npm package
+- `.gitignore` - Files to exclude from git (including .tgz files)
+
+## Installation Methods for Users
+
+### Method 1: npm (after publishing)
+
+```bash
+npm install -g atdd-guardian-mcp-server
+```
+
+Configure VS Code `.vscode/mcp.json`:
+```json
+{
+  "servers": {
+    "atdd-guardian": {
+      "type": "stdio",
+      "command": "atdd-guardian-mcp"
+    }
+  }
+}
+```
+
+### Method 2: GitHub
+
+```bash
+git clone https://github.com/MarkSchilling/atdd-guardian.git
+cd atdd-guardian
+npm install
+npm run build
+```
+
+Configure VS Code `.vscode/mcp.json`:
+```json
+{
+  "servers": {
+    "atdd-guardian": {
+      "type": "stdio",
+      "command": "node",
+      "args": ["/absolute/path/to/atdd-guardian/dist/index.js"]
+    }
+  }
+}
+```
+
+### Method 3: Tarball
+
+```bash
+# Create tarball
+npm pack
+
+# Share .tgz file, users install with:
+npm install atdd-guardian-mcp-server-1.0.0.tgz
+```
+
+## What's Included in the npm Package
+
+The package includes:
+- ✅ Compiled JavaScript (dist/)
+- ✅ TypeScript declarations (.d.ts files)
+- ✅ Team standards rules (src/rules/team-standards.json)
+- ✅ README documentation
+- ✅ LICENSE file
+
+Excluded from package (development only):
+- ❌ Source TypeScript files (src/*.ts)
+- ❌ Configuration files (tsconfig.json)
+- ❌ Git files
+- ❌ Examples directory
+- ❌ Test files
+
+## Next Steps
+
+1. **Test the distribution:**
+   - Install the package locally using `npm pack`
+   - Verify it works in a clean environment
+   - Test with actual VS Code + Copilot setup
+
+2. **Publish to npm:**
+   - Follow [DISTRIBUTION.md - Publishing to npm](DISTRIBUTION.md#publishing-to-npm)
+   - Create npm account if needed
+   - Run `npm publish`
+
+3. **Create GitHub release:**
+   - Tag version: `git tag -a v1.0.0`
+   - Push tag: `git push origin v1.0.0`
+   - Create release with notes from CHANGELOG.md
+
+4. **Announce and share:**
+   - Share on social media
+   - Post in relevant communities
+   - Update any related documentation
+
+## Maintenance
+
+For ongoing distribution:
+
+1. **Version updates:**
+   - Update package.json version
+   - Update CHANGELOG.md
+   - Create git tag
+   - Publish to npm
+   - Create GitHub release
+
+2. **Documentation:**
+   - Keep README up to date
+   - Update examples as needed
+   - Respond to issues and questions
+
+3. **Community:**
+   - Review pull requests
+   - Address bug reports
+   - Consider feature requests
+
+## Resources
+
+- **Full Distribution Guide:** [DISTRIBUTION.md](DISTRIBUTION.md)
+- **Quick Start for Users:** [QUICKSTART.md](QUICKSTART.md)
+- **Contributing:** [CONTRIBUTING.md](CONTRIBUTING.md)
+- **Examples:** [examples/](examples/)
+- **Changelog:** [CHANGELOG.md](CHANGELOG.md)
+
+## Summary
+
+✅ **The repository is now ready for distribution!**
+
+All necessary files and documentation have been added to enable sharing through:
+- npm package registry
+- GitHub repository
+- Direct tarball distribution
+
+Choose the method that best fits your needs and follow the guides in DISTRIBUTION.md.

package/dist/constants.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Shared Constants
+ *
+ * Constants used across the MCP server modules.
+ */
+/**
+ * Default directories and patterns to exclude from code review
+ */
+export declare const DEFAULT_EXCLUDES: string[];
+/**
+ * File extensions that should be reviewed
+ */
+export declare const REVIEWABLE_EXTENSIONS: string[];
+/**
+ * Maximum character limit for formatted output
+ * to prevent overwhelming the MCP client
+ */
+export declare const CHARACTER_LIMIT = 50000;
+//# sourceMappingURL=constants.d.ts.map

package/dist/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;GAEG;AACH,eAAO,MAAM,gBAAgB,UAQ5B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,qBAAqB,UAWjC,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,eAAe,QAAQ,CAAC"}

package/dist/constants.js

@@ -0,0 +1,38 @@
+/**
+ * Shared Constants
+ *
+ * Constants used across the MCP server modules.
+ */
+/**
+ * Default directories and patterns to exclude from code review
+ */
+export const DEFAULT_EXCLUDES = [
+    "**/node_modules/**",
+    "**/dist/**",
+    "**/build/**",
+    "**/.git/**",
+    "**/coverage/**",
+    "**/*.min.js",
+    "**/*.bundle.js",
+];
+/**
+ * File extensions that should be reviewed
+ */
+export const REVIEWABLE_EXTENSIONS = [
+    ".ts",
+    ".tsx",
+    ".js",
+    ".jsx",
+    ".vue",
+    ".svelte",
+    ".html",
+    ".css",
+    ".scss",
+    ".less",
+];
+/**
+ * Maximum character limit for formatted output
+ * to prevent overwhelming the MCP client
+ */
+export const CHARACTER_LIMIT = 50000;
+//# sourceMappingURL=constants.js.map

package/dist/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;GAEG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG;IAC9B,oBAAoB;IACpB,YAAY;IACZ,aAAa;IACb,YAAY;IACZ,gBAAgB;IAChB,aAAa;IACb,gBAAgB;CACjB,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG;IACnC,KAAK;IACL,MAAM;IACN,KAAK;IACL,MAAM;IACN,MAAM;IACN,SAAS;IACT,OAAO;IACP,MAAM;IACN,OAAO;IACP,OAAO;CACR,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,KAAK,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,23 @@
+#!/usr/bin/env node
+/**
+ * ATDD Guardian MCP Server
+ *
+ * An ATDD-enforcing code reviewer that validates code against
+ * team standards before submission. Designed to catch the issues
+ * teammates flag in PR reviews BEFORE the PR is created.
+ *
+ * ATDD Workflow Integration:
+ *   1. Generate tests from Jira stories (your existing ATDD MCP server)
+ *   2. Make tests pass (Copilot + SKILL.md context)
+ *   3. Run `review_code` (THIS server — catches standards violations)
+ *   4. Fix findings, re-review until verdict = pass
+ *   5. Submit PR with confidence
+ *
+ * PDCA Cycle:
+ *   - PLAN: Define rules in team-standards.json
+ *   - DO:   Write code, run review_code
+ *   - CHECK: Examine findings, compare to PR feedback
+ *   - ACT:  Use add_rule to capture new patterns from rejected PRs
+ */
+export {};
+//# 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;;;;;;;;;;;;;;;;;;;GAmBG"}

package/dist/index.js

@@ -0,0 +1,72 @@
+#!/usr/bin/env node
+/**
+ * ATDD Guardian MCP Server
+ *
+ * An ATDD-enforcing code reviewer that validates code against
+ * team standards before submission. Designed to catch the issues
+ * teammates flag in PR reviews BEFORE the PR is created.
+ *
+ * ATDD Workflow Integration:
+ *   1. Generate tests from Jira stories (your existing ATDD MCP server)
+ *   2. Make tests pass (Copilot + SKILL.md context)
+ *   3. Run `review_code` (THIS server — catches standards violations)
+ *   4. Fix findings, re-review until verdict = pass
+ *   5. Submit PR with confidence
+ *
+ * PDCA Cycle:
+ *   - PLAN: Define rules in team-standards.json
+ *   - DO:   Write code, run review_code
+ *   - CHECK: Examine findings, compare to PR feedback
+ *   - ACT:  Use add_rule to capture new patterns from rejected PRs
+ */
+import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
+import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
+import { registerTools } from "./tools/review-tools.js";
+// ─── Server Setup ────────────────────────────────────────────────
+const server = new McpServer({
+    name: "atdd-guardian-mcp-server",
+    version: "1.0.0",
+});
+// Register all review tools
+registerTools(server);
+// ─── Transport: stdio (for VS Code / Copilot integration) ───────
+async function runStdio() {
+    const transport = new StdioServerTransport();
+    await server.connect(transport);
+    console.error("ATDD Guardian MCP Server running on stdio");
+}
+// ─── Transport: HTTP (for remote / shared use) ──────────────────
+async function runHTTP() {
+    const express = await import("express");
+    const { StreamableHTTPServerTransport } = await import("@modelcontextprotocol/sdk/server/streamableHttp.js");
+    const app = express.default();
+    app.use(express.default.json());
+    app.post("/mcp", async (req, res) => {
+        const transport = new StreamableHTTPServerTransport({
+            sessionIdGenerator: undefined,
+            enableJsonResponse: true,
+        });
+        res.on("close", () => transport.close());
+        await server.connect(transport);
+        await transport.handleRequest(req, res, req.body);
+    });
+    const port = parseInt(process.env.PORT || "3001");
+    app.listen(port, () => {
+        console.error(`ATDD Guardian MCP Server running on http://localhost:${port}/mcp`);
+    });
+}
+// ─── Start ───────────────────────────────────────────────────────
+const transport = process.env.TRANSPORT || "stdio";
+if (transport === "http") {
+    runHTTP().catch((error) => {
+        console.error("Server error:", error);
+        process.exit(1);
+    });
+}
+else {
+    runStdio().catch((error) => {
+        console.error("Server error:", error);
+        process.exit(1);
+    });
+}
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AACA;;;;;;;;;;;;;;;;;;;GAmBG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,yCAAyC,CAAC;AACpE,OAAO,EAAE,oBAAoB,EAAE,MAAM,2CAA2C,CAAC;AACjF,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAExD,oEAAoE;AAEpE,MAAM,MAAM,GAAG,IAAI,SAAS,CAAC;IAC3B,IAAI,EAAE,0BAA0B;IAChC,OAAO,EAAE,OAAO;CACjB,CAAC,CAAC;AAEH,4BAA4B;AAC5B,aAAa,CAAC,MAAM,CAAC,CAAC;AAEtB,mEAAmE;AAEnE,KAAK,UAAU,QAAQ;IACrB,MAAM,SAAS,GAAG,IAAI,oBAAoB,EAAE,CAAC;IAC7C,MAAM,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IAChC,OAAO,CAAC,KAAK,CAAC,2CAA2C,CAAC,CAAC;AAC7D,CAAC;AAED,mEAAmE;AAEnE,KAAK,UAAU,OAAO;IACpB,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,SAAS,CAAC,CAAC;IACxC,MAAM,EAAE,6BAA6B,EAAE,GAAG,MAAM,MAAM,CACpD,oDAAoD,CACrD,CAAC;IAEF,MAAM,GAAG,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAC9B,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;IAEhC,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,EAAE;QAClC,MAAM,SAAS,GAAG,IAAI,6BAA6B,CAAC;YAClD,kBAAkB,EAAE,SAAS;YAC7B,kBAAkB,EAAE,IAAI;SACzB,CAAC,CAAC;QACH,GAAG,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC,CAAC;QACzC,MAAM,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QAChC,MAAM,SAAS,CAAC,aAAa,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC;IACpD,CAAC,CAAC,CAAC;IAEH,MAAM,IAAI,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,IAAI,MAAM,CAAC,CAAC;IAClD,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,GAAG,EAAE;QACpB,OAAO,CAAC,KAAK,CAAC,wDAAwD,IAAI,MAAM,CAAC,CAAC;IACpF,CAAC,CAAC,CAAC;AACL,CAAC;AAED,oEAAoE;AAEpE,MAAM,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC,SAAS,IAAI,OAAO,CAAC;AACnD,IAAI,SAAS,KAAK,MAAM,EAAE,CAAC;IACzB,OAAO,EAAE,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;QACxB,OAAO,CAAC,KAAK,CAAC,eAAe,EAAE,KAAK,CAAC,CAAC;QACtC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC,CAAC,CAAC;AACL,CAAC;KAAM,CAAC;IACN,QAAQ,EAAE,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;QACzB,OAAO,CAAC,KAAK,CAAC,eAAe,EAAE,KAAK,CAAC,CAAC;QACtC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC,CAAC,CAAC;AACL,CAAC"}