npm/nopt

docs: remove stale DEBUG_NOPT / NOPT_DEBUG references from README

Closed

#198 opened on May 8, 2026

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)JavaScript (42 forks)batch import
Good First Issue

Repository metrics

Stars
 (485 stars)
PR merge metrics
 (Avg merge 1d 4h) (1 merged PR in 30d)

Description

After #197 lands, the in-repo lib/debug.js shim is removed and the DEBUG_NOPT / NOPT_DEBUG environment variables no longer do anything. The README still documents them:

https://github.com/npm/nopt/blob/main/README.md#L144

By default nopt logs debug messages if DEBUG_NOPT or NOPT_DEBUG are set in the environment.

This sentence (and any surrounding context referring to debug logging) should be removed so the docs match runtime behavior.

Suggested change

Delete the line in README.md that mentions DEBUG_NOPT / NOPT_DEBUG. No code changes needed.

How to verify

grep -n "DEBUG_NOPT\|NOPT_DEBUG" README.md
# should print nothing after the fix

Follow-up to #197.

Contributor guide

Research direction
Open the README.md file and delete the line containing 'DEBUG NOPT' or 'NOPT DEBUG'.
Tech stack
javascript
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
95