strict JSDoc type linting #6
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 16 commits
November 1, 2019 14:28
as needed by `--noImplicitThis` flag in checkjs command script
…SDoc type checing
|
/cc @rbiggs |
brodybits
commented
Nov 1, 2019
| @@ -4,6 +4,8 @@ var expect = require('chai').expect, | |||
|
|
|||
|
|
|||
| describe('program-helper', function () { | |||
| // FUTURE TODO DEFINE EXPLICITLY in lib/program-helper.js: | |||
| /** @type {Record<string, Function>} */ | |||
There was a problem hiding this comment.
I think this workaround hack should be removed, if possible.
brodybits
commented
Nov 1, 2019
| @@ -20,11 +20,13 @@ function error() { | |||
|
|
|||
| /** | |||
| * Resolve file globs based in command line or tsconfig.json file. | |||
| * @returns {Array} | |||
| * May throw an error. | |||
There was a problem hiding this comment.
should use JSDoc @throws comment here, and check for other places where this may be needed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Updates to support strict JSDoc type linting
Note that there is a quick workaround hack in
test/program-helper.spec.js. TODO item is to updatelib/program-helper.jsto export the helper object with proper typing. (Alternative would be to add a .d.ts file, which seems to be common practice but I think it is not 100% ideal.)TODO items:
lib/program-helper.jsto export helper object with proper JSDoc typings