Add linter error preventing use of async outside the test suite
#1010
Conversation
This file contains hidden or 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
We want to keep the runtime dependency footprint small, so that means
avoiding use of `async` at runtime (which creates a dependency on the
Regenerator runtime).
There is no built-in eslint rule for this, so we make a custom one.
Test plan:
Add an `async` function to a file, run `yarn run lint` and see:
graphql-js/src/subscription/subscribe.js
288:1 error async functions are not allowed outside of the test suite no-async
✖ 1 problem (1 error, 0 warnings)
Note that no errors are issued for the `async` functions in the test
suite.
Closes: #1008
robzhu
reviewed
Aug 26, 2017
| "wrap-regex": 0, | ||
| "yoda": [2, "never", {"exceptRange": true}] | ||
| "yoda": [2, "never", {"exceptRange": true}], | ||
|
|
There was a problem hiding this comment.
extra line break intended here?
There was a problem hiding this comment.
Yeah, I wanted to separate the custom rules. Would have put in a comment to make it clear but this is faux-JSON so there are no comments... (We do use a blank line as a separator higher up in the file, at least.)
resources/lint/no-async.js
Outdated
| if (node.async) { | ||
| context.report( | ||
| node, | ||
| 'async functions are not allowed outside of the test suite' |
There was a problem hiding this comment.
I suggest adding more detail here: "async functions are not allowed outside of the test suite because older versions of NodeJS do not support async functions without transpilation. Instead, use explicit Promises."
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
We want to keep the runtime dependency footprint small, so that means avoiding use of
asyncat runtime (which creates a dependency on the Regenerator runtime).There is no built-in eslint rule for this, so we make a custom one.
Test plan:
Add an
asyncfunction to a file, runyarn run lintand see:Note that no errors are issued for the
asyncfunctions in the test suite.Closes: #1008