mirror of
https://github.com/hanzoai/next.js.git
synced 2026-10-30 14:46:38 +00:00
Jude GaoandGitHub
b9ec2e4f8d
AI coding agents often rely on outdated training data when working with Next.js projects, leading to hallucinated APIs and deprecated patterns. This PR addresses that by shipping version-matched documentation inside the `next` npm package and generating agent instruction files during `create-next-app`. During `next` build, a new `copy_docs` task copies `docs/` from the repo root into `dist/docs/`. Since `"dist"` is already in the package's `files` array, the docs are automatically published at `node_modules/next/dist/docs/`. `create-next-app` gains a new `--agents-md` / `--no-agents-md` flag (defaults to `true`). When enabled it writes two files: - `AGENTS.md` — instructs agents to read `node_modules/next/dist/docs/` instead of relying on training data - `CLAUDE.md` — uses `@AGENTS.md` import syntax for Claude Code The option appears in the recommended defaults display and is prompted during the customize flow. Existing tests are updated with `--no-agents-md` to avoid the new prompt.
197 lines
4.6 KiB
TypeScript
197 lines
4.6 KiB
TypeScript
import {
|
|
DEFAULT_FILES,
|
|
FULL_EXAMPLE_PATH,
|
|
projectFilesShouldExist,
|
|
projectFilesShouldNotExist,
|
|
run,
|
|
useTempDir,
|
|
} from '../utils'
|
|
|
|
const lockFile = 'pnpm-lock.yaml'
|
|
const files = [...DEFAULT_FILES, lockFile]
|
|
|
|
describe('create-next-app with package manager pnpm', () => {
|
|
let nextTgzFilename: string
|
|
|
|
beforeAll(async () => {
|
|
if (!process.env.NEXT_TEST_PKG_PATHS) {
|
|
throw new Error('This test needs to be run with `node run-tests.js`.')
|
|
}
|
|
|
|
const pkgPaths = new Map<string, string>(
|
|
JSON.parse(process.env.NEXT_TEST_PKG_PATHS)
|
|
)
|
|
|
|
nextTgzFilename = pkgPaths.get('next')
|
|
})
|
|
|
|
it('should use pnpm for --use-pnpm flag', async () => {
|
|
await useTempDir(async (cwd) => {
|
|
const projectName = 'use-pnpm'
|
|
const res = await run(
|
|
[
|
|
projectName,
|
|
'--ts',
|
|
'--app',
|
|
'--use-pnpm',
|
|
'--no-linter',
|
|
'--no-src-dir',
|
|
'--no-tailwind',
|
|
'--no-import-alias',
|
|
'--no-react-compiler',
|
|
'--no-agents-md',
|
|
],
|
|
nextTgzFilename,
|
|
{
|
|
cwd,
|
|
}
|
|
)
|
|
|
|
expect(res.exitCode).toBe(0)
|
|
projectFilesShouldExist({
|
|
cwd,
|
|
projectName,
|
|
files,
|
|
})
|
|
})
|
|
})
|
|
|
|
it('should use pnpm when user-agent is pnpm', async () => {
|
|
await useTempDir(async (cwd) => {
|
|
const projectName = 'user-agent-pnpm'
|
|
const res = await run(
|
|
[
|
|
projectName,
|
|
'--ts',
|
|
'--app',
|
|
'--no-linter',
|
|
'--no-src-dir',
|
|
'--no-tailwind',
|
|
'--no-import-alias',
|
|
'--no-react-compiler',
|
|
'--no-agents-md',
|
|
],
|
|
nextTgzFilename,
|
|
{
|
|
cwd,
|
|
env: { npm_config_user_agent: 'pnpm' },
|
|
}
|
|
)
|
|
|
|
expect(res.exitCode).toBe(0)
|
|
projectFilesShouldExist({
|
|
cwd,
|
|
projectName,
|
|
files,
|
|
})
|
|
})
|
|
})
|
|
|
|
// These tests use --skip-install because:
|
|
// 1. We only need to verify the workspace file is created/not created
|
|
// 2. The CI runs pnpm v9, but when testing v10 behavior, the workspace file
|
|
// created for v10 (without packages field) would fail with pnpm v9
|
|
it('should create pnpm-workspace.yaml for pnpm v10+', async () => {
|
|
await useTempDir(async (cwd) => {
|
|
const projectName = 'pnpm-v10-workspace'
|
|
const res = await run(
|
|
[
|
|
projectName,
|
|
'--ts',
|
|
'--app',
|
|
'--no-linter',
|
|
'--no-src-dir',
|
|
'--no-tailwind',
|
|
'--no-import-alias',
|
|
'--no-react-compiler',
|
|
'--no-agents-md',
|
|
'--skip-install',
|
|
],
|
|
nextTgzFilename,
|
|
{
|
|
cwd,
|
|
env: { npm_config_user_agent: 'pnpm/10.0.0 npm/? node/v20.0.0' },
|
|
}
|
|
)
|
|
|
|
expect(res.exitCode).toBe(0)
|
|
projectFilesShouldExist({
|
|
cwd,
|
|
projectName,
|
|
files: ['package.json', 'pnpm-workspace.yaml'],
|
|
})
|
|
})
|
|
})
|
|
|
|
it('should NOT create pnpm-workspace.yaml for pnpm v9', async () => {
|
|
await useTempDir(async (cwd) => {
|
|
const projectName = 'pnpm-v9-no-workspace'
|
|
const res = await run(
|
|
[
|
|
projectName,
|
|
'--ts',
|
|
'--app',
|
|
'--no-linter',
|
|
'--no-src-dir',
|
|
'--no-tailwind',
|
|
'--no-import-alias',
|
|
'--no-react-compiler',
|
|
'--no-agents-md',
|
|
'--skip-install',
|
|
],
|
|
nextTgzFilename,
|
|
{
|
|
cwd,
|
|
env: { npm_config_user_agent: 'pnpm/9.13.2 npm/? node/v20.0.0' },
|
|
}
|
|
)
|
|
|
|
expect(res.exitCode).toBe(0)
|
|
projectFilesShouldNotExist({
|
|
cwd,
|
|
projectName,
|
|
files: ['pnpm-workspace.yaml'],
|
|
})
|
|
})
|
|
})
|
|
|
|
it('should use pnpm for --use-pnpm flag with example', async () => {
|
|
await useTempDir(async (cwd) => {
|
|
const projectName = 'use-pnpm-with-example'
|
|
const res = await run(
|
|
[projectName, '--use-pnpm', '--example', FULL_EXAMPLE_PATH],
|
|
nextTgzFilename,
|
|
{ cwd }
|
|
)
|
|
|
|
expect(res.exitCode).toBe(0)
|
|
projectFilesShouldExist({
|
|
cwd,
|
|
projectName,
|
|
files,
|
|
})
|
|
})
|
|
})
|
|
|
|
it('should use pnpm when user-agent is pnpm with example', async () => {
|
|
await useTempDir(async (cwd) => {
|
|
const projectName = 'user-agent-pnpm-with-example'
|
|
const res = await run(
|
|
[projectName, '--example', FULL_EXAMPLE_PATH],
|
|
nextTgzFilename,
|
|
{
|
|
cwd,
|
|
env: { npm_config_user_agent: 'pnpm' },
|
|
}
|
|
)
|
|
|
|
expect(res.exitCode).toBe(0)
|
|
projectFilesShouldExist({
|
|
cwd,
|
|
projectName,
|
|
files,
|
|
})
|
|
})
|
|
})
|
|
})
|