refactor: clean up fs.readFile usage #3966
Merged
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
fs.readFile
was being used looked like a code smell, and sure enough, the way it was being mocked would cause surprise errors for anyone who adds idiomaticfs-extra
calls in new or updated tests. Pass encoding ('utf8'
, the default) to getreadFile
to resolve to a string instead of a buffer, and usereadJson
where applicable. Update fs mocks to behave a bit more likefs-extra
in this regard (though I'm not sure it would be possible to support all options, but we can at least support encoding string as second argument).