speced / speced/respec

Contextualizing definitions for export

Open
#4,522 34 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

Description of problem

The terminology include file is being processed, but restrictReferences() is failing, which results in unused terms appearing in the final document, each of which generates a warning.

URL to affected spec or repo:

https://w3c.github.io/vc-use-cases/

What happened (e.g., it crashed)?:

ReferenceError: $ is not defined
    at restrictReferences (common.js:123:5)
    at ln (utils.js:294:28)
    at Ls (data-include.js:54:16)
    at data-include.js:98:7
    at async Promise.all (/vc-use-cases/index 34)
    at async Ps (data-include.js:107:6)
    at async Object.run (data-include.js:77:8)
    at async base-runner.js:72:27

Expected behavior (e.g., it shouldn't crash):

Unused terms should be removed.

Optional, steps to reproduce:

See https://github.com/w3c/vc-use-cases/blob/2023-08-25-cleanup/index.html and https://github.com/w3c/vc-use-cases/blob/2023-08-25-cleanup/terms.html.

Fails under Chrome Version 116.0.5845.96 (Official Build) (x86_64) on MacBook Pro, macOS Monterey 12.6.7.

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 at restrictReferences in common.js:123 and trace its callers in utils.js:294 and data-include.js:54. Reproduce with index.html and terms.html from the linked vc-use-cases revision, then verify that unused terms are removed without a ReferenceError or generated warnings.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.