@clerc/utils 0.8.1 → 0.8.3

package/dist/index.d.ts

@@ -1,271 +1,32 @@
-import * as terminal_link from 'terminal-link';
-import * as child_process from 'child_process';
-import * as picocolors_types from 'picocolors/types';
-import * as tasuku from 'tasuku';
-import * as kons from 'kons';
-import * as konsola from 'kons/consola';
-import spinner from 'ora';
-import open from 'open';
-import progress from 'cli-progress';
-import columns from 'terminal-columns';
-import Table from 'cli-table3';
-import { prompt } from 'enquirer';
+import * as clerc from 'clerc';
+import { Command } from 'clerc';
 
-declare const Toolkit: {
-    prompt: typeof prompt;
-    task: tasuku.Task;
-    figures: {
-        readonly tick: string;
-        readonly info: string;
-        readonly warning: string;
-        readonly cross: string;
-        readonly square: string;
-        readonly squareSmall: string;
-        readonly squareSmallFilled: string;
-        readonly squareDarkShade: string;
-        readonly squareMediumShade: string;
-        readonly squareLightShade: string;
-        readonly squareTop: string;
-        readonly squareBottom: string;
-        readonly squareLeft: string;
-        readonly squareRight: string;
-        readonly squareCenter: string;
-        readonly circle: string;
-        readonly circleFilled: string;
-        readonly circleDotted: string;
-        readonly circleDouble: string;
-        readonly circleCircle: string;
-        readonly circleCross: string;
-        readonly circlePipe: string;
-        readonly circleQuestionMark: string;
-        readonly radioOn: string;
-        readonly radioOff: string;
-        readonly checkboxOn: string;
-        readonly checkboxOff: string;
-        readonly checkboxCircleOn: string;
-        readonly checkboxCircleOff: string;
-        readonly questionMarkPrefix: string;
-        readonly bullet: string;
-        readonly dot: string;
-        readonly ellipsis: string;
-        readonly pointer: string;
-        readonly pointerSmall: string;
-        readonly triangleUp: string;
-        readonly triangleUpSmall: string;
-        readonly triangleUpOutline: string;
-        readonly triangleDown: string;
-        readonly triangleDownSmall: string;
-        readonly triangleLeft: string;
-        readonly triangleLeftSmall: string;
-        readonly triangleRight: string;
-        readonly triangleRightSmall: string;
-        readonly lozenge: string;
-        readonly lozengeOutline: string;
-        readonly home: string;
-        readonly hamburger: string;
-        readonly smiley: string;
-        readonly mustache: string;
-        readonly heart: string;
-        readonly star: string;
-        readonly play: string;
-        readonly musicNote: string;
-        readonly musicNoteBeamed: string;
-        readonly nodejs: string;
-        readonly arrowUp: string;
-        readonly arrowDown: string;
-        readonly arrowLeft: string;
-        readonly arrowRight: string;
-        readonly arrowLeftRight: string;
-        readonly arrowUpDown: string;
-        readonly almostEqual: string;
-        readonly notEqual: string;
-        readonly lessOrEqual: string;
-        readonly greaterOrEqual: string;
-        readonly identical: string;
-        readonly infinity: string;
-        readonly subscriptZero: string;
-        readonly subscriptOne: string;
-        readonly subscriptTwo: string;
-        readonly subscriptThree: string;
-        readonly subscriptFour: string;
-        readonly subscriptFive: string;
-        readonly subscriptSix: string;
-        readonly subscriptSeven: string;
-        readonly subscriptEight: string;
-        readonly subscriptNine: string;
-        readonly oneHalf: string;
-        readonly oneThird: string;
-        readonly oneQuarter: string;
-        readonly oneFifth: string;
-        readonly oneSixth: string;
-        readonly oneSeventh: string;
-        readonly oneEighth: string;
-        readonly oneNinth: string;
-        readonly oneTenth: string;
-        readonly twoThirds: string;
-        readonly twoFifths: string;
-        readonly threeQuarters: string;
-        readonly threeFifths: string;
-        readonly threeEighths: string;
-        readonly fourFifths: string;
-        readonly fiveSixths: string;
-        readonly fiveEighths: string;
-        readonly sevenEighth: string;
-        readonly line: string;
-        readonly lineBold: string;
-        readonly lineDouble: string;
-        readonly lineDashed0: string;
-        readonly lineDashed1: string;
-        readonly lineDashed2: string;
-        readonly lineDashed3: string;
-        readonly lineDashed4: string;
-        readonly lineDashed5: string;
-        readonly lineDashed6: string;
-        readonly lineDashed7: string;
-        readonly lineDashed8: string;
-        readonly lineDashed9: string;
-        readonly lineDashed10: string;
-        readonly lineDashed11: string;
-        readonly lineDashed12: string;
-        readonly lineDashed13: string;
-        readonly lineDashed14: string;
-        readonly lineDashed15: string;
-        readonly lineVertical: string;
-        readonly lineVerticalBold: string;
-        readonly lineVerticalDouble: string;
-        readonly lineVerticalDashed0: string;
-        readonly lineVerticalDashed1: string;
-        readonly lineVerticalDashed2: string;
-        readonly lineVerticalDashed3: string;
-        readonly lineVerticalDashed4: string;
-        readonly lineVerticalDashed5: string;
-        readonly lineVerticalDashed6: string;
-        readonly lineVerticalDashed7: string;
-        readonly lineVerticalDashed8: string;
-        readonly lineVerticalDashed9: string;
-        readonly lineVerticalDashed10: string;
-        readonly lineVerticalDashed11: string;
-        readonly lineDownLeft: string;
-        readonly lineDownLeftArc: string;
-        readonly lineDownBoldLeftBold: string;
-        readonly lineDownBoldLeft: string;
-        readonly lineDownLeftBold: string;
-        readonly lineDownDoubleLeftDouble: string;
-        readonly lineDownDoubleLeft: string;
-        readonly lineDownLeftDouble: string;
-        readonly lineDownRight: string;
-        readonly lineDownRightArc: string;
-        readonly lineDownBoldRightBold: string;
-        readonly lineDownBoldRight: string;
-        readonly lineDownRightBold: string;
-        readonly lineDownDoubleRightDouble: string;
-        readonly lineDownDoubleRight: string;
-        readonly lineDownRightDouble: string;
-        readonly lineUpLeft: string;
-        readonly lineUpLeftArc: string;
-        readonly lineUpBoldLeftBold: string;
-        readonly lineUpBoldLeft: string;
-        readonly lineUpLeftBold: string;
-        readonly lineUpDoubleLeftDouble: string;
-        readonly lineUpDoubleLeft: string;
-        readonly lineUpLeftDouble: string;
-        readonly lineUpRight: string;
-        readonly lineUpRightArc: string;
-        readonly lineUpBoldRightBold: string;
-        readonly lineUpBoldRight: string;
-        readonly lineUpRightBold: string;
-        readonly lineUpDoubleRightDouble: string;
-        readonly lineUpDoubleRight: string;
-        readonly lineUpRightDouble: string;
-        readonly lineUpDownLeft: string;
-        readonly lineUpBoldDownBoldLeftBold: string;
-        readonly lineUpBoldDownBoldLeft: string;
-        readonly lineUpDownLeftBold: string;
-        readonly lineUpBoldDownLeftBold: string;
-        readonly lineUpDownBoldLeftBold: string;
-        readonly lineUpDownBoldLeft: string;
-        readonly lineUpBoldDownLeft: string;
-        readonly lineUpDoubleDownDoubleLeftDouble: string;
-        readonly lineUpDoubleDownDoubleLeft: string;
-        readonly lineUpDownLeftDouble: string;
-        readonly lineUpDownRight: string;
-        readonly lineUpBoldDownBoldRightBold: string;
-        readonly lineUpBoldDownBoldRight: string;
-        readonly lineUpDownRightBold: string;
-        readonly lineUpBoldDownRightBold: string;
-        readonly lineUpDownBoldRightBold: string;
-        readonly lineUpDownBoldRight: string;
-        readonly lineUpBoldDownRight: string;
-        readonly lineUpDoubleDownDoubleRightDouble: string;
-        readonly lineUpDoubleDownDoubleRight: string;
-        readonly lineUpDownRightDouble: string;
-        readonly lineDownLeftRight: string;
-        readonly lineDownBoldLeftBoldRightBold: string;
-        readonly lineDownLeftBoldRightBold: string;
-        readonly lineDownBoldLeftRight: string;
-        readonly lineDownBoldLeftBoldRight: string;
-        readonly lineDownBoldLeftRightBold: string;
-        readonly lineDownLeftRightBold: string;
-        readonly lineDownLeftBoldRight: string;
-        readonly lineDownDoubleLeftDoubleRightDouble: string;
-        readonly lineDownDoubleLeftRight: string;
-        readonly lineDownLeftDoubleRightDouble: string;
-        readonly lineUpLeftRight: string;
-        readonly lineUpBoldLeftBoldRightBold: string;
-        readonly lineUpLeftBoldRightBold: string;
-        readonly lineUpBoldLeftRight: string;
-        readonly lineUpBoldLeftBoldRight: string;
-        readonly lineUpBoldLeftRightBold: string;
-        readonly lineUpLeftRightBold: string;
-        readonly lineUpLeftBoldRight: string;
-        readonly lineUpDoubleLeftDoubleRightDouble: string;
-        readonly lineUpDoubleLeftRight: string;
-        readonly lineUpLeftDoubleRightDouble: string;
-        readonly lineUpDownLeftRight: string;
-        readonly lineUpBoldDownBoldLeftBoldRightBold: string;
-        readonly lineUpDownBoldLeftBoldRightBold: string;
-        readonly lineUpBoldDownLeftBoldRightBold: string;
-        readonly lineUpBoldDownBoldLeftRightBold: string;
-        readonly lineUpBoldDownBoldLeftBoldRight: string;
-        readonly lineUpBoldDownLeftRight: string;
-        readonly lineUpDownBoldLeftRight: string;
-        readonly lineUpDownLeftBoldRight: string;
-        readonly lineUpDownLeftRightBold: string;
-        readonly lineUpBoldDownBoldLeftRight: string;
-        readonly lineUpDownLeftBoldRightBold: string;
-        readonly lineUpBoldDownLeftBoldRight: string;
-        readonly lineUpBoldDownLeftRightBold: string;
-        readonly lineUpDownBoldLeftBoldRight: string;
-        readonly lineUpDownBoldLeftRightBold: string;
-        readonly lineUpDoubleDownDoubleLeftDoubleRightDouble: string;
-        readonly lineUpDoubleDownDoubleLeftRight: string;
-        readonly lineUpDownLeftDoubleRightDouble: string;
-        readonly lineCross: string;
-        readonly lineBackslash: string;
-        readonly lineSlash: string;
-    };
-    colors: picocolors_types.Colors & {
-        createColors: (enabled?: boolean | undefined) => picocolors_types.Colors;
-    };
-    spinner: typeof spinner;
-    open: {
-        (target: string, options?: open.Options | undefined): Promise<child_process.ChildProcess>;
-        apps: Record<open.AppName, string | readonly string[]>;
-        openApp: (name: string | readonly string[], options?: open.OpenAppOptions | undefined) => Promise<child_process.ChildProcess>;
-    };
-    progress: typeof progress;
-    columns: typeof columns;
-    link: {
-        (text: string, url: string, options?: terminal_link.Options | undefined): string;
-        readonly stderr: {
-            (text: string, url: string, options?: terminal_link.Options | undefined): string;
-            readonly isSupported: boolean;
-        };
-        readonly isSupported: boolean;
-    };
-    kons: typeof kons;
-    konsola: typeof konsola;
-    Table: Table;
-};
+/**
+ * Copied from type-fest
+ */
+type Primitive = null | undefined | string | number | boolean | symbol | bigint;
+/**
+* Copied from type-fest
+*/
+type LiteralUnion<LiteralType, BaseType extends Primitive> = LiteralType | (BaseType & Record<never, never>);
+type Dict<T> = Record<string, T>;
+type MustArray<T> = T extends any[] ? T : [T];
+type MaybeArray<T> = T | T[];
+type GetLength<T extends any[]> = T extends {
+    length: infer L extends number;
+} ? L : never;
+type GetTail<T extends any[]> = T extends [infer _Head, ...infer Tail] ? Tail : never;
+type EnhanceSingle<T, E extends Dict<any>> = T & E;
+type Enhance<T, E extends Dict<any> | Dict<any>[]> = GetLength<MustArray<E>> extends 0 ? T : Enhance<EnhanceSingle<T, MustArray<E>[0]>, GetTail<MustArray<E>>>;
+declare const mustArray: <T>(a: MaybeArray<T>) => T[];
+type CamelCase<T extends string> = T extends `${infer A}-${infer B}${infer C}` ? `${A}${Capitalize<B>}${CamelCase<C>}` : T;
+declare const camelCase: <T extends string>(s: T) => CamelCase<T>;
+type KebabCase<T extends string, A extends string = ""> = T extends `${infer F}${infer R}` ? KebabCase<R, `${A}${F extends Lowercase<F> ? "" : "-"}${Lowercase<F>}`> : A;
+declare const kebabCase: <T extends string>(s: T) => KebabCase<T, "">;
+declare const gracefulFlagName: (n: string) => string;
+declare const gracefulVersion: (v: string) => string;
+declare const arrayStartsWith: <T>(arr: T[], start: T[]) => boolean;
+declare const arrayEquals: <T>(arr1: T[], arr2: T[]) => boolean;
+declare const generateCommandRecordFromCommandArray: <C extends Command<string, clerc.CommandOptions<string[], MaybeArray<string>, Dict<clerc.FlagOptions>>>>(commands: C[]) => Dict<C>;
 
