speced / speced/respec

Linter that warns when data-cite= is used with a WebRef spec

Open
#3,561 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Feature request High priority
Dominant language
JavaScript
Stars
806
Forks
434
Avg merge
1d 21h
Merged PRs (30d)
32

Description

Is your feature request related to a problem? Please describe.
I'm always frustrated when specs use data-cite="html#whatever" or other specs in WebRef.

Describe the solution you'd like
For there to be a linter that tells Editors not to do that, and how to fix it. Including WARNING when a term is already exported, and ERRORing when the term is not exported.

Describe alternatives you've considered
Manually fixing all the specs in the world by hand. This didn't scale.

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 linting or validation entry points; the issue does not name specific files or tests. Define the linter's handling of WebRef data-cite references, including WARNING for exported terms and ERROR for unexported terms, and document how editors should fix each case.

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.