你的第一个原生插件

在站点旁边创建一个原生包目录。

mkdir -p ../plugin-activity/src
cd ../plugin-activity

添加包元数据和构建脚本。

{
    "name": "@example/plugin-activity",
    "version": "0.1.0",
    "type": "module",
    "main": "./dist/index.mjs",
    "exports": {
        ".": {
            "types": "./dist/index.d.mts",
            "import": "./dist/index.mjs"
        }
    },
    "files": ["dist"],
    "scripts": {
        "build": "tsdown src/index.ts --format esm --dts --clean",
        "dev": "tsdown src/index.ts --format esm --dts --watch",
        "typecheck": "tsc --noEmit"
    },
    "peerDependencies": {
        "emdash": "*"
    },
    "devDependencies": {
        "emdash": "*",
        "tsdown": "^0.20.0",
        "typescript": "^5.9.0"
    }
}

npm 包名称是 @example/plugin-activity。下面的运行时代码使用不带作用域的插件 ID plugin-activity，以便它能放入插件 API 路由的 URL 中。

添加 TypeScript 配置。

{
    "compilerOptions": {
        "target": "ES2022",
        "module": "preserve",
        "moduleResolution": "bundler",
        "strict": true,
        "esModuleInterop": true,
        "declaration": true,
        "outDir": "./dist",
        "rootDir": "./src"
    },
    "include": ["src/**/*"],
    "exclude": ["node_modules", "dist"]
}

安装包的依赖。

pnpm install

创建带有内容保存钩子的 src/index.ts。

import { definePlugin } from "emdash";
import type { PluginDescriptor } from "emdash";

export interface ActivityPluginOptions {
    logUpdates?: boolean;
}

export function activityPlugin(
    options: ActivityPluginOptions = {},
): PluginDescriptor<ActivityPluginOptions> {
    return {
        id: "plugin-activity",
        version: "0.1.0",
        format: "native",
        entrypoint: "@example/plugin-activity",
        options,
    };
}

export function createPlugin(options: ActivityPluginOptions = {}) {
    return definePlugin({
        id: "plugin-activity",
        version: "0.1.0",
        capabilities: ["content:read"],
        hooks: {
            "content:afterSave": async (event, ctx) => {
                if (!event.isNew && options.logUpdates === false) return;

                ctx.log.info("Content saved", {
                    collection: event.collection,
                    contentId: event.content.id,
                    isNew: event.isNew,
                });
            },
        },
    });
}

export default createPlugin;

content:afterSave 需要 content:read 能力。缺少该能力时，EmDash 会跳过该钩子。

构建该包。

pnpm build

在站点中安装本地包。

cd ../my-emdash-site
pnpm add ../plugin-activity

在 EmDash 集成中注册描述符工厂。

import { defineConfig } from "astro/config";
import emdash from "emdash/astro";
import { activityPlugin } from "@example/plugin-activity";

export default defineConfig({
    integrations: [
        emdash({
            plugins: [activityPlugin({ logUpdates: true })],
        }),
    ],
});

原生描述符应放在 plugins 中，而不是 sandboxed 中。如果 sandboxed 数组中出现原生描述符，EmDash 会拒绝它。

启动站点，并在管理面板中保存一个条目。

pnpm dev

服务器日志会包含 Content saved，以及集合、内容 ID 和该条目是否为新建。