-export { Toolkit, Toolkit as default };
+export { CamelCase, Dict, Enhance, GetLength, GetTail, KebabCase, LiteralUnion, MaybeArray, MustArray, Primitive, arrayEquals, arrayStartsWith, camelCase, generateCommandRecordFromCommandArray, gracefulFlagName, gracefulVersion, kebabCase, mustArray };

package/dist/index.js

@@ -0,0 +1,26 @@
+const mustArray = (a) => Array.isArray(a) ? a : [a];
+const camelCase = (s) => s.replace(/-([a-z])/g, (_, c) => c.toUpperCase());
+const kebabCase = (s) => s.replace(/([A-Z])/g, (_, c) => `-${c.toLowerCase()}`);
+const gracefulFlagName = (n) => n.length <= 1 ? `-${n}` : `--${n}`;
+const gracefulVersion = (v) => v.length === 0 ? "" : v.startsWith("v") ? v : `v${v}`;
+const arrayStartsWith = (arr, start) => {
+  if (start.length > arr.length) {
+    return false;
+  }
+  return arr.slice(0, start.length).every((item, i) => item === start[i]);
+};
+const arrayEquals = (arr1, arr2) => {
+  if (arr2.length !== arr1.length) {
+    return false;
+  }
+  return arr1.every((item, i) => item === arr2[i]);
+};
+const generateCommandRecordFromCommandArray = (commands) => {
+  const record = {};
+  for (const command of commands) {
+    record[command.name] = command;
+  }
+  return record;
+};
+
+export { arrayEquals, arrayStartsWith, camelCase, generateCommandRecordFromCommandArray, gracefulFlagName, gracefulVersion, kebabCase, mustArray };

