Add flow comments annotation to function signatures #2319
Merged
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
lib/assignDisabledRanges.js
Outdated
| const enableCommand/*: string*/ = COMMAND_PREFIX + "enable" | ||
| const disableLineCommand/*: string*/ = COMMAND_PREFIX + "disable-line" | ||
| const disableNextLineCommand/*: string*/ = COMMAND_PREFIX + "disable-next-line" | ||
| const ALL_RULES/*: string*/ = "all" |
There was a problem hiding this comment.
There is no need to annotate constants, since Flow can understand them just fine.
lib/assignDisabledRanges.js
Outdated
| @@ -20,7 +20,7 @@ const ALL_RULES = "all" | |||
| module.exports = function ( | |||
| root/*: Object*/, | |||
| result/*: Object*/ | |||
| ) { | |||
| )/*: Object*/ { | |||
There was a problem hiding this comment.
Does this always return an object? If so, what object? Is there a more precise annotation we can give?
|
@ivanzusko As discussed in that other PR, let's remove all of the annotations on variables and just stick with those on the function signatures. Can you add any more specificity than |
jeddy3
changed the title
…ty to returning object;
|
@davidtheclark , hope I made a correct annotation to returning object... |
lib/assignDisabledRanges.js
Outdated
| // Run it like a plugin ... | ||
| module.exports = function ( | ||
| root/*: Object*/, | ||
| result/*: Object*/ | ||
| ) { | ||
| )/*: returningResult*/ { |
There was a problem hiding this comment.
The return value here is a postcss$result, right?
There was a problem hiding this comment.
@davidtheclark do you mean I have to rename this type?
There are just several points:
- I did not find
postcss$resultin declaration files, that's why I assumed that you've meant renaming - I've run tests and found out that returning object is much bigger than I described. Should I expand the type annotation of the returning object?
There was a problem hiding this comment.
@davidtheclark , I got it!
lib/assignDisabledRanges.js
Outdated
| @@ -121,7 +130,7 @@ module.exports = function ( | |||
| } | |||
|
|
|||
| function checkComment(comment/*: postcss$comment*/) { | |||
| const text = comment.text | |||
| const text/*: string*/ = comment.text | |||
lib/assignDisabledRanges.js
Outdated
| if (_.isEmpty(rules)) { | ||
| return [ALL_RULES] | ||
| } | ||
| return rules | ||
| } | ||
|
|
||
| function startDisabledRange(line/*: number*/, ruleName/*: string*/) { | ||
| const rangeObj = { start: line } | ||
| const rangeObj/*: Object*/ = { start: line } |
There was a problem hiding this comment.
No need to annotate this.
lib/assignDisabledRanges.js
Outdated
| @@ -144,15 +153,15 @@ module.exports = function ( | |||
| command/*: string*/, | |||
| fullText/*: string*/ | |||
| )/*: Array<string>*/ { | |||
| const rules = _.compact(fullText.slice(command.length).split(",")).map(r => r.trim()) | |||
| const rules/*: Array<string>*/ = _.compact(fullText.slice(command.length).split(",")).map(r => r.trim()) | |||
There was a problem hiding this comment.
No need to annotate this.
|
Thanks @ivanzusko! |
|
@davidtheclark thank you :) |
m-allanson
added a commit
that referenced
this pull request
Mar 12, 2017
* master: Update CHANGELOG.md Add flow comments annotation to function signatures (#2319) Update CHANGELOG.md Fix custom properties sets followed by comments in no-extra-semicolons (#2396) Fixed: `value-keyword-case` is now ignore counter, counters and attr fucntions. Fix typos (#2412) Fixed: `value-keyword-case` is now ignore counter-reset property. chore(package): update flow-bin to version 0.41.0 chore(package): update eslint to version 3.17.0 Fix the example for Custom Message in docs (#2409) Update CHANGELOG.md Update CHANGELOG.md Add at-rule-semicolon-space-before rule (#2388) Update CHANGELOG.md Print out filenames/globs when files do not exist (#2328) Tests: improved tests for `no-missing-end-of-source-newline` rule. (#2384) Update stylelint-disable-reason changelog entry (#2393) Add min rules chore(package): update flow-bin to version 0.40.0 (#2390) chore: Update `remark-*` modules (#2391)
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.
No description provided.