Skip to content

Commit

Permalink
Add warning for missing tsconfig
Browse files Browse the repository at this point in the history
  • Loading branch information
Gerrit0 committed Oct 23, 2022
1 parent d1f8927 commit cbe6e16
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 0 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Unreleased

### Features

- Improved error reporting when failing to find entry points, #2080, #2082.

### Bug Fixes

- Constructor parameter-properties will now use the `@param` comment for the parameter if available, #1261.
Expand Down
8 changes: 8 additions & 0 deletions src/lib/utils/options/readers/tsconfig.ts
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ import {
tsdocModifierTags,
} from "../tsdoc-defaults";
import { unique } from "../../array";
import { EntryPointStrategy } from "../../entry-point";

function isFile(file: string) {
return existsSync(file) && statSync(file).isFile();
Expand Down Expand Up @@ -104,6 +105,13 @@ export class TSConfigReader implements OptionsReader {
logger.error(
`The tsconfig file ${nicePath(file)} does not exist`
);
} else if (
container.getValue("entryPointStrategy") !==
EntryPointStrategy.Packages
) {
logger.warn(
"No tsconfig file found, this will prevent TypeDoc from finding your entry points."
);
}
return;
}
Expand Down

0 comments on commit cbe6e16

Please sign in to comment.