package/dist/index.mjs

@@ -1,29 +1,26 @@
-import * as kons from 'kons';
-import * as konsola from 'kons/consola';
-import colors from 'picocolors';
-import figures from 'figures';
-import task from 'tasuku';
-import spinner from 'ora';
-import open from 'open';
-import progress from 'cli-progress';
-import columns from 'terminal-columns';
-import link from 'terminal-link';
-import Table from 'cli-table3';
-import { prompt } from 'enquirer';
-
-const Toolkit = {
-  prompt,
-  task,
-  figures,
-  colors,
-  spinner,
-  open,
-  progress,
-  columns,
-  link,
-  kons,
-  konsola,
-  Table
+const mustArray = (a) => Array.isArray(a) ? a : [a];
+const camelCase = (s) => s.replace(/-([a-z])/g, (_, c) => c.toUpperCase());
+const kebabCase = (s) => s.replace(/([A-Z])/g, (_, c) => `-${c.toLowerCase()}`);
+const gracefulFlagName = (n) => n.length <= 1 ? `-${n}` : `--${n}`;
+const gracefulVersion = (v) => v.length === 0 ? "" : v.startsWith("v") ? v : `v${v}`;
+const arrayStartsWith = (arr, start) => {
+  if (start.length > arr.length) {
+    return false;
+  }
+  return arr.slice(0, start.length).every((item, i) => item === start[i]);
+};
+const arrayEquals = (arr1, arr2) => {
+  if (arr2.length !== arr1.length) {
+    return false;
+  }
+  return arr1.every((item, i) => item === arr2[i]);
+};
+const generateCommandRecordFromCommandArray = (commands) => {
+  const record = {};
+  for (const command of commands) {
+    record[command.name] = command;
+  }
+  return record;
 };
 
-export { Toolkit, Toolkit as default };
+export { arrayEquals, arrayStartsWith, camelCase, generateCommandRecordFromCommandArray, gracefulFlagName, gracefulVersion, kebabCase, mustArray };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@clerc/utils",
-  "version": "0.8.1",
+  "version": "0.8.3",
   "author": "Ray <nn_201312@163.com> (https://github.com/so1ve)",
   "description": "Clerc utils",
   "keywords": [
@@ -11,8 +11,10 @@
     "arguments",
     "argv",
     "args",
-    "terminal"
+    "terminal",
+    "utils"
   ],
+  "type": "module",
   "homepage": "https://github.com/so1ve/clerc/tree/main/packages/utils#readme",
   "repository": {
     "type": "git",
@@ -27,11 +29,10 @@
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
-      "require": "./dist/index.cjs",
       "import": "./dist/index.mjs"
     }
   },
