@sfdxy/mule-lint 1.18.1 → 1.19.0

package/docs/mcp-design.md

@@ -1,50 +1,58 @@
 # Mule Lint MCP Server Design
 
 ## Executive Summary
+
 This document outlines the strategy for exposing `mule-lint` capabilities via the Model Context Protocol (MCP). By wrapping the linter in an MCP server, we enable AI agents (like Claude, IDE assistants, etc.) to autonomously discover linting rules, validate MuleSoft projects, and retrieve detailed rule documentation without needing to shell out or parse CLI text output.
 
 ## Architecture Decision: Monorepo vs. Separate Repo
+
 **Recommendation: Same Repo (Monorepo)**
 
 We should implement the MCP server directly in the `mule-lint` repository, likely under `src/mcp` or as a separate package if this was a workspace.
-*   **Pros**: Direct access to `src/core`, `src/rules`, and types without publishing/installing packages. Easier to keep rule definitions and agent-exposed descriptions in sync.
-*   **Cons**: Adds a dependency on `@modelcontextprotocol/sdk` to the main repo (or requires a build split).
+
+- **Pros**: Direct access to `src/core`, `src/rules`, and types without publishing/installing packages. Easier to keep rule definitions and agent-exposed descriptions in sync.
+- **Cons**: Adds a dependency on `@modelcontextprotocol/sdk` to the main repo (or requires a build split).
 
 ## Features & Capabilities
 
 ### 1. Tools
+
 Tools allow the agent to perform actions.
 
-| Tool Name | Arguments | Description |
-| :--- | :--- | :--- |
-| `run_lint_analysis` | `projectPath` (string) | Runs the scanning engine on a specified directory. Returns a JSON summary of errors, warnings, and code references. |
-| `validate_snippet` | `code` (string), `type` (xml/dwl) | quickly validates a small chunk of code without a full project structure. Useful for agents generating code on the fly. |
-| `get_rule_details` | `ruleId` (string) | Returns the full documentation, examples, and rationale for a specific rule (e.g., `MULE-001`). |
+| Tool Name           | Arguments                         | Description                                                                                                             |
+| :------------------ | :-------------------------------- | :---------------------------------------------------------------------------------------------------------------------- |
+| `run_lint_analysis` | `projectPath` (string)            | Runs the scanning engine on a specified directory. Returns a JSON summary of errors, warnings, and code references.     |
+| `validate_snippet`  | `code` (string), `type` (xml/dwl) | quickly validates a small chunk of code without a full project structure. Useful for agents generating code on the fly. |
+| `get_rule_details`  | `ruleId` (string)                 | Returns the full documentation, examples, and rationale for a specific rule (e.g., `MULE-001`).                         |
 
 ### 2. Resources
+
 Resources allow the agent to read context.
 
-| Resource URI | Description |
-| :--- | :--- |
-| `mule-lint://rules` | A JSON list of all registered rules, their categories, and severity levels. |
-| `mule-lint://config/schema` | The JSON schema for `.mule-lintrc` to help agents author valid configurations. |
-| `mule-lint://docs/{slug}` | Access internal documentation (e.g., `best-practices`, `architecture`, `naming`). |
+| Resource URI                | Description                                                                       |
+| :-------------------------- | :-------------------------------------------------------------------------------- |
+| `mule-lint://rules`         | A JSON list of all registered rules, their categories, and severity levels.       |
+| `mule-lint://config/schema` | The JSON schema for `.mule-lintrc` to help agents author valid configurations.    |
+| `mule-lint://docs/{slug}`   | Access internal documentation (e.g., `best-practices`, `architecture`, `naming`). |
 
 ### 3. Prompts
+
 Pre-defined prompts to help users interacting with the agent.
 
-| Prompt Name | Description |
-| :--- | :--- |
-| `analyze_current_project` | "Run a comprehensive analysis on this project and summarize the top 3 critical issues." |
-| `explain_violation` | "Here is an error I found: {{ErrorString}}. Explain why this is bad and how to fix it using `get_rule_details`." |
+| Prompt Name               | Description                                                                                                      |
+| :------------------------ | :--------------------------------------------------------------------------------------------------------------- |
+| `analyze_current_project` | "Run a comprehensive analysis on this project and summarize the top 3 critical issues."                          |
+| `explain_violation`       | "Here is an error I found: {{ErrorString}}. Explain why this is bad and how to fix it using `get_rule_details`." |
 
 ## Implementation Phases
 
 ### Phase 1: Foundation (The "Reader" Agent)
