Skip to content

Commit

Permalink
Mention app dir in TS setup tip (#70337)
Browse files Browse the repository at this point in the history
<!-- Thanks for opening a PR! Your contribution is much appreciated.
To make sure your PR is handled as smoothly as possible we request that
you follow the checklist sections below.
Choose the right checklist for the change(s) that you're making:

## For Contributors

### Improving Documentation

- Run `pnpm prettier-fix` to fix formatting issues before opening the
PR.
- Read the Docs Contribution Guide to ensure your contribution follows
the docs guidelines:
https://nextjs.org/docs/community/contribution-guide

### Adding or Updating Examples

- The "examples guidelines" are followed from our contributing doc
https://github.com/vercel/next.js/blob/canary/contributing/examples/adding-examples.md
- Make sure the linting passes by running `pnpm build && pnpm lint`. See
https://github.com/vercel/next.js/blob/canary/contributing/repository/linting.md

### Fixing a bug

- Related issues linked using `fixes #number`
- Tests added. See:
https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs
- Errors have a helpful link attached, see
https://github.com/vercel/next.js/blob/canary/contributing.md

### Adding a feature

- Implements an existing feature request or RFC. Make sure the feature
request has been accepted for implementation before opening a PR. (A
discussion must be opened, see
https://github.com/vercel/next.js/discussions/new?category=ideas)
- Related issues/discussions are linked using `fixes #number`
- e2e tests added
(https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs)
- Documentation added
- Telemetry added. In case of a feature if it's used or not.
- Errors have a helpful link attached, see
https://github.com/vercel/next.js/blob/canary/contributing.md


## For Maintainers

- Minimal description (aim for explaining to someone not on the team to
understand the PR)
- When linking to a Slack thread, you might want to share details of the
conclusion
- Link both the Linear (Fixes NEXT-xxx) and the GitHub issues
- Add review comments if necessary to explain to the reviewer the logic
behind a change

### What?

### Why?

### How?

Closes NEXT-
Fixes #

-->

### What?

Update the tip to also mention `app` directory when setting up
TypeScript.

### Why?

The user may be using App Router instead of Pages Router (or both).

### How?

---------

Co-authored-by: JJ Kasper <jj@jjsweb.site>
  • Loading branch information
kidonng and ijjk committed Sep 23, 2024
1 parent e2b56d6 commit 055b7c2
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion packages/next/src/lib/typescript/missingDependencyError.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ export function missingDepsError(
bold(
'If you are not trying to use TypeScript, please remove the ' +
cyan('tsconfig.json') +
' file from your package root (and any TypeScript files in your pages directory).'
' file from your package root (and any TypeScript files in your app and pages directories).'
)

throw new FatalError(
Expand Down
2 changes: 1 addition & 1 deletion packages/next/src/lib/verify-typescript-setup.ts
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ export async function verifyTypeScriptSetup({
bold(
'If you are not trying to use TypeScript, please remove the ' +
cyan('tsconfig.json') +
' file from your package root (and any TypeScript files in your pages directory).'
' file from your package root (and any TypeScript files in your app and pages directories).'
) +
'\n'
)
Expand Down

0 comments on commit 055b7c2

Please sign in to comment.