Unverified Commit 6bfd8184 authored by Joseph's avatar Joseph Committed by GitHub

Fix grammar and typos in typescript doc (#86513)

<!-- 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

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

### 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?
Fixes grammar and typos in the TypeScript configuration documentation.

### Why?
To improve the clarity and correctness of the documentation.

### How?
- Removed an unnecessary article ("the") on line 38.
- Corrected a preposition ("on" to "in") on line 128.
- Fixed subject-verb agreement ("need" to "needs") on line 158.

Closes NEXT-
Fixes #

-->

---
[Slack
Thread](https://vercel.slack.com/archives/C07BS1WEYAZ/p1764105619569089?thread_ts=1764105619.569089&cid=C07BS1WEYAZ)

<a
href="https://cursor.com/background-agent?bcId=bc-732fcdec-b21b-4ce1-9c26-b10386636edc"><picture><source
media="(prefers-color-scheme: dark)"
srcset="https://cursor.com/open-in-cursor-dark.svg"><source
media="(prefers-color-scheme: light)"
srcset="https://cursor.com/open-in-cursor-light.svg"><img alt="Open in
Cursor"
src="https://cursor.com/open-in-cursor.svg"></picture></a>&nbsp;<a
href="https://cursor.com/agents?id=bc-732fcdec-b21b-4ce1-9c26-b10386636edc"><picture><source
media="(prefers-color-scheme: dark)"
srcset="https://cursor.com/open-in-web-dark.svg"><source
media="(prefers-color-scheme: light)"
srcset="https://cursor.com/open-in-web-light.svg"><img alt="Open in Web"
src="https://cursor.com/open-in-web.svg"></picture></a>
Co-authored-by: 's avatarCursor Agent <cursoragent@cursor.com>
parent f585c0dd
......@@ -35,7 +35,7 @@ Now, when editing files, the custom plugin will be enabled. When running `next b
The TypeScript plugin can help with:
- Warning if the invalid values for [segment config options](/docs/app/api-reference/file-conventions/route-segment-config) are passed.
- Warning if invalid values for [segment config options](/docs/app/api-reference/file-conventions/route-segment-config) are passed.
- Showing available options and in-context documentation.
- Ensuring the `'use client'` directive is used correctly.
- Ensuring client hooks (like `useState`) are only used in Client Components.
......@@ -125,7 +125,7 @@ NODE_OPTIONS=--experimental-transform-types next <command>
#### For CommonJS Projects (Default)
Although `next.config.ts` supports native ESM syntax on CommonJS projects, Node.js will still assume `next.config.ts` is a CommonJS file by default, resulting in Node.js reparsing the file as ESM when module syntax is detected. Therefore, we recommend using the `next.config.mts` file for CommonJS projects to explicitly indicate it's an ESM module:
Although `next.config.ts` supports native ESM syntax in CommonJS projects, Node.js will still assume `next.config.ts` is a CommonJS file by default, resulting in Node.js reparsing the file as ESM when module syntax is detected. Therefore, we recommend using the `next.config.mts` file for CommonJS projects to explicitly indicate it's an ESM module:
```ts filename="next.config.mts"
import type { NextConfig } from 'next'
......@@ -155,7 +155,7 @@ Works in both the Pages and App Router for the `href` prop in `next/link`. In th
Literal `href` strings are validated, while non-literal `href`s may require a cast with `as Route`.
To opt-into this feature, `typedRoutes` need to be enabled and the project needs to be using TypeScript.
To opt-into this feature, `typedRoutes` needs to be enabled and the project needs to be using TypeScript.
```ts filename="next.config.ts"
import type { NextConfig } from 'next'
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment