|
| 1 | +/* Elixir wizard using posthog-agent with PostHog MCP */ |
| 2 | +import * as fs from 'node:fs'; |
| 3 | +import * as path from 'node:path'; |
| 4 | +import type { WizardRunOptions } from '@utils/types'; |
| 5 | +import type { FrameworkConfig } from '@lib/framework-config'; |
| 6 | +import { mixPackageManager } from '@lib/detection/package-manager'; |
| 7 | +import { Integration } from '@lib/constants'; |
| 8 | + |
| 9 | +type ElixirContext = { |
| 10 | + phoenix?: boolean; |
| 11 | +}; |
| 12 | + |
| 13 | +function readMixExs(installDir: string): string | undefined { |
| 14 | + const mixExsPath = path.join(installDir, 'mix.exs'); |
| 15 | + if (!fs.existsSync(mixExsPath)) { |
| 16 | + return undefined; |
| 17 | + } |
| 18 | + return fs.readFileSync(mixExsPath, 'utf-8'); |
| 19 | +} |
| 20 | + |
| 21 | +/** Phoenix apps get the Plug integration; plain Elixir apps don't. */ |
| 22 | +function isPhoenixProject(installDir: string): boolean { |
| 23 | + const mixExs = readMixExs(installDir); |
| 24 | + return !!mixExs && /\{\s*:phoenix\s*,/.test(mixExs); |
| 25 | +} |
| 26 | + |
| 27 | +export const ELIXIR_AGENT_CONFIG: FrameworkConfig<ElixirContext> = { |
| 28 | + metadata: { |
| 29 | + name: 'Elixir', |
| 30 | + integration: Integration.elixir, |
| 31 | + docsUrl: 'https://posthog.com/docs/libraries/elixir', |
| 32 | + gatherContext: (options: WizardRunOptions) => { |
| 33 | + const phoenix = isPhoenixProject(options.installDir); |
| 34 | + return Promise.resolve({ phoenix }); |
| 35 | + }, |
| 36 | + }, |
| 37 | + |
| 38 | + detection: { |
| 39 | + packageName: 'posthog', |
| 40 | + packageDisplayName: 'Elixir', |
| 41 | + usesPackageJson: false, |
| 42 | + getVersion: () => undefined, |
| 43 | + // A mix.exs defining a project marks a Mix project root; the def project |
| 44 | + // check keeps stray files named mix.exs from claiming the directory. |
| 45 | + detect: (options) => { |
| 46 | + const mixExs = readMixExs(options.installDir); |
| 47 | + return Promise.resolve(!!mixExs && /def\s+project\b/.test(mixExs)); |
| 48 | + }, |
| 49 | + detectPackageManager: mixPackageManager, |
| 50 | + }, |
| 51 | + |
| 52 | + environment: { |
| 53 | + uploadToHosting: false, |
| 54 | + getEnvVars: (apiKey: string, host: string) => ({ |
| 55 | + POSTHOG_API_KEY: apiKey, |
| 56 | + POSTHOG_HOST: host, |
| 57 | + }), |
| 58 | + }, |
| 59 | + |
| 60 | + analytics: { |
| 61 | + getTags: (context) => ({ |
| 62 | + projectType: context.phoenix ? 'phoenix' : 'elixir', |
| 63 | + }), |
| 64 | + }, |
| 65 | + |
| 66 | + prompts: { |
| 67 | + projectTypeDetection: |
| 68 | + 'This is an Elixir project. Look for mix.exs, mix.lock, config/, lib/, and application.ex to confirm; Phoenix apps also have endpoint and router modules.', |
| 69 | + packageInstallation: |
| 70 | + 'Mix has no single add command. Add `{:posthog, "~> 2.0"}` to the deps list in mix.exs, then run `mix deps.get` to fetch it.', |
| 71 | + getAdditionalContextLines: (context) => { |
| 72 | + const lines = [ |
| 73 | + `Framework docs ID: elixir (use posthog://docs/frameworks/elixir for documentation)`, |
| 74 | + 'Configure PostHog in application config (api_key, api_host, in_app_otp_apps) reading from environment variables; set test_mode: true in the test environment.', |
| 75 | + ]; |
| 76 | + if (context.phoenix) { |
| 77 | + lines.push( |
| 78 | + 'This is a Phoenix app — add PostHog.Integrations.Plug before the router so request context is attached to captured events.', |
| 79 | + ); |
| 80 | + } |
| 81 | + return lines; |
| 82 | + }, |
| 83 | + }, |
| 84 | + |
| 85 | + ui: { |
| 86 | + successMessage: 'PostHog integration complete', |
| 87 | + estimatedDurationMinutes: 5, |
| 88 | + getOutroChanges: (context) => [ |
| 89 | + `Analyzed your ${ |
| 90 | + context.phoenix ? 'Phoenix' : 'Elixir' |
| 91 | + } project structure`, |
| 92 | + 'Added the posthog Hex package to mix.exs and fetched it with mix deps.get', |
| 93 | + 'Configured PostHog in application config from environment variables', |
| 94 | + 'Instrumented meaningful events with PostHog.capture', |
| 95 | + ], |
| 96 | + getOutroNextSteps: (context) => [ |
| 97 | + context.phoenix |
| 98 | + ? 'Start your Phoenix server with `mix phx.server` and trigger the instrumented code paths' |
| 99 | + : 'Run your Elixir application and trigger the instrumented code paths', |
| 100 | + 'Visit your PostHog dashboard to see incoming events', |
| 101 | + 'Use PostHog.capture/2 to track custom events', |
| 102 | + 'Use PostHog.set_context/1 to set a distinct_id once per request or job process', |
| 103 | + ], |
| 104 | + }, |
| 105 | +}; |
0 commit comments