Add TS types for Check, remove circular dependency
#11901
Conversation
|
Thank you for the pull request, @jjspace! ✅ We can confirm we have a CLA on file for you. |
| ) | ||
| .replace( | ||
| /\/\*\*[\*\s\w]*?\*\/\nexport const Check: any;/m, | ||
| `\n${readFileSync("./packages/engine/Source/Core/Check.d.ts").toString()}` |
There was a problem hiding this comment.
Can this be made generic to and **/Source/**/*.d.ts file? That way any future additions don't need to tweak build code.
There was a problem hiding this comment.
I would love to do that but I couldn't find or think of a nice clean way to do that. As it is it needs to be specific to replace the definition in the types file for the corresponding code. Otherwise we'd end up with a duplicated definition which breaks TS. I'd love if tsd-jsdoc let you pass in a set of types files to use in places like this.
| * @param {string} name The name of the variable being tested | ||
| * @param {*} test The value that is to be checked | ||
| * @exception {DeveloperError} test must be defined | ||
| */ |
There was a problem hiding this comment.
Can you explain why the inline docs need to be duplicated?
There was a problem hiding this comment.
Without them the intellisense that VSCode picks up has no description of any of the functions. The way the build is adding this it's taking the file wholesale. I was not able to find a way to get the tsd-jsdoc to output anything other than const Check: any so it also didn't include any of the descriptions other than the top one for Check. It's annoying and I'd love to remove the duplication but I couldn't figure out a way to do that and I didn't want to spend a ton more time on digging into it.
Technically speaking, this should be added as an addition in |
Description
Adds types for the
Checkgroup of functions with type assertions to help in TS based projects.I chose to add this as a
Check.d.tsfile right next toCheck.jsto keep them closer together.tsd-jsdocdoesn't seem to have a way to import this types file though so it still needs a custom replace in our generate TS build step.Also removed a circular dependency I accidentally added in #11859
Issue number and link
No issue
Testing plan
npm run build-tsand make sure it succeedsSource/Ceisum.d.tsandpackages/engine/index.d.tsthat they have the correct definition forChecknpm run build-docsand make sure it succeedsCheckon the globals page.For the circular dependency you can use
dpdmto check inmainand this branch with the commandnpx dpdm packages/engine/Source/DataSources/CzmlDataSource.jsAuthor checklist
CONTRIBUTORS.mdCHANGES.mdwith a short summary of my change