D-Pow / MockRequests / 207 / 1

100%

master: 100%

push

travis-ci

Bug fix: Fix types.d.ts outputs for nested custom typedefs

I'm not exactly sure why, but it seems any type references to the custom `@typedef` entries that are nested inside other `@typedef` entries fail to be parsed correctly by typescript, and end up with `any` as the type instead. e.g. `MockResponseConfig.dynamicResponseModFn == any` and `DynamicResponseModFn.request == any`. Idk if it's the fact that the declarations are nested inside a module/namespace or what, but none of the my work-around attempts worked (extracting them out of the function scope, unmarking them as `@member`, unmarking everything as `@member`, and all sorts of various tsconfig.json config field changes).

This meant that they had to be extracted to a separate file. But even if that helped generate the right type for a nested field, it still removed the JSDoc from them (even if tsconfig.json had `removeComments: false` and`importsNotUsedAsValues: "preserve"`). This would make IDE autocompletion way less helpful than it could've been (e.g. we should definitely tell the user what default values are and what exactly the purpose of the fields are).

Thus, the only acceptable solution was to move them to their own typescript file so that both the nested types and JSDoc would both be accurate. Of course, this hides them from the tsconfig.src.json parsing (even if changing configs like `include`, `files`, `typeRoots`). Since triple slash references (like `/// <reference path="./types.ts" />`) are ignored in `compilerOptions.module != 'AMD|System'`, they have to be imported in the src file itself so that they're properly injected into the final output types.d.ts file.

Long story short, I need to not do this manually. So a future TODO: either add a `ts-loader`/config entry to webpack.config.js, or convert the entire codebase to typescript.

84 of 84 branches covered (100.0%)

Branch coverage included in aggregate %.

131 of 131 relevant lines covered (100.0%)

63.48 hits per line