Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix all internal JSDoc comments #14

Closed

Conversation

jakebailey
Copy link
Owner

@jakebailey jakebailey commented Sep 7, 2022

If these are regular comments, then they won't appear in our d.ts files.
But, now we are relying on an external d.ts bundler to produce our final
merged, so they need to be present in the "input" d.ts files, meaning
they have to be JSDoc comments.

These comments only work today because all of our builds load their TS
files from scratch, so they see the actual source files and their
non-JSDoc comments.

The comments also need to be attached to a declaration, not floating,
otherwise they won't be used by api-extractor, so move them if needed.


Please do not comment on this PR. Depending on how this set of PRs evolves, this PR's contents may change entirely based on the order of commits.

This PR is a part of a stack:

  1. Make a few changes to allow all code to be loaded as one project
  2. Explicitly reference ts namespace in tsserverlibrary
  3. Generated module conversion step - unindent
  4. Generated module conversion step - explicitify
  5. Generated module conversion step - stripNamespaces
  6. Generated module conversion step - inlineImports
  7. Generated module conversion step - .git-ignore-blame-revs
  8. Add gitlens settings suggestion
  9. Make processDiagnosticMessages generate a module
  10. Fix up linting, make lint clean
  11. Undo changes needed to load codebase into ts-morph
  12. Add JSDoc eslint rule
  13. Fix all internal JSDoc comments (this PR)
  14. Convert require calls to imports
  15. Remove typescriptServices, protocol.d.ts, typescript_standalone.d.ts
  16. Get codebase building pre bundling
  17. Add build via esbuild
  18. Add dts bundling
  19. Consolidate checks that test if the current environment is Node
  20. Add ts to globalThis in run.js for convenience during debugging
  21. Rename Gulpfile to Herebyfile for improved git diff
  22. Change build system to hereby
  23. Update baselines for corrected line endings in lib files
  24. Use jsonc-parser instead of LKG compiler in build
  25. Modernize localize script, use new XML library
  26. Don't use needsUpdate for quick tasks
  27. Remove mkdirp
  28. Export ts namespace from tsserver for hacky-post patching
  29. Directly import namespaces for improved esbuild output
  30. Ensure ts object passed to plugins contains deprecatedCompat declarations
  31. Move compiler-debug into Debug namespace, which allows the compiler to be tree shaken
  32. Remove Promise redeclaration
  33. Remove globalThisShim and globalThis modification for TypeScriptServicesFactory
  34. Disable slow CodeQL queries
  35. Remove outFiles from launch.json
  36. Remove dynamicImport and setDynamicImport

