@mdwrk/extension-manifest

Extension metadata and compatibility contract

This package defines the canonical MdWrk extension manifest shape, including capabilities, contributions, settings, integrity data, and compatibility declarations.

Why

Use it when you need to describe an extension package in a durable, host-agnostic way.

What

• Manifest structure for bundled and external extensions.
• Capability, contribution, settings, i18n, support, integrity, and distribution types.
• The package boundary consumed by extension packages, runtimes, and host validators.

Installation

Node.js 20.x through 22.x, matching the workspace engine contract in the root package manifest.

npm install @mdwrk/extension-manifest

Usage

import type { ExtensionManifest } from "@mdwrk/extension-manifest";

const manifest: ExtensionManifest = {
  manifestVersion: 1,
  id: "example.extension",
  packageName: "@scope/example-extension",
  version: "1.0.0",
  displayName: { defaultMessage: "Example Extension" },
  description: { defaultMessage: "Demonstrates the manifest contract." },
  kind: "bundled",
  icon: { kind: "lucide", name: "Plug" },
  enabledByDefault: true,
  capabilities: [],
  compatibility: { hostApi: "*", runtime: "*", themeContract: "*" },
  entry: { module: "./index.js" },
  contributions: {},
};

Related

• Packages index - family and package navigation
• Root README - repo overview