diff --git a/src/lib/constants.ts b/src/lib/constants.ts index 27842e0e5..f54d9d36c 100644 --- a/src/lib/constants.ts +++ b/src/lib/constants.ts @@ -1,5 +1,3 @@ -import path from 'path'; - export enum Integration { nextjs = 'nextjs', } @@ -32,10 +30,6 @@ export interface Args { export const DEFAULT_URL = 'http://us.posthog.com'; export const ISSUES_URL = 'https://github.com/posthog/wizard/issues'; -export const INSTALL_DIR = path.join( - process.cwd(), - process.env.POSTHOG_WIZARD_INSTALL_DIR ?? '', -); export const CLOUD_URL = 'https://us.posthog.com'; export const DEFAULT_HOST_URL = 'https://us.i.posthog.com'; export const DUMMY_PROJECT_API_KEY = '_YOUR_POSTHOG_PROJECT_API_KEY_'; diff --git a/src/nextjs/docs.ts b/src/nextjs/docs.ts index 72efd80e5..c13aa2605 100644 --- a/src/nextjs/docs.ts +++ b/src/nextjs/docs.ts @@ -1,4 +1,4 @@ -import { getAssetHostFromHost } from './utils'; +import { getAssetHostFromHost, getUiHostFromHost } from './utils'; export const getNextjsAppRouterDocs = ({ host, @@ -9,26 +9,28 @@ export const getNextjsAppRouterDocs = ({ }) => { return ` ============================== -FILE: app/components/PostHogProvider.${language === 'typescript' ? 'tsx' : 'jsx' - } +FILE: PostHogProvider.${ + language === 'typescript' ? 'tsx' : 'jsx' + } (put it somewhere where client files are, like the components folder) +LOCATION: Wherever other providers are, or the components folder ============================== Changes: - Create a PostHogProvider component that will be imported into the layout file. Example: -------------------------------------------------- -'use client' +"use client" -import posthog from 'posthog-js' -import { PostHogProvider as PHProvider, usePostHog } from 'posthog-js/react' -import { Suspense, useEffect } from 'react' +import posthog from "posthog-js" +import { PostHogProvider as PHProvider, usePostHog } from "posthog-js/react" +import { Suspense, useEffect } from "react" import { usePathname, useSearchParams } from "next/navigation" export function PostHogProvider({ children }: { children: React.ReactNode }) { useEffect(() => { posthog.init(process.env.NEXT_PUBLIC_POSTHOG_KEY!, { api_host: "/ingest", - ui_host: process.env.NEXT_PUBLIC_POSTHOG_HOST, + ui_host: "${getUiHostFromHost(host)}", capture_pageview: false, // We capture pageviews manually capture_pageleave: true, // Enable pageleave capture }) @@ -55,7 +57,7 @@ function PostHogPageView() { if (search) { url += "?" + search } - posthog.capture('$pageview', { '$current_url': url }) + posthog.capture("$pageview", { "$current_url": url }) } }, [pathname, searchParams, posthog]) @@ -72,7 +74,8 @@ function SuspendedPostHogPageView() { -------------------------------------------------- ============================== -FILE: app/layout.${language === 'typescript' ? 'tsx' : 'jsx'} +FILE: layout.${language === 'typescript' ? 'tsx' : 'jsx'} +LOCATION: Wherever the root layout is ============================== Changes: - Import the PostHogProvider from the providers file and wrap the app in it. @@ -80,7 +83,7 @@ Changes: Example: -------------------------------------------------- // other imports -import { PostHogProvider } from './components/providers' +import { PostHogProvider } from "LOCATION_OF_POSTHOG_PROVIDER" export default function RootLayout({ children }) { return ( @@ -98,18 +101,19 @@ export default function RootLayout({ children }) { -------------------------------------------------- ============================== -FILE: app/lib/server/posthog.${language === 'typescript' ? 'ts' : 'js'} +FILE: posthog.${language === 'typescript' ? 'ts' : 'js'} +LOCATION: Wherever works best given the project structure ============================== Changes: - Initialize the PostHog Node.js client Example: -------------------------------------------------- -import { PostHog } from 'posthog-node' +import { PostHog } from "posthog-node" export default function PostHogClient() { const posthogClient = new PostHog(process.env.NEXT_PUBLIC_POSTHOG_KEY!, { - host: process.env.NEXT_PUBLIC_POSTHOG_HOST, + host: "${host}", flushAt: 1, flushInterval: 0, }) @@ -119,6 +123,7 @@ export default function PostHogClient() { ============================== FILE: next.config.{js,ts,mjs,cjs} +LOCATION: Wherever the root next config is ============================== Changes: - Add rewrites to the Next.js config to support PostHog, if there are existing rewrites, add the PostHog rewrites to them. @@ -160,7 +165,10 @@ export const getNextjsPagesRouterDocs = ({ }) => { return ` ============================== -FILE: pages/_app.${language === 'typescript' ? 'tsx' : 'jsx'} +FILE: _app.${language === 'typescript' ? 'tsx' : 'jsx'} +LOCATION: Wherever the root _app.${ + language === 'typescript' ? 'tsx' : 'jsx' + } file is ============================== Changes: - Initialize PostHog in _app.js. @@ -169,25 +177,26 @@ Changes: Example: -------------------------------------------------- -import { useEffect } from 'react' -import { Router } from 'next/router' -import posthog from 'posthog-js' -import { PostHogProvider } from 'posthog-js/react' +import { useEffect } from "react" +import { Router } from "next/router" +import posthog from "posthog-js" +import { PostHogProvider } from "posthog-js/react" export default function App({ Component, pageProps }) { useEffect(() => { posthog.init(process.env.NEXT_PUBLIC_POSTHOG_KEY, { - api_host: process.env.NEXT_PUBLIC_POSTHOG_HOST || 'https://us.i.posthog.com', + api_host: "/ingest", + ui_host: "${getUiHostFromHost(host)}", loaded: (posthog) => { - if (process.env.NODE_ENV === 'development') posthog.debug() + if (process.env.NODE_ENV === "development") posthog.debug() }, }) - const handleRouteChange = () => posthog?.capture('$pageview') - Router.events.on('routeChangeComplete', handleRouteChange) + const handleRouteChange = () => posthog?.capture("$pageview") + Router.events.on("routeChangeComplete", handleRouteChange) return () => { - Router.events.off('routeChangeComplete', handleRouteChange) + Router.events.off("routeChangeComplete", handleRouteChange) } }, []) @@ -200,18 +209,19 @@ export default function App({ Component, pageProps }) { -------------------------------------------------- ============================== -FILE: lib/server/posthog.${language === 'typescript' ? 'ts' : 'js'} +FILE: posthog.${language === 'typescript' ? 'ts' : 'js'} +LOCATION: Wherever works best given the project structure ============================== Changes: - Initialize the PostHog Node.js client for server-side tracking. Example: -------------------------------------------------- -import { PostHog } from 'posthog-node' +import { PostHog } from "posthog-node" export default function PostHogClient() { return new PostHog(process.env.NEXT_PUBLIC_POSTHOG_KEY!, { - host: process.env.NEXT_PUBLIC_POSTHOG_HOST, + host: "${host}", flushAt: 1, flushInterval: 0, }) @@ -220,6 +230,7 @@ export default function PostHogClient() { ============================== FILE: next.config.{js,ts,mjs,cjs} +LOCATION: Wherever the root next config is ============================== Changes: - Add rewrites to support PostHog tracking. @@ -231,8 +242,8 @@ const nextConfig = { async rewrites() { return [ { source: "/ingest/static/:path*", destination: "${getAssetHostFromHost( - host, - )}/static/:path*" }, + host, + )}/static/:path*" }, { source: "/ingest/:path*", destination: "${host}/:path*" }, { source: "/ingest/decide", destination: "${host}/decide" }, ] diff --git a/src/nextjs/nextjs-wizard.ts b/src/nextjs/nextjs-wizard.ts index 853e68357..43e903c90 100644 --- a/src/nextjs/nextjs-wizard.ts +++ b/src/nextjs/nextjs-wizard.ts @@ -17,7 +17,7 @@ import { runPrettierIfInstalled, } from '../utils/clack-utils'; import type { WizardOptions } from '../utils/types'; -import { traceStep, } from '../telemetry'; +import { traceStep } from '../telemetry'; import { getPackageVersion, hasPackageInstalled } from '../utils/package-json'; import { getNextJsRouter, @@ -33,14 +33,11 @@ import { query } from '../utils/query'; import clack from '../utils/clack'; import fg from 'fast-glob'; import path from 'path'; -import { INSTALL_DIR, Integration, ISSUES_URL } from '../lib/constants'; +import { Integration, ISSUES_URL } from '../lib/constants'; import { getNextjsAppRouterDocs, getNextjsPagesRouterDocs } from './docs'; import { Analytics } from '../utils/analytics'; - -export async function runNextjsWizard( - options: WizardOptions, -): Promise { +export async function runNextjsWizard(options: WizardOptions): Promise { const { telemetryEnabled, forceInstall } = options; printWelcome({ @@ -57,11 +54,11 @@ export async function runNextjsWizard( ); } - const typeScriptDetected = isUsingTypeScript(); + const typeScriptDetected = isUsingTypeScript(options); await confirmContinueIfNoOrDirtyGitRepo(); - const packageJson = await getPackageDotJson(); + const packageJson = await getPackageDotJson(options); await ensurePackageIsInstalled(packageJson, 'next', 'Next.js'); @@ -84,6 +81,7 @@ export async function runNextjsWizard( alreadyInstalled: !!packageJson?.dependencies?.['posthog-js'], forceInstall, askBeforeUpdating: false, + installDir: options.installDir, }); await installPackage({ @@ -93,11 +91,12 @@ export async function runNextjsWizard( alreadyInstalled: !!packageJson?.dependencies?.['posthog-node'], forceInstall, askBeforeUpdating: false, + installDir: options.installDir, }); - const router = await getNextJsRouter(); + const router = await getNextJsRouter(options); - const relevantFiles = await getRelevantFilesForNextJs(); + const relevantFiles = await getRelevantFilesForNextJs(options); const installationDocumentation = getInstallationDocumentation({ router, @@ -124,7 +123,7 @@ export async function runNextjsWizard( let oldContent = undefined; try { oldContent = await fs.promises.readFile( - path.join(INSTALL_DIR, filePath), + path.join(options.installDir, filePath), 'utf8', ); } catch (readError) { @@ -152,7 +151,7 @@ export async function runNextjsWizard( }); if (newContent !== oldContent) { - await updateFile({ filePath, oldContent, newContent }); + await updateFile({ filePath, oldContent, newContent }, options); changes.push({ filePath, oldContent, newContent }); } @@ -166,21 +165,22 @@ export async function runNextjsWizard( await addOrUpdateEnvironmentVariables({ projectApiKey, - host, + installDir: options.installDir, }); const packageManagerForOutro = - packageManagerFromInstallStep ?? (await getPackageManager()); + packageManagerFromInstallStep ?? (await getPackageManager(options)); - await runPrettierIfInstalled(); + await runPrettierIfInstalled(options); clack.outro(` -${chalk.green('Successfully installed PostHog!')} ${`\n\n${aiConsent +${chalk.green('Successfully installed PostHog!')} ${`\n\n${ + aiConsent ? `Note: This uses experimental AI to setup your project. It might have got it wrong, pleaes check!\n` : `` - }You should validate your setup by (re)starting your dev environment (e.g. ${chalk.cyan( - `${packageManagerForOutro.runScriptCommand} dev`, - )})`} + }You should validate your setup by (re)starting your dev environment (e.g. ${chalk.cyan( + `${packageManagerForOutro.runScriptCommand} dev`, + )})`} ${chalk.dim(`If you encounter any issues, let us know here: ${ISSUES_URL}`)}`); } @@ -210,7 +210,9 @@ async function askForAIConsent() { }); } -async function getRelevantFilesForNextJs() { +async function getRelevantFilesForNextJs({ + installDir, +}: Pick) { const filterPatterns = ['**/*.{tsx,ts,jsx,js,mjs,cjs}']; const ignorePatterns = [ 'node_modules', @@ -222,15 +224,17 @@ async function getRelevantFilesForNextJs() { ]; const filteredFiles = await fg(filterPatterns, { - cwd: INSTALL_DIR, + cwd: installDir, ignore: ignorePatterns, }); return filteredFiles; } -export async function detectNextJs(): Promise { - const packageJson = await getPackageDotJson(); +export async function detectNextJs( + options: Pick, +): Promise { + const packageJson = await getPackageDotJson(options); const hasNextInstalled = hasPackageInstalled('next', packageJson); @@ -327,11 +331,14 @@ async function generateFileChanges({ return response.newContent; } -async function updateFile(change: FileChange) { - const dir = path.dirname(path.join(INSTALL_DIR, change.filePath)); +async function updateFile( + change: FileChange, + { installDir }: Pick, +) { + const dir = path.dirname(path.join(installDir, change.filePath)); await fs.promises.mkdir(dir, { recursive: true }); await fs.promises.writeFile( - path.join(INSTALL_DIR, change.filePath), + path.join(installDir, change.filePath), change.newContent, ); } @@ -344,22 +351,22 @@ type FileChange = { export async function addOrUpdateEnvironmentVariables({ projectApiKey, - host, + installDir, }: { projectApiKey: string; - host: string; + installDir: string; }): Promise { - const envVarContent = `# Posthog\nNEXT_PUBLIC_POSTHOG_KEY=${projectApiKey}\nNEXT_PUBLIC_POSTHOG_HOST=${host}\n`; + const envVarContent = `# Posthog\nNEXT_PUBLIC_POSTHOG_KEY=${projectApiKey}`; - const dotEnvLocalFilePath = path.join(INSTALL_DIR, '.env.local'); - const dotEnvFilePath = path.join(INSTALL_DIR, '.env'); + const dotEnvLocalFilePath = path.join(installDir, '.env.local'); + const dotEnvFilePath = path.join(installDir, '.env'); const targetEnvFilePath = fs.existsSync(dotEnvLocalFilePath) ? dotEnvLocalFilePath : dotEnvFilePath; const dotEnvFileExists = fs.existsSync(targetEnvFilePath); - const relativeEnvFilePath = path.relative(INSTALL_DIR, targetEnvFilePath); + const relativeEnvFilePath = path.relative(installDir, targetEnvFilePath); if (dotEnvFileExists) { const dotEnvFileContent = fs.readFileSync(targetEnvFilePath, 'utf8'); @@ -367,11 +374,7 @@ export async function addOrUpdateEnvironmentVariables({ const hasProjectApiKey = dotEnvFileContent.includes( `NEXT_PUBLIC_POSTHOG_KEY=${projectApiKey}`, ); - const hasHost = dotEnvFileContent.includes( - `NEXT_PUBLIC_POSTHOG_HOST=${host}`, - ); - - if (hasProjectApiKey && hasHost) { + if (hasProjectApiKey) { clack.log.success( `${chalk.bold.cyan( relativeEnvFilePath, @@ -379,15 +382,20 @@ export async function addOrUpdateEnvironmentVariables({ ); } else { try { - const newContent = dotEnvFileContent - .replace( + let newContent = dotEnvFileContent; + + if (dotEnvFileContent.match(/^NEXT_PUBLIC_POSTHOG_KEY=.*$/m)) { + newContent = dotEnvFileContent.replace( /^NEXT_PUBLIC_POSTHOG_KEY=.*$/m, `NEXT_PUBLIC_POSTHOG_KEY=${projectApiKey}`, - ) - .replace( - /^NEXT_PUBLIC_POSTHOG_HOST=.*$/m, - `NEXT_PUBLIC_POSTHOG_HOST=${host}`, ); + } else { + if (!dotEnvFileContent.endsWith('\n')) { + newContent += '\n'; + } + newContent += envVarContent; + } + await fs.promises.writeFile(targetEnvFilePath, newContent, { encoding: 'utf8', flag: 'w', @@ -420,18 +428,19 @@ export async function addOrUpdateEnvironmentVariables({ clack.log.warning( `Failed to create ${chalk.bold.cyan( relativeEnvFilePath, - )} with environment variables for PostHog. Please add them manually. Error: ${error.message + )} with environment variables for PostHog. Please add them manually. Error: ${ + error.message }`, ); } } - const gitignorePath = getDotGitignore(); + const gitignorePath = getDotGitignore({ installDir }); if (gitignorePath) { const gitignoreContent = fs.readFileSync(gitignorePath, 'utf8'); const envFiles = ['.env', '.env.local']; - const missingEnvFiles = envFiles + const missingEnvFiles = envFiles; if (missingEnvFiles.length > 0) { try { @@ -459,7 +468,7 @@ export async function addOrUpdateEnvironmentVariables({ try { const newGitignoreContent = `.env\n.env.local\n`; await fs.promises.writeFile( - path.join(INSTALL_DIR, '.gitignore'), + path.join(installDir, '.gitignore'), newGitignoreContent, { encoding: 'utf8', @@ -479,8 +488,10 @@ export async function addOrUpdateEnvironmentVariables({ } } -export function getDotGitignore() { - const gitignorePath = path.join(INSTALL_DIR, '.gitignore'); +export function getDotGitignore({ + installDir, +}: Pick) { + const gitignorePath = path.join(installDir, '.gitignore'); const gitignoreExists = fs.existsSync(gitignorePath); if (gitignoreExists) { diff --git a/src/nextjs/utils.ts b/src/nextjs/utils.ts index 6890da33a..86a57a7d3 100644 --- a/src/nextjs/utils.ts +++ b/src/nextjs/utils.ts @@ -2,7 +2,7 @@ import { major, minVersion } from 'semver'; import fg from 'fast-glob'; import { abortIfCancelled } from '../utils/clack-utils'; import clack from '../utils/clack'; -import { INSTALL_DIR } from '../lib/constants'; +import type { WizardOptions } from '../utils/types'; export function getNextJsVersionBucket(version: string | undefined) { if (!version) { @@ -34,23 +34,37 @@ export const IGNORE_PATTERNS = [ '**/dist/**', '**/build/**', '**/public/**', -] -export async function getNextJsRouter(): Promise { - const pagesMatches = await fg('**/pages/_app.@(ts|tsx|js|jsx)', { dot: true, cwd: INSTALL_DIR, ignore: IGNORE_PATTERNS }); +]; +export async function getNextJsRouter({ + installDir, +}: Pick): Promise { + const pagesMatches = await fg('**/pages/_app.@(ts|tsx|js|jsx)', { + dot: true, + cwd: installDir, + ignore: IGNORE_PATTERNS, + }); const hasPagesDir = pagesMatches.length > 0; - const appMatches = await fg('**/app/**/layout.@(ts|tsx|js|jsx)', { dot: true, cwd: INSTALL_DIR, ignore: IGNORE_PATTERNS }); + const appMatches = await fg('**/app/**/layout.@(ts|tsx|js|jsx)', { + dot: true, + cwd: installDir, + ignore: IGNORE_PATTERNS, + }); const hasAppDir = appMatches.length > 0; if (hasPagesDir && !hasAppDir) { - clack.log.info(`Detected ${getNextJsRouterName(NextJsRouter.PAGES_ROUTER)} 📃`); + clack.log.info( + `Detected ${getNextJsRouterName(NextJsRouter.PAGES_ROUTER)} 📃`, + ); return NextJsRouter.PAGES_ROUTER; } if (hasAppDir && !hasPagesDir) { - clack.log.info(`Detected ${getNextJsRouterName(NextJsRouter.APP_ROUTER)} 📱`); + clack.log.info( + `Detected ${getNextJsRouterName(NextJsRouter.APP_ROUTER)} 📱`, + ); return NextJsRouter.APP_ROUTER; } @@ -58,10 +72,16 @@ export async function getNextJsRouter(): Promise { clack.select({ message: 'What router are you using?', options: [ - { label: getNextJsRouterName(NextJsRouter.APP_ROUTER), value: NextJsRouter.APP_ROUTER }, - { label: getNextJsRouterName(NextJsRouter.PAGES_ROUTER), value: NextJsRouter.PAGES_ROUTER }, + { + label: getNextJsRouterName(NextJsRouter.APP_ROUTER), + value: NextJsRouter.APP_ROUTER, + }, + { + label: getNextJsRouterName(NextJsRouter.PAGES_ROUTER), + value: NextJsRouter.PAGES_ROUTER, + }, ], - }) + }), ); return result; @@ -69,7 +89,7 @@ export async function getNextJsRouter(): Promise { export const getNextJsRouterName = (router: NextJsRouter) => { return router === NextJsRouter.APP_ROUTER ? 'app router' : 'pages router'; -} +}; export const getAssetHostFromHost = (host: string) => { if (host.includes('us.i.posthog.com')) { @@ -81,4 +101,16 @@ export const getAssetHostFromHost = (host: string) => { } return host; -} +}; + +export const getUiHostFromHost = (host: string) => { + if (host.includes('us.i.posthog.com')) { + return 'https://us.posthog.com'; + } + + if (host.includes('eu.i.posthog.com')) { + return 'https://eu.posthog.com'; + } + + return host; +}; diff --git a/src/run.ts b/src/run.ts index 203468799..d61ab215a 100644 --- a/src/run.ts +++ b/src/run.ts @@ -6,11 +6,13 @@ import { detectNextJs, runNextjsWizard } from './nextjs/nextjs-wizard'; import { getIntegrationDescription, Integration } from './lib/constants'; import { readEnvironment } from './utils/environment'; import clack from './utils/clack'; +import path from 'path'; type Args = { integration?: Integration; debug?: boolean; forceInstall?: boolean; + installDir?: string; }; export async function run(argv: Args) { const finalArgs = { @@ -18,18 +20,20 @@ export async function run(argv: Args) { ...readEnvironment(), }; - - clack.intro(`Welcome to the PostHog setup wizard ✨`); - - const integration = finalArgs.integration ?? await getIntegrationForSetup(); - - const wizardOptions: WizardOptions = { debug: finalArgs.debug ?? false, forceInstall: finalArgs.forceInstall ?? false, telemetryEnabled: false, + installDir: finalArgs.installDir + ? path.join(process.cwd(), finalArgs.installDir) + : process.cwd(), }; + clack.intro(`Welcome to the PostHog setup wizard ✨`); + + const integration = + finalArgs.integration ?? (await getIntegrationForSetup(wizardOptions)); + switch (integration) { case Integration.nextjs: await runNextjsWizard(wizardOptions); @@ -40,27 +44,28 @@ export async function run(argv: Args) { } } - -async function detectIntegration(): Promise { - - const detectors = [ - detectNextJs - ] +async function detectIntegration( + options: Pick, +): Promise { + const detectors = [detectNextJs]; for (const detector of detectors) { - const integration = await detector(); + const integration = await detector(options); if (integration) { return integration; } } } -async function getIntegrationForSetup() { - - const detectedIntegration = await detectIntegration(); +async function getIntegrationForSetup( + options: Pick, +) { + const detectedIntegration = await detectIntegration(options); if (detectedIntegration) { - clack.log.success(`Detected integration: ${getIntegrationDescription(detectedIntegration)}`); + clack.log.success( + `Detected integration: ${getIntegrationDescription(detectedIntegration)}`, + ); return detectedIntegration; } diff --git a/src/utils/clack-utils.ts b/src/utils/clack-utils.ts index b6d1c8aad..175ee1f9e 100644 --- a/src/utils/clack-utils.ts +++ b/src/utils/clack-utils.ts @@ -21,7 +21,6 @@ import { CLOUD_URL, DEFAULT_HOST_URL, DUMMY_PROJECT_API_KEY, - INSTALL_DIR, ISSUES_URL, } from '../lib/constants'; import { Analytics } from './analytics'; @@ -76,7 +75,6 @@ export function printWelcome(options: { message?: string; telemetryEnabled?: boolean; }): void { - // eslint-disable-next-line no-console console.log(''); clack.intro(chalk.inverse(` ${options.wizardName} `)); @@ -227,7 +225,7 @@ export async function confirmContinueIfPackageVersionNotSupported({ clack.note( note ?? - `Please upgrade to ${acceptableVersions} if you wish to use the PostHog Wizard.`, + `Please upgrade to ${acceptableVersions} if you wish to use the PostHog Wizard.`, ); const continueWithUnsupportedVersion = await abortIfCancelled( clack.confirm({ @@ -258,6 +256,7 @@ export async function installPackage({ packageNameDisplayLabel, packageManager, forceInstall = false, + installDir, }: { /** The string that is passed to the package manager CLI as identifier to install (e.g. `posthog-js`, or `posthog-js@^1.100.0`) */ packageName: string; @@ -268,6 +267,7 @@ export async function installPackage({ packageManager?: PackageManager; /** Add force install flag to command to skip install precondition fails */ forceInstall?: boolean; + installDir: string; }): Promise<{ packageManager?: PackageManager }> { return traceStep('install-package', async () => { if (alreadyInstalled && askBeforeUpdating) { @@ -286,7 +286,8 @@ export async function installPackage({ const sdkInstallSpinner = clack.spinner(); - const pkgManager = packageManager || (await getPackageManager()); + const pkgManager = + packageManager || (await getPackageManager({ installDir })); sdkInstallSpinner.start( `${alreadyInstalled ? 'Updating' : 'Installing'} ${chalk.bold.cyan( @@ -297,9 +298,10 @@ export async function installPackage({ try { await new Promise((resolve, reject) => { childProcess.exec( - `${pkgManager.installCommand} ${packageName} ${pkgManager.flags} ${forceInstall ? pkgManager.forceInstallFlag : '' + `${pkgManager.installCommand} ${packageName} ${pkgManager.flags} ${ + forceInstall ? pkgManager.forceInstallFlag : '' }`, - { cwd: INSTALL_DIR }, + { cwd: installDir }, (err, stdout, stderr) => { if (err) { // Write a log file so we can better troubleshoot issues @@ -345,7 +347,9 @@ export async function installPackage({ }); } -export async function runPrettierIfInstalled(): Promise { +export async function runPrettierIfInstalled({ + installDir, +}: Pick): Promise { return traceStep('run-prettier', async () => { if (!isInGitRepo()) { // We only run formatting on changed files. If we're not in a git repo, we can't find @@ -364,7 +368,7 @@ export async function runPrettierIfInstalled(): Promise { return; } - const packageJson = await getPackageDotJson(); + const packageJson = await getPackageDotJson({ installDir }); const prettierInstalled = hasPackageInstalled('prettier', packageJson); Analytics.setTag('prettier-installed', prettierInstalled); @@ -437,9 +441,11 @@ export async function ensurePackageIsInstalled( }); } -export async function getPackageDotJson(): Promise { +export async function getPackageDotJson({ + installDir, +}: Pick): Promise { const packageJsonFileContents = await fs.promises - .readFile(join(INSTALL_DIR, 'package.json'), 'utf8') + .readFile(join(installDir, 'package.json'), 'utf8') .catch(() => { clack.log.error( 'Could not find package.json. Make sure to run the wizard in the root of your app!', @@ -467,10 +473,11 @@ export async function getPackageDotJson(): Promise { export async function updatePackageDotJson( packageDotJson: PackageDotJson, + { installDir }: Pick, ): Promise { try { await fs.promises.writeFile( - join(INSTALL_DIR, 'package.json'), + join(installDir, 'package.json'), // TODO: maybe figure out the original indentation JSON.stringify(packageDotJson, null, 2), { @@ -485,8 +492,10 @@ export async function updatePackageDotJson( } } -export async function getPackageManager(): Promise { - const detectedPackageManager = detectPackageManger(); +export async function getPackageManager({ + installDir, +}: Pick): Promise { + const detectedPackageManager = detectPackageManger({ installDir }); if (detectedPackageManager) { return detectedPackageManager; @@ -508,9 +517,11 @@ export async function getPackageManager(): Promise { return selectedPackageManager; } -export function isUsingTypeScript() { +export function isUsingTypeScript({ + installDir, +}: Pick) { try { - return fs.existsSync(join(INSTALL_DIR, 'tsconfig.json')); + return fs.existsSync(join(installDir, 'tsconfig.json')); } catch { return false; } @@ -545,8 +556,8 @@ ${chalk.cyan(ISSUES_URL)}`); clack.log .info(`In the meantime, we'll add a dummy project API key (${chalk.cyan( - `"${DUMMY_PROJECT_API_KEY}"`, - )}) for you to replace later. + `"${DUMMY_PROJECT_API_KEY}"`, + )}) for you to replace later. You can find your Project API key here: ${chalk.cyan(`${CLOUD_URL}/settings/project#variables`)}`); } @@ -716,7 +727,8 @@ export async function showCopyPasteInstructions( hint?: string, ): Promise { clack.log.step( - `Add the following code to your ${chalk.cyan(basename(filename))} file:${hint ? chalk.dim(` (${chalk.dim(hint)})`) : '' + `Add the following code to your ${chalk.cyan(basename(filename))} file:${ + hint ? chalk.dim(` (${chalk.dim(hint)})`) : '' }`, ); @@ -796,6 +808,7 @@ export function makeCodeSnippet( export async function createNewConfigFile( filepath: string, codeSnippet: string, + { installDir }: Pick, moreInformation?: string, ): Promise { if (!isAbsolute(filepath)) { @@ -803,7 +816,7 @@ export async function createNewConfigFile( return false; } - const prettyFilename = chalk.cyan(relative(INSTALL_DIR, filepath)); + const prettyFilename = chalk.cyan(relative(installDir, filepath)); try { await fs.promises.writeFile(filepath, codeSnippet); diff --git a/src/utils/package-manager.ts b/src/utils/package-manager.ts index 8809cca59..0b0ec177e 100644 --- a/src/utils/package-manager.ts +++ b/src/utils/package-manager.ts @@ -3,8 +3,8 @@ import * as fs from 'fs'; import * as path from 'path'; import { traceStep } from '../telemetry'; import { getPackageDotJson, updatePackageDotJson } from './clack-utils'; -import { INSTALL_DIR } from '../lib/constants'; import { Analytics } from './analytics'; +import type { WizardOptions } from './types'; export interface PackageManager { name: string; @@ -15,8 +15,12 @@ export interface PackageManager { runScriptCommand: string; flags: string; forceInstallFlag: string; - detect: () => boolean; - addOverride: (pkgName: string, pkgVersion: string) => Promise; + detect: ({ installDir }: Pick) => boolean; + addOverride: ( + pkgName: string, + pkgVersion: string, + { installDir }: Pick, + ) => Promise; } export const BUN: PackageManager = { @@ -27,21 +31,28 @@ export const BUN: PackageManager = { runScriptCommand: 'bun run', flags: '', forceInstallFlag: '--force', - detect: () => + detect: ({ installDir }: Pick) => ['bun.lockb', 'bun.lock'].some((lockFile) => - fs.existsSync(path.join(INSTALL_DIR, lockFile)), + fs.existsSync(path.join(installDir, lockFile)), ), - addOverride: async (pkgName, pkgVersion): Promise => { - const packageDotJson = await getPackageDotJson(); + addOverride: async ( + pkgName, + pkgVersion, + { installDir }: Pick, + ): Promise => { + const packageDotJson = await getPackageDotJson({ installDir }); const overrides = packageDotJson.overrides || {}; - await updatePackageDotJson({ - ...packageDotJson, - overrides: { - ...overrides, - [pkgName]: pkgVersion, + await updatePackageDotJson( + { + ...packageDotJson, + overrides: { + ...overrides, + [pkgName]: pkgVersion, + }, }, - }); + { installDir: installDir }, + ); }, }; export const YARN_V1: PackageManager = { @@ -52,27 +63,34 @@ export const YARN_V1: PackageManager = { runScriptCommand: 'yarn', flags: '--ignore-workspace-root-check', forceInstallFlag: '--force', - detect: () => { + detect: ({ installDir }: Pick) => { try { return fs - .readFileSync(path.join(INSTALL_DIR, 'yarn.lock'), 'utf-8') + .readFileSync(path.join(installDir, 'yarn.lock'), 'utf-8') .slice(0, 500) .includes('yarn lockfile v1'); } catch (e) { return false; } }, - addOverride: async (pkgName, pkgVersion): Promise => { - const packageDotJson = await getPackageDotJson(); + addOverride: async ( + pkgName, + pkgVersion, + { installDir }: Pick, + ): Promise => { + const packageDotJson = await getPackageDotJson({ installDir }); const resolutions = packageDotJson.resolutions || {}; - await updatePackageDotJson({ - ...packageDotJson, - resolutions: { - ...resolutions, - [pkgName]: pkgVersion, + await updatePackageDotJson( + { + ...packageDotJson, + resolutions: { + ...resolutions, + [pkgName]: pkgVersion, + }, }, - }); + { installDir }, + ); }, }; /** YARN V2/3/4 */ @@ -84,27 +102,34 @@ export const YARN_V2: PackageManager = { runScriptCommand: 'yarn', flags: '', forceInstallFlag: '--force', - detect: () => { + detect: ({ installDir }: Pick) => { try { return fs - .readFileSync(path.join(INSTALL_DIR, 'yarn.lock'), 'utf-8') + .readFileSync(path.join(installDir, 'yarn.lock'), 'utf-8') .slice(0, 500) .includes('__metadata'); } catch (e) { return false; } }, - addOverride: async (pkgName, pkgVersion): Promise => { - const packageDotJson = await getPackageDotJson(); + addOverride: async ( + pkgName, + pkgVersion, + { installDir }: Pick, + ): Promise => { + const packageDotJson = await getPackageDotJson({ installDir }); const resolutions = packageDotJson.resolutions || {}; - await updatePackageDotJson({ - ...packageDotJson, - resolutions: { - ...resolutions, - [pkgName]: pkgVersion, + await updatePackageDotJson( + { + ...packageDotJson, + resolutions: { + ...resolutions, + [pkgName]: pkgVersion, + }, }, - }); + { installDir }, + ); }, }; export const PNPM: PackageManager = { @@ -115,22 +140,30 @@ export const PNPM: PackageManager = { runScriptCommand: 'pnpm', flags: '--ignore-workspace-root-check', forceInstallFlag: '--force', - detect: () => fs.existsSync(path.join(INSTALL_DIR, 'pnpm-lock.yaml')), - addOverride: async (pkgName, pkgVersion): Promise => { - const packageDotJson = await getPackageDotJson(); + detect: ({ installDir }: Pick) => + fs.existsSync(path.join(installDir, 'pnpm-lock.yaml')), + addOverride: async ( + pkgName, + pkgVersion, + { installDir }: Pick, + ): Promise => { + const packageDotJson = await getPackageDotJson({ installDir }); const pnpm = packageDotJson.pnpm || {}; const overrides = pnpm.overrides || {}; - await updatePackageDotJson({ - ...packageDotJson, - pnpm: { - ...pnpm, - overrides: { - ...overrides, - [pkgName]: pkgVersion, + await updatePackageDotJson( + { + ...packageDotJson, + pnpm: { + ...pnpm, + overrides: { + ...overrides, + [pkgName]: pkgVersion, + }, }, }, - }); + { installDir }, + ); }, }; export const NPM: PackageManager = { @@ -141,27 +174,37 @@ export const NPM: PackageManager = { runScriptCommand: 'npm run', flags: '', forceInstallFlag: '--force', - detect: () => fs.existsSync(path.join(INSTALL_DIR, 'package-lock.json')), - addOverride: async (pkgName, pkgVersion): Promise => { - const packageDotJson = await getPackageDotJson(); + detect: ({ installDir }: Pick) => + fs.existsSync(path.join(installDir, 'package-lock.json')), + addOverride: async ( + pkgName, + pkgVersion, + { installDir }: Pick, + ): Promise => { + const packageDotJson = await getPackageDotJson({ installDir }); const overrides = packageDotJson.overrides || {}; - await updatePackageDotJson({ - ...packageDotJson, - overrides: { - ...overrides, - [pkgName]: pkgVersion, + await updatePackageDotJson( + { + ...packageDotJson, + overrides: { + ...overrides, + [pkgName]: pkgVersion, + }, }, - }); + { installDir }, + ); }, }; export const packageManagers = [BUN, YARN_V1, YARN_V2, PNPM, NPM]; -export function detectPackageManger(): PackageManager | null { +export function detectPackageManger({ + installDir, +}: Pick): PackageManager | null { return traceStep('detect-package-manager', () => { for (const packageManager of packageManagers) { - if (packageManager.detect()) { + if (packageManager.detect({ installDir })) { Analytics.setTag('package-manager', packageManager.name); return packageManager; } diff --git a/src/utils/types.ts b/src/utils/types.ts index fc785e2db..7b3fe6194 100644 --- a/src/utils/types.ts +++ b/src/utils/types.ts @@ -25,6 +25,11 @@ export type WizardOptions = { * Does not apply to all wizard flows (currently NPM only) */ forceInstall: boolean; + + /** + * The directory to run the wizard in. + */ + installDir: string; }; export interface Feature { diff --git a/test/utils/clack-utils.test.ts b/test/utils/clack-utils.test.ts index 90dc4f1cb..ca7affdba 100644 --- a/test/utils/clack-utils.test.ts +++ b/test/utils/clack-utils.test.ts @@ -92,7 +92,9 @@ describe('createNewConfigFile', () => { const filename = '/webpack.config.js'; const code = 'module.exports = {/*config...*/}'; - const result = await createNewConfigFile(filename, code); + const result = await createNewConfigFile(filename, code, { + installDir: process.cwd(), + }); expect(result).toBe(true); expect(writeFileSpy).toHaveBeenCalledWith(filename, code); @@ -105,7 +107,14 @@ describe('createNewConfigFile', () => { const code = 'module.exports = {/*config...*/}'; const moreInfo = 'More information...'; - await createNewConfigFile(filename, code, moreInfo); + await createNewConfigFile( + filename, + code, + { + installDir: process.cwd(), + }, + moreInfo, + ); expect(clack.log.info).toHaveBeenCalledTimes(1); expect(clack.log.info).toHaveBeenCalledWith( @@ -121,7 +130,9 @@ describe('createNewConfigFile', () => { const filename = '/webpack.config.js'; const code = 'module.exports = {/*config...*/}'; - const result = await createNewConfigFile(filename, code); + const result = await createNewConfigFile(filename, code, { + installDir: process.cwd(), + }); expect(result).toBe(false); expect(writeFileSpy).toHaveBeenCalledWith(filename, code); @@ -132,6 +143,7 @@ describe('createNewConfigFile', () => { const result = await createNewConfigFile( './relative/webpack.config.js', '', + { installDir: process.cwd() }, ); expect(result).toBe(false); @@ -173,6 +185,7 @@ describe('installPackage', () => { forceInstall: true, askBeforeUpdating: false, packageManager: packageManagerMock, + installDir: process.cwd(), }); expect(execSpy).toHaveBeenCalledWith( @@ -213,6 +226,7 @@ describe('installPackage', () => { forceInstall: flag, askBeforeUpdating: false, packageManager: packageManagerMock, + installDir: process.cwd(), }); expect(execSpy).toHaveBeenCalledWith(