Warn if package.json does not include name/version

Resolves #1907

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Unreleased
 
+### Bug Fixes
+
+-   TypeDoc will now warn if a project name/version cannot be inferred from a package.json file, #1907.
+
 ## v0.22.14 (2022-04-07)
 
 ### Bug Fixes

src/lib/converter/plugins/PackagePlugin.ts

@@ -37,6 +37,10 @@ export class PackagePlugin extends ConverterComponent {
         this.listenTo(this.owner, {
             [Converter.EVENT_BEGIN]: this.onBegin,
             [Converter.EVENT_RESOLVE_BEGIN]: this.onBeginResolve,
+            [Converter.EVENT_END]: () => {
+                delete this.readmeFile;
+                delete this.packageFile;
+            },
         });
     }
 
@@ -64,7 +68,7 @@ export class PackagePlugin extends ConverterComponent {
             getCommonDirectory(this.application.options.getValue("entryPoints"))
         );
         this.application.logger.verbose(
-            `Begin readme search at ${nicePath(dirName)}`
+            `Begin readme.md/package.json search at ${nicePath(dirName)}`
         );
         while (!packageAndReadmeFound() && !reachedTopDirectory(dirName)) {
             FS.readdirSync(dirName).forEach((file) => {
@@ -100,11 +104,30 @@ export class PackagePlugin extends ConverterComponent {
         if (this.packageFile) {
             project.packageInfo = JSON.parse(readFile(this.packageFile));
             if (!project.name) {
-                project.name = String(project.packageInfo.name);
+                if (!project.packageInfo.name) {
+                    context.logger.warn(
+                        'The --name option was not specified, and package.json does not have a name field. Defaulting project name to "Documentation"'
+                    );
+                    project.name = "Documentation";
+                } else {
+                    project.name = String(project.packageInfo.name);
+                }
             }
             if (this.includeVersion) {
                 project.name = `${project.name} - v${project.packageInfo.version}`;
             }
+        } else {
+            if (!project.name) {
+                context.logger.warn(
+                    'The --name option was not specified, and no package.json was found. Defaulting project name to "Documentation"'
+                );
+                project.name = "Documentation";
+            }
+            if (this.includeVersion) {
+                context.logger.warn(
+                    "--includeVersion was specified, but no package.json was found. Not adding package version to the documentation."
+                );
+            }
         }
     }
 }

src/lib/utils/options/options.ts

@@ -292,7 +292,7 @@ export class Options {
     setValue(name: string, value: unknown, configPath?: string): void {
         if (this.isFrozen()) {
             throw new Error(
-                "Tried to modify an option value after options have been sealed."
+                "Tried to modify an option value after options have been frozen."
             );
         }
 

src/test/converter2.test.ts

@@ -35,6 +35,7 @@ function runTest(
         ok(sourceFile, `No source file found for ${entryPoint}`);
 
         app.logger = new TestLogger();
+        app.options.setValue("entryPoints", [entryPoint]);
         const project = app.converter.convert([
             {
                 displayName: entry,

src/test/converter2/issues/gh1907/index.ts

@@ -0,0 +1 @@
+export const foo = 123;

src/test/converter2/issues/gh1907/package.json

@@ -0,0 +1 @@
+{}

src/test/issueTests.ts

@@ -370,4 +370,12 @@ export const issueTests: {
             ["typedoc"]
         );
     },
+
+    gh1907(_project, logger) {
+        logger.expectMessage(
+            'warn: The --name option was not specified, and package.json does not have a name field. Defaulting project name to "Documentation"'
+        );
+        logger.discardDebugMessages();
+        logger.expectNoOtherMessages();
+    },
 };

src/test/programs.ts

@@ -54,13 +54,11 @@ export function getConverter2App() {
         converter2App = new Application();
         converter2App.options.addReader(new TSConfigReader());
         converter2App.bootstrap({
-            name: "typedoc",
             excludeExternals: true,
             tsconfig: join(getConverter2Base(), "tsconfig.json"),
             plugin: [],
             validation: true,
         });
-        converter2App.options.freeze();
     }
     return converter2App;
 }