@jakebailey jakebailey force-pushed the transform-stack-commit-12 branch from 7bb2d56 to efaf2d7 Compare September 13, 2022 16:52
@jakebailey jakebailey force-pushed the transform-stack-commit-13 branch from 739e71d to a31b0ef Compare September 13, 2022 16:52
@jakebailey jakebailey force-pushed the transform-stack-commit-12 branch from efaf2d7 to 9d46c28 Compare September 13, 2022 20:27
@jakebailey jakebailey force-pushed the transform-stack-commit-13 branch from a31b0ef to 223a3f5 Compare September 13, 2022 20:27
@jakebailey jakebailey force-pushed the transform-stack-commit-12 branch from 9d46c28 to 2e6b763 Compare September 13, 2022 21:02
@jakebailey jakebailey changed the title Get entrypoints working Get test suites running Sep 13, 2022
@jakebailey jakebailey force-pushed the transform-stack-commit-13 branch from 223a3f5 to 9b79d42 Compare September 13, 2022 21:02
@jakebailey jakebailey force-pushed the transform-stack-commit-12 branch from 2e6b763 to 0c5afda Compare September 13, 2022 21:47
@jakebailey jakebailey force-pushed the transform-stack-commit-13 branch from 9b79d42 to 72d390c Compare September 13, 2022 21:47
@jakebailey jakebailey force-pushed the transform-stack-commit-12 branch from 0c5afda to bb1c98d Compare September 13, 2022 21:58
@jakebailey jakebailey changed the title Get test suites running Get entrypoints working Sep 13, 2022
@jakebailey jakebailey force-pushed the transform-stack-commit-13 branch from 72d390c to ff637c0 Compare September 13, 2022 21:58
@jakebailey jakebailey force-pushed the transform-stack-commit-12 branch from bb1c98d to b75e466 Compare September 13, 2022 23:22
@jakebailey jakebailey force-pushed the transform-stack-commit-13 branch from ff637c0 to 40f3f72 Compare September 13, 2022 23:22
@jakebailey jakebailey force-pushed the transform-stack-commit-12 branch from b75e466 to 980ee49 Compare September 14, 2022 17:26
@jakebailey jakebailey force-pushed the transform-stack-commit-13 branch from 40f3f72 to d4005a7 Compare September 14, 2022 17:26
@jakebailey jakebailey force-pushed the transform-stack-commit-12 branch from 980ee49 to ee7ee41 Compare September 16, 2022 04:35
@jakebailey jakebailey force-pushed the transform-stack-commit-13 branch from d4005a7 to c80e914 Compare September 16, 2022 04:35
@jakebailey jakebailey force-pushed the transform-stack-commit-12 branch from ee7ee41 to 8debd97 Compare September 16, 2022 04:37
@jakebailey jakebailey force-pushed the transform-stack-commit-13 branch from c80e914 to 1764185 Compare September 16, 2022 04:37
@jakebailey jakebailey force-pushed the transform-stack-commit-12 branch from 8debd97 to d7091d6 Compare September 16, 2022 05:43
@jakebailey jakebailey force-pushed the transform-stack-commit-13 branch from 1764185 to ebf0539 Compare September 16, 2022 05:43
@jakebailey jakebailey force-pushed the transform-stack-commit-12 branch from d7091d6 to 7d9b69a Compare September 19, 2022 20:11
@jakebailey jakebailey force-pushed the transform-stack-commit-13 branch from ebf0539 to 22a440a Compare September 19, 2022 20:11
@jakebailey jakebailey force-pushed the transform-stack-commit-12 branch from 7d9b69a to df9f2b8 Compare September 19, 2022 20:37
@jakebailey jakebailey force-pushed the transform-stack-commit-13 branch from 22a440a to e744bbc Compare September 19, 2022 20:38
@jakebailey jakebailey force-pushed the transform-stack-commit-12 branch from df9f2b8 to d6035b0 Compare September 20, 2022 05:06
@jakebailey jakebailey force-pushed the transform-stack-commit-13 branch from e744bbc to 0d8842b Compare September 20, 2022 05:06
@jakebailey jakebailey force-pushed the transform-stack-commit-12 branch from d6035b0 to 94dedfd Compare September 20, 2022 05:10
@jakebailey jakebailey force-pushed the transform-stack-commit-13 branch from 0d8842b to 99362b4 Compare September 20, 2022 05:10
@jakebailey jakebailey changed the title Add JSDoc eslint rule Fix all internal JSDoc comments Oct 24, 2022
@jakebailey jakebailey force-pushed the transform-stack-commit-13 branch from 4ff5210 to fb79c58 Compare October 24, 2022 23:14
@jakebailey jakebailey force-pushed the transform-stack-commit-12 branch from 1d08a7a to efb82d0 Compare October 25, 2022 02:23
@jakebailey jakebailey force-pushed the transform-stack-commit-13 branch from fb79c58 to d611199 Compare October 25, 2022 02:23
@jakebailey jakebailey force-pushed the transform-stack-commit-12 branch from efb82d0 to 67fb332 Compare October 27, 2022 04:21
@jakebailey jakebailey force-pushed the transform-stack-commit-13 branch from d611199 to f73b5d5 Compare October 27, 2022 04:22
@jakebailey jakebailey force-pushed the transform-stack-commit-12 branch from 67fb332 to af3c30f Compare October 27, 2022 17:39
@jakebailey jakebailey force-pushed the transform-stack-commit-13 branch from f73b5d5 to f9a831b Compare October 27, 2022 17:40
@jakebailey jakebailey force-pushed the transform-stack-commit-12 branch from af3c30f to 763d093 Compare October 28, 2022 02:21
@jakebailey jakebailey force-pushed the transform-stack-commit-13 branch from f9a831b to 55034d7 Compare October 28, 2022 02:22
@jakebailey jakebailey force-pushed the transform-stack-commit-12 branch from 763d093 to f63b759 Compare October 31, 2022 21:32
@jakebailey jakebailey force-pushed the transform-stack-commit-13 branch from 55034d7 to 875c9e5 Compare October 31, 2022 21:33
@jakebailey jakebailey force-pushed the transform-stack-commit-12 branch from f63b759 to 8dd2d7a Compare November 2, 2022 00:43
@jakebailey jakebailey force-pushed the transform-stack-commit-13 branch from 875c9e5 to a976a7b Compare November 2, 2022 00:43
@jakebailey jakebailey force-pushed the transform-stack-commit-12 branch from 8dd2d7a to 75cbb86 Compare November 2, 2022 16:54
@jakebailey jakebailey force-pushed the transform-stack-commit-13 branch from a976a7b to 0034428 Compare November 2, 2022 16:55
@jakebailey jakebailey force-pushed the transform-stack-commit-12 branch from 75cbb86 to 80efc34 Compare November 2, 2022 19:44
@jakebailey jakebailey force-pushed the transform-stack-commit-13 branch from 0034428 to bd75883 Compare November 2, 2022 19:45
@jakebailey jakebailey force-pushed the transform-stack-commit-12 branch from 80efc34 to 2141f05 Compare November 6, 2022 21:52
@jakebailey jakebailey force-pushed the transform-stack-commit-13 branch from bd75883 to 6549b80 Compare November 6, 2022 21:52
@jakebailey jakebailey force-pushed the transform-stack-commit-12 branch from 2141f05 to 86f4fd2 Compare November 6, 2022 21:58
@jakebailey jakebailey force-pushed the transform-stack-commit-13 branch from 6549b80 to 48ab28c Compare November 6, 2022 21:58
@jakebailey jakebailey force-pushed the transform-stack-commit-12 branch from 86f4fd2 to 41f98af Compare November 7, 2022 03:53
@jakebailey jakebailey force-pushed the transform-stack-commit-13 branch from 48ab28c to b71c759 Compare November 7, 2022 03:53
@jakebailey jakebailey force-pushed the transform-stack-commit-12 branch from 41f98af to b718f5a Compare November 7, 2022 19:27
@jakebailey jakebailey force-pushed the transform-stack-commit-13 branch from b71c759 to dcef3b9 Compare November 7, 2022 19:27
If these are regular comments, then they won't appear in our d.ts files.
But, now we are relying on an external d.ts bundler to produce our final
merged, so they need to be present in the "input" d.ts files, meaning
they have to be JSDoc comments.

These comments only work today because all of our builds load their TS
files from scratch, so they see the actual source files and their
non-JSDoc comments.

The comments also need to be attached to a declaration, not floating,
otherwise they won't be used by api-extractor, so move them if needed.
@jakebailey jakebailey force-pushed the transform-stack-commit-13 branch from dcef3b9 to 597e4a7 Compare November 7, 2022 21:37
@jakebailey jakebailey closed this Nov 7, 2022
@jakebailey jakebailey deleted the transform-stack-commit-13 branch November 7, 2022 23:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant