Skip to main content

adding-framework-support

Add or extend language and framework support in the PostHog wizard, including detection, framework configuration, registration, and matching context-mill content.

Informations de source

Dépôt
PostHog/wizard
Dernière activité de la source
5 octobre 2026 à 09:50
Langue détectée de SKILL.md
anglais
Étoiles
197
Forks
52

Options d'installation

Le prompt qui vérifie d'abord la source est sélectionné par défaut. Vous pouvez passer à une commande directe ou télécharger une copie locale.

Vérifiez les fichiers source

Lisez SKILL.md et les fichiers associés affichés par SkillsMP avant de décider de l'installer.

Affichage de SKILL.md

SKILL.md
Instructions source · Aperçu en lecture seule
name
adding-framework-support
description
Add or extend language and framework support in the PostHog wizard, including detection, framework configuration, registration, and matching context-mill content.
compatibility
Designed for coding agents working on the PostHog wizard codebase.
metadata
{"author":"posthog","version":"2.1"}
# Adding Framework Support Read [wizard-development](../wizard-development/SKILL.md) for the shared design policy and gateway contract. New agent work uses Pi and prefers the orchestrator; adding a framework extends the integration program without creating its own runner or changing existing routing defaults. ## Extend the framework configuration Start with [FrameworkConfig](../../../src/programs/framework-config.ts) and a nearby example under [src/programs/frameworks](../../../src/programs/frameworks/). Framework-specific detection, context, environment conventions, and UI metadata belong here. Integration instructions and examples belong in context-mill. 1. Add the integration to [Integration](../../../src/shared/constants.ts). Its order controls first-match detection and the framework picker. Keep specific frameworks before language fallbacks and generic Node last; preserve the overlap rules in the [detection checks](../../../src/programs/detection/__tests__/framework.test.ts). 2. Add the config under `src/programs/frameworks/<name>/<name>-wizard-agent.ts`. Use a `type` for framework context so it satisfies `Record<string, unknown>`. Export the config; the integration program already supplies execution. 3. Import the config into [FRAMEWORK_REGISTRY](../../../src/programs/frameworks/registry.ts). `metadata.name` is the framework's label once detection or the picker settles it. Read the current interface for the complete required fields. In particular, `detection.detectPackageManager` is required: reuse an adapter from [package-manager detection](../../../src/programs/detection/package-manager.ts). Use `metadata.setup.questions` for unresolved project variants; `metadata.gatherContext` collects framework context. When the gathered context names a more specific variant, return its label from `metadata.getDetectedFrameworkLabel(context)`; detection sets the label through its context. Framework configs never use the UI. Optional notices and extra MCP servers also belong in metadata. Use `usesPackageJson: false` for frameworks without a package.json dependency. Their required `getVersion` callback can return `undefined`. Minimum-version checking requires both `minimumVersion` and `getInstalledVersion`; unknown versions pass. [Context detection](../../../src/programs/detection/context.ts) returns unsupported-version data for the integration UI rather than aborting itself. ## Detection and examples | Starting point | Pattern to reuse | | ------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | | [Next.js](../../../src/programs/frameworks/nextjs/) | `hasDeclaredDependency` from `utils/package-json`, `tryGetPackageJson` from `utils/setup-utils`, and router setup questions | | [Django](../../../src/programs/frameworks/django/) | Python project files, context gathering, and Python package-manager detection | | [Laravel](../../../src/programs/frameworks/laravel/) | Composer and framework-specific filesystem signals | | [Rails](../../../src/programs/frameworks/rails/) | Gemfile detection and Ruby conventions | Use [bounded filesystem helpers](../../../src/shared/utils/bounded-fs.ts) for project scans and reads. They bound traversal and skip dependency/build directories; add framework-specific exclusions with `extraIgnore`. Keep complex parsers and detectors beside the config so they can be checked independently. ## Complete the content side Ensure [context-mill](https://github.com/PostHog/context-mill) supplies the matching integration reference and task-skill variants for the framework. A registry entry alone does not provide integration knowledge. The orchestrator resolves framework variants from the skill menu and rejects missing task variants; see the [orchestrator runner](../../../src/agent/runner/sequence/orchestrator/orchestrator-runner.ts). Keep project-specific facts in configuration and reusable integration guidance in that content. Model IDs, reasoning efforts, and gateway-required system prompts follow the cross-repo contract in [wizard-development](../wizard-development/SKILL.md); a framework config cannot enable a new gateway model. ## Verify the changed behavior Check detection against the target framework and the closest overlapping framework/fallback. Reuse the existing detection checks; add a focused case only for behavior they do not cover. Confirm package-manager selection and matching context-mill variants. For an end-to-end run, use a disposable test app and the [exploration guide](../exploring-the-wizard/SKILL.md). For prompt, environment-upload, or outro changes, inspect the current [integration program](../../../src/programs/posthog-integration/) and the selected sequence. `ui.getOutroNextSteps` and `analytics.getEventProperties` have no consumer. Linear post-run/outro hooks are not shared by the orchestrator; see the [program guide](../adding-skill-program/SKILL.md). Use the proportionate validation guidance in [wizard-development](../wizard-development/SKILL.md). Documentation-only changes need source/link checks, not an agent run.
Voir sur GitHub