Enable TS docs generation. #1324
Conversation
Codecov Report
@@ Coverage Diff @@
## master #1324 +/- ##
=======================================
Coverage 65.75% 65.75%
=======================================
Files 233 233
Lines 4068 4068
Branches 1458 1458
=======================================
Hits 2675 2675
Misses 1234 1234
Partials 159 159 Continue to review full report at Codecov.
|
| const files = glob.sync(`${componentsSrc}/**/*.js`).filter(file => !file.match(/((test|spec|index).js|(\/__mock__\/|\/__mocks__\/|\/test\/))/gmi)); | ||
| const files = | ||
| glob | ||
| .sync(`${componentsSrc}/**/*.{js,ts,tsx}`) |
There was a problem hiding this comment.
How about excluding d.ts?
| .sync(`${componentsSrc}/**/*.{js,ts,tsx}`) | |
| .sync(`${componentsSrc}/**/*.[!d.]{js,ts,tsx}`) |
Not sure about the dot, if it needs to be escaped or not.
There was a problem hiding this comment.
@karelhala the .d.ts files are filtered on the line below. The glob pattern does not play very nicely with eclusions. I find it simpler to read to split the exclusions.
There was a problem hiding this comment.
Mhh it feels a bit too heavy to call filter just to remove .d.ts files if we could just add ?!(d.) to it (previously the ignore was not correct).
That being said if you'd still prefer the filter to do the job I'd rather join them together. This way we are perfomring one extra loop just to ignore them, whic honestly feels a bit too complex.
There was a problem hiding this comment.
@karelhala I don't think glob supports ?!(d.). That is why I've gone with the additional filter.
|
|
||
| async function parseFile(file) { | ||
| async function parseTSFile(file) { | ||
| return new Promise((resolve, reject) => { |
There was a problem hiding this comment.
I know it's the same pattern as previously used. But I am not a fan of callbacks, could this be solved by using util.html#utilpromisifyoriginal? That way we'd fully use async/await and no need to mess with callbacks and nesting.
There was a problem hiding this comment.
I mean it could, but then this one function would be entirely different to every other user to generate the docs.
I can imagine this to be a nice task for one of our upcoming interns to get familiar with the environment.
There was a problem hiding this comment.
Good point! I've created issue to addess this #1326
With the TS additions, the docs generator was failing the build. This PR prepares the groundwork for generating docs from TS/TSX source files.
Additional work is required to properly generate the content
undefined