Document helper precompilation caveat (in code at least) #1251
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
|
I think inline in the code is a good place to document this. We also have https://github.com/avajs/ava/blob/master/maintaining.md for internal notes. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
The way helpers are precompiled, if you invoke AVA from inside a directory, with file arguments, then only helper files inside that directory are precompiled.
We'll be able to fix it when we move compilation into the workers, and I'm not even convinced it should be considered a bug at this stage. I did want to document the behavior somewhere, but I'm not sure it has to be in user-facing documentation as it's (hopefully) a rather specific edge-case.