search

typedoc2md / typedoc-plugin-markdown

A plugin for TypeDoc that enables TypeScript API documentation to be generated in Markdown.
https://typedoc-plugin-markdown.org
MIT License
702 stars 176 forks source link

Error from plugin does not crash Docusaurus build #429

Closed PatrikTrefil closed 4 months ago

PatrikTrefil commented 1 year ago

Observed behavior

If the generation of the markdown files throws errors, then the whole build is considered to be successful.

Expected behavior

The build should fail.

Steps to reproduce

  1. Setup the plugin with docusaurus
  2. Do not install dependencies in the TypeScript project
  3. docusaurus build

Should get something like this:

../src/web-app/pages/prehled.tsx:7:18 - error TS2307: Cannot find module 'next/head' or its corresponding type declarations.

7 import Head from "next/head";

The docusaurus build returns status code 0.

tgreyuk commented 1 year ago

Thanks - good point - is fixed in next version.

tgreyuk commented 4 months ago

docusaurus-plugin-typedoc@1.0.0