Catalog npm
Back to packageRELEASE DETAILS

1.0.1

npm

@-xun/cli

Opinionated utilities for building CLIs on top of Black Flag

Published17 Feb 2025
Direct dependencies10
Transitive dependenciesNot calculated

README

Current package documentation

Opinionated utilities for building CLIs on top of Black Flag


Black Lives Matter! Last commit timestamp Codecov Source license Uses Semantic Release!

NPM version Monthly Downloads


cli-utils (@-xun/cli)

Opinionated utilities for building CLIs on top of Black Flag.



Install

To install:

npm install @-xun/cli

[!TIP]

@-xun/cli already comes bundled with (and re-exports) @black-flag/core, @black-flag/extensions, and @black-flag/checks. @-xun/cli is 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/.

Published Package Details

This is a CJS2 package 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 ... or await 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 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's exports[ENTRY] object includes one or more export conditions. These entries may or may not include: an exports[ENTRY].types condition pointing to a type declaration file for TypeScript and IDEs, a exports[ENTRY].module condition pointing to (usually ESM) source for Webpack/Rollup, a exports[ENTRY].node and/or exports[ENTRY].default condition pointing to (usually CJS2) source for Node.js require/import and for browsers and other environments, and other conditions not enumerated here. Check the package.json file to see which export conditions are supported.

Note that, regardless of the { "type": "..." } specified in package.json, any JavaScript files written in ESM syntax (including distributables) will always have the .mjs extension. Note also that package.json may include the sideEffects key, which is almost always false for optimal tree shaking where appropriate.

License

See LICENSE.

Contributing and Support

New issues and pull requests are always welcome and greatly appreciated! 🤩 Just as well, you can star 🌟 this project to let me know you found it useful! ✊🏿 Or buy me a beer, I'd appreciate it. Thank you!

See CONTRIBUTING.md and SUPPORT.md for more information.

Contributors

All Contributors

Thanks goes to these wonderful people (emoji key):

This project follows the all-contributors specification. Contributions of any kind welcome!

Downloads & popularity

Awaiting observations

No metric observations yet

Download counts and popularity will appear here as the collector receives them.

Declared dependencies 10

Native requirements
10 direct targetsNot calculated transitive count
Package / targetRequirementRelationship
core-js
Environment
{
  "local_name": "core-js",
  "alias": false,
  "peer_metadata": null
}
^3.40.0runtime
rejoinder
Environment
{
  "local_name": "rejoinder",
  "alias": false,
  "peer_metadata": null
}
^1.2.4runtime
@black-flag/core
Environment
{
  "local_name": "@black-flag/core",
  "alias": false,
  "peer_metadata": null
}
^1.3.2runtime
@-xun/project-types
Environment
{
  "local_name": "@-xun/project-types",
  "alias": false,
  "peer_metadata": null
}
^1.0.2runtime
@black-flag/extensions
Environment
{
  "local_name": "@black-flag/extensions",
  "alias": false,
  "peer_metadata": null
}
^1.0.2runtime
listr2
Environment
{
  "local_name": "listr2",
  "alias": false,
  "peer_metadata": null
}
^8.2.5development
@-xun/run
Environment
{
  "local_name": "@-xun/run",
  "alias": false,
  "peer_metadata": null
}
^1.0.1development
type-fest
Environment
{
  "local_name": "type-fest",
  "alias": false,
  "peer_metadata": null
}
^4.35.0development
@-xun/symbiote
Environment
{
  "local_name": "@-xun/symbiote",
  "alias": false,
  "peer_metadata": null
}
^2.25.1development
rejoinder-listr2
Environment
{
  "local_name": "rejoinder-listr2",
  "alias": false,
  "peer_metadata": {
    "optional": true
  }
}
^1.0.2peer

Distribution files

1 collected
Distribution 1

Source distribution

Source file
Checksums from source
{
  "shasum": "a1a31ee95aac2efef5f970e44eae6613a48ab6d5",
  "tarball": "https://registry.npmjs.org/@-xun/cli/-/cli-1.0.1.tgz",
  "fileCount": 15,
  "integrity": "sha512-78EO3zmR9FhR8v1ooQ+H1Vy4eT5EpJvwrakkNubFJho/z+i0ZKfTcq1l0R7Bq5E1sHIyrIGM/dPl90agmPZVYA==",
  "signatures": [
    {
      "sig": "MEQCIAjb4keBVd8ebLkwd6KhVedqJ6MiAje7UgZo/6RivnX4AiAKRRbiojsXxC4nsx+6okIDbN7Uwgf3ANlEfv0Litz0og==",
      "keyid": "SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"
    }
  ],
  "unpackedSize": 43805
}

Repository

PENDING
xunnamius/cli-utils

Shared repository data · GitHub

License detected in repository
Not collected

Metadata history

Meaningful changes
Current collected state Current

Observed since 20 Oct, 21:50 UTC

No superseded metadata states collected. Unchanged observations do not create new revisions.

Record identity

package_version:b41583f3fa3b1bf45ea7c8a540a5d1d1b7ba911d6be6c110a3a9399fccef50bf

Other collected versions

2.0.710 Jul2.0.610 Jul2.0.58 Jul2.0.414 Jun2.0.331 May2.0.228 MayView all collected versions →