diff --git a/CHANGELOG.md b/CHANGELOG.md index e372adc..1bff66e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,4 +1,4 @@ -# ultraflag +# @bomb.sh/args (fka `ultraflag`) ## 0.2.3 diff --git a/README.md b/README.md index 19b852c..4bc9f8a 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# `ultraflag` +# `@bomb.sh/args` -A <1kB library for parsing CLI flags. Inspired by Deno's `std` [`flags`](https://github.com/denoland/deno_std/blob/main/flags/mod.ts) module. +A <1kB library for parsing CLI flags. Inspired by Deno's `std/cli` [`parseArgs`](https://github.com/denoland/std/blob/main/cli/parse_args.ts) module. ### Features @@ -17,7 +17,7 @@ A <1kB library for parsing CLI flags. Inspired by Deno's `std` [`flags`](https:/ Basic usage does not require any configuration. ```js -import { parse } from "ultraflag"; +import { parse } from "@bomb.sh/args"; // my-cli build --bundle -rf --a value --b=value --c 1 const argv = process.argv.slice(2); @@ -42,9 +42,13 @@ const args = parse(argv, { ## Benchmarks ``` -mri x 1,650,986 ops/sec ±0.32% (97 runs sampled) -ultraflag x 1,407,191 ops/sec ±0.38% (99 runs sampled) -minimist x 383,506 ops/sec ±0.28% (99 runs sampled) -node:util x 320,953 ops/sec ±0.35% (98 runs sampled) -yargs-parser x 31,874 ops/sec ±1.32% (92 runs sampled) +mri x 1,650,986 ops/sec ±0.32% (97 runs sampled) +@bomb.sh/args x 1,407,191 ops/sec ±0.38% (99 runs sampled) +minimist x 383,506 ops/sec ±0.28% (99 runs sampled) +node:util x 320,953 ops/sec ±0.35% (98 runs sampled) +yargs-parser x 31,874 ops/sec ±1.32% (92 runs sampled) ``` + +## Acknowledgements + +This package was previously published as `ultraflag` up until `v0.2.3`, when it was transferred to `@bomb.sh/args`. diff --git a/package.json b/package.json index 8aaf50a..5905c28 100644 --- a/package.json +++ b/package.json @@ -1,16 +1,20 @@ { - "name": "ultraflag", + "name": "@bomb.sh/args", + "publishConfig": { + "access": "public", + "provenance": true + }, "type": "module", "version": "0.2.3", "types": "./dist/index.d.ts", "repository": { "type": "git", - "url": "https://github.com/natemoo-re/ultraflag" + "url": "https://github.com/bombshell-dev/args" }, "bugs": { - "url": "https://github.com/natemoo-re/ultraflag/issues" + "url": "https://github.com/bombshell-dev/args/issues" }, - "homepage": "https://github.com/natemoo-re/ultraflag#README", + "homepage": "https://github.com/bombshell-dev/args#README", "scripts": { "build": "node scripts/build.js && tsc -p .", "lint": "prettier \"**/*.{js,ts,md}\"", @@ -38,7 +42,7 @@ "author": { "name": "Nate Moore", "email": "nate@natemoo.re", - "url": "https://twitter.com/n_moore" + "url": "https://natemoo.re" }, "license": "MIT", "volta": { diff --git a/scripts/build.js b/scripts/build.js index df77e51..b530c3c 100644 --- a/scripts/build.js +++ b/scripts/build.js @@ -1,7 +1,7 @@ +import colors from 'chalk'; import { build } from "esbuild"; import { gzipSizeFromFileSync } from 'gzip-size'; import bytes from 'pretty-bytes'; -import colors from 'chalk'; async function run() { const files = ['src/index.ts']; diff --git a/test/flags.test.ts b/test/flags.test.ts index e1a1b37..a96bd5c 100644 --- a/test/flags.test.ts +++ b/test/flags.test.ts @@ -1,5 +1,5 @@ -import { parse } from "../src"; import { describe, expect, it, test } from "vitest"; +import { parse } from "../src"; describe("flags", () => { it("a b c", () => {