TypeDoc 0.16.4: project.removeReflection does not fully remove a reflection

[christopherthielen]

• I have checked issues with bug label and found no duplicates

Expected Behavior

Calling ProjectReflection.removeReflection() should remove the reflection from the project

Actual Behavior

A reference to the removed reflection remains in the ProjectReflection.reflections array. This array is still used in some typedoc code to iterate reflections.

If --json is used, the reflection does not appear in the output. However, the reflection appears in the output if --out dist is used.

Steps to reproduce the bug

Create a plugin that deletes reflections, then generate HTML docs. Note that the deleted modules appear in the module list table of contents.

./delete-this-reflection.ts

export class Test {
  public number = 1;
  private string = "asfff";
  method(arg: number) { }
}

./delete-reflections-plugin.js

const { Converter } = require('typedoc/dist/lib/converter');
module.exports = function load(host) {
  const reflections = [];
  const app = host.application;

  app.converter.on(Converter.EVENT_CREATE_DECLARATION, (context, reflection) => {
    reflections.push(reflection);
  });

  app.converter.on(Converter.EVENT_RESOLVE_BEGIN, context => {
    reflections.forEach(reflection => context.project.removeReflection(reflection));
  });
}

Then run this command:

npm init -y
npm install typedoc@0.16.4
./node_modules/.bin/typedoc --plugin ../../../../../delete-reflections-plugin ./delete-this-reflection.ts --out dist

Note that the deleted Module reflection still appears in the table of contents:

Environment

• Typedoc version: 0.16.4
• Node.js version: 10.15.1
• OS: MacOS Catalina 10.15.2

Other details

I encountered this while trying to update typescript-plugin-external-module-name plugin to support 0.16.4

[Gerrit0]

Thanks for the reproduction! Should be an easy fix.

[Gerrit0]

Fixed in 0.16.6

[christopherthielen]

wow thanks! so fast :)