[RFC]: Bringing `minimist` Dependency In-House
Maintainer antworten meist innerhalb von 1 Tag
Dieses Issue hat noch niemand übernommen.
Bewertung
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Anfängerfreundlichkeit
- 55/100
- Issue-Typ
- Feature
- Klarheit
- Klar beschrieben
- Aktivitätsstatus
- Ruhig
- Tech-Stack
- javascript, nodejs
Rechercherichtung
Beginnen Sie mit der vorgeschlagenen @stdlib/cli/parse-args-Struktur und ihrem Einstiegspunkt lib/main.js. Untersuchen Sie anschließend @stdlib/cli/ctor/lib/main.js und die aufgeführten _tools-Verbraucher. Führen Sie die Verifizierungsbefehle für parse-args, cli/ctor und die End-to-End-CLI aus. Als abgeschlossen gilt die Arbeit, wenn das dokumentierte minimist-Verhalten abgedeckt ist, die Verbraucher das stdlib-Paket verwenden und minimist entfernt wurde.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Beschreibung
Replace minimist Dependency with In-House @stdlib/cli/parse-args
Replace the third-party minimist dependency with a stdlib-native equivalent to reduce supply-chain security risk and bring all production code into conformance with stdlib conventions (docs, tests, examples, benchmarks, backward-compatibility).
Background
minimistis used exclusively as a command-line argument parser- Primary consumer: [
@stdlib/cli/ctor/lib/main.js]— the central CLI class used by every stdlib package with a CLI - Secondary consumers: ~12 internal tool scripts under
@stdlib/_tools/package-json/scripts/and@stdlib/_tools/modules/pkg-deps/bin/cli - The existing code has a [TODO comment]:
// TODO: replace with stdlib equivalent - The minimist source is 264 lines — straightforward to reimplement
API Surface Analysis
The full minimist API supports these options: boolean, string, alias, default, stopEarly, -- separator, unknown callback, and dotted key expansion.
What stdlib actually uses (confirmed by auditing every cli_opts.json and direct call site):
| Option | Used? | Example |
|---|---|---|
boolean |
✅ Yes | ["help", "version"] |
string |
✅ Yes | ["split", "aliases"] |
alias |
✅ Yes | { "help": ["h"], "version": ["V"] } |
default |
❌ No | — |
stopEarly |
❌ No | — |
unknown |
❌ No | — |
-- separator |
❌ No | — |
[!IMPORTANT]
Decision: Implement the full minimist API (all 7 options) for backward-compatibility and completeness, but prioritize testing the 3 options actually used. This ensures the replacement is a true drop-in and supports any future stdlib packages that might need additional options.
Proposed Changes
1. New Package: @stdlib/cli/parse-args
Create a brand-new stdlib package that reimplements minimist's parseArgs(args, opts) function.
Folder Structure
lib/node_modules/@stdlib/cli/parse-args/
├── package.json
├── README.md
├── lib/
│ ├── index.js # Standard stdlib entry point
│ └── main.js # Core argument parser implementation
├── test/
│ ├── test.js # Main export, basic parsing, type checks
│ ├── test.bool.js # boolean option, --no- prefix, allBools
│ ├── test.string.js # string option, number coercion suppression
│ ├── test.alias.js # alias option, bidirectional resolution
│ ├── test.default.js # default option
│ ├── test.long.js # Long flags (--key, --key=val, --key val)
│ ├── test.short.js # Short flags (-k, -abc, -k=val, -k val)
│ ├── test.dash.js # -- separator and opts['--']
│ ├── test.stop_early.js # stopEarly option
│ ├── test.unknown.js # unknown callback
│ ├── test.num.js # Number coercion
│ └── test.proto.js # Prototype pollution prevention
├── benchmark/
│ └── benchmark.js # Performance benchmarks
├── examples/
│ └── index.js # Runnable usage examples
└── docs/
└── types/
├── index.d.ts # TypeScript declarations
└── test.ts # TypeScript compile-time tests
main.js
Core implementation. The function signature:
function parseArgs( args, opts ) → { _: Array, ...flags }
Behavior to reimplement (in order of parsing priority):
--key=value— long flag with inline value--no-key— long flag negation → setskey: false--key value— long flag with next-arg value--key(boolean) — long boolean flag →true-abc— short flag grouping (each letter is a boolean flag)-k value— short flag with next-arg value-k=value— short flag with inline value--— stop parsing, rest goes to_(orargv['--'])- Positional args — everything else goes to
_ - Number coercion — numeric strings → Number (unless
stringoption set) - Alias expansion — set value on all aliases simultaneously
- Default values — apply defaults for keys not explicitly set
stopEarly— after first positional, everything goes to_unknowncallback — called for undefined flags; if returnsfalse, skip- Prototype pollution guard — reject
__proto__andconstructor
2. Update Consumer: @stdlib/cli/ctor
[MODIFY] @stdlib/cli/ctor/lib/main.js
Single-line change on line 25:
-var parseArgs = require( 'minimist' ); // TODO: replace with stdlib equivalent
+var parseArgs = require( '@stdlib/cli/parse-args' );
3. Update Consumers: Internal Tool Scripts
[MODIFY] 12 files under @stdlib/_tools/
Same single-line change in each file:
-var parseArgs = require( 'minimist' );
+var parseArgs = require( '@stdlib/cli/parse-args' );
Files to update:
_tools/modules/pkg-deps/bin/cli_tools/package-json/scripts/update_directories_tools/package-json/scripts/update_license_tools/package-json/scripts/update_engines_node_version_tools/package-json/scripts/update_homepage_tools/package-json/scripts/update_author_tools/package-json/scripts/update_os_tools/package-json/scripts/update_bugs_tools/package-json/scripts/update_contributors_tools/package-json/scripts/update_engines_npm_version_tools/package-json/scripts/update_gypfile_tools/package-json/scripts/update_repository
4. Remove minimist from Dependencies
npm uninstall minimist
Verification Plan
Automated Tests
-
New package unit tests (primary verification):
make TESTS_FILTER=".*/cli/parse-args/.*" -
Existing
@stdlib/cli/ctortests (regression — must continue passing after swap):make TESTS_FILTER=".*/cli/ctor/.*" -
Equivalence test — Run the existing minimist test suite against our implementation to verify behavioral parity:
# We can create a shim that points minimist's tests at our implementation NODE_PATH=lib/node_modules node -e "var parse = require('@stdlib/cli/parse-args'); console.log(JSON.stringify(parse(['--foo', 'bar', '-abc', '--no-debug', '--count=5'])))"
Manual Verification
- End-to-end CLI test — Run a real stdlib CLI command and verify it still works:
NODE_PATH=lib/node_modules node bin/cli is-leap-year 2024 # Expected: true NODE_PATH=lib/node_modules node bin/cli is-leap-year 2023 # Expected: false NODE_PATH=lib/node_modules node bin/cli --help # Expected: prints usage text NODE_PATH=lib/node_modules node bin/cli --version # Expected: prints version
- Vorherrschende Sprache
- JavaScript
- Sterne
- 6k
- Forks
- 1.3k
- Ø Merge
- 1 T. 21 Std.
- Gemergte PRs (30 T.)
- 224
Entwicklungsumgebung
Startet den Dev-Container des Projekts im Browser, mit Ihrem eigenen GitHub-Konto.
- Kein Dockerfile und keine Docker-Compose-Datei
- Hat eine Pull-Request-Vorlage
- Beitragsleitfaden lesen
Erste Schritte
- Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
- Forken Sie das Repository und arbeiten Sie in einem Branch.
- Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.
Mehr aus stdlib-js/stdlib
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 72/100
stdlib-js/stdlib#16655 · 1 Kommentar ·
Maintainer antworten meist innerhalb von 1 Tag
-
Fix JavaScript lint errorsEvtl. vergeben @protestershankar hat das vor 6 Tagen übernommen. OffenGood First Issue
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 82/100
stdlib-js/stdlib#16563 · 3 Kommentare ·
Maintainer antworten meist innerhalb von 1 Tag
-
Fix C lint errorsEvtl. vergeben @raus7n hat das vor 14 Tagen übernommen. OffenGood First Issue
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 82/100
stdlib-js/stdlib#16454 · 1 Kommentar ·
Maintainer antworten meist innerhalb von 1 Tag
-
Fix JavaScript lint errorsEvtl. vergeben @Devansh-18155 hat das vor 39 Tagen übernommen. OffenGood First Issue
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 82/100
stdlib-js/stdlib#15970 · 1 Kommentar ·
Maintainer antworten meist innerhalb von 1 Tag
-
Fix JavaScript lint errorsEvtl. vergeben @lb1192176991-lab hat das vor 44 Tagen übernommen. OffenGood First Issue
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 90/100
stdlib-js/stdlib#15831 · 2 Kommentare ·
Maintainer antworten meist innerhalb von 1 Tag
Alle Issues in stdlib-js/stdlib
Ähnliche Issues
-
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 69/100
Maintainer antworten meist innerhalb von 1 Tag
-
bug ready-for-agent
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 72/100
nearform/unbreakci#897 · 1 Kommentar · 1 Reaktion ·
Maintainer antworten meist innerhalb von 1 Tag
-
automation chore ci-cd consistency developer-experience difficulty: easy discoverability documentation enhancement github-actions good first issue help wanted hygiene priority: P3 seo shell yaml
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 76/100
-
bug
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 84/100
swc-project/swc-next-issues#394 ·
-
Schwierigkeit 1/5 1-3 Stunden Anfängerfreundlichkeit 88/100
githubnext/gh-aw-workshop#5790 ·
Maintainer antworten meist innerhalb von 1 Tag