Add hex_tarball:unpack_docs/1
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- Erlang
- Stars
- 105
- Forks
- 34
- Avg merge
- 1d 4h
- Merged PRs (30d)
- 6
Description
Validations:
- the same size validations as we currently do for package tarballs
- ensure top-level file is not a valid semver
Contributor guide
No contributing guide indexed for this repository
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
Compare the package tarball size validations in src/hex_tarball.erl at lines 7-8 with the semver check in hexdocs/lib/hexdocs/tar.ex at lines 48-59. Use those implementations as the starting point for hex_tarball:unpack_docs/1; it is done when the requested validations are covered, including rejecting a top-level file that is a valid semver.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- erlang
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100