Add type Formatter for formatter functions
#4823
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
m-allanson
commented
Jun 6, 2020
| @@ -83,6 +83,13 @@ declare module 'stylelint' { | |||
| warn(message: string, options?: StylelintWarningOptions): void; | |||
| }; | |||
|
|
|||
| export type Formatter = ( | |||
| results: Array<StylelintResult>, | |||
| returnValue?: StylelintStandaloneReturnValue, | |||
There was a problem hiding this comment.
This second value returnValue isn't used in any of stylelint's built-in formatters (as far as I can tell).
However, it is mentioned in the docs, and there's some tests that ensure the value is passed through to the formatter.
So I've included it in the type definition here. But maybe it's an old argument that can be removed?
14 tasks
hudochenkov
approved these changes
Jun 6, 2020
m-allanson
added a commit
that referenced
this pull request
Jun 10, 2020
# By Mike Allanson (6) and others # Via GitHub * master: Bump got from 11.2.0 to 11.3.0 (#4825) Export an object from the CSS-in-JS syntax (#4824) Add type `Formatter` for formatter functions (#4823) Update CHANGELOG.md Fix false positives for namespaced variables in property-no-unknown (#4803) Update CHANGELOG.md Fix TypeError for inline comments and autofix for sugarss in max-empty-lines (#4821) Create new 'lintPostcssResult' module (#4819) 13.6.0 Update deps Prepare 13.6.0 Update CHANGELOG.md
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.
Add a named type for formatter functions.
Related to issue #3935
This change is a small part of the changes in PR #4796. On its own this change is quite small. The new type will be used as part of a follow up PR. See this diff for details.