Opinionated utilities for building CLIs on top of Black Flag

[![Black Lives Matter!][x-badge-blm-image]][x-badge-blm-link]
[![Last commit timestamp][x-badge-lastcommit-image]][x-badge-repo-link]
[![Codecov][x-badge-codecov-image]][x-badge-codecov-link]
[![Source license][x-badge-license-image]][x-badge-license-link]
[![Uses Semantic Release!][x-badge-semanticrelease-image]][x-badge-semanticrelease-link]

[![NPM version][x-badge-npm-image]][x-badge-npm-link]
[![Monthly Downloads][x-badge-downloads-image]][x-badge-downloads-link]

cli-utils (@-xun/cli)

Opinionated utilities for building CLIs on top of Black Flag.

---

- Install
- Usage
- Appendix
- Published Package Details
- License
- Contributing and Support
- Contributors

Install

To install:

``shell npm install @-xun/cli`

> [!TIP] > >@-xun/clialready comes bundled with (and re-exports) [@black-flag/core][1], > [@black-flag/extensions][2], and [@black-flag/checks][3]. _@-xun/cliis an > all-in-one package!_ Redundantly installing the@black-flag/*packages may > lead to version mis-matches, which can cause strange bugs.

`Usage`

TODO

`Appendix`

Further documentation can be found under [docs/][x-repo-docs].

`$3`

This is a [CJS2 package][x-pkg-cjs-mojito] with statically-analyzable exports built by Babel for use in Node.js versions that are not end-of-life. For TypeScript users, this package supports both"Node10" and "Node16"module resolution strategies.

Expand details

That means both CJS2 (via require(...)) and ESM (via import { ... } from ...orawait import(...)) source will load this package from the same entry points when using Node. This has several benefits, the foremost being: less code shipped/smaller package size, avoiding [dual package hazard][x-pkg-dual-package-hazard] entirely, distributables are not packed/bundled/uglified, a drastically less complex build process, and CJS consumers aren't shafted.

Each entry point (i.e. ENTRY) in [package.json'sexports[ENTRY]][x-repo-package-json] object includes one or more [export conditions][x-pkg-exports-conditions]. These entries may or may not include: an [exports[ENTRY].types][x-pkg-exports-types-key] condition pointing to a type declaration file for TypeScript and IDEs, a [exports[ENTRY].module][x-pkg-exports-module-key] condition pointing to (usually ESM) source for Webpack/Rollup, aexports[ENTRY].nodeand/orexports[ENTRY].defaultcondition pointing to (usually CJS2) source for Node.jsrequire/importand for browsers and other environments, and [other conditions][x-pkg-exports-conditions] not enumerated here. Check the [package.json][x-repo-package-json] file to see which export conditions are supported.

Note that, regardless of the [{ "type": "..." }][x-pkg-type] specified in [package.json][x-repo-package-json], any JavaScript files written in ESM syntax (including distributables) will always have the.mjsextension. Note also that [package.json][x-repo-package-json] may include the [sideEffects][x-pkg-side-effects-key] key, which is almost always false` for
optimal [tree shaking][x-pkg-tree-shaking] where appropriate.

$3

See [LICENSE][x-repo-license].

Contributing and Support

**[New issues][x-repo-choose-new-issue] and [pull requests][x-repo-pr-compare]
are always welcome and greatly appreciated! 🤩** Just as well, you can [star 🌟
this project][x-badge-repo-link] to let me know you found it useful! ✊🏿 Or [buy
me a beer][x-repo-sponsor], I'd appreciate it. Thank you!

See [CONTRIBUTING.md][x-repo-contributing] and [SUPPORT.md][x-repo-support] for
more information.

$3

![All Contributors](#contributors-)

Thanks goes to these wonderful people ([emoji
key][x-repo-all-contributors-emojis]):

_Bernard 🚇 💻 📖 🚧 ⚠️ 👀
Add your contributions

This project follows the [all-contributors][x-repo-all-contributors]
specification. Contributions of any kind welcome!

[x-badge-blm-image]: https://xunn.at/badge-blm 'Join the movement!'
[x-badge-blm-link]: https://xunn.at/donate-blm
[x-badge-codecov-image]:
https://img.shields.io/codecov/c/github/Xunnamius/cli-utils/main?style=flat-square&token=HWRIOBAAPW&flag=package.main_root
'Is this package well-tested?'
[x-badge-codecov-link]: https://codecov.io/gh/Xunnamius/cli-utils
[x-badge-downloads-image]:
https://img.shields.io/npm/dm/@-xun/cli?style=flat-square
'Number of times this package has been downloaded per month'
[x-badge-downloads-link]: https://npmtrends.com/@-xun/cli
[x-badge-lastcommit-image]:
https://img.shields.io/github/last-commit/Xunnamius/cli-utils?style=flat-square
'Latest commit timestamp'
[x-badge-license-image]:
https://img.shields.io/npm/l/@-xun/cli?style=flat-square
"This package's source license"
[x-badge-license-link]: https://github.com/Xunnamius/cli-utils/blob/main/LICENSE
[x-badge-npm-image]:
https://xunn.at/npm-pkg-version/@-xun/cli
'Install this package using npm or yarn!'
[x-badge-npm-link]: https://npm.im/@-xun/cli
[x-badge-repo-link]: https://github.com/Xunnamius/cli-utils
[x-badge-semanticrelease-image]:
https://xunn.at/badge-semantic-release
'This repo practices continuous integration and deployment!'
[x-badge-semanticrelease-link]:
https://github.com/semantic-release/semantic-release
[x-pkg-cjs-mojito]:
https://dev.to/jakobjingleheimer/configuring-commonjs-es-modules-for-nodejs-12ed#publish-only-a-cjs-distribution-with-property-exports
[x-pkg-dual-package-hazard]:
https://nodejs.org/api/packages.html#dual-package-hazard
[x-pkg-exports-conditions]:
https://webpack.js.org/guides/package-exports#reference-syntax
[x-pkg-exports-module-key]:
https://webpack.js.org/guides/package-exports#providing-commonjs-and-esm-version-stateless
[x-pkg-exports-types-key]:
https://devblogs.microsoft.com/typescript/announcing-typescript-4-5-beta#packagejson-exports-imports-and-self-referencing
[x-pkg-side-effects-key]:
https://webpack.js.org/guides/tree-shaking#mark-the-file-as-side-effect-free
[x-pkg-tree-shaking]: https://webpack.js.org/guides/tree-shaking
[x-pkg-type]:
https://github.com/nodejs/node/blob/8d8e06a345043bec787e904edc9a2f5c5e9c275f/doc/api/packages.md#type
[x-repo-all-contributors]: https://github.com/all-contributors/all-contributors
[x-repo-all-contributors-emojis]: https://allcontributors.org/docs/en/emoji-key
[x-repo-choose-new-issue]:
https://github.com/Xunnamius/cli-utils/issues/new/choose
[x-repo-contributing]: /CONTRIBUTING.md
[x-repo-docs]: docs
[x-repo-license]: ./LICENSE
[x-repo-package-json]: package.json
[x-repo-pr-compare]: https://github.com/Xunnamius/cli-utils/compare
[x-repo-sponsor]: https://github.com/sponsors/Xunnamius
[x-repo-support]: /.github/SUPPORT.md
[1]: https://npm.im/@black-flag/core
[2]: https://npm.im/@black-flag/extensions
[3]: https://npm.im/@black-flag/checks