ca84688229
I noticed our internal comments about exported functions that should not be used in application code. TSDoc has the [`@internal`](https://tsdoc.org/pages/tags/internal/) option that can be used together with TS's [`stripInternal: true` compiler option](https://www.typescriptlang.org/tsconfig/#stripInternal), hiding these from inferred types: Before:  After:  It would also be great to use `/**/` comments instead of `//` when documenting methods/properties/functions, as these can be picked up by the editor when referring to these, so someone new to the codebase will hopefully have to jump around less to get some useful comments. ## Bug - [ ] Related issues linked using `fixes #number` - [ ] Integration tests added - [ ] Errors have helpful link attached, see `contributing.md` ## Feature - [ ] Implements an existing feature request or RFC. Make sure the feature request has been accepted for implementation before opening a PR. - [ ] Related issues linked using `fixes #number` - [ ] Integration tests added - [ ] Documentation added - [ ] Telemetry added. In case of a feature if it's used or not. - [ ] Errors have helpful link attached, see `contributing.md` ## Documentation / Examples - [ ] Make sure the linting passes by running `pnpm lint` - [ ] The examples guidelines are followed from [our contributing doc](https://github.com/vercel/next.js/blob/canary/contributing.md#adding-examples)
13 lines
326 B
JSON
13 lines
326 B
JSON
{
|
|
"extends": "../../tsconfig-tsec.json",
|
|
"compilerOptions": {
|
|
"strict": true,
|
|
"module": "esnext",
|
|
"target": "ES2017",
|
|
"esModuleInterop": true,
|
|
"moduleResolution": "node",
|
|
"jsx": "react",
|
|
"stripInternal": true
|
|
},
|
|
"exclude": ["dist", "./*.d.ts", "future/*.d.ts", "image-types/global.d.ts"]
|
|
}
|