refactor: don't expose tempdir in common.state#903
Merged
Conversation
Previously, the cached `tempdir` value was stored in `common.state`. Unlike the other `common.state` values, this isn't immediately useful to other commands (they can just call the tempdir API). So, this moves the cached value into `tempdir.js`. This also adds a unit test for the caching behavior, and exposes test-only helpers to verify this behavior. Finally, this adds a note to `common.state` that values should generally be considered read-only, since this can be important for customized behavior. Although, I recognize our code base has one exception to this rule (`echo()`), we should strive to maintain this. Fixes #902 Test: Added a unit test.
Member
Author
|
@wyardley interested in doing a code review? |
wyardley
approved these changes
Nov 8, 2018
Member
Author
|
Thanks! |
This was referenced Nov 29, 2019
This was referenced Mar 24, 2020
This was referenced Apr 24, 2020
This was referenced Sep 12, 2024
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
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.
Previously, the cached
tempdirvalue was stored incommon.state.Unlike the other
common.statevalues, this isn't immediately useful toother commands (they can just call the tempdir API). So, this moves the
cached value into
tempdir.js.This also adds a unit test for the caching behavior, and exposes
test-only helpers to verify this behavior.
Finally, this adds a note to
common.statethat values should generallybe considered read-only, since this can be important for customized
behavior. Although, I recognize our code base has one exception to this
rule (
echo()), we should strive to maintain this.Fixes #902
Test: Added a unit test.