documentcloud / documentcloud/underscore-contrib
Make string path shorthands consistent and opt-in
Open
Nobody has claimed this yet.
after modules
docs
enhancement
- Dominant language
- JavaScript
- Stars
- 622
- Forks
- 114
- PR merge metrics
- No merged PRs in 30d
Description
Following up on #231, https://github.com/jashkenas/underscore/pull/2877 and #220 (stage 4):
- Turn the internal
keysFromPathfunction into a public function that can optionally be used to override the new_.toPathfunction in the upcoming core Underscore 1.12. - In all functions that work with paths, use the new
_.getfrom core Underscore 1.12. - Update the documentation to reflect that path behavior is configurable from a single point of truth.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Read the context in #231, pull request #2877, and #220 before tracing the internal keysFromPath function and the path-handling functions. Check how the upcoming core Underscore 1.12 _.toPath and _.get APIs are expected to integrate. Done means an optional public path override, consistent use of _.get, and documentation describing one configurable source of truth.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100