-  "main": "dist/index.cjs",
+  "main": "dist/index.js",
   "module": "dist/index.mjs",
   "types": "dist/index.d.ts",
   "files": [
@@ -40,23 +41,6 @@
   "publishConfig": {
     "access": "public"
   },
-  "peerDependencies": {
-    "clerc": "*"
-  },
-  "dependencies": {
-    "@types/cli-progress": "^3.11.0",
-    "cli-progress": "^3.11.2",
-    "cli-table3": "^0.6.3",
-    "enquirer": "^2.3.6",
-    "figures": "^5.0.0",
-    "kons": "^0.5.4",
-    "open": "^8.4.0",
-    "ora": "^6.1.2",
-    "picocolors": "^1.0.0",
-    "tasuku": "^2.0.0",
-    "terminal-columns": "^1.4.1",
-    "terminal-link": "^3.0.0"
-  },
   "scripts": {
     "build": "puild",
     "watch": "puild --watch"

package/dist/index.cjs

@@ -1,66 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-var kons = require('kons');
-var konsola = require('kons/consola');
-var colors = require('picocolors');
-var figures = require('figures');
-var task = require('tasuku');
-var spinner = require('ora');
-var open = require('open');
-var progress = require('cli-progress');
-var columns = require('terminal-columns');
-var link = require('terminal-link');
-var Table = require('cli-table3');
-var enquirer = require('enquirer');
-
-function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
-
-function _interopNamespace(e) {
-  if (e && e.__esModule) return e;
-  var n = Object.create(null);
-  if (e) {
-    Object.keys(e).forEach(function (k) {
-      if (k !== 'default') {
-        var d = Object.getOwnPropertyDescriptor(e, k);
-        Object.defineProperty(n, k, d.get ? d : {
-          enumerable: true,
-          get: function () { return e[k]; }
-        });
-      }
-    });
-  }
-  n["default"] = e;
-  return Object.freeze(n);
-}
-
-var kons__namespace = /*#__PURE__*/_interopNamespace(kons);
-var konsola__namespace = /*#__PURE__*/_interopNamespace(konsola);
-var colors__default = /*#__PURE__*/_interopDefaultLegacy(colors);
-var figures__default = /*#__PURE__*/_interopDefaultLegacy(figures);
-var task__default = /*#__PURE__*/_interopDefaultLegacy(task);
-var spinner__default = /*#__PURE__*/_interopDefaultLegacy(spinner);
-var open__default = /*#__PURE__*/_interopDefaultLegacy(open);
-var progress__default = /*#__PURE__*/_interopDefaultLegacy(progress);
-var columns__default = /*#__PURE__*/_interopDefaultLegacy(columns);
-var link__default = /*#__PURE__*/_interopDefaultLegacy(link);
-var Table__default = /*#__PURE__*/_interopDefaultLegacy(Table);
-
-const Toolkit = {
-  prompt: enquirer.prompt,
-  task: task__default["default"],
-  figures: figures__default["default"],
-  colors: colors__default["default"],
-  spinner: spinner__default["default"],
-  open: open__default["default"],
-  progress: progress__default["default"],
-  columns: columns__default["default"],
-  link: link__default["default"],
-  kons: kons__namespace,
-  konsola: konsola__namespace,
-  Table: Table__default["default"]
-};
-
-exports.Toolkit = Toolkit;
-exports["default"] = Toolkit;