`lib.audit`

Audit ecosystem packages for issues

MCPCLI

Package: @procedures/lib · README
Path: ["lib","audit"]
CLI: mark lib audit
MCP tool: lib.audit on the dev-tools server
As data: {"$proc":["lib","audit"],"input":{}}

Use it

In TypeScript

import { Client, LocalTransport, PROCEDURE_REGISTRY } from "@procedures/client";
import "@procedures/lib"; // registers its procedures

const client = new Client(new LocalTransport({ registry: PROCEDURE_REGISTRY }));
const result = await client.exec(["lib","audit"], {});
console.log(JSON.stringify(result));

From the command line

$ mark lib audit

As data, in a program

{ "$proc": ["lib", "audit"], "input": {} }

Input

Field	Type	Required	Default	Description
`rootPath`	`string`	no		Workspace root (defaults to the pnpm workspace that contains client-lib)
`fix`	`boolean`	no	`false`	Attempt to fix issues (create missing files/dirs)

Output

Field	Type	Required	Description
`success`	`boolean`	yes	True when every package passes the audit
`flagNotices`	`object[]`	yes	Procedure flags that hide a global flag of mark after the command path (information only)
`template`	`object`	yes	The template of the audit
`results`	`object[]`	yes	The result of each package
`summary`	`object`	yes	The counts

JSON Schemas

{
  "input": {
    "type": "object",
    "properties": {
      "rootPath": {
        "description": "Workspace root (defaults to the pnpm workspace that contains client-lib)",
        "type": "string"
      },
      "fix": {
        "default": false,
        "description": "Attempt to fix issues (create missing files/dirs)",
        "type": "boolean"
      }
    }
  },
  "output": {
    "type": "object",
    "properties": {
      "success": {
        "type": "boolean",
        "description": "True when every package passes the audit"
      },
      "flagNotices": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "procedure": {
              "type": "string",
              "description": "The procedure path, for example \"docker compose down\""
            },
            "flag": {
              "type": "string",
              "description": "The flag of the procedure, for example \"-v\""
            },
            "global": {
              "type": "string",
              "description": "The global flag of mark that it hides, for example \"-v (--version)\""
            }
          },
          "required": [
            "procedure",
            "flag",
            "global"
          ],
          "additionalProperties": {}
        },
        "description": "Procedure flags that hide a global flag of mark after the command path (information only)"
      },
      "template": {
        "type": "object",
        "properties": {
          "files": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "The files that each package needs"
          },
          "dirs": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "The folders that each package needs"
          }
        },
        "required": [
          "files",
          "dirs"
        ],
        "additionalProperties": {},
        "description": "The template of the audit"
      },
      "results": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "name": {
              "type": "string",
              "description": "The package name"
            },
            "path": {
              "type": "string",
              "description": "The package folder"
            },
            "valid": {
              "type": "boolean",
              "description": "True when the package passes"
            },
            "missingFiles": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "description": "The required files that are missing"
            },
            "missingDirs": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "description": "The required folders that are missing"
            },
            "pnpmIssues": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "type": {
                    "type": "string",
                    "enum": [
                      "npm-lockfile",
                      "package-lockfile",
                      "ignored-pnpm-field",
                      "not-workspace-link"
                    ],
                    "description": "The kind of pnpm problem"
                  },
                  "message": {
                    "type": "string",
                    "description": "The problem"
                  },
                  "package": {
                    "description": "The dependency that the problem is about",
                    "type": "string"
                  }
                },
                "required": [
                  "type",
                  "message"
                ],
                "additionalProperties": {}
              },
              "description": "The pnpm configuration problems"
            },
            "fixedFiles": {
              "description": "The files that fix made",
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "fixedDirs": {
              "description": "The folders that fix made",
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          "required": [
            "name",
            "path",
            "valid",
            "missingFiles",
            "missingDirs",
            "pnpmIssues"
          ],
          "additionalProperties": {}
        },
        "description": "The result of each package"
      },
      "summary": {
        "type": "object",
        "properties": {
          "total": {
            "type": "number",
            "description": "The number of packages"
          },
          "valid": {
            "type": "number",
            "description": "The number of packages that pass"
          },
          "invalid": {
            "type": "number",
            "description": "The number of packages that fail"
          }
        },
        "required": [
          "total",
          "valid",
          "invalid"
        ],
        "additionalProperties": {},
        "description": "The counts"
      }
    },
    "required": [
      "success",
      "flagNotices",
      "template",
      "results",
      "summary"
    ],
    "additionalProperties": {}
  }
}