speced / speced/respec

Add [$op$] shorthand for abstract operation links

Open
#5,270 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
JavaScript
Stars
806
Forks
434
Avg merge
1d 21h
Merged PRs (30d)
32

Description

Bikeshed has [$Run fetch$] as a dedicated shorthand for abstract operation links. ReSpec currently requires [= op =] which shares the dfn|abstract-op fallback type and can't express strict abstract-op intent.

Proposed syntax:

  • [$ operation $] — basic link
  • [$ For/operation $] — with for-context
  • [$ op|display text $] — pipe aliasing
  • [$ op!!abstract-op $] — type validation (only abstract-op valid)

Output: <code><a data-link-type="abstract-op">...</a></code>

Part of the Bikeshed inline shorthand parity effort.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating ReSpec's existing [= op =] inline shorthand handling and the code that produces abstract-operation links. Trace how the proposed basic, for-context, pipe-alias, and abstract-op validation forms are parsed, then verify completion against the stated <code><a data-link-type="abstract-op">...</a></code> output.

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
65/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.