seas-computing / react-boilerplate

Starting point for react-based projects at SEAS computing

0 stars 1 forks source link

Switch TypeDoc to file mode #18

Closed rmainwork closed 5 years ago

rmainwork commented 5 years ago

Submodules are currently broken in TypeDoc (as-of TypeDoc v0.14). This appears to be because of a change made by TypeDoc to their underlying API. More information in: christopherthielen/typedoc-plugin-external-module-name#332. That being the case, using file mode at least cleans up the output a little and makes it easier to until submodules can be used.

This PR aims to clean up the organization of documented objects a little so that this:

Ends up looking like this:

Types of changes

[x] Bug fix (non-breaking change which fixes an issue)
[ ] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

[x] I have run eslint on the code
[x] I have added JSDoc for all of my code (where applicable)
[ ] I have added tests to cover my changes.

Priority:

[x] Normal
[ ] High

Related Issues:

Provides a (partial) work-around for #17

codecov[bot] commented 5 years ago

Codecov Report

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

@@           Coverage Diff           @@
##           master      #18   +/-   ##
=======================================
  Coverage   95.91%   95.91%           
=======================================
  Files          14       14           
  Lines          98       98           
  Branches        9        9           
=======================================
  Hits           94       94           
  Misses          2        2           
  Partials        2        2

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 1ec0cb7...77593d7. Read the comment docs.

rmainwork commented 5 years ago

I'm not so sure we need to do this.

I configured this deployment to GH Pages a while ago without .nojekylll. I think you can configure this.

jonseitz commented 5 years ago

Strictly speaking it's not required to deploy on github pages, but that's the reason why the links in the current deployed pages at https://seas-computing.github.io/react-boilerplate/ aren't working. I don't think it will continue to be an issue with the mode changed, but I'd rather change this now to avoid running into this bug again if TypeDoc adds _ to start of other filenames in the future.

(There's also a Typedoc plugin to do the same thing, but I'd prefer not to add extra dependencies for something this minor.)

rmainwork commented 5 years ago

I was trying to figure out why node-pureimage didn't require a .nojekyl file. Turns out that the file/folder names don't begin with an underscore. I guess that would be why.

Addressed in 77593d7b5b4d5212867bc7db83ed2aa0a22a511d