@posthog/wizard
Version:
The PostHog wizard helps you to configure your project
153 lines • 6.87 kB
JavaScript
;
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || (function () {
var ownKeys = function(o) {
ownKeys = Object.getOwnPropertyNames || function (o) {
var ar = [];
for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
return ar;
};
return ownKeys(o);
};
return function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
__setModuleDefault(result, mod);
return result;
};
})();
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.runReactRouterWizardAgent = runReactRouterWizardAgent;
const debug_1 = require("../utils/debug");
const agent_runner_1 = require("../lib/agent-runner");
const constants_1 = require("../lib/constants");
const package_json_1 = require("../utils/package-json");
const clack_utils_1 = require("../utils/clack-utils");
const clack_1 = __importDefault(require("../utils/clack"));
const chalk_1 = __importDefault(require("chalk"));
const semver = __importStar(require("semver"));
const utils_1 = require("./utils");
/**
* React Router framework configuration for the universal agent runner.
*/
const MINIMUM_REACT_ROUTER_VERSION = '6.0.0';
const REACT_ROUTER_AGENT_CONFIG = {
metadata: {
name: 'React Router',
integration: constants_1.Integration.reactRouter,
docsUrl: 'https://posthog.com/docs/libraries/react',
unsupportedVersionDocsUrl: 'https://posthog.com/docs/libraries/react',
gatherContext: async (options) => {
const routerMode = await (0, utils_1.getReactRouterMode)(options);
return { routerMode };
},
},
detection: {
packageName: 'react-router',
packageDisplayName: 'React Router',
getVersion: (packageJson) => (0, package_json_1.getPackageVersion)('react-router', packageJson),
getVersionBucket: utils_1.getReactRouterVersionBucket,
},
environment: {
uploadToHosting: false,
getEnvVars: (apiKey, host) => ({
REACT_APP_POSTHOG_KEY: apiKey,
REACT_APP_POSTHOG_HOST: host,
}),
},
analytics: {
getTags: (context) => {
const routerMode = context.routerMode;
return {
routerMode: routerMode || 'unknown',
};
},
},
prompts: {
projectTypeDetection: 'This is a JavaScript/TypeScript project. Look for package.json and lockfiles (package-lock.json, yarn.lock, pnpm-lock.yaml, bun.lockb) to confirm.',
packageInstallation: 'Look for lockfiles to determine the package manager (npm, yarn, pnpm, bun). Do not manually edit package.json.',
getAdditionalContextLines: (context) => {
const routerMode = context.routerMode;
const modeName = routerMode
? (0, utils_1.getReactRouterModeName)(routerMode)
: 'unknown';
// Map router mode to framework ID for MCP docs resource
const frameworkIdMap = {
[utils_1.ReactRouterMode.V6]: 'react-react-router-6',
[utils_1.ReactRouterMode.V7_FRAMEWORK]: 'react-react-router-7-framework',
[utils_1.ReactRouterMode.V7_DATA]: 'react-react-router-7-data',
[utils_1.ReactRouterMode.V7_DECLARATIVE]: 'react-react-router-7-declarative',
};
const frameworkId = routerMode
? frameworkIdMap[routerMode]
: utils_1.ReactRouterMode.V7_FRAMEWORK;
return [
`Router mode: ${modeName}`,
`Framework docs ID: ${frameworkId} (use posthog://docs/frameworks/${frameworkId} for documentation)`,
];
},
},
ui: {
successMessage: 'PostHog integration complete',
estimatedDurationMinutes: 8,
getOutroChanges: (context) => {
const routerMode = context.routerMode;
const modeName = routerMode
? (0, utils_1.getReactRouterModeName)(routerMode)
: 'React Router';
return [
`Analyzed your React Router project structure (${modeName})`,
`Created and configured PostHog initializers`,
`Integrated PostHog into your application`,
];
},
getOutroNextSteps: () => [
'Start your development server to see PostHog in action',
'Visit your PostHog dashboard to see incoming events',
],
},
};
/**
* React Router wizard powered by the universal agent runner.
*/
async function runReactRouterWizardAgent(options) {
if (options.debug) {
(0, debug_1.enableDebugLogs)();
}
// Check React Router version - agent wizard requires >= 6.0.0
const packageJson = await (0, clack_utils_1.getPackageDotJson)(options);
const reactRouterVersion = (0, package_json_1.getPackageVersion)('react-router', packageJson);
if (reactRouterVersion) {
const coercedVersion = semver.coerce(reactRouterVersion);
if (coercedVersion &&
semver.lt(coercedVersion, MINIMUM_REACT_ROUTER_VERSION)) {
const docsUrl = REACT_ROUTER_AGENT_CONFIG.metadata.unsupportedVersionDocsUrl ??
REACT_ROUTER_AGENT_CONFIG.metadata.docsUrl;
clack_1.default.log.warn(`Sorry: the wizard can't help you with React Router ${reactRouterVersion}. Upgrade to React Router ${MINIMUM_REACT_ROUTER_VERSION} or later, or check out the manual setup guide.`);
clack_1.default.log.info(`Setup React Router manually: ${chalk_1.default.cyan(docsUrl)}`);
clack_1.default.outro('PostHog wizard will see you next time!');
return;
}
}
await (0, agent_runner_1.runAgentWizard)(REACT_ROUTER_AGENT_CONFIG, options);
}
//# sourceMappingURL=react-router-wizard-agent.js.map