Skip to content

Commit 81eca14

Browse files
authored
docs: add Scope to give context without wading through history (#71)
1 parent 2ab5af3 commit 81eca14

1 file changed

Lines changed: 6 additions & 1 deletion

File tree

README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,11 @@
99
1010
Polyfill of future proposal to the [nodejs/tooling](https://github.com/nodejs/tooling) repo for `util.parseArgs()`
1111

12+
### Scope
1213

13-
This package was implemented using [tape](https://www.npmjs.com/package/tape) as its test harness.
14+
It is already possible to build great arg parsing modules on top of what Node.js provides; the prickly API is abstracted away by these modules. Thus, process.parseArgs() is not necessarily intended for library authors; it is intended for developers of simple CLI tools, ad-hoc scripts, deployed Node.js applications, and learning materials.
15+
16+
It is exceedingly difficult to provide an API which would both be friendly to these Node.js users while being extensible enough for libraries to build upon. We chose to prioritize these use cases because these are currently not well-served by Node.js' API.
1417

1518
### Links & Resources
1619

@@ -55,6 +58,8 @@ Any person who wants to contribute to the initiative is welcome! Please first re
5558

5659
Additionally, reading the [`Examples w/ Output`](#-examples-w-output) section of this document will be the best way to familiarize yourself with the target expected behavior for parseArgs() once it is fully implemented.
5760

61+
This package was implemented using [tape](https://www.npmjs.com/package/tape) as its test harness.
62+
5863
----
5964

6065
## 💡 `process.mainArgs` Proposal

0 commit comments

Comments
 (0)