fix(dev-cli): Add warning about Turbopack usage#6189

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dstaley merged 1 commit into from
Jun 25, 2025
Merged

fix(dev-cli): Add warning about Turbopack usage #6189

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/easy-papers-hug.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/dev-cli': patch
---

Add warning regarding Turbopack usage.
58 changes: 49 additions & 9 deletions packages/dev-cli/src/commands/setup.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
import { spawn } from 'node:child_process';
import { existsSync } from 'node:fs';
import { readFile, writeFile } from 'node:fs/promises';
import { join } from 'node:path';
import path, { join } from 'node:path';

import { parse } from 'dotenv';

import { applyCodemod } from '../codemods/index.js';
import { INVALID_INSTANCE_KEYS_ERROR } from '../utils/errors.js';
import { INVALID_INSTANCE_KEYS_ERROR, NULL_ROOT_ERROR } from '../utils/errors.js';
import { getClerkPackages } from '../utils/getClerkPackages.js';
import { getConfiguration } from '../utils/getConfiguration.js';
import { getDependencies } from '../utils/getDependencies.js';
import { getMonorepoRoot } from '../utils/getMonorepoRoot.js';
import { getPackageJSON } from '../utils/getPackageJSON.js';

/**
* Returns `true` if the cwd contains a file named `filename`, otherwise returns `false`.
Expand All@@ -35,11 +36,11 @@ function hasPackage(packages, dependency) {

/**
* Returns a string corresponding to the framework detected in the cwd.
* @returns {Promise<string>}
* @param {{ dependencies?: Record<string, string>, devDependencies?: Record<string, string>}} pkgJSON
* @returns {string}
*/
async function detectFramework() {
const { dependencies, devDependencies } = await getDependencies(join(process.cwd(), 'package.json'));

function detectFramework(pkgJSON) {
const { dependencies, devDependencies } = pkgJSON;
const IS_NEXT = hasPackage(dependencies, 'next');
if (IS_NEXT) {
return 'nextjs';
Expand All@@ -58,6 +59,36 @@ async function detectFramework() {
throw new Error('unable to determine framework');
}

/**
* Returns the output file tracing root for the current working directory.
* @returns {Promise<string | null>}
*/
async function getOutputFileTracingRoot() {
const monorepoRoot = await getMonorepoRoot();
if (!monorepoRoot) {
throw new Error(NULL_ROOT_ERROR);
}
const p1 = path.resolve(monorepoRoot);
const p2 = path.resolve(process.cwd());

const root1 = path.parse(p1).root;
const root2 = path.parse(p2).root;

if (root1 !== root2) return null;

const parts1 = p1.slice(root1.length).split(path.sep);
const parts2 = p2.slice(root2.length).split(path.sep);

const len = Math.min(parts1.length, parts2.length);
const common = [];
for (let i = 0; i < len; i++) {
if (parts1[i] === parts2[i]) common.push(parts1[i]);
else break;
}

return common.length ? path.join(root1, ...common) : root1;
}

/**
* Returns the active instance of the provided `configuration`.
* @param {import('../utils/getConfiguration.js').Configuration} configuration
Expand DownExpand Up@@ -161,7 +192,7 @@ async function importPackageLock() {
* @returns {Promise<void>}
*/
async function linkDependencies() {
const { dependencies } = await getDependencies(join(process.cwd(), 'package.json'));
const { dependencies } = await getPackageJSON(join(process.cwd(), 'package.json'));
if (!dependencies) {
throw new Error('you have no dependencies');
}
Expand DownExpand Up@@ -208,7 +239,9 @@ export async function setup({ js = true, skipInstall = false }) {
const config = await getConfiguration();
const instance = await getInstanceConfiguration(config);

const framework = await detectFramework();
const pkgJSON = await getPackageJSON(join(process.cwd(), 'package.json'));

const framework = detectFramework(pkgJSON);
switch (framework) {
case 'nextjs': {
console.log('Next.js detected, writing environment variables to .env.local...');
Expand All@@ -217,6 +250,13 @@ export async function setup({ js = true, skipInstall = false }) {
CLERK_SECRET_KEY: instance.secretKey,
...(js ? { NEXT_PUBLIC_CLERK_JS_URL: 'http://localhost:4000/npm/clerk.browser.js' } : {}),
});

if (pkgJSON.scripts?.dev && pkgJSON.scripts.dev.includes('--turbo')) {

@coderabbitaicoderabbitaiBotJun 24, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Fix optional chaining as suggested by static analysis.

The static analysis tool correctly identified that pkgJSON.scripts.dev should use optional chaining to prevent potential runtime errors when scripts is undefined.

- if (pkgJSON.scripts?.dev && pkgJSON.scripts.dev.includes('--turbo')) {+ if (pkgJSON.scripts?.dev?.includes('--turbo')) {
📝 Committable suggestion

‼️IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
if(pkgJSON.scripts?.dev&&pkgJSON.scripts.dev.includes('--turbo')){
if(pkgJSON.scripts?.dev?.includes('--turbo')){
🧰 Tools
🪛 Biome (1.9.4)

[error] 254-254: Change to an optional chain.

Unsafe fix: Change to an optional chain.

(lint/complexity/useOptionalChain)

🤖 Prompt for AI Agents
In packages/dev-cli/src/commands/setup.js at line 254, the code accesses
pkgJSON.scripts.dev without optional chaining, which can cause runtime errors if
scripts is undefined. Update the condition to use optional chaining on scripts
as well, changing pkgJSON.scripts.dev to pkgJSON.scripts?.dev to safely handle
cases where scripts might be undefined.

const outputFileTracingRoot = await getOutputFileTracingRoot();
console.warn(
`\n\x1b[43m\x1b[30m Heads up! \x1b[0m Your \`dev\` script is using Turbopack. You will need to set the \`outputFileTracingRoot\` in your \`next.config.mjs\` file to "${outputFileTracingRoot}".\n`,
);
}
break;
}
case 'remix': {
Expand Down
4 changes: 2 additions & 2 deletions packages/dev-cli/src/commands/watch.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,8 +4,8 @@ import concurrently from 'concurrently';

import { NULL_ROOT_ERROR } from '../utils/errors.js';
import { getClerkPackages } from '../utils/getClerkPackages.js';
import { getDependencies } from '../utils/getDependencies.js';
import { getMonorepoRoot } from '../utils/getMonorepoRoot.js';
import { getPackageJSON } from '../utils/getPackageJSON.js';

/**
* Starts long-running watchers for Clerk dependencies.
Expand All@@ -14,7 +14,7 @@ import { getMonorepoRoot } from '../utils/getMonorepoRoot.js';
* @returns {Promise<import('concurrently').CloseEvent[]>}
*/
export async function watch({ js }) {
const { dependencies, devDependencies } = await getDependencies(join(process.cwd(), 'package.json'));
const { dependencies, devDependencies } = await getPackageJSON(join(process.cwd(), 'package.json'));
const clerkPackages = Object.keys(await getClerkPackages());

const packagesInPackageJSON = [...Object.keys(dependencies ?? {}), ...Object.keys(devDependencies ?? {})];
Expand Down
12 changes: 0 additions & 12 deletions packages/dev-cli/src/utils/getDependencies.js
View file
Open in desktop

This file was deleted.

11 changes: 11 additions & 0 deletions packages/dev-cli/src/utils/getPackageJSON.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
import { readFile } from 'node:fs/promises';

/**
* Gets the contents of the provided package.json.
* @param {string} pathToPackageJSON
* @returns {Promise<{ scripts?: Record<string, string>, dependencies?: Record<string, string>, devDependencies?: Record<string, string>}>}
*/
export async function getPackageJSON(pathToPackageJSON) {
const packageJSON = await readFile(pathToPackageJSON, 'utf-8');
return JSON.parse(packageJSON);
}
Comment on lines +8 to +11

@coderabbitaicoderabbitaiBotJun 24, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Add error handling for file operations and JSON parsing.

The function lacks error handling for common failure scenarios such as file not found or invalid JSON syntax. Consider adding try-catch blocks to provide more meaningful error messages.

 export async function getPackageJSON(pathToPackageJSON) {
- const packageJSON = await readFile(pathToPackageJSON, 'utf-8');- return JSON.parse(packageJSON);+ try {+ const packageJSON = await readFile(pathToPackageJSON, 'utf-8');+ return JSON.parse(packageJSON);+ } catch (error) {+ if (error.code === 'ENOENT') {+ throw new Error(`package.json not found at: ${pathToPackageJSON}`);+ }+ if (error instanceof SyntaxError) {+ throw new Error(`Invalid JSON in package.json at: ${pathToPackageJSON}`);+ }+ throw error;+ }
}
📝 Committable suggestion

‼️IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
exportasyncfunctiongetPackageJSON(pathToPackageJSON){
constpackageJSON=awaitreadFile(pathToPackageJSON,'utf-8');
returnJSON.parse(packageJSON);
}
exportasyncfunctiongetPackageJSON(pathToPackageJSON){
try{
constpackageJSON=awaitreadFile(pathToPackageJSON,'utf-8');
returnJSON.parse(packageJSON);
}catch(error){
if(error.code==='ENOENT'){
thrownewError(`package.json not found at: ${pathToPackageJSON}`);
}
if(errorinstanceofSyntaxError){
thrownewError(`Invalid JSON in package.json at: ${pathToPackageJSON}`);
}
throwerror;
}
}
🤖 Prompt for AI Agents
In packages/dev-cli/src/utils/getPackageJSON.js around lines 8 to 11, the
function getPackageJSON lacks error handling for file reading and JSON parsing
failures. Wrap the file reading and JSON.parse calls in a try-catch block, and
in the catch block, throw or log a meaningful error message indicating whether
the failure was due to file access issues or invalid JSON syntax.

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
fix(dev-cli): Add warning about Turbopack usage#6189

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

dstaley
merged 1 commit into

from

Jun 25, 2025
 Merged


fix(dev-cli): Add warning about Turbopack usage
#6189
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
.changeset/easy-papers-hug.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/dev-cli': patch
---

Add warning regarding Turbopack usage.

58 changes: 49 additions & 9 deletions
packages/dev-cli/src/commands/setup.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
import { spawn } from 'node:child_process';
import { existsSync } from 'node:fs';
import { readFile, writeFile } from 'node:fs/promises';
import { join } from 'node:path';
import path, { join } from 'node:path';

import { parse } from 'dotenv';

import { applyCodemod } from '../codemods/index.js';
import { INVALID_INSTANCE_KEYS_ERROR } from '../utils/errors.js';
import { INVALID_INSTANCE_KEYS_ERROR, NULL_ROOT_ERROR } from '../utils/errors.js';
import { getClerkPackages } from '../utils/getClerkPackages.js';
import { getConfiguration } from '../utils/getConfiguration.js';
import { getDependencies } from '../utils/getDependencies.js';
import { getMonorepoRoot } from '../utils/getMonorepoRoot.js';
import { getPackageJSON } from '../utils/getPackageJSON.js';

/**
 * Returns `true` if the cwd contains a file named `filename`, otherwise returns `false`.
Expand All@@ -35,11 +36,11 @@ function hasPackage(packages, dependency) {

/**
 * Returns a string corresponding to the framework detected in the cwd.
 * @returns {Promise<string>}
 * @param {{ dependencies?: Record<string, string>, devDependencies?: Record<string, string>}} pkgJSON
 * @returns {string}
 */
async function detectFramework() {
 const { dependencies, devDependencies } = await getDependencies(join(process.cwd(), 'package.json'));

function detectFramework(pkgJSON) {
 const { dependencies, devDependencies } = pkgJSON;
 const IS_NEXT = hasPackage(dependencies, 'next');
 if (IS_NEXT) {
 return 'nextjs';
Expand All@@ -58,6 +59,36 @@ async function detectFramework() {
 throw new Error('unable to determine framework');
}

/**
 * Returns the output file tracing root for the current working directory.
 * @returns {Promise<string | null>}
 */
async function getOutputFileTracingRoot() {
 const monorepoRoot = await getMonorepoRoot();
 if (!monorepoRoot) {
 throw new Error(NULL_ROOT_ERROR);
 }
 const p1 = path.resolve(monorepoRoot);
 const p2 = path.resolve(process.cwd());

 const root1 = path.parse(p1).root;
 const root2 = path.parse(p2).root;

 if (root1 !== root2) return null;

 const parts1 = p1.slice(root1.length).split(path.sep);
 const parts2 = p2.slice(root2.length).split(path.sep);

 const len = Math.min(parts1.length, parts2.length);
 const common = [];
 for (let i = 0; i < len; i++) {
 if (parts1[i] === parts2[i]) common.push(parts1[i]);
 else break;
 }

 return common.length ? path.join(root1, ...common) : root1;
}

/**
 * Returns the active instance of the provided `configuration`.
 * @param {import('../utils/getConfiguration.js').Configuration} configuration
Expand DownExpand Up@@ -161,7 +192,7 @@ async function importPackageLock() {
 * @returns {Promise<void>}
 */
async function linkDependencies() {
 const { dependencies } = await getDependencies(join(process.cwd(), 'package.json'));
 const { dependencies } = await getPackageJSON(join(process.cwd(), 'package.json'));
 if (!dependencies) {
 throw new Error('you have no dependencies');
 }
Expand DownExpand Up@@ -208,7 +239,9 @@ export async function setup({ js = true, skipInstall = false }) {
 const config = await getConfiguration();
 const instance = await getInstanceConfiguration(config);

 const framework = await detectFramework();
 const pkgJSON = await getPackageJSON(join(process.cwd(), 'package.json'));

 const framework = detectFramework(pkgJSON);
 switch (framework) {
 case 'nextjs': {
 console.log('Next.js detected, writing environment variables to .env.local...');
Expand All@@ -217,6 +250,13 @@ export async function setup({ js = true, skipInstall = false }) {
 CLERK_SECRET_KEY: instance.secretKey,
 ...(js ? { NEXT_PUBLIC_CLERK_JS_URL: 'http://localhost:4000/npm/clerk.browser.js' } : {}),
 });

 if (pkgJSON.scripts?.dev && pkgJSON.scripts.dev.includes('--turbo')) {
@coderabbitaicoderabbitaiBotJun 24, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue
Fix optional chaining as suggested by static analysis.
The static analysis tool correctly identified that pkgJSON.scripts.dev should use optional chaining to prevent potential runtime errors when scripts is undefined.
- if (pkgJSON.scripts?.dev && pkgJSON.scripts.dev.includes('--turbo')) {+ if (pkgJSON.scripts?.dev?.includes('--turbo')) {
📝 Committable suggestion
‼️IMPORTANT

Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

if(pkgJSON.scripts?.dev&&pkgJSON.scripts.dev.includes('--turbo')){
if(pkgJSON.scripts?.dev?.includes('--turbo')){
🧰 Tools
🪛 Biome (1.9.4)
[error] 254-254: Change to an optional chain.
Unsafe fix: Change to an optional chain.
(lint/complexity/useOptionalChain)
🤖 Prompt for AI Agents
In packages/dev-cli/src/commands/setup.js at line 254, the code accesses
pkgJSON.scripts.dev without optional chaining, which can cause runtime errors if
scripts is undefined. Update the condition to use optional chaining on scripts
as well, changing pkgJSON.scripts.dev to pkgJSON.scripts?.dev to safely handle
cases where scripts might be undefined.

 const outputFileTracingRoot = await getOutputFileTracingRoot();
 console.warn(
 `\n\x1b[43m\x1b[30m Heads up! \x1b[0m Your \`dev\` script is using Turbopack. You will need to set the \`outputFileTracingRoot\` in your \`next.config.mjs\` file to "${outputFileTracingRoot}".\n`,
 );
 }
 break;
 }
 case 'remix': {
Expand Down

4 changes: 2 additions & 2 deletions
packages/dev-cli/src/commands/watch.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,8 +4,8 @@ import concurrently from 'concurrently';

import { NULL_ROOT_ERROR } from '../utils/errors.js';
import { getClerkPackages } from '../utils/getClerkPackages.js';
import { getDependencies } from '../utils/getDependencies.js';
import { getMonorepoRoot } from '../utils/getMonorepoRoot.js';
import { getPackageJSON } from '../utils/getPackageJSON.js';

/**
 * Starts long-running watchers for Clerk dependencies.
Expand All@@ -14,7 +14,7 @@ import { getMonorepoRoot } from '../utils/getMonorepoRoot.js';
 * @returns {Promise<import('concurrently').CloseEvent[]>}
 */
export async function watch({ js }) {
 const { dependencies, devDependencies } = await getDependencies(join(process.cwd(), 'package.json'));
 const { dependencies, devDependencies } = await getPackageJSON(join(process.cwd(), 'package.json'));
 const clerkPackages = Object.keys(await getClerkPackages());

 const packagesInPackageJSON = [...Object.keys(dependencies ?? {}), ...Object.keys(devDependencies ?? {})];
Expand Down

12 changes: 0 additions & 12 deletions
packages/dev-cli/src/utils/getDependencies.js

View file


Open in desktop


This file was deleted.


11 changes: 11 additions & 0 deletions
packages/dev-cli/src/utils/getPackageJSON.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
import { readFile } from 'node:fs/promises';

/**
 * Gets the contents of the provided package.json.
 * @param {string} pathToPackageJSON
 * @returns {Promise<{ scripts?: Record<string, string>, dependencies?: Record<string, string>, devDependencies?: Record<string, string>}>}
 */
export async function getPackageJSON(pathToPackageJSON) {
 const packageJSON = await readFile(pathToPackageJSON, 'utf-8');
 return JSON.parse(packageJSON);
}

Comment on lines

+8
 to 
+11

@coderabbitaicoderabbitaiBotJun 24, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion
Add error handling for file operations and JSON parsing.
The function lacks error handling for common failure scenarios such as file not found or invalid JSON syntax. Consider adding try-catch blocks to provide more meaningful error messages.
 export async function getPackageJSON(pathToPackageJSON) {
- const packageJSON = await readFile(pathToPackageJSON, 'utf-8');- return JSON.parse(packageJSON);+ try {+ const packageJSON = await readFile(pathToPackageJSON, 'utf-8');+ return JSON.parse(packageJSON);+ } catch (error) {+ if (error.code === 'ENOENT') {+ throw new Error(`package.json not found at: ${pathToPackageJSON}`);+ }+ if (error instanceof SyntaxError) {+ throw new Error(`Invalid JSON in package.json at: ${pathToPackageJSON}`);+ }+ throw error;+ }
}
📝 Committable suggestion
‼️IMPORTANT

Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

exportasyncfunctiongetPackageJSON(pathToPackageJSON){
constpackageJSON=awaitreadFile(pathToPackageJSON,'utf-8');
returnJSON.parse(packageJSON);
}
exportasyncfunctiongetPackageJSON(pathToPackageJSON){
try{
constpackageJSON=awaitreadFile(pathToPackageJSON,'utf-8');
returnJSON.parse(packageJSON);
}catch(error){
if(error.code==='ENOENT'){
thrownewError(`package.json not found at: ${pathToPackageJSON}`);
}
if(errorinstanceofSyntaxError){
thrownewError(`Invalid JSON in package.json at: ${pathToPackageJSON}`);
}
throwerror;
}
}
🤖 Prompt for AI Agents
In packages/dev-cli/src/utils/getPackageJSON.js around lines 8 to 11, the
function getPackageJSON lacks error handling for file reading and JSON parsing
failures. Wrap the file reading and JSON.parse calls in a try-catch block, and
in the catch block, throw or log a meaningful error message indicating whether
the failure was due to file access issues or invalid JSON syntax.


, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
fix(dev-cli): Add warning about Turbopack usage#6189

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

dstaley
merged 1 commit into

from

Jun 25, 2025
 Merged


fix(dev-cli): Add warning about Turbopack usage
#6189
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
.changeset/easy-papers-hug.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/dev-cli': patch
---

Add warning regarding Turbopack usage.

58 changes: 49 additions & 9 deletions
packages/dev-cli/src/commands/setup.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
import { spawn } from 'node:child_process';
import { existsSync } from 'node:fs';
import { readFile, writeFile } from 'node:fs/promises';
import { join } from 'node:path';
import path, { join } from 'node:path';

import { parse } from 'dotenv';

import { applyCodemod } from '../codemods/index.js';
import { INVALID_INSTANCE_KEYS_ERROR } from '../utils/errors.js';
import { INVALID_INSTANCE_KEYS_ERROR, NULL_ROOT_ERROR } from '../utils/errors.js';
import { getClerkPackages } from '../utils/getClerkPackages.js';
import { getConfiguration } from '../utils/getConfiguration.js';
import { getDependencies } from '../utils/getDependencies.js';
import { getMonorepoRoot } from '../utils/getMonorepoRoot.js';
import { getPackageJSON } from '../utils/getPackageJSON.js';

/**
 * Returns `true` if the cwd contains a file named `filename`, otherwise returns `false`.
Expand All@@ -35,11 +36,11 @@ function hasPackage(packages, dependency) {

/**
 * Returns a string corresponding to the framework detected in the cwd.
 * @returns {Promise<string>}
 * @param {{ dependencies?: Record<string, string>, devDependencies?: Record<string, string>}} pkgJSON
 * @returns {string}
 */
async function detectFramework() {
 const { dependencies, devDependencies } = await getDependencies(join(process.cwd(), 'package.json'));

function detectFramework(pkgJSON) {
 const { dependencies, devDependencies } = pkgJSON;
 const IS_NEXT = hasPackage(dependencies, 'next');
 if (IS_NEXT) {
 return 'nextjs';
Expand All@@ -58,6 +59,36 @@ async function detectFramework() {
 throw new Error('unable to determine framework');
}

/**
 * Returns the output file tracing root for the current working directory.
 * @returns {Promise<string | null>}
 */
async function getOutputFileTracingRoot() {
 const monorepoRoot = await getMonorepoRoot();
 if (!monorepoRoot) {
 throw new Error(NULL_ROOT_ERROR);
 }
 const p1 = path.resolve(monorepoRoot);
 const p2 = path.resolve(process.cwd());

 const root1 = path.parse(p1).root;
 const root2 = path.parse(p2).root;

 if (root1 !== root2) return null;

 const parts1 = p1.slice(root1.length).split(path.sep);
 const parts2 = p2.slice(root2.length).split(path.sep);

 const len = Math.min(parts1.length, parts2.length);
 const common = [];
 for (let i = 0; i < len; i++) {
 if (parts1[i] === parts2[i]) common.push(parts1[i]);
 else break;
 }

 return common.length ? path.join(root1, ...common) : root1;
}

/**
 * Returns the active instance of the provided `configuration`.
 * @param {import('../utils/getConfiguration.js').Configuration} configuration
Expand DownExpand Up@@ -161,7 +192,7 @@ async function importPackageLock() {
 * @returns {Promise<void>}
 */
async function linkDependencies() {
 const { dependencies } = await getDependencies(join(process.cwd(), 'package.json'));
 const { dependencies } = await getPackageJSON(join(process.cwd(), 'package.json'));
 if (!dependencies) {
 throw new Error('you have no dependencies');
 }
Expand DownExpand Up@@ -208,7 +239,9 @@ export async function setup({ js = true, skipInstall = false }) {
 const config = await getConfiguration();
 const instance = await getInstanceConfiguration(config);

 const framework = await detectFramework();
 const pkgJSON = await getPackageJSON(join(process.cwd(), 'package.json'));

 const framework = detectFramework(pkgJSON);
 switch (framework) {
 case 'nextjs': {
 console.log('Next.js detected, writing environment variables to .env.local...');
Expand All@@ -217,6 +250,13 @@ export async function setup({ js = true, skipInstall = false }) {
 CLERK_SECRET_KEY: instance.secretKey,
 ...(js ? { NEXT_PUBLIC_CLERK_JS_URL: 'http://localhost:4000/npm/clerk.browser.js' } : {}),
 });

 if (pkgJSON.scripts?.dev && pkgJSON.scripts.dev.includes('--turbo')) {
@coderabbitaicoderabbitaiBotJun 24, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue
Fix optional chaining as suggested by static analysis.
The static analysis tool correctly identified that pkgJSON.scripts.dev should use optional chaining to prevent potential runtime errors when scripts is undefined.
- if (pkgJSON.scripts?.dev && pkgJSON.scripts.dev.includes('--turbo')) {+ if (pkgJSON.scripts?.dev?.includes('--turbo')) {
📝 Committable suggestion
‼️IMPORTANT

Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

if(pkgJSON.scripts?.dev&&pkgJSON.scripts.dev.includes('--turbo')){
if(pkgJSON.scripts?.dev?.includes('--turbo')){
🧰 Tools
🪛 Biome (1.9.4)
[error] 254-254: Change to an optional chain.
Unsafe fix: Change to an optional chain.
(lint/complexity/useOptionalChain)
🤖 Prompt for AI Agents
In packages/dev-cli/src/commands/setup.js at line 254, the code accesses
pkgJSON.scripts.dev without optional chaining, which can cause runtime errors if
scripts is undefined. Update the condition to use optional chaining on scripts
as well, changing pkgJSON.scripts.dev to pkgJSON.scripts?.dev to safely handle
cases where scripts might be undefined.

 const outputFileTracingRoot = await getOutputFileTracingRoot();
 console.warn(
 `\n\x1b[43m\x1b[30m Heads up! \x1b[0m Your \`dev\` script is using Turbopack. You will need to set the \`outputFileTracingRoot\` in your \`next.config.mjs\` file to "${outputFileTracingRoot}".\n`,
 );
 }
 break;
 }
 case 'remix': {
Expand Down

4 changes: 2 additions & 2 deletions
packages/dev-cli/src/commands/watch.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,8 +4,8 @@ import concurrently from 'concurrently';

import { NULL_ROOT_ERROR } from '../utils/errors.js';
import { getClerkPackages } from '../utils/getClerkPackages.js';
import { getDependencies } from '../utils/getDependencies.js';
import { getMonorepoRoot } from '../utils/getMonorepoRoot.js';
import { getPackageJSON } from '../utils/getPackageJSON.js';

/**
 * Starts long-running watchers for Clerk dependencies.
Expand All@@ -14,7 +14,7 @@ import { getMonorepoRoot } from '../utils/getMonorepoRoot.js';
 * @returns {Promise<import('concurrently').CloseEvent[]>}
 */
export async function watch({ js }) {
 const { dependencies, devDependencies } = await getDependencies(join(process.cwd(), 'package.json'));
 const { dependencies, devDependencies } = await getPackageJSON(join(process.cwd(), 'package.json'));
 const clerkPackages = Object.keys(await getClerkPackages());

 const packagesInPackageJSON = [...Object.keys(dependencies ?? {}), ...Object.keys(devDependencies ?? {})];
Expand Down

12 changes: 0 additions & 12 deletions
packages/dev-cli/src/utils/getDependencies.js

View file


Open in desktop


This file was deleted.


11 changes: 11 additions & 0 deletions
packages/dev-cli/src/utils/getPackageJSON.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
import { readFile } from 'node:fs/promises';

/**
 * Gets the contents of the provided package.json.
 * @param {string} pathToPackageJSON
 * @returns {Promise<{ scripts?: Record<string, string>, dependencies?: Record<string, string>, devDependencies?: Record<string, string>}>}
 */
export async function getPackageJSON(pathToPackageJSON) {
 const packageJSON = await readFile(pathToPackageJSON, 'utf-8');
 return JSON.parse(packageJSON);
}

Comment on lines

+8
 to 
+11

@coderabbitaicoderabbitaiBotJun 24, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion
Add error handling for file operations and JSON parsing.
The function lacks error handling for common failure scenarios such as file not found or invalid JSON syntax. Consider adding try-catch blocks to provide more meaningful error messages.
 export async function getPackageJSON(pathToPackageJSON) {
- const packageJSON = await readFile(pathToPackageJSON, 'utf-8');- return JSON.parse(packageJSON);+ try {+ const packageJSON = await readFile(pathToPackageJSON, 'utf-8');+ return JSON.parse(packageJSON);+ } catch (error) {+ if (error.code === 'ENOENT') {+ throw new Error(`package.json not found at: ${pathToPackageJSON}`);+ }+ if (error instanceof SyntaxError) {+ throw new Error(`Invalid JSON in package.json at: ${pathToPackageJSON}`);+ }+ throw error;+ }
}
📝 Committable suggestion
‼️IMPORTANT

Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

exportasyncfunctiongetPackageJSON(pathToPackageJSON){
constpackageJSON=awaitreadFile(pathToPackageJSON,'utf-8');
returnJSON.parse(packageJSON);
}
exportasyncfunctiongetPackageJSON(pathToPackageJSON){
try{
constpackageJSON=awaitreadFile(pathToPackageJSON,'utf-8');
returnJSON.parse(packageJSON);
}catch(error){
if(error.code==='ENOENT'){
thrownewError(`package.json not found at: ${pathToPackageJSON}`);
}
if(errorinstanceofSyntaxError){
thrownewError(`Invalid JSON in package.json at: ${pathToPackageJSON}`);
}
throwerror;
}
}
🤖 Prompt for AI Agents
In packages/dev-cli/src/utils/getPackageJSON.js around lines 8 to 11, the
function getPackageJSON lacks error handling for file reading and JSON parsing
failures. Wrap the file reading and JSON.parse calls in a try-catch block, and
in the catch block, throw or log a meaningful error message indicating whether
the failure was due to file access issues or invalid JSON syntax.


, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
fix(dev-cli): Add warning about Turbopack usage#6189

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

dstaley
merged 1 commit into

from

Jun 25, 2025
 Merged


fix(dev-cli): Add warning about Turbopack usage
#6189
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
.changeset/easy-papers-hug.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/dev-cli': patch
---

Add warning regarding Turbopack usage.

58 changes: 49 additions & 9 deletions
packages/dev-cli/src/commands/setup.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
import { spawn } from 'node:child_process';
import { existsSync } from 'node:fs';
import { readFile, writeFile } from 'node:fs/promises';
import { join } from 'node:path';
import path, { join } from 'node:path';

import { parse } from 'dotenv';

import { applyCodemod } from '../codemods/index.js';
import { INVALID_INSTANCE_KEYS_ERROR } from '../utils/errors.js';
import { INVALID_INSTANCE_KEYS_ERROR, NULL_ROOT_ERROR } from '../utils/errors.js';
import { getClerkPackages } from '../utils/getClerkPackages.js';
import { getConfiguration } from '../utils/getConfiguration.js';
import { getDependencies } from '../utils/getDependencies.js';
import { getMonorepoRoot } from '../utils/getMonorepoRoot.js';
import { getPackageJSON } from '../utils/getPackageJSON.js';

/**
 * Returns `true` if the cwd contains a file named `filename`, otherwise returns `false`.
Expand All@@ -35,11 +36,11 @@ function hasPackage(packages, dependency) {

/**
 * Returns a string corresponding to the framework detected in the cwd.
 * @returns {Promise<string>}
 * @param {{ dependencies?: Record<string, string>, devDependencies?: Record<string, string>}} pkgJSON
 * @returns {string}
 */
async function detectFramework() {
 const { dependencies, devDependencies } = await getDependencies(join(process.cwd(), 'package.json'));

function detectFramework(pkgJSON) {
 const { dependencies, devDependencies } = pkgJSON;
 const IS_NEXT = hasPackage(dependencies, 'next');
 if (IS_NEXT) {
 return 'nextjs';
Expand All@@ -58,6 +59,36 @@ async function detectFramework() {
 throw new Error('unable to determine framework');
}

/**
 * Returns the output file tracing root for the current working directory.
 * @returns {Promise<string | null>}
 */
async function getOutputFileTracingRoot() {
 const monorepoRoot = await getMonorepoRoot();
 if (!monorepoRoot) {
 throw new Error(NULL_ROOT_ERROR);
 }
 const p1 = path.resolve(monorepoRoot);
 const p2 = path.resolve(process.cwd());

 const root1 = path.parse(p1).root;
 const root2 = path.parse(p2).root;

 if (root1 !== root2) return null;

 const parts1 = p1.slice(root1.length).split(path.sep);
 const parts2 = p2.slice(root2.length).split(path.sep);

 const len = Math.min(parts1.length, parts2.length);
 const common = [];
 for (let i = 0; i < len; i++) {
 if (parts1[i] === parts2[i]) common.push(parts1[i]);
 else break;
 }

 return common.length ? path.join(root1, ...common) : root1;
}

/**
 * Returns the active instance of the provided `configuration`.
 * @param {import('../utils/getConfiguration.js').Configuration} configuration
Expand DownExpand Up@@ -161,7 +192,7 @@ async function importPackageLock() {
 * @returns {Promise<void>}
 */
async function linkDependencies() {
 const { dependencies } = await getDependencies(join(process.cwd(), 'package.json'));
 const { dependencies } = await getPackageJSON(join(process.cwd(), 'package.json'));
 if (!dependencies) {
 throw new Error('you have no dependencies');
 }
Expand DownExpand Up@@ -208,7 +239,9 @@ export async function setup({ js = true, skipInstall = false }) {
 const config = await getConfiguration();
 const instance = await getInstanceConfiguration(config);

 const framework = await detectFramework();
 const pkgJSON = await getPackageJSON(join(process.cwd(), 'package.json'));

 const framework = detectFramework(pkgJSON);
 switch (framework) {
 case 'nextjs': {
 console.log('Next.js detected, writing environment variables to .env.local...');
Expand All@@ -217,6 +250,13 @@ export async function setup({ js = true, skipInstall = false }) {
 CLERK_SECRET_KEY: instance.secretKey,
 ...(js ? { NEXT_PUBLIC_CLERK_JS_URL: 'http://localhost:4000/npm/clerk.browser.js' } : {}),
 });

 if (pkgJSON.scripts?.dev && pkgJSON.scripts.dev.includes('--turbo')) {
@coderabbitaicoderabbitaiBotJun 24, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue
Fix optional chaining as suggested by static analysis.
The static analysis tool correctly identified that pkgJSON.scripts.dev should use optional chaining to prevent potential runtime errors when scripts is undefined.
- if (pkgJSON.scripts?.dev && pkgJSON.scripts.dev.includes('--turbo')) {+ if (pkgJSON.scripts?.dev?.includes('--turbo')) {
📝 Committable suggestion
‼️IMPORTANT

Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

if(pkgJSON.scripts?.dev&&pkgJSON.scripts.dev.includes('--turbo')){
if(pkgJSON.scripts?.dev?.includes('--turbo')){
🧰 Tools
🪛 Biome (1.9.4)
[error] 254-254: Change to an optional chain.
Unsafe fix: Change to an optional chain.
(lint/complexity/useOptionalChain)
🤖 Prompt for AI Agents
In packages/dev-cli/src/commands/setup.js at line 254, the code accesses
pkgJSON.scripts.dev without optional chaining, which can cause runtime errors if
scripts is undefined. Update the condition to use optional chaining on scripts
as well, changing pkgJSON.scripts.dev to pkgJSON.scripts?.dev to safely handle
cases where scripts might be undefined.

 const outputFileTracingRoot = await getOutputFileTracingRoot();
 console.warn(
 `\n\x1b[43m\x1b[30m Heads up! \x1b[0m Your \`dev\` script is using Turbopack. You will need to set the \`outputFileTracingRoot\` in your \`next.config.mjs\` file to "${outputFileTracingRoot}".\n`,
 );
 }
 break;
 }
 case 'remix': {
Expand Down

4 changes: 2 additions & 2 deletions
packages/dev-cli/src/commands/watch.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,8 +4,8 @@ import concurrently from 'concurrently';

import { NULL_ROOT_ERROR } from '../utils/errors.js';
import { getClerkPackages } from '../utils/getClerkPackages.js';
import { getDependencies } from '../utils/getDependencies.js';
import { getMonorepoRoot } from '../utils/getMonorepoRoot.js';
import { getPackageJSON } from '../utils/getPackageJSON.js';

/**
 * Starts long-running watchers for Clerk dependencies.
Expand All@@ -14,7 +14,7 @@ import { getMonorepoRoot } from '../utils/getMonorepoRoot.js';
 * @returns {Promise<import('concurrently').CloseEvent[]>}
 */
export async function watch({ js }) {
 const { dependencies, devDependencies } = await getDependencies(join(process.cwd(), 'package.json'));
 const { dependencies, devDependencies } = await getPackageJSON(join(process.cwd(), 'package.json'));
 const clerkPackages = Object.keys(await getClerkPackages());

 const packagesInPackageJSON = [...Object.keys(dependencies ?? {}), ...Object.keys(devDependencies ?? {})];
Expand Down

12 changes: 0 additions & 12 deletions
packages/dev-cli/src/utils/getDependencies.js

View file


Open in desktop


This file was deleted.


11 changes: 11 additions & 0 deletions
packages/dev-cli/src/utils/getPackageJSON.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
import { readFile } from 'node:fs/promises';

/**
 * Gets the contents of the provided package.json.
 * @param {string} pathToPackageJSON
 * @returns {Promise<{ scripts?: Record<string, string>, dependencies?: Record<string, string>, devDependencies?: Record<string, string>}>}
 */
export async function getPackageJSON(pathToPackageJSON) {
 const packageJSON = await readFile(pathToPackageJSON, 'utf-8');
 return JSON.parse(packageJSON);
}

Comment on lines

+8
 to 
+11

@coderabbitaicoderabbitaiBotJun 24, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion
Add error handling for file operations and JSON parsing.
The function lacks error handling for common failure scenarios such as file not found or invalid JSON syntax. Consider adding try-catch blocks to provide more meaningful error messages.
 export async function getPackageJSON(pathToPackageJSON) {
- const packageJSON = await readFile(pathToPackageJSON, 'utf-8');- return JSON.parse(packageJSON);+ try {+ const packageJSON = await readFile(pathToPackageJSON, 'utf-8');+ return JSON.parse(packageJSON);+ } catch (error) {+ if (error.code === 'ENOENT') {+ throw new Error(`package.json not found at: ${pathToPackageJSON}`);+ }+ if (error instanceof SyntaxError) {+ throw new Error(`Invalid JSON in package.json at: ${pathToPackageJSON}`);+ }+ throw error;+ }
}
📝 Committable suggestion
‼️IMPORTANT

Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

exportasyncfunctiongetPackageJSON(pathToPackageJSON){
constpackageJSON=awaitreadFile(pathToPackageJSON,'utf-8');
returnJSON.parse(packageJSON);
}
exportasyncfunctiongetPackageJSON(pathToPackageJSON){
try{
constpackageJSON=awaitreadFile(pathToPackageJSON,'utf-8');
returnJSON.parse(packageJSON);
}catch(error){
if(error.code==='ENOENT'){
thrownewError(`package.json not found at: ${pathToPackageJSON}`);
}
if(errorinstanceofSyntaxError){
thrownewError(`Invalid JSON in package.json at: ${pathToPackageJSON}`);
}
throwerror;
}
}
🤖 Prompt for AI Agents
In packages/dev-cli/src/utils/getPackageJSON.js around lines 8 to 11, the
function getPackageJSON lacks error handling for file reading and JSON parsing
failures. Wrap the file reading and JSON.parse calls in a try-catch block, and
in the catch block, throw or log a meaningful error message indicating whether
the failure was due to file access issues or invalid JSON syntax.


, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
fix(dev-cli): Add warning about Turbopack usage#6189

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

dstaley
merged 1 commit into

from

Jun 25, 2025
 Merged


fix(dev-cli): Add warning about Turbopack usage
#6189
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
.changeset/easy-papers-hug.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/dev-cli': patch
---

Add warning regarding Turbopack usage.

58 changes: 49 additions & 9 deletions
packages/dev-cli/src/commands/setup.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
import { spawn } from 'node:child_process';
import { existsSync } from 'node:fs';
import { readFile, writeFile } from 'node:fs/promises';
import { join } from 'node:path';
import path, { join } from 'node:path';

import { parse } from 'dotenv';

import { applyCodemod } from '../codemods/index.js';
import { INVALID_INSTANCE_KEYS_ERROR } from '../utils/errors.js';
import { INVALID_INSTANCE_KEYS_ERROR, NULL_ROOT_ERROR } from '../utils/errors.js';
import { getClerkPackages } from '../utils/getClerkPackages.js';
import { getConfiguration } from '../utils/getConfiguration.js';
import { getDependencies } from '../utils/getDependencies.js';
import { getMonorepoRoot } from '../utils/getMonorepoRoot.js';
import { getPackageJSON } from '../utils/getPackageJSON.js';

/**
 * Returns `true` if the cwd contains a file named `filename`, otherwise returns `false`.
Expand All@@ -35,11 +36,11 @@ function hasPackage(packages, dependency) {

/**
 * Returns a string corresponding to the framework detected in the cwd.
 * @returns {Promise<string>}
 * @param {{ dependencies?: Record<string, string>, devDependencies?: Record<string, string>}} pkgJSON
 * @returns {string}
 */
async function detectFramework() {
 const { dependencies, devDependencies } = await getDependencies(join(process.cwd(), 'package.json'));

function detectFramework(pkgJSON) {
 const { dependencies, devDependencies } = pkgJSON;
 const IS_NEXT = hasPackage(dependencies, 'next');
 if (IS_NEXT) {
 return 'nextjs';
Expand All@@ -58,6 +59,36 @@ async function detectFramework() {
 throw new Error('unable to determine framework');
}

/**
 * Returns the output file tracing root for the current working directory.
 * @returns {Promise<string | null>}
 */
async function getOutputFileTracingRoot() {
 const monorepoRoot = await getMonorepoRoot();
 if (!monorepoRoot) {
 throw new Error(NULL_ROOT_ERROR);
 }
 const p1 = path.resolve(monorepoRoot);
 const p2 = path.resolve(process.cwd());

 const root1 = path.parse(p1).root;
 const root2 = path.parse(p2).root;

 if (root1 !== root2) return null;

 const parts1 = p1.slice(root1.length).split(path.sep);
 const parts2 = p2.slice(root2.length).split(path.sep);

 const len = Math.min(parts1.length, parts2.length);
 const common = [];
 for (let i = 0; i < len; i++) {
 if (parts1[i] === parts2[i]) common.push(parts1[i]);
 else break;
 }

 return common.length ? path.join(root1, ...common) : root1;
}

/**
 * Returns the active instance of the provided `configuration`.
 * @param {import('../utils/getConfiguration.js').Configuration} configuration
Expand DownExpand Up@@ -161,7 +192,7 @@ async function importPackageLock() {
 * @returns {Promise<void>}
 */
async function linkDependencies() {
 const { dependencies } = await getDependencies(join(process.cwd(), 'package.json'));
 const { dependencies } = await getPackageJSON(join(process.cwd(), 'package.json'));
 if (!dependencies) {
 throw new Error('you have no dependencies');
 }
Expand DownExpand Up@@ -208,7 +239,9 @@ export async function setup({ js = true, skipInstall = false }) {
 const config = await getConfiguration();
 const instance = await getInstanceConfiguration(config);

 const framework = await detectFramework();
 const pkgJSON = await getPackageJSON(join(process.cwd(), 'package.json'));

 const framework = detectFramework(pkgJSON);
 switch (framework) {
 case 'nextjs': {
 console.log('Next.js detected, writing environment variables to .env.local...');
Expand All@@ -217,6 +250,13 @@ export async function setup({ js = true, skipInstall = false }) {
 CLERK_SECRET_KEY: instance.secretKey,
 ...(js ? { NEXT_PUBLIC_CLERK_JS_URL: 'http://localhost:4000/npm/clerk.browser.js' } : {}),
 });

 if (pkgJSON.scripts?.dev && pkgJSON.scripts.dev.includes('--turbo')) {
@coderabbitaicoderabbitaiBotJun 24, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue
Fix optional chaining as suggested by static analysis.
The static analysis tool correctly identified that pkgJSON.scripts.dev should use optional chaining to prevent potential runtime errors when scripts is undefined.
- if (pkgJSON.scripts?.dev && pkgJSON.scripts.dev.includes('--turbo')) {+ if (pkgJSON.scripts?.dev?.includes('--turbo')) {
📝 Committable suggestion
‼️IMPORTANT

Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

if(pkgJSON.scripts?.dev&&pkgJSON.scripts.dev.includes('--turbo')){
if(pkgJSON.scripts?.dev?.includes('--turbo')){
🧰 Tools
🪛 Biome (1.9.4)
[error] 254-254: Change to an optional chain.
Unsafe fix: Change to an optional chain.
(lint/complexity/useOptionalChain)
🤖 Prompt for AI Agents
In packages/dev-cli/src/commands/setup.js at line 254, the code accesses
pkgJSON.scripts.dev without optional chaining, which can cause runtime errors if
scripts is undefined. Update the condition to use optional chaining on scripts
as well, changing pkgJSON.scripts.dev to pkgJSON.scripts?.dev to safely handle
cases where scripts might be undefined.

 const outputFileTracingRoot = await getOutputFileTracingRoot();
 console.warn(
 `\n\x1b[43m\x1b[30m Heads up! \x1b[0m Your \`dev\` script is using Turbopack. You will need to set the \`outputFileTracingRoot\` in your \`next.config.mjs\` file to "${outputFileTracingRoot}".\n`,
 );
 }
 break;
 }
 case 'remix': {
Expand Down

4 changes: 2 additions & 2 deletions
packages/dev-cli/src/commands/watch.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,8 +4,8 @@ import concurrently from 'concurrently';

import { NULL_ROOT_ERROR } from '../utils/errors.js';
import { getClerkPackages } from '../utils/getClerkPackages.js';
import { getDependencies } from '../utils/getDependencies.js';
import { getMonorepoRoot } from '../utils/getMonorepoRoot.js';
import { getPackageJSON } from '../utils/getPackageJSON.js';

/**
 * Starts long-running watchers for Clerk dependencies.
Expand All@@ -14,7 +14,7 @@ import { getMonorepoRoot } from '../utils/getMonorepoRoot.js';
 * @returns {Promise<import('concurrently').CloseEvent[]>}
 */
export async function watch({ js }) {
 const { dependencies, devDependencies } = await getDependencies(join(process.cwd(), 'package.json'));
 const { dependencies, devDependencies } = await getPackageJSON(join(process.cwd(), 'package.json'));
 const clerkPackages = Object.keys(await getClerkPackages());

 const packagesInPackageJSON = [...Object.keys(dependencies ?? {}), ...Object.keys(devDependencies ?? {})];
Expand Down

12 changes: 0 additions & 12 deletions
packages/dev-cli/src/utils/getDependencies.js

View file


Open in desktop


This file was deleted.


11 changes: 11 additions & 0 deletions
packages/dev-cli/src/utils/getPackageJSON.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
import { readFile } from 'node:fs/promises';

/**
 * Gets the contents of the provided package.json.
 * @param {string} pathToPackageJSON
 * @returns {Promise<{ scripts?: Record<string, string>, dependencies?: Record<string, string>, devDependencies?: Record<string, string>}>}
 */
export async function getPackageJSON(pathToPackageJSON) {
 const packageJSON = await readFile(pathToPackageJSON, 'utf-8');
 return JSON.parse(packageJSON);
}

Comment on lines

+8
 to 
+11

@coderabbitaicoderabbitaiBotJun 24, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion
Add error handling for file operations and JSON parsing.
The function lacks error handling for common failure scenarios such as file not found or invalid JSON syntax. Consider adding try-catch blocks to provide more meaningful error messages.
 export async function getPackageJSON(pathToPackageJSON) {
- const packageJSON = await readFile(pathToPackageJSON, 'utf-8');- return JSON.parse(packageJSON);+ try {+ const packageJSON = await readFile(pathToPackageJSON, 'utf-8');+ return JSON.parse(packageJSON);+ } catch (error) {+ if (error.code === 'ENOENT') {+ throw new Error(`package.json not found at: ${pathToPackageJSON}`);+ }+ if (error instanceof SyntaxError) {+ throw new Error(`Invalid JSON in package.json at: ${pathToPackageJSON}`);+ }+ throw error;+ }
}
📝 Committable suggestion
‼️IMPORTANT

Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

exportasyncfunctiongetPackageJSON(pathToPackageJSON){
constpackageJSON=awaitreadFile(pathToPackageJSON,'utf-8');
returnJSON.parse(packageJSON);
}
exportasyncfunctiongetPackageJSON(pathToPackageJSON){
try{
constpackageJSON=awaitreadFile(pathToPackageJSON,'utf-8');
returnJSON.parse(packageJSON);
}catch(error){
if(error.code==='ENOENT'){
thrownewError(`package.json not found at: ${pathToPackageJSON}`);
}
if(errorinstanceofSyntaxError){
thrownewError(`Invalid JSON in package.json at: ${pathToPackageJSON}`);
}
throwerror;
}
}
🤖 Prompt for AI Agents
In packages/dev-cli/src/utils/getPackageJSON.js around lines 8 to 11, the
function getPackageJSON lacks error handling for file reading and JSON parsing
failures. Wrap the file reading and JSON.parse calls in a try-catch block, and
in the catch block, throw or log a meaningful error message indicating whether
the failure was due to file access issues or invalid JSON syntax.


, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
fix(dev-cli): Add warning about Turbopack usage#6189

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

dstaley
merged 1 commit into

from

Jun 25, 2025
 Merged


fix(dev-cli): Add warning about Turbopack usage
#6189
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
.changeset/easy-papers-hug.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/dev-cli': patch
---

Add warning regarding Turbopack usage.

58 changes: 49 additions & 9 deletions
packages/dev-cli/src/commands/setup.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
import { spawn } from 'node:child_process';
import { existsSync } from 'node:fs';
import { readFile, writeFile } from 'node:fs/promises';
import { join } from 'node:path';
import path, { join } from 'node:path';

import { parse } from 'dotenv';

import { applyCodemod } from '../codemods/index.js';
import { INVALID_INSTANCE_KEYS_ERROR } from '../utils/errors.js';
import { INVALID_INSTANCE_KEYS_ERROR, NULL_ROOT_ERROR } from '../utils/errors.js';
import { getClerkPackages } from '../utils/getClerkPackages.js';
import { getConfiguration } from '../utils/getConfiguration.js';
import { getDependencies } from '../utils/getDependencies.js';
import { getMonorepoRoot } from '../utils/getMonorepoRoot.js';
import { getPackageJSON } from '../utils/getPackageJSON.js';

/**
 * Returns `true` if the cwd contains a file named `filename`, otherwise returns `false`.
Expand All@@ -35,11 +36,11 @@ function hasPackage(packages, dependency) {

/**
 * Returns a string corresponding to the framework detected in the cwd.
 * @returns {Promise<string>}
 * @param {{ dependencies?: Record<string, string>, devDependencies?: Record<string, string>}} pkgJSON
 * @returns {string}
 */
async function detectFramework() {
 const { dependencies, devDependencies } = await getDependencies(join(process.cwd(), 'package.json'));

function detectFramework(pkgJSON) {
 const { dependencies, devDependencies } = pkgJSON;
 const IS_NEXT = hasPackage(dependencies, 'next');
 if (IS_NEXT) {
 return 'nextjs';
Expand All@@ -58,6 +59,36 @@ async function detectFramework() {
 throw new Error('unable to determine framework');
}

/**
 * Returns the output file tracing root for the current working directory.
 * @returns {Promise<string | null>}
 */
async function getOutputFileTracingRoot() {
 const monorepoRoot = await getMonorepoRoot();
 if (!monorepoRoot) {
 throw new Error(NULL_ROOT_ERROR);
 }
 const p1 = path.resolve(monorepoRoot);
 const p2 = path.resolve(process.cwd());

 const root1 = path.parse(p1).root;
 const root2 = path.parse(p2).root;

 if (root1 !== root2) return null;

 const parts1 = p1.slice(root1.length).split(path.sep);
 const parts2 = p2.slice(root2.length).split(path.sep);

 const len = Math.min(parts1.length, parts2.length);
 const common = [];
 for (let i = 0; i < len; i++) {
 if (parts1[i] === parts2[i]) common.push(parts1[i]);
 else break;
 }

 return common.length ? path.join(root1, ...common) : root1;
}

/**
 * Returns the active instance of the provided `configuration`.
 * @param {import('../utils/getConfiguration.js').Configuration} configuration
Expand DownExpand Up@@ -161,7 +192,7 @@ async function importPackageLock() {
 * @returns {Promise<void>}
 */
async function linkDependencies() {
 const { dependencies } = await getDependencies(join(process.cwd(), 'package.json'));
 const { dependencies } = await getPackageJSON(join(process.cwd(), 'package.json'));
 if (!dependencies) {
 throw new Error('you have no dependencies');
 }
Expand DownExpand Up@@ -208,7 +239,9 @@ export async function setup({ js = true, skipInstall = false }) {
 const config = await getConfiguration();
 const instance = await getInstanceConfiguration(config);

 const framework = await detectFramework();
 const pkgJSON = await getPackageJSON(join(process.cwd(), 'package.json'));

 const framework = detectFramework(pkgJSON);
 switch (framework) {
 case 'nextjs': {
 console.log('Next.js detected, writing environment variables to .env.local...');
Expand All@@ -217,6 +250,13 @@ export async function setup({ js = true, skipInstall = false }) {
 CLERK_SECRET_KEY: instance.secretKey,
 ...(js ? { NEXT_PUBLIC_CLERK_JS_URL: 'http://localhost:4000/npm/clerk.browser.js' } : {}),
 });

 if (pkgJSON.scripts?.dev && pkgJSON.scripts.dev.includes('--turbo')) {
@coderabbitaicoderabbitaiBotJun 24, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue
Fix optional chaining as suggested by static analysis.
The static analysis tool correctly identified that pkgJSON.scripts.dev should use optional chaining to prevent potential runtime errors when scripts is undefined.
- if (pkgJSON.scripts?.dev && pkgJSON.scripts.dev.includes('--turbo')) {+ if (pkgJSON.scripts?.dev?.includes('--turbo')) {
📝 Committable suggestion
‼️IMPORTANT

Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

if(pkgJSON.scripts?.dev&&pkgJSON.scripts.dev.includes('--turbo')){
if(pkgJSON.scripts?.dev?.includes('--turbo')){
🧰 Tools
🪛 Biome (1.9.4)
[error] 254-254: Change to an optional chain.
Unsafe fix: Change to an optional chain.
(lint/complexity/useOptionalChain)
🤖 Prompt for AI Agents
In packages/dev-cli/src/commands/setup.js at line 254, the code accesses
pkgJSON.scripts.dev without optional chaining, which can cause runtime errors if
scripts is undefined. Update the condition to use optional chaining on scripts
as well, changing pkgJSON.scripts.dev to pkgJSON.scripts?.dev to safely handle
cases where scripts might be undefined.

 const outputFileTracingRoot = await getOutputFileTracingRoot();
 console.warn(
 `\n\x1b[43m\x1b[30m Heads up! \x1b[0m Your \`dev\` script is using Turbopack. You will need to set the \`outputFileTracingRoot\` in your \`next.config.mjs\` file to "${outputFileTracingRoot}".\n`,
 );
 }
 break;
 }
 case 'remix': {
Expand Down

4 changes: 2 additions & 2 deletions
packages/dev-cli/src/commands/watch.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,8 +4,8 @@ import concurrently from 'concurrently';

import { NULL_ROOT_ERROR } from '../utils/errors.js';
import { getClerkPackages } from '../utils/getClerkPackages.js';
import { getDependencies } from '../utils/getDependencies.js';
import { getMonorepoRoot } from '../utils/getMonorepoRoot.js';
import { getPackageJSON } from '../utils/getPackageJSON.js';

/**
 * Starts long-running watchers for Clerk dependencies.
Expand All@@ -14,7 +14,7 @@ import { getMonorepoRoot } from '../utils/getMonorepoRoot.js';
 * @returns {Promise<import('concurrently').CloseEvent[]>}
 */
export async function watch({ js }) {
 const { dependencies, devDependencies } = await getDependencies(join(process.cwd(), 'package.json'));
 const { dependencies, devDependencies } = await getPackageJSON(join(process.cwd(), 'package.json'));
 const clerkPackages = Object.keys(await getClerkPackages());

 const packagesInPackageJSON = [...Object.keys(dependencies ?? {}), ...Object.keys(devDependencies ?? {})];
Expand Down

12 changes: 0 additions & 12 deletions
packages/dev-cli/src/utils/getDependencies.js

View file


Open in desktop


This file was deleted.


11 changes: 11 additions & 0 deletions
packages/dev-cli/src/utils/getPackageJSON.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
import { readFile } from 'node:fs/promises';

/**
 * Gets the contents of the provided package.json.
 * @param {string} pathToPackageJSON
 * @returns {Promise<{ scripts?: Record<string, string>, dependencies?: Record<string, string>, devDependencies?: Record<string, string>}>}
 */
export async function getPackageJSON(pathToPackageJSON) {
 const packageJSON = await readFile(pathToPackageJSON, 'utf-8');
 return JSON.parse(packageJSON);
}

Comment on lines

+8
 to 
+11

@coderabbitaicoderabbitaiBotJun 24, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion
Add error handling for file operations and JSON parsing.
The function lacks error handling for common failure scenarios such as file not found or invalid JSON syntax. Consider adding try-catch blocks to provide more meaningful error messages.
 export async function getPackageJSON(pathToPackageJSON) {
- const packageJSON = await readFile(pathToPackageJSON, 'utf-8');- return JSON.parse(packageJSON);+ try {+ const packageJSON = await readFile(pathToPackageJSON, 'utf-8');+ return JSON.parse(packageJSON);+ } catch (error) {+ if (error.code === 'ENOENT') {+ throw new Error(`package.json not found at: ${pathToPackageJSON}`);+ }+ if (error instanceof SyntaxError) {+ throw new Error(`Invalid JSON in package.json at: ${pathToPackageJSON}`);+ }+ throw error;+ }
}
📝 Committable suggestion
‼️IMPORTANT

Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

exportasyncfunctiongetPackageJSON(pathToPackageJSON){
constpackageJSON=awaitreadFile(pathToPackageJSON,'utf-8');
returnJSON.parse(packageJSON);
}
exportasyncfunctiongetPackageJSON(pathToPackageJSON){
try{
constpackageJSON=awaitreadFile(pathToPackageJSON,'utf-8');
returnJSON.parse(packageJSON);
}catch(error){
if(error.code==='ENOENT'){
thrownewError(`package.json not found at: ${pathToPackageJSON}`);
}
if(errorinstanceofSyntaxError){
thrownewError(`Invalid JSON in package.json at: ${pathToPackageJSON}`);
}
throwerror;
}
}
🤖 Prompt for AI Agents
In packages/dev-cli/src/utils/getPackageJSON.js around lines 8 to 11, the
function getPackageJSON lacks error handling for file reading and JSON parsing
failures. Wrap the file reading and JSON.parse calls in a try-catch block, and
in the catch block, throw or log a meaningful error message indicating whether
the failure was due to file access issues or invalid JSON syntax.


, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
fix(dev-cli): Add warning about Turbopack usage#6189

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

dstaley
merged 1 commit into

from

Jun 25, 2025
 Merged


fix(dev-cli): Add warning about Turbopack usage
#6189
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
.changeset/easy-papers-hug.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/dev-cli': patch
---

Add warning regarding Turbopack usage.

58 changes: 49 additions & 9 deletions
packages/dev-cli/src/commands/setup.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
import { spawn } from 'node:child_process';
import { existsSync } from 'node:fs';
import { readFile, writeFile } from 'node:fs/promises';
import { join } from 'node:path';
import path, { join } from 'node:path';

import { parse } from 'dotenv';

import { applyCodemod } from '../codemods/index.js';
import { INVALID_INSTANCE_KEYS_ERROR } from '../utils/errors.js';
import { INVALID_INSTANCE_KEYS_ERROR, NULL_ROOT_ERROR } from '../utils/errors.js';
import { getClerkPackages } from '../utils/getClerkPackages.js';
import { getConfiguration } from '../utils/getConfiguration.js';
import { getDependencies } from '../utils/getDependencies.js';
import { getMonorepoRoot } from '../utils/getMonorepoRoot.js';
import { getPackageJSON } from '../utils/getPackageJSON.js';

/**
 * Returns `true` if the cwd contains a file named `filename`, otherwise returns `false`.
Expand All@@ -35,11 +36,11 @@ function hasPackage(packages, dependency) {

/**
 * Returns a string corresponding to the framework detected in the cwd.
 * @returns {Promise<string>}
 * @param {{ dependencies?: Record<string, string>, devDependencies?: Record<string, string>}} pkgJSON
 * @returns {string}
 */
async function detectFramework() {
 const { dependencies, devDependencies } = await getDependencies(join(process.cwd(), 'package.json'));

function detectFramework(pkgJSON) {
 const { dependencies, devDependencies } = pkgJSON;
 const IS_NEXT = hasPackage(dependencies, 'next');
 if (IS_NEXT) {
 return 'nextjs';
Expand All@@ -58,6 +59,36 @@ async function detectFramework() {
 throw new Error('unable to determine framework');
}

/**
 * Returns the output file tracing root for the current working directory.
 * @returns {Promise<string | null>}
 */
async function getOutputFileTracingRoot() {
 const monorepoRoot = await getMonorepoRoot();
 if (!monorepoRoot) {
 throw new Error(NULL_ROOT_ERROR);
 }
 const p1 = path.resolve(monorepoRoot);
 const p2 = path.resolve(process.cwd());

 const root1 = path.parse(p1).root;
 const root2 = path.parse(p2).root;

 if (root1 !== root2) return null;

 const parts1 = p1.slice(root1.length).split(path.sep);
 const parts2 = p2.slice(root2.length).split(path.sep);

 const len = Math.min(parts1.length, parts2.length);
 const common = [];
 for (let i = 0; i < len; i++) {
 if (parts1[i] === parts2[i]) common.push(parts1[i]);
 else break;
 }

 return common.length ? path.join(root1, ...common) : root1;
}

/**
 * Returns the active instance of the provided `configuration`.
 * @param {import('../utils/getConfiguration.js').Configuration} configuration
Expand DownExpand Up@@ -161,7 +192,7 @@ async function importPackageLock() {
 * @returns {Promise<void>}
 */
async function linkDependencies() {
 const { dependencies } = await getDependencies(join(process.cwd(), 'package.json'));
 const { dependencies } = await getPackageJSON(join(process.cwd(), 'package.json'));
 if (!dependencies) {
 throw new Error('you have no dependencies');
 }
Expand DownExpand Up@@ -208,7 +239,9 @@ export async function setup({ js = true, skipInstall = false }) {
 const config = await getConfiguration();
 const instance = await getInstanceConfiguration(config);

 const framework = await detectFramework();
 const pkgJSON = await getPackageJSON(join(process.cwd(), 'package.json'));

 const framework = detectFramework(pkgJSON);
 switch (framework) {
 case 'nextjs': {
 console.log('Next.js detected, writing environment variables to .env.local...');
Expand All@@ -217,6 +250,13 @@ export async function setup({ js = true, skipInstall = false }) {
 CLERK_SECRET_KEY: instance.secretKey,
 ...(js ? { NEXT_PUBLIC_CLERK_JS_URL: 'http://localhost:4000/npm/clerk.browser.js' } : {}),
 });

 if (pkgJSON.scripts?.dev && pkgJSON.scripts.dev.includes('--turbo')) {
@coderabbitaicoderabbitaiBotJun 24, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue
Fix optional chaining as suggested by static analysis.
The static analysis tool correctly identified that pkgJSON.scripts.dev should use optional chaining to prevent potential runtime errors when scripts is undefined.
- if (pkgJSON.scripts?.dev && pkgJSON.scripts.dev.includes('--turbo')) {+ if (pkgJSON.scripts?.dev?.includes('--turbo')) {
📝 Committable suggestion
‼️IMPORTANT

Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

if(pkgJSON.scripts?.dev&&pkgJSON.scripts.dev.includes('--turbo')){
if(pkgJSON.scripts?.dev?.includes('--turbo')){
🧰 Tools
🪛 Biome (1.9.4)
[error] 254-254: Change to an optional chain.
Unsafe fix: Change to an optional chain.
(lint/complexity/useOptionalChain)
🤖 Prompt for AI Agents
In packages/dev-cli/src/commands/setup.js at line 254, the code accesses
pkgJSON.scripts.dev without optional chaining, which can cause runtime errors if
scripts is undefined. Update the condition to use optional chaining on scripts
as well, changing pkgJSON.scripts.dev to pkgJSON.scripts?.dev to safely handle
cases where scripts might be undefined.

 const outputFileTracingRoot = await getOutputFileTracingRoot();
 console.warn(
 `\n\x1b[43m\x1b[30m Heads up! \x1b[0m Your \`dev\` script is using Turbopack. You will need to set the \`outputFileTracingRoot\` in your \`next.config.mjs\` file to "${outputFileTracingRoot}".\n`,
 );
 }
 break;
 }
 case 'remix': {
Expand Down

4 changes: 2 additions & 2 deletions
packages/dev-cli/src/commands/watch.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,8 +4,8 @@ import concurrently from 'concurrently';

import { NULL_ROOT_ERROR } from '../utils/errors.js';
import { getClerkPackages } from '../utils/getClerkPackages.js';
import { getDependencies } from '../utils/getDependencies.js';
import { getMonorepoRoot } from '../utils/getMonorepoRoot.js';
import { getPackageJSON } from '../utils/getPackageJSON.js';

/**
 * Starts long-running watchers for Clerk dependencies.
Expand All@@ -14,7 +14,7 @@ import { getMonorepoRoot } from '../utils/getMonorepoRoot.js';
 * @returns {Promise<import('concurrently').CloseEvent[]>}
 */
export async function watch({ js }) {
 const { dependencies, devDependencies } = await getDependencies(join(process.cwd(), 'package.json'));
 const { dependencies, devDependencies } = await getPackageJSON(join(process.cwd(), 'package.json'));
 const clerkPackages = Object.keys(await getClerkPackages());

 const packagesInPackageJSON = [...Object.keys(dependencies ?? {}), ...Object.keys(devDependencies ?? {})];
Expand Down

12 changes: 0 additions & 12 deletions
packages/dev-cli/src/utils/getDependencies.js

View file


Open in desktop


This file was deleted.


11 changes: 11 additions & 0 deletions
packages/dev-cli/src/utils/getPackageJSON.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
import { readFile } from 'node:fs/promises';

/**
 * Gets the contents of the provided package.json.
 * @param {string} pathToPackageJSON
 * @returns {Promise<{ scripts?: Record<string, string>, dependencies?: Record<string, string>, devDependencies?: Record<string, string>}>}
 */
export async function getPackageJSON(pathToPackageJSON) {
 const packageJSON = await readFile(pathToPackageJSON, 'utf-8');
 return JSON.parse(packageJSON);
}

Comment on lines

+8
 to 
+11

@coderabbitaicoderabbitaiBotJun 24, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion
Add error handling for file operations and JSON parsing.
The function lacks error handling for common failure scenarios such as file not found or invalid JSON syntax. Consider adding try-catch blocks to provide more meaningful error messages.
 export async function getPackageJSON(pathToPackageJSON) {
- const packageJSON = await readFile(pathToPackageJSON, 'utf-8');- return JSON.parse(packageJSON);+ try {+ const packageJSON = await readFile(pathToPackageJSON, 'utf-8');+ return JSON.parse(packageJSON);+ } catch (error) {+ if (error.code === 'ENOENT') {+ throw new Error(`package.json not found at: ${pathToPackageJSON}`);+ }+ if (error instanceof SyntaxError) {+ throw new Error(`Invalid JSON in package.json at: ${pathToPackageJSON}`);+ }+ throw error;+ }
}
📝 Committable suggestion
‼️IMPORTANT

Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

exportasyncfunctiongetPackageJSON(pathToPackageJSON){
constpackageJSON=awaitreadFile(pathToPackageJSON,'utf-8');
returnJSON.parse(packageJSON);
}
exportasyncfunctiongetPackageJSON(pathToPackageJSON){
try{
constpackageJSON=awaitreadFile(pathToPackageJSON,'utf-8');
returnJSON.parse(packageJSON);
}catch(error){
if(error.code==='ENOENT'){
thrownewError(`package.json not found at: ${pathToPackageJSON}`);
}
if(errorinstanceofSyntaxError){
thrownewError(`Invalid JSON in package.json at: ${pathToPackageJSON}`);
}
throwerror;
}
}
🤖 Prompt for AI Agents
In packages/dev-cli/src/utils/getPackageJSON.js around lines 8 to 11, the
function getPackageJSON lacks error handling for file reading and JSON parsing
failures. Wrap the file reading and JSON.parse calls in a try-catch block, and
in the catch block, throw or log a meaningful error message indicating whether
the failure was due to file access issues or invalid JSON syntax.


, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
fix(dev-cli): Add warning about Turbopack usage#6189

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

dstaley
merged 1 commit into

from

Jun 25, 2025
 Merged


fix(dev-cli): Add warning about Turbopack usage
#6189
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
.changeset/easy-papers-hug.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/dev-cli': patch
---

Add warning regarding Turbopack usage.

58 changes: 49 additions & 9 deletions
packages/dev-cli/src/commands/setup.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
import { spawn } from 'node:child_process';
import { existsSync } from 'node:fs';
import { readFile, writeFile } from 'node:fs/promises';
import { join } from 'node:path';
import path, { join } from 'node:path';

import { parse } from 'dotenv';

import { applyCodemod } from '../codemods/index.js';
import { INVALID_INSTANCE_KEYS_ERROR } from '../utils/errors.js';
import { INVALID_INSTANCE_KEYS_ERROR, NULL_ROOT_ERROR } from '../utils/errors.js';
import { getClerkPackages } from '../utils/getClerkPackages.js';
import { getConfiguration } from '../utils/getConfiguration.js';
import { getDependencies } from '../utils/getDependencies.js';
import { getMonorepoRoot } from '../utils/getMonorepoRoot.js';
import { getPackageJSON } from '../utils/getPackageJSON.js';

/**
 * Returns `true` if the cwd contains a file named `filename`, otherwise returns `false`.
Expand All@@ -35,11 +36,11 @@ function hasPackage(packages, dependency) {

/**
 * Returns a string corresponding to the framework detected in the cwd.
 * @returns {Promise<string>}
 * @param {{ dependencies?: Record<string, string>, devDependencies?: Record<string, string>}} pkgJSON
 * @returns {string}
 */
async function detectFramework() {
 const { dependencies, devDependencies } = await getDependencies(join(process.cwd(), 'package.json'));

function detectFramework(pkgJSON) {
 const { dependencies, devDependencies } = pkgJSON;
 const IS_NEXT = hasPackage(dependencies, 'next');
 if (IS_NEXT) {
 return 'nextjs';
Expand All@@ -58,6 +59,36 @@ async function detectFramework() {
 throw new Error('unable to determine framework');
}

/**
 * Returns the output file tracing root for the current working directory.
 * @returns {Promise<string | null>}
 */
async function getOutputFileTracingRoot() {
 const monorepoRoot = await getMonorepoRoot();
 if (!monorepoRoot) {
 throw new Error(NULL_ROOT_ERROR);
 }
 const p1 = path.resolve(monorepoRoot);
 const p2 = path.resolve(process.cwd());

 const root1 = path.parse(p1).root;
 const root2 = path.parse(p2).root;

 if (root1 !== root2) return null;

 const parts1 = p1.slice(root1.length).split(path.sep);
 const parts2 = p2.slice(root2.length).split(path.sep);

 const len = Math.min(parts1.length, parts2.length);
 const common = [];
 for (let i = 0; i < len; i++) {
 if (parts1[i] === parts2[i]) common.push(parts1[i]);
 else break;
 }

 return common.length ? path.join(root1, ...common) : root1;
}

/**
 * Returns the active instance of the provided `configuration`.
 * @param {import('../utils/getConfiguration.js').Configuration} configuration
Expand DownExpand Up@@ -161,7 +192,7 @@ async function importPackageLock() {
 * @returns {Promise<void>}
 */
async function linkDependencies() {
 const { dependencies } = await getDependencies(join(process.cwd(), 'package.json'));
 const { dependencies } = await getPackageJSON(join(process.cwd(), 'package.json'));
 if (!dependencies) {
 throw new Error('you have no dependencies');
 }
Expand DownExpand Up@@ -208,7 +239,9 @@ export async function setup({ js = true, skipInstall = false }) {
 const config = await getConfiguration();
 const instance = await getInstanceConfiguration(config);

 const framework = await detectFramework();
 const pkgJSON = await getPackageJSON(join(process.cwd(), 'package.json'));

 const framework = detectFramework(pkgJSON);
 switch (framework) {
 case 'nextjs': {
 console.log('Next.js detected, writing environment variables to .env.local...');
Expand All@@ -217,6 +250,13 @@ export async function setup({ js = true, skipInstall = false }) {
 CLERK_SECRET_KEY: instance.secretKey,
 ...(js ? { NEXT_PUBLIC_CLERK_JS_URL: 'http://localhost:4000/npm/clerk.browser.js' } : {}),
 });

 if (pkgJSON.scripts?.dev && pkgJSON.scripts.dev.includes('--turbo')) {
@coderabbitaicoderabbitaiBotJun 24, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue
Fix optional chaining as suggested by static analysis.
The static analysis tool correctly identified that pkgJSON.scripts.dev should use optional chaining to prevent potential runtime errors when scripts is undefined.
- if (pkgJSON.scripts?.dev && pkgJSON.scripts.dev.includes('--turbo')) {+ if (pkgJSON.scripts?.dev?.includes('--turbo')) {
📝 Committable suggestion
‼️IMPORTANT

Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

if(pkgJSON.scripts?.dev&&pkgJSON.scripts.dev.includes('--turbo')){
if(pkgJSON.scripts?.dev?.includes('--turbo')){
🧰 Tools
🪛 Biome (1.9.4)
[error] 254-254: Change to an optional chain.
Unsafe fix: Change to an optional chain.
(lint/complexity/useOptionalChain)
🤖 Prompt for AI Agents
In packages/dev-cli/src/commands/setup.js at line 254, the code accesses
pkgJSON.scripts.dev without optional chaining, which can cause runtime errors if
scripts is undefined. Update the condition to use optional chaining on scripts
as well, changing pkgJSON.scripts.dev to pkgJSON.scripts?.dev to safely handle
cases where scripts might be undefined.

 const outputFileTracingRoot = await getOutputFileTracingRoot();
 console.warn(
 `\n\x1b[43m\x1b[30m Heads up! \x1b[0m Your \`dev\` script is using Turbopack. You will need to set the \`outputFileTracingRoot\` in your \`next.config.mjs\` file to "${outputFileTracingRoot}".\n`,
 );
 }
 break;
 }
 case 'remix': {
Expand Down

4 changes: 2 additions & 2 deletions
packages/dev-cli/src/commands/watch.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,8 +4,8 @@ import concurrently from 'concurrently';

import { NULL_ROOT_ERROR } from '../utils/errors.js';
import { getClerkPackages } from '../utils/getClerkPackages.js';
import { getDependencies } from '../utils/getDependencies.js';
import { getMonorepoRoot } from '../utils/getMonorepoRoot.js';
import { getPackageJSON } from '../utils/getPackageJSON.js';

/**
 * Starts long-running watchers for Clerk dependencies.
Expand All@@ -14,7 +14,7 @@ import { getMonorepoRoot } from '../utils/getMonorepoRoot.js';
 * @returns {Promise<import('concurrently').CloseEvent[]>}
 */
export async function watch({ js }) {
 const { dependencies, devDependencies } = await getDependencies(join(process.cwd(), 'package.json'));
 const { dependencies, devDependencies } = await getPackageJSON(join(process.cwd(), 'package.json'));
 const clerkPackages = Object.keys(await getClerkPackages());

 const packagesInPackageJSON = [...Object.keys(dependencies ?? {}), ...Object.keys(devDependencies ?? {})];
Expand Down

12 changes: 0 additions & 12 deletions
packages/dev-cli/src/utils/getDependencies.js

View file


Open in desktop


This file was deleted.


11 changes: 11 additions & 0 deletions
packages/dev-cli/src/utils/getPackageJSON.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
import { readFile } from 'node:fs/promises';

/**
 * Gets the contents of the provided package.json.
 * @param {string} pathToPackageJSON
 * @returns {Promise<{ scripts?: Record<string, string>, dependencies?: Record<string, string>, devDependencies?: Record<string, string>}>}
 */
export async function getPackageJSON(pathToPackageJSON) {
 const packageJSON = await readFile(pathToPackageJSON, 'utf-8');
 return JSON.parse(packageJSON);
}

Comment on lines

+8
 to 
+11

@coderabbitaicoderabbitaiBotJun 24, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion
Add error handling for file operations and JSON parsing.
The function lacks error handling for common failure scenarios such as file not found or invalid JSON syntax. Consider adding try-catch blocks to provide more meaningful error messages.
 export async function getPackageJSON(pathToPackageJSON) {
- const packageJSON = await readFile(pathToPackageJSON, 'utf-8');- return JSON.parse(packageJSON);+ try {+ const packageJSON = await readFile(pathToPackageJSON, 'utf-8');+ return JSON.parse(packageJSON);+ } catch (error) {+ if (error.code === 'ENOENT') {+ throw new Error(`package.json not found at: ${pathToPackageJSON}`);+ }+ if (error instanceof SyntaxError) {+ throw new Error(`Invalid JSON in package.json at: ${pathToPackageJSON}`);+ }+ throw error;+ }
}
📝 Committable suggestion
‼️IMPORTANT

Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

exportasyncfunctiongetPackageJSON(pathToPackageJSON){
constpackageJSON=awaitreadFile(pathToPackageJSON,'utf-8');
returnJSON.parse(packageJSON);
}
exportasyncfunctiongetPackageJSON(pathToPackageJSON){
try{
constpackageJSON=awaitreadFile(pathToPackageJSON,'utf-8');
returnJSON.parse(packageJSON);
}catch(error){
if(error.code==='ENOENT'){
thrownewError(`package.json not found at: ${pathToPackageJSON}`);
}
if(errorinstanceofSyntaxError){
thrownewError(`Invalid JSON in package.json at: ${pathToPackageJSON}`);
}
throwerror;
}
}
🤖 Prompt for AI Agents
In packages/dev-cli/src/utils/getPackageJSON.js around lines 8 to 11, the
function getPackageJSON lacks error handling for file reading and JSON parsing
failures. Wrap the file reading and JSON.parse calls in a try-catch block, and
in the catch block, throw or log a meaningful error message indicating whether
the failure was due to file access issues or invalid JSON syntax.