安装
$
genpm add @core/site你将获得
- 源代码位于 src/lib/site/,共 10 个文件。 (19.3 kB)
- AI 规则位于 src/lib/site/AGENTS.md,另附 IDE 规则文件。
- 添加到 .env.example 的环境变量:SITE_URL, SITE_REDIRECT_HOSTS。
- 自动为你解析 @core/content, @core/contracts, @core/db。
README
此包没有 README。
约 583 个 token→ src/lib/site/AGENTS.md→ .cursor/rules/genpm-core-site.mdc
这正是你的 AI 在 src/lib/site 中工作时读取的内容。不会向其上下文添加其他任何内容。
@core/site — rules for AI agents
Purpose
What every site has: settings (name, logo, contact, social profiles, legal page paths) as a @core/content singleton,
editable menus up to 3 levels as a content collection (slug = location: header, footer), and redirects managed
from the admin with loop detection, safe targets (site paths or https to allowed hosts) and hit counters.
No page content, no SEO tags (@core/seo reads these settings).
Map
index.ts— public API:getSiteSettings,getMenu,upsertRedirect(byfrom),updateRedirect(by id),resolveRedirect,redirectResponse,siteAdminResources.content.ts—siteSettings,menusand their schemas.redirects.ts— redirect logic.links.ts— link validation.adapters/hono.ts—redirectMiddleware.adapters/next.ts—redirectFor(req).
Integration
- Env:
SITE_URL(https://example.com), optionalSITE_REDIRECT_HOSTS(comma-separated external hosts allowed as redirect targets). Migrations as insrc/lib/db/AGENTS.md. - Import this module once at startup (it registers the
site_settingsandmenuscontent definitions). - Seed initial values with
seedEntry(@core/content): settings and theheader/footermenus, using the site's current ones. - Render:
const settings = await getSiteSettings({ locale }),const items = await getMenu('header', { locale }). - Redirects: Hono
app.use(redirectMiddleware); Next.jsmiddleware.tswithruntime: 'nodejs'callingredirectFor(req). - Add
...siteAdminResources()tosrc/genpm/admin.ts. - Verify: create a redirect
/old → /newand request/old(301 to/new).
Conventions
- Menu links are site paths,
https://,mailto:ortel:; open external links withrel="noopener". - Redirect sources are exact paths without query; the incoming query string is preserved.
- Permissions:
site_settings:*,menus:*,redirects:read|create|update|delete.
Don't
- Don't hardcode the site name, logo or menus in components once this module is installed.
- Don't build redirects from user input; only from the admin through
upsertRedirect/updateRedirect. Editing changes that row by id and fails withinvalid_path(422) if the newfrombelongs to another redirect. - Don't put legal text here; only the paths of the legal pages.
# @core/site — rules for AI agents
## Purpose
What every site has: settings (name, logo, contact, social profiles, legal page paths) as a @core/content singleton,
editable menus up to 3 levels as a content collection (slug = location: `header`, `footer`), and redirects managed
from the admin with loop detection, safe targets (site paths or https to allowed hosts) and hit counters.
No page content, no SEO tags (@core/seo reads these settings).
## Map
- `index.ts` — public API: `getSiteSettings`, `getMenu`, `upsertRedirect` (by `from`), `updateRedirect` (by id), `resolveRedirect`, `redirectResponse`, `siteAdminResources`.
- `content.ts` — `siteSettings`, `menus` and their schemas. `redirects.ts` — redirect logic. `links.ts` — link validation.
- `adapters/hono.ts` — `redirectMiddleware`. `adapters/next.ts` — `redirectFor(req)`.
## Integration
1. Env: `SITE_URL` (`https://example.com`), optional `SITE_REDIRECT_HOSTS` (comma-separated external hosts allowed as redirect targets). Migrations as in `src/lib/db/AGENTS.md`.
2. Import this module once at startup (it registers the `site_settings` and `menus` content definitions).
3. Seed initial values with `seedEntry` (@core/content): settings and the `header`/`footer` menus, using the site's current ones.
4. Render: `const settings = await getSiteSettings({ locale })`, `const items = await getMenu('header', { locale })`.
5. Redirects: Hono `app.use(redirectMiddleware)`; Next.js `middleware.ts` with `runtime: 'nodejs'` calling `redirectFor(req)`.
6. Add `...siteAdminResources()` to `src/genpm/admin.ts`.
7. Verify: create a redirect `/old → /new` and request `/old` (301 to `/new`).
## Conventions
- Menu links are site paths, `https://`, `mailto:` or `tel:`; open external links with `rel="noopener"`.
- Redirect sources are exact paths without query; the incoming query string is preserved.
- Permissions: `site_settings:*`, `menus:*`, `redirects:read|create|update|delete`.
## Don't
- Don't hardcode the site name, logo or menus in components once this module is installed.
- Don't build redirects from user input; only from the admin through `upsertRedirect` / `updateRedirect`. Editing changes that row by id and fails with `invalid_path` (422) if the new `from` belongs to another redirect.
- Don't put legal text here; only the paths of the legal pages.
应用 .genpmignore 后将被注入的确切目录树。固定于
// Ajustes del sitio (singleton) y menús (colección; el slug es la ubicación: header, footer…) sobre @core/content.
import { z } from 'zod';
import type { AdminField } from '../contracts/index.ts';
import { defineCollection, defineSingleton, getEntry, getSingleton } from '../content/index.ts';
import { isSafeLink } from './links.ts';
const Link = z.string().max(500).refine(isSafeLink, 'Use a site path (/about), an https:// URL, mailto: or tel:');
export const SocialPlatforms = ['facebook', 'instagram', 'x', 'tiktok', 'youtube', 'linkedin', 'pinterest', 'github', 'whatsapp', 'other'] as const;
export const SiteSettingsSchema = z.object({
name: z.string().min(1).max(120),
tagline: z.string().max(200).optional(),
/** Claves de @core/media o URLs (logo, favicon, imagen social por defecto). */
logo: z.string().max(500).optional(),
favicon: z.string().max(500).optional(),
ogImage: z.string().max(500).optional(),
contactEmail: z.email().optional(),
phone: z.string().max(40).optional(),
address: z.string().max(300).optional(),
social: z.array(z.object({ platform: z.enum(SocialPlatforms), url: Link })).max(20).default([]),
/** Rutas de las páginas legales (las plantillas las ponen los kits; aquí solo se asignan). */
legal: z
.object({ privacy: Link.optional(), terms: Link.optional(), cookies: Link.optional(), imprint: Link.optional(), returns: Link.optional() })
.default({}),
});
export type SiteSettings = z.infer<typeof SiteSettingsSchema>;
export type MenuItem = { label: string; href: string; newTab?: boolean; children?: MenuItem[] };
const item = (depth: number): z.ZodType<MenuItem> =>
z.object({
label: z.string().min(1).max(80),
href: Link,
newTab: z.boolean().optional(),
...(depth > 1 ? { children: z.array(z.lazy(() => item(depth - 1))).max(30).optional() } : {}),
}) as z.ZodType<MenuItem>;
/** Hasta 3 niveles de anidamiento. */
export const MenuSchema = z.object({ items: z.array(item(3)).max(30).default([]) });
const settingsFields: AdminField[] = [
{ name: 'name', label: 'Site name', type: 'text', required: true },
{ name: 'tagline', label: 'Tagline', type: 'text' },
{ name: 'logo', label: 'Logo', type: 'media' },
{ name: 'favicon', label: 'Favicon', type: 'media' },
{ name: 'ogImage', label: 'Default social image', type: 'media' },
{ name: 'contactEmail', label: 'Contact email', type: 'email' },
{ name: 'phone', label: 'Phone', type: 'text' },
{ name: 'address', label: 'Address', type: 'textarea' },
{ name: 'social', label: 'Social profiles', type: 'json' },
{ name: 'legal', label: 'Legal pages', type: 'json' },
];
export const siteSettings = defineSingleton('site_settings', {
schema: SiteSettingsSchema,
label: { singular: 'Site settings', plural: 'Site settings' },
fields: settingsFields,
titleField: 'name',
});
export const menus = defineCollection('menus', {
schema: MenuSchema,
label: { singular: 'Menu', plural: 'Menus' },
fields: [{ name: 'items', label: 'Items', type: 'json', required: true }],
});
/** Ajustes publicados (o null si aún no se han guardado). */
export async function getSiteSettings(opts: { locale?: string; draft?: boolean } = {}): Promise<SiteSettings | null> {
return (await getSingleton<SiteSettings>('site_settings', opts))?.data ?? null;
}
/** Elementos del menú de una ubicación (`header`, `footer`…); vacío si no existe. */
export async function getMenu(location: string, opts: { locale?: string; draft?: boolean } = {}): Promise<MenuItem[]> {
return (await getEntry<{ items: MenuItem[] }>('menus', location, opts))?.data.items ?? [];
}
此包未声明 MCP 服务器。
| 版本 | 提交 | 发布时间 | 扫描 |
|---|---|---|---|
| 1.1.0 | b7c13fa | 6小时前 | 扫描通过 |
- npm
- zod ^4.0.0
- 建议
- GenPM 会给出 npm 命令建议,只有你同意时才会运行。
- 被以下包使用(2)
- @core/kit-cms ^1.0.0@core/seo ^1.0.0
- 扫描
- 扫描通过 · 0 个问题
- 提交
- v1.1.0 → b7c13fa9b316c9880bceb62d510ee9661a76ae08 · 获取后已校验
- 脚本
- 无。GenPM 从不运行包中的代码。
- 许可证
- MIT
- 质量
- 100/100
- 可识别的许可证已满足
- AGENTS.md 说明了用途已满足
- AGENTS.md 包含集成步骤已满足
- AGENTS.md 列出约定或禁止事项已满足
- 包含测试已满足
- 通过安全扫描已满足
- 最近 6 个月内发布已满足
- 已验证的发布者已满足
- 摘要和关键词已满足
- 举报
- 发现问题了吗?