dojo/grunt-dojo2-extras

Typedoc Integration Tests

devpaul opened this issue · 1 comments

devpaul commented

Typedoc is an item undergoing major improvement while also being integral to all of the Dojo 2 projects. It would be good to have a set of integration tests to ensure given a set of inputs that we can produce a set of desired API documentation. There is currently a basic typedoc integration test that validates building API documentation outside of the current working directory. We should add tests that:

  • test typedoc's externalPattern and excludeExternals option
  • test typedoc's exclude option
  • test the creation of JSON with typedoc
  • test typedoc's includeDeclarations option
jacobroufa commented

@eheasley I cannot edit the Estimate field for this issue, and I've not discussed this issue with @devpaul yet as I'm working on #11 first. Given that, I'm inclined to pad my estimate more, so probably 4-5 days of work. The tests are described above plainly enough but I've never worked with typedoc before, so I'll adjust this once I've got a better handle on what the expectations are for these tests.