feat: Discover prettier config files

typedoc2md · Apr 25, 2023 · 8051a37 · 8051a37
1 parent 8d80ccf
commit 8051a37
Show file tree

Hide file tree

Showing 2 changed files with 29 additions and 5 deletions.
diff --git a/packages/typedoc-plugin-markdown/README.md b/packages/typedoc-plugin-markdown/README.md
@@ -15,6 +15,8 @@ The plugin replaces the default HTML theme with a built-in Markdown theme and ex
 
 > Please note the `next` pre-release version may contain breaking changes within the same semantic version.
 
+> [TypeDoc](https://typedoc.org) and [Prettier](https://prettier.io/) are both required peer dependencies.
+
 ```bash
 npm install typedoc-plugin-markdown@next --save-dev
 ```
@@ -25,8 +27,6 @@ npm install typedoc-plugin-markdown@next --save-dev
 typedoc --plugin typedoc-plugin-markdown
 ```
 
-Generated Markdown is now parsed with [Prettier](https://prettier.io/) which is backed by the remark-parse package. This does require an additional peer dependency, however introduces a consistent output format.
-
 ## Options
 
 The following options can be used in addition to relevant [TypeDoc options](https://typedoc.org/options/)
@@ -90,7 +90,17 @@ See [Front matter options](./docs/frontmatter.md) for further documentation.
 - **`--baseUrl`**<br>
   Specifies the base url for internal link. If omitted all urls will be relative. Defaults to `.`
 
-## Documentation
+## Output formatting (Prettier)
+
+Generated Markdown is now parsed with [Prettier](https://prettier.io/) which is backed by the remark-parse package. This does require an additional peer dependency but has several benefits:
+
+- Produces a consistent format.
+- Remove unnecessary escape characters.
+- Formats code blocks inside comment fenced blocks.
+
+Any [prettier configuration](https://prettier.io/docs/en/configuration.html) files discovered will be passed as options to the parser.
+
+## Further Documentation
 
 - [File output options](./docs/file-output-options.md)
 - [Frontmatter options](./docs/frontmatter.md)

diff --git a/packages/typedoc-plugin-markdown/src/theme.ts b/packages/typedoc-plugin-markdown/src/theme.ts
@@ -16,6 +16,7 @@ import { TemplateMapping } from './models';
 import { URL_PREFIX } from './support/constants';
 import { slugify } from './support/utils';
 import { MarkdownThemeRenderContext } from './theme-context';
+
 export class MarkdownTheme extends Theme {
   @BindOption('entryDocument') entryDocument!: string;
   @BindOption('entryPoints') entryPoints!: string[];
@@ -26,8 +27,8 @@ export class MarkdownTheme extends Theme {
   @BindOption('preserveAnchorCasing') preserveAnchorCasing!: boolean;
   @BindOption('readme') readme!: string;
 
-  private _renderContext?: MarkdownThemeRenderContext;
-
+  private _renderContext: MarkdownThemeRenderContext;
+  private _prettierOptions: prettier.Options | null;
   private anchors: Record<string, string[]>;
 
   constructor(renderer: Renderer) {
@@ -50,6 +51,18 @@ export class MarkdownTheme extends Theme {
     return this._renderContext;
   }
 
+  getPrettierOptions() {
+    if (!this._prettierOptions) {
+      this._prettierOptions = this.resolvePrettierOptions();
+    }
+    return this._prettierOptions;
+  }
+
+  resolvePrettierOptions() {
+    const prettierFile = prettier.resolveConfigFile.sync();
+    return prettierFile ? prettier.resolveConfig.sync(prettierFile) : null;
+  }
+
   readmeTemplate = (pageEvent: PageEvent<ProjectReflection>) => {
     return this.getRenderContext().templates.readmeTemplate(pageEvent);
   };
@@ -71,6 +84,7 @@ export class MarkdownTheme extends Theme {
     template: RenderTemplate<PageEvent<Reflection>>,
   ): string {
     return prettier.format(template(page) as string, {
+      ...this.getPrettierOptions(),
       parser: 'markdown',
     });
   }