levibostian / decaf / 21144387508

82%

push

github

feat: rename the environment variable used to communicate wtih user scripts (#130)

## Related GitHub Issues
<!-- Link to any related GitHub issues that this pull request addresses
or closes. -->

## Problem
<!-- A clear description of the problem that this pull request is
solving. -->

I just want a better name. DATA_FILE_PATH describes poorly what tool
owns the env var and what the purpose is.

## Solution
<!-- Describe the approach you took to solve the problem and the changes
made in this pull request. -->

New name: `DECAF_COMM_FILE_PATH` - it includes "decaf" in the name,
"comm" to indicate it's used for communication, and "file path" is still
in the name because the value is a file path.

This has the potential of being a breaking change. Though we are
pre-1.0, I dont want to make it breaking now for such a small change.
Because of that, we are just adding support for the new env var so users
can begin to use it. Then in 1.0, we will drop the old one.

## Testing
<!-- Choose one of the below options for how you tested the code change.
Include any specific setup or instructions for testing. -->
- [X] Added automated tests. 
- [ ] Manually tested. If you check this box, provide instructions for
others to test, too.   

## Notes for reviewers 
<!-- If there is any additional information you would like to share with
the person reviewing this pull request, please provide it here. -->

Marking this as a `feat:` to ship this change to prod as a new release.
Even though this is a small change, we are updating the README docs to
encourage people to use the new env var name as soon as possible to
prepare for v1.0. To do that, we need to ship this change, otherwise
their script will not work.

210 of 225 branches covered (93.33%)

Branch coverage included in aggregate %.

5 of 5 new or added lines in 3 files covered. (100.0%)

1335 of 1668 relevant lines covered (80.04%)

73.61 hits per line