+
 > [!NOTE]
 > **Status**: Completed. Available on NPM as `@sfdxy/mule-lint`.
 
-*Goal: Allow an agent to see what rules exist and run a scan.*
+_Goal: Allow an agent to see what rules exist and run a scan._
+
 - [x] Install `@modelcontextprotocol/sdk`.
 - [x] Create `McpServer` class in `src/mcp/index.ts`.
 - [x] Implement `mule-lint://rules` resource.
@@ -52,28 +60,34 @@ Pre-defined prompts to help users interacting with the agent.
 - [x] Add `stdio` transport for local running.
 
 ### Phase 2: Interactive Context (The "Helper" Agent)
+
 > [!NOTE]
 > **Status**: Completed.
 
 *Goal: Allow the agent to understand *why* things failed.*
+
 - [x] Implement `get_rule_details` tool.
 - [x] Expose internal documentation of rules via MCP.
 - [x] Add `validate_snippet` for real-time code generation checks.
 
 ### Phase 3: Remediation (The "Fixer" Agent)
+
 > [!NOTE]
 > **Status**: Partially Completed. `apply_fix` deferred. Enhanced reporting added.
 
-*Goal: Allow the agent to automatically fix issues.*
+_Goal: Allow the agent to automatically fix issues._
+
 - [ ] Implement `apply_fix` tool (Deferred: requires AST write support).
 - [x] Enhanced error reporting with precise range/location data (Added column/suggestion).
 
 ## Libraries & Dependencies
-*   **Core**: `@modelcontextprotocol/sdk`
-*   **Transport**: Stdio (standard input/output) for local CLI integration.
-*   **Runtime**: Node.js (uses existing project runtime).
+
+- **Core**: `@modelcontextprotocol/sdk`
+- **Transport**: Stdio (standard input/output) for local CLI integration.
+- **Runtime**: Node.js (uses existing project runtime).
 
 ## Agent Workflow Example
+
 1.  **Discovery**: Agent connects and reads `mule-lint://rules` to know what it is looking for.
 2.  **Action**: User asks "Check my code". Agent calls `run_lint_analysis(cwd)`.
 3.  **Context**: Agent sees error `DW-004`. Agent calls `get_rule_details("DW-004")` to read the "Java 17 DataWeave" docs.

package/package.json

