Skip to content

Commit cbe6e16

Browse files
committed
Add warning for missing tsconfig
1 parent d1f8927 commit cbe6e16

File tree

2 files changed

+12
-0
lines changed

2 files changed

+12
-0
lines changed

CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# Unreleased
22

3+
### Features
4+
5+
- Improved error reporting when failing to find entry points, #2080, #2082.
6+
37
### Bug Fixes
48

59
- Constructor parameter-properties will now use the `@param` comment for the parameter if available, #1261.

src/lib/utils/options/readers/tsconfig.ts

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ import {
2222
tsdocModifierTags,
2323
} from "../tsdoc-defaults";
2424
import { unique } from "../../array";
25+
import { EntryPointStrategy } from "../../entry-point";
2526

2627
function isFile(file: string) {
2728
return existsSync(file) && statSync(file).isFile();
@@ -104,6 +105,13 @@ export class TSConfigReader implements OptionsReader {
104105
logger.error(
105106
`The tsconfig file ${nicePath(file)} does not exist`
106107
);
108+
} else if (
109+
container.getValue("entryPointStrategy") !==
110+
EntryPointStrategy.Packages
111+
) {
112+
logger.warn(
113+
"No tsconfig file found, this will prevent TypeDoc from finding your entry points."
114+
);
107115
}
108116
return;
109117
}

0 commit comments

Comments
 (0)