fix: readme could not be set to none in a config file

Closes #1608
TypeStrong · Jun 25, 2021 · da27756 · da27756
1 parent bf79e32
commit da27756
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 4 deletions.
diff --git a/src/lib/converter/plugins/PackagePlugin.ts b/src/lib/converter/plugins/PackagePlugin.ts
@@ -6,7 +6,6 @@ import { Converter } from "../converter";
 import { Context } from "../context";
 import { BindOption, readFile } from "../../utils";
 import { getCommonDirectory } from "../../utils/fs";
-import { join } from "path";
 
 /**
  * A handler that tries to find the package.json and readme.md files of the
@@ -48,7 +47,7 @@ export class PackagePlugin extends ConverterComponent {
         this.packageFile = undefined;
 
         // Path will be resolved already. This is kind of ugly, but...
-        const noReadmeFile = this.readme == join(process.cwd(), "none");
+        const noReadmeFile = this.readme.endsWith("none");
         if (!noReadmeFile && this.readme) {
             if (FS.existsSync(this.readme)) {
                 this.readmeFile = this.readme;

diff --git a/src/lib/output/themes/DefaultTheme.ts b/src/lib/output/themes/DefaultTheme.ts
@@ -130,7 +130,7 @@ export class DefaultTheme extends Theme {
     getUrls(project: ProjectReflection): UrlMapping[] {
         const urls: UrlMapping[] = [];
 
-        if (this.application.options.getValue("readme") === "none") {
+        if (false == hasReadme(this.application.options.getValue("readme"))) {
             project.url = "index.html";
             urls.push(new UrlMapping("index.html", project, "reflection.hbs"));
         } else {
@@ -165,7 +165,7 @@ export class DefaultTheme extends Theme {
             multipleEntryPoints
         );
         return builder.build(
-            this.application.options.getValue("readme") !== "none"
+            hasReadme(this.application.options.getValue("readme"))
         );
     }
 
@@ -581,3 +581,7 @@ export class NavigationBuilder {
         })(reflection);
     }
 }
+
+function hasReadme(readme: string) {
+    return !readme.endsWith("none");
+}