Skip to content

Add JSDoc eslint rule #12

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.

Sign up for GitHub

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

Jump to bottom
Closed
wants to merge 12 commits into from
Closed

Add JSDoc eslint rule #12

wants to merge 12 commits into from

Conversation

@jakebailey
Copy link
Owner

@jakebailey jakebailey commented Sep 3, 2022 •
edited
Loading

See the next commit for a more fleshed-out description.

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 (this PR)
  13. Fix all internal JSDoc comments
  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-11 branch from cd1a0b4 to 14a4530 Compare September 3, 2022 04:43
@jakebailey jakebailey force-pushed the transform-stack-commit-12 branch from ce4b3b5 to 0810976 Compare September 3, 2022 04:43
@jakebailey jakebailey force-pushed the transform-stack-commit-11 branch from 14a4530 to c8c2f6e Compare September 7, 2022 22:31
@jakebailey jakebailey changed the title Add api-extractor Get test suites running Sep 7, 2022
@jakebailey jakebailey force-pushed the transform-stack-commit-12 branch from 0810976 to 7bb2d56 Compare September 7, 2022 22:31
@jakebailey jakebailey force-pushed the transform-stack-commit-11 branch from c8c2f6e to a3f6679 Compare September 13, 2022 16:51
@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-11 branch from a3f6679 to e1cf7e2 Compare September 13, 2022 20:27
@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-11 branch from e1cf7e2 to 1710f42 Compare September 13, 2022 21:02
@jakebailey jakebailey changed the title Get test suites running Add TODOs in Gulpfile Sep 13, 2022
@jakebailey jakebailey force-pushed the transform-stack-commit-12 branch from 9d46c28 to 2e6b763 Compare September 13, 2022 21:02
@jakebailey jakebailey force-pushed the transform-stack-commit-11 branch from 1710f42 to 4c9d190 Compare September 13, 2022 21:47
@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-11 branch from 4c9d190 to 47cd884 Compare September 13, 2022 21:58
@jakebailey jakebailey changed the title Add TODOs in Gulpfile Get test suites running Sep 13, 2022
@jakebailey jakebailey force-pushed the transform-stack-commit-12 branch from 0c5afda to bb1c98d Compare September 13, 2022 21:58
@jakebailey jakebailey force-pushed the transform-stack-commit-11 branch from 47cd884 to 48837fd Compare September 13, 2022 23:22
@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-11 branch from 48837fd to 34b5a83 Compare September 14, 2022 17:25
@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-11 branch from 34b5a83 to 572883e Compare September 16, 2022 04:35
@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-11 branch from 572883e to 89e8b12 Compare September 16, 2022 04:37
@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-11 branch from 89e8b12 to ca17f3f Compare September 16, 2022 05:43
@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-11 branch from ca17f3f to a91f9b4 Compare September 19, 2022 20:11
@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-11 branch from a91f9b4 to 1b1c620 Compare September 19, 2022 20:37
@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-11 branch from f1a12d2 to 9cbb403 Compare November 2, 2022 00:42
@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-11 branch from 9cbb403 to fd1d9d5 Compare November 2, 2022 16:54
@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-11 branch from fd1d9d5 to fde6c03 Compare November 2, 2022 19:44
@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-11 branch from fde6c03 to b71dbbe Compare November 6, 2022 21:52
@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-11 branch from b71dbbe to c927b0b Compare November 6, 2022 21:58
@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-11 branch from c927b0b to b6458c5 Compare November 7, 2022 03:53
@jakebailey jakebailey force-pushed the transform-stack-commit-12 branch from 86f4fd2 to 41f98af Compare November 7, 2022 03:53
@jakebailey
Make a few changes to allow all code to be loaded as one project
1f60a62
@jakebailey
Explicitly reference ts namespace in tsserverlibrary
24aae59
@jakebailey
Generated module conversion step - unindent
1de6c28 
This step makes further commits look clearer by unindenting all of the top level namespaces preemptively.
@jakebailey
Generated module conversion step - explicitify
7310192 
This step makes all implicit namespace accesses explicit, e.g. "Node" turns into "ts.Node".
@jakebailey
Generated module conversion step - stripNamespaces
46802eb 
This step converts each file into an exported module by hoisting the namespace bodies into the global scope and transferring internal markers down onto declarations as needed.

The namespaces are reconstructed as "barrel"-style modules, which are identical to the old namespace objects in structure. These reconstructed namespaces are then imported in the newly module-ified files, making existing expressions like "ts." valid.
@jakebailey
Generated module conversion step - inlineImports
d9d9c50 
This step converts as many explicit accesses as possible in favor of direct imports from the modules in which things were declared. This restores the code (as much as possible) back to how it looked originally before the explicitify step, e.g. instead of "ts.Node" and "ts.Symbol", we have just "Node" and "Symbol".
@jakebailey
Generated module conversion step - .git-ignore-blame-revs
e5b97c7
@jakebailey
Add gitlens settings suggestion
7823493 
While GitHub automatically uses this file if present, GitLens in VS Code
does not. Add the right option to our example settings.json for those
who use the extension.

Unfortunately, you can't leave this enabled if you want to look at the
repo _without_ the file; git blame just crashes when the file isn't
present. I'm not sure that there's a workaround for that.
@jakebailey
Make processDiagnosticMessages generate a module
0b309d6
@jakebailey
Fix up linting, make lint clean
e9d7536 
Now that we are modules, there's no reason to ban multiple namespaces
per file; each file is its own scope and declaring a namespace won't
merge it into any other files.
@jakebailey
Undo changes needed to load codebase into ts-morph
4584e55
@jakebailey
Add JSDoc eslint rule
b718f5a 
See the next commit for a more fleshed-out description.
@jakebailey jakebailey force-pushed the transform-stack-commit-11 branch from b6458c5 to 4584e55 Compare November 7, 2022 19:27
@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-11 branch from 4584e55 to b1fc250 Compare November 7, 2022 21:37
@jakebailey jakebailey deleted the branch transform-stack-commit-11 November 7, 2022 23:54
@jakebailey jakebailey closed this Nov 7, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@jakebailey