Skip to content

Update typedoc-plugin-external-module-name to the latest version 🚀#291

Merged
bingenito merged 2 commits intomasterfrom
greenkeeper/typedoc-plugin-external-module-name-3.0.0
Jan 28, 2020
Merged

Update typedoc-plugin-external-module-name to the latest version 🚀#291
bingenito merged 2 commits intomasterfrom
greenkeeper/typedoc-plugin-external-module-name-3.0.0

Conversation

@greenkeeper
Copy link
Contributor

@greenkeeper greenkeeper bot commented Jan 16, 2020

The devDependency typedoc-plugin-external-module-name was updated from 2.2.1 to 3.0.0.

This version is not covered by your current version range.

If you don’t accept this pull request, your project will work just like it did before. However, you might be missing out on a bunch of new features, fixes and/or performance improvements from the dependency update.


Publisher: christopherthielen
License: MIT

Release Notes for 3.0.0

3.0.0 (2020-01-16)

Compare typedoc-plugin-external-module-name versions 2.2.1 and 3.0.0

Bug Fixes

  • emptycomment: Remove empty comments on source reflections that are being merged, just in case.. not sure if this is even necessary! (bd9b5cd)
  • typedoc0.16: Some fixes for 0.16.x (WIP) (0089d19)

Features

  • typedoc0.16.4: Support typedoc 0.16.4 (02aa15a)

BREAKING CHANGE

This plugin no longer attempts to work around the two comment problem in order to identify a comment as module documentation. I recommend using the @packageDocumentation annotation going forward. The issue comment states that TypeDoc will continue to support the two comment legacy mechanism.

Before:

/** @module foo */

After:

/** @packageDocumentation @module foo */

or

/** @packageDocumentation @module foo */ /** for typedoc */
Commits

The new version differs by 9 commits.

  • eb9951b 3.0.0
  • e36ae2a chore: Add a barebones DEVELOPING.md with instructions for running the integration tests
  • f2dad45 test: Use a github actions matrix to test typedoc versions
  • 8e36d35 test: add tests for typedoc 0.16.5
  • 02aa15a feat(typedoc0.16.4): Support typedoc 0.16.4
  • 2be99b7 test: Add some tests, update some tests
  • c8a04d4 test: Add some tests, update some tests
  • 0089d19 fix(typedoc0.16): Some fixes for 0.16.x (WIP)
  • bd9b5cd fix(emptycomment): Remove empty comments on source reflections that are being merged, just in case.. not sure if this is even necessary!

See the full diff


FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.


Your Greenkeeper bot 🌴

@greenkeeper greenkeeper bot requested a review from a team January 16, 2020 05:03
Copy link
Member

@bingenito bingenito left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@codecov
Copy link

codecov bot commented Jan 28, 2020

Codecov Report

Merging #291 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #291   +/-   ##
=======================================
  Coverage   93.37%   93.37%           
=======================================
  Files          16       16           
  Lines        1539     1539           
  Branches      264      264           
=======================================
  Hits         1437     1437           
  Misses        102      102

@bingenito bingenito merged commit 298fdd4 into master Jan 28, 2020
@greenkeeper greenkeeper bot deleted the greenkeeper/typedoc-plugin-external-module-name-3.0.0 branch January 28, 2020 11:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant