Add [:Header:] shorthand for HTTP header links
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- JavaScript
- Stars
- 806
- Forks
- 434
- Avg merge
- 1d 21h
- Merged PRs (30d)
- 32
Description
Bikeshed has [:Content-Type:] as a dedicated shorthand for HTTP header links. ReSpec currently requires the verbose [= Header!!http-header =] to achieve the same.
Proposed syntax:
[: Header :]— basic link[: Header|display text :]— pipe aliasing[: Header!!http-header :]— type validation (onlyhttp-headervalid)
Output: <code><a data-link-type="http-header">...</a></code>
Part of the Bikeshed inline shorthand parity effort.
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
Start by locating the existing handling for the verbose [= Header!!http-header =] syntax and compare it with ReSpec's support for the [:Content-Type:] shorthand. Add parsing for the three proposed forms, preserving aliases and restricting type validation to http-header; verify that output uses the specified code-wrapped HTTP-header link markup.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100