@@ -1,75 +1,86 @@
 {
-    "name": "@sfdxy/mule-lint",
-    "version": "1.18.1",
-    "description": "Static analysis tool for MuleSoft applications - supports humans, AI agents, and CI/CD pipelines",
-    "author": "Avinava",
-    "license": "MIT",
-    "keywords": [
-        "mulesoft",
-        "mule",
-        "lint",
-        "static-analysis",
-        "xml",
-        "sarif",
-        "cli"
-    ],
-    "bin": {
-        "mule-lint": "./dist/bin/mule-lint.js",
-        "mule-lint-mcp": "./dist/bin/mule-lint-mcp.js"
-    },
-    "main": "./dist/index.js",
-    "types": "./dist/index.d.ts",
-    "files": [
-        "dist",
-        "README.md",
-        "LICENSE",
-        "docs"
-    ],
-    "scripts": {
-        "build": "tsc",
-        "build:watch": "tsc --watch",
-        "test": "NODE_OPTIONS='--experimental-vm-modules' jest",
-        "test:watch": "NODE_OPTIONS='--experimental-vm-modules' jest --watch",
-        "test:coverage": "NODE_OPTIONS='--experimental-vm-modules' jest --coverage",
-        "lint": "eslint src/ --ext .ts",
-        "lint:fix": "eslint src/ --ext .ts --fix",
-        "format": "prettier --write \"src/**/*.{ts,js,json,md}\"",
-        "clean": "rm -rf dist",
-        "prepublishOnly": "npm run clean && npm run build && npm test",
-        "release": "git tag v$(node -p 'require(\"./package.json\").version') && git push origin v$(node -p 'require(\"./package.json\").version')"
-    },
-    "dependencies": {
-        "@modelcontextprotocol/sdk": "^1.25.2",
-        "@prettier/plugin-xml": "^3.4.2",
-        "@xmldom/xmldom": "^0.8.10",
-        "chalk": "^4.1.2",
-        "commander": "^11.1.0",
-        "fast-glob": "^3.3.2",
-        "js-yaml": "^4.1.1",
-        "prettier": "^3.8.1",
-        "xpath": "^0.0.34",
-        "zod": "^3.25.0"
-    },
-    "devDependencies": {
-        "@types/jest": "^29.5.11",
-        "@types/js-yaml": "^4.0.9",
-        "@types/node": "^20.19.27",
-        "@typescript-eslint/eslint-plugin": "^6.15.0",
-        "@typescript-eslint/parser": "^6.15.0",
-        "eslint": "^8.56.0",
-        "jest": "^29.7.0",
-        "ts-jest": "^29.1.1",
-        "typescript": "^5.3.3"
-    },
-    "engines": {
-        "node": ">=18.0.0"
-    },
-    "repository": {
-        "type": "git",
-        "url": "https://github.com/Avinava/mule-lint.git"
-    },
-    "bugs": {
-        "url": "https://github.com/Avinava/mule-lint/issues"
-    },
-    "homepage": "https://github.com/Avinava/mule-lint#readme"
+  "name": "@sfdxy/mule-lint",
+  "version": "1.19.0",
+  "description": "Static analysis tool for MuleSoft applications - supports humans, AI agents, and CI/CD pipelines",
+  "author": "Avinava",
+  "license": "MIT",
+  "keywords": [
+    "mulesoft",
+    "mule",
+    "lint",
+    "static-analysis",
+    "xml",
+    "sarif",
+    "cli"
+  ],
+  "bin": {
+    "mule-lint": "./dist/bin/mule-lint.js",
+    "mule-lint-mcp": "./dist/bin/mule-lint-mcp.js"
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE",
+    "docs"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "build:watch": "tsc --watch",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run",
+    "test:watch": "vitest watch",
+    "test:coverage": "vitest run --coverage",
+    "lint": "eslint 'src/**/*.ts'",
+    "lint:unused": "knip",
+    "format": "prettier --write \"src/**/*.{ts,js,json,md}\"",
+    "prettier:check": "prettier --check '**/*.{ts,js,json,md,yml}'",
+    "prettier:fix": "prettier --write '**/*.{ts,js,json,md,yml}'",
+    "clean": "rm -rf dist",
+    "prepublishOnly": "npm run clean && npm run build && npm test",
+    "release": "git tag v$(node -p 'require(\"./package.json\").version') && git push origin v$(node -p 'require(\"./package.json\").version')",
+    "prepare": "lefthook install"
+  },
+  "lint-staged": {
+    "*.{ts,tsx,js,jsx,mjs,cjs,json,md,css,html,yml,yaml}": "prettier --write"
+  },
+  "dependencies": {
+    "@modelcontextprotocol/sdk": "^1.25.2",
+    "@prettier/plugin-xml": "^3.4.2",
+    "@xmldom/xmldom": "^0.8.10",
+    "chalk": "^4.1.2",
+    "commander": "^11.1.0",
+    "fast-glob": "^3.3.2",
+    "js-yaml": "^4.1.1",
+    "prettier": "^3.8.1",
+    "xpath": "^0.0.34",
+    "zod": "^3.25.0"
+  },
+  "devDependencies": {
+    "@commitlint/cli": "^19.0.0",
+    "@commitlint/config-conventional": "^19.0.0",
+    "@types/js-yaml": "^4.0.9",
+    "@types/node": "^20.19.27",
+    "eslint": "^9.0.0",
+    "eslint-config-prettier": "^10.0.0",
+    "knip": "^5.0.0",
+    "lefthook": "^1.10.0",
+    "lint-staged": "^15.0.0",
+    "publint": "^0.3.0",
+    "typescript": "^5.7.0",
+    "typescript-eslint": "^8.0.0",
+    "vitest": "^3.0.0"
+  },
+  "engines": {
+    "node": ">=20.0.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Avinava/mule-lint.git"
+  },
+  "bugs": {
+    "url": "https://github.com/Avinava/mule-lint/issues"
+  },
+  "homepage": "https://github.com/Avinava/mule-lint#readme"
 }