@ntnyq/utils 0.0.2 → 0.1.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022-PRESENT ntnyq <https://github.com/ntnyq>
+Copyright (c) 2024-PRESENT ntnyq <https://github.com/ntnyq>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,19 +1,27 @@
 # @ntnyq/utils
 
+[![CI](https://github.com/ntnyq/utils/workflows/CI/badge.svg)](https://github.com/ntnyq/utils/actions)
 [![NPM VERSION](https://img.shields.io/npm/v/@ntnyq/utils.svg)](https://www.npmjs.com/package/@ntnyq/utils)
+[![NPM DOWNLOADS](https://img.shields.io/npm/dy/@ntnyq/utils.svg)](https://www.npmjs.com/package/@ntnyq/utils)
+[![CODECOV](https://codecov.io/github/ntnyq/utils/branch/main/graph/badge.svg)](https://codecov.io/github/ntnyq/utils)
+[![LICENSE](https://img.shields.io/github/license/ntnyq/utils.svg)](https://github.com/ntnyq/utils/blob/main/LICENSE)
+
+> Common used utils.
 
 ## Install
 
 ```bash
-pnpm add @ntnyq/utils -D
+npm install @ntnyq/utils
 ```
 
-## Utils
+```bash
+yarn add @ntnyq/utils
+```
 
-- [camelCase](./src/camelCase.ts)
-- [capitalize](./src/capitalize.ts)
-- [kekabCase](./src/kekabCase.ts)
+```bash
+pnpm add @ntnyq/utils
+```
 
 ## License
 
-[MIT](./LICENSE) License © 2022-PRESENT [ntnyq](https://github.com/ntnyq)
+[MIT](./LICENSE) License © 2024-PRESENT [ntnyq](https://github.com/ntnyq)

package/dist/index.cjs

@@ -1,17 +1,228 @@
-'use strict';
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
-function kekabCase(input) {
-  return input.replace(/([a-z])([A-Z])/g, "$1-$2").replace(/[\s_]+/g, "-").toLowerCase();
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  cAF: () => cAF,
+  camelCase: () => camelCase,
+  capitalize: () => capitalize,
+  days: () => days,
+  flatCase: () => flatCase,
+  hours: () => hours,
+  isBrowser: () => isBrowser,
+  isUppercase: () => isUppercase,
+  kebabCase: () => kebabCase,
+  lowerFirst: () => lowerFirst,
+  minutes: () => minutes,
+  pascalCase: () => pascalCase,
+  rAF: () => rAF,
+  seconds: () => seconds,
+  snakeCase: () => snakeCase,
+  splitByCase: () => splitByCase,
+  titleCase: () => titleCase,
+  toArray: () => toArray,
+  trainCase: () => trainCase,
+  unique: () => unique,
+  upperFirst: () => upperFirst,
+  waitFor: () => waitFor,
+  warnOnce: () => warnOnce,
+  weeks: () => weeks
+});
+module.exports = __toCommonJS(src_exports);
+
+// src/env/isBrowser.ts
+var isBrowser = () => typeof document !== "undefined";
+
+// node_modules/.pnpm/scule@1.3.0/node_modules/scule/dist/index.mjs
+var NUMBER_CHAR_RE = /\d/;
+var STR_SPLITTERS = ["-", "_", "/", "."];
+function isUppercase(char = "") {
+  if (NUMBER_CHAR_RE.test(char)) {
+    return void 0;
+  }
+  return char !== char.toLowerCase();
+}
+function splitByCase(str, separators) {
+  const splitters = separators ?? STR_SPLITTERS;
+  const parts = [];
+  if (!str || typeof str !== "string") {
+    return parts;
+  }
+  let buff = "";
+  let previousUpper;
+  let previousSplitter;
+  for (const char of str) {
+    const isSplitter = splitters.includes(char);
+    if (isSplitter === true) {
+      parts.push(buff);
+      buff = "";
+      previousUpper = void 0;
+      continue;
+    }
+    const isUpper = isUppercase(char);
+    if (previousSplitter === false) {
+      if (previousUpper === false && isUpper === true) {
+        parts.push(buff);
+        buff = char;
+        previousUpper = isUpper;
+        continue;
+      }
+      if (previousUpper === true && isUpper === false && buff.length > 1) {
+        const lastChar = buff.at(-1);
+        parts.push(buff.slice(0, Math.max(0, buff.length - 1)));
+        buff = lastChar + char;
+        previousUpper = isUpper;
+        continue;
+      }
+    }
+    buff += char;
+    previousUpper = isUpper;
+    previousSplitter = isSplitter;
+  }
+  parts.push(buff);
+  return parts;
+}
+function upperFirst(str) {
+  return str ? str[0].toUpperCase() + str.slice(1) : "";
+}
+function lowerFirst(str) {
+  return str ? str[0].toLowerCase() + str.slice(1) : "";
+}
+function pascalCase(str, opts) {
+  return str ? (Array.isArray(str) ? str : splitByCase(str)).map((p) => upperFirst(opts?.normalize ? p.toLowerCase() : p)).join("") : "";
+}
+function camelCase(str, opts) {
+  return lowerFirst(pascalCase(str || "", opts));
 }
+function kebabCase(str, joiner) {
+  return str ? (Array.isArray(str) ? str : splitByCase(str)).map((p) => p.toLowerCase()).join(joiner ?? "-") : "";
+}
+function snakeCase(str) {
+  return kebabCase(str || "", "_");
+}
+function flatCase(str) {
+  return kebabCase(str || "", "");
+}
+function trainCase(str, opts) {
+  return (Array.isArray(str) ? str : splitByCase(str)).filter(Boolean).map((p) => upperFirst(opts?.normalize ? p.toLowerCase() : p)).join("-");
+}
+var titleCaseExceptions = /^(a|an|and|as|at|but|by|for|if|in|is|nor|of|on|or|the|to|with)$/i;
+function titleCase(str, opts) {
+  return (Array.isArray(str) ? str : splitByCase(str)).filter(Boolean).map(
+    (p) => titleCaseExceptions.test(p) ? p.toLowerCase() : upperFirst(opts?.normalize ? p.toLowerCase() : p)
+  ).join(" ");
+}
+
+// src/case.ts
+var capitalize = upperFirst;
 
-function camelCase(input) {
-  return input.replace(/[._-](\w)/g, (_, c) => c ? c.toUpperCase() : "");
+// src/misc/raf.ts
+var root = isBrowser() ? window : globalThis;
+var prev = Date.now();
+function mockRAF(fn) {
+  const curr = Date.now();
+  const ms = Math.max(0, 16 - (curr - prev));
+  const id = setTimeout(fn, ms);
+  prev = curr + ms;
+  return id;
 }
+function rAF(fn) {
+  const raf = root.requestAnimationFrame || mockRAF;
+  return raf.call(root, fn);
+}
+function cAF(id) {
+  const caf = root.cancelAnimationFrame || root.clearTimeout;
+  return caf.call(root, id);
+}
+
+// src/misc/time.ts
+var ONE_SECOND = 1e3;
+var ONE_MINUTE = 60 * ONE_SECOND;
+var ONE_HOUR = 60 * ONE_MINUTE;
+var ONE_DAY = 24 * ONE_HOUR;
+var ONE_WEEK = 7 * ONE_DAY;
+function seconds(count) {
+  return count * ONE_SECOND;
+}
+function minutes(count) {
+  return count * ONE_MINUTE;
+}
+function hours(count) {
+  return count * ONE_HOUR;
+}
+function days(count) {
+  return count * ONE_DAY;
+}
+function weeks(count) {
+  return count * ONE_WEEK;
+}
+
+// src/misc/waitFor.ts
+function waitFor(ms) {
+  return new Promise((resolve) => setTimeout(resolve, ms));
+}
+
+// src/misc/warnOnce.ts
+var warned = /* @__PURE__ */ new Set();
+var warnOnce = (message) => {
+  if (warned.has(message)) {
+    return;
+  }
+  warned.add(message);
+  console.warn(message);
+};
 
-function capitalize(input) {
-  return `${input.charAt(0).toUpperCase()}${input.slice(1)}`;
+// src/array/unique.ts
+function unique(val) {
+  return Array.from(new Set(val));
 }
 
-exports.camelCase = camelCase;
-exports.capitalize = capitalize;
-exports.kekabCase = kekabCase;
+// src/array/toArray.ts
+function toArray(val) {
+  val = val ?? [];
+  return Array.isArray(val) ? val : [val];
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  cAF,
+  camelCase,
+  capitalize,
+  days,
+  flatCase,
+  hours,
+  isBrowser,
+  isUppercase,
+  kebabCase,
+  lowerFirst,
+  minutes,
+  pascalCase,
+  rAF,
+  seconds,
+  snakeCase,
+  splitByCase,
+  titleCase,
+  toArray,
+  trainCase,
+  unique,
+  upperFirst,
+  waitFor,
+  warnOnce,
+  weeks
+});

package/dist/index.d.cts

@@ -0,0 +1,79 @@
+import { upperFirst } from 'scule';
+export * from 'scule';
+
+/**
+ * @file env.ts
+ */
+/**
+ * Checks if the code is running in a browser
+ *
+ * @returns boolean - true if the code is running in a browser
+ */
+declare const isBrowser: () => boolean;
+
+/**
+ * @file case utils
+ * @category Case
+ */
+
+/**
+ * @deprecated use upperFirst instead
+ */
+declare const capitalize: typeof upperFirst;
+
+/**
+ * @file raf.ts
+ */
+/**
+ * Request animation frame
+ *
+ * @param fn callback
+ * @returns id
+ */
+declare function rAF(fn: FrameRequestCallback): number;
+/**
+ * Cancel animation frame
+ *
+ * @param id id
+ * @returns void
+ */
+declare function cAF(id: number): void;
+
+/**
+ * @category Utils - time
+ */
+declare function seconds(count: number): number;
+declare function minutes(count: number): number;
+declare function hours(count: number): number;
+declare function days(count: number): number;
+declare function weeks(count: number): number;
+
+/**
+ * Wait for a number of milliseconds
+ *
+ * @param ms millseconds to wait
+ * @returns a promise that resolves after ms milliseconds
+ *
+ * @example
+ * ```
+ * import { waitFor } from '@ntnyq/utils'
+ * await waitFor(3e3)
+ * // do somthing after 3 seconds
+ * ```
+ */
+declare function waitFor(ms: number): Promise<unknown>;
+
+declare const warnOnce: (message: string) => void;
+
+declare function unique<T>(val: T[]): T[];
+
+type Nullable<T> = T | null;
+type MayBe<T> = T | undefined;
+type AnyFn<T = any, R = any> = (...args: T[]) => R;
+type Arrayable<T> = T | T[];
+type Awaitable<T> = T | Promise<T>;
+type Prettify<T> = Omit<T, never>;
+
+declare function toArray<T>(val?: Nullable<Arrayable<T>>): Arrayable<T>;
+
+export { type AnyFn, type Arrayable, type Awaitable, type MayBe, type Nullable, type Prettify, cAF, capitalize, days, hours, isBrowser, minutes, rAF, seconds, toArray, unique, waitFor, warnOnce, weeks };

package/dist/index.d.ts

@@ -1,43 +1,79 @@
+import { upperFirst } from 'scule';
+export * from 'scule';
+
 /**
- * transform given string to kekabCase
- *
- * @param input given string
- * @returns string in kekabCase
+ * @file env.ts
+ */
+/**
+ * Checks if the code is running in a browser
  *
- * @example
- * ```
- * import { kekabCase } from '@ntnyq/utils'
- * kekabCase('FooBarBaz') // foo-bar-baz
- * ```
+ * @returns boolean - true if the code is running in a browser
  */
-declare function kekabCase(input: string): string;
+declare const isBrowser: () => boolean;
 
 /**
- * transform given string to camelCase
+ * @file case utils
+ * @category Case
+ */
+
+/**
+ * @deprecated use upperFirst instead
+ */
+declare const capitalize: typeof upperFirst;
+
+/**
+ * @file raf.ts
+ */
+/**
+ * Request animation frame
  *
- * @param input given string
- * @returns string in camelCase
+ * @param fn callback
+ * @returns id
+ */
+declare function rAF(fn: FrameRequestCallback): number;
+/**
+ * Cancel animation frame
  *
- * @example
- * ```
- * import { camelCase } from '@ntnyq/utils'
- * camelCase('foo-bar-baz') // fooBarBaz
- * ```
+ * @param id id
+ * @returns void
  */
-declare function camelCase(input: string): string;
+declare function cAF(id: number): void;
 
 /**
- * capitalize the given string's first letter
+ * @category Utils - time
+ */
+declare function seconds(count: number): number;
+declare function minutes(count: number): number;
+declare function hours(count: number): number;
+declare function days(count: number): number;
+declare function weeks(count: number): number;
+
+/**
+ * Wait for a number of milliseconds
  *
- * @param input given string
- * @returns string first letter capitalize
+ * @param ms millseconds to wait
+ * @returns a promise that resolves after ms milliseconds
  *
  * @example
  * ```
- * import { capitalize } from '@ntnyq/utils'
- * capitalize('fooBarBaz') // FooBarBaz
+ * import { waitFor } from '@ntnyq/utils'
+ * await waitFor(3e3)
+ * // do somthing after 3 seconds
  * ```
  */
-declare function capitalize(input: string): string;
+declare function waitFor(ms: number): Promise<unknown>;
+
+declare const warnOnce: (message: string) => void;
+
+declare function unique<T>(val: T[]): T[];
+
+type Nullable<T> = T | null;
+type MayBe<T> = T | undefined;
+type AnyFn<T = any, R = any> = (...args: T[]) => R;
+type Arrayable<T> = T | T[];
+type Awaitable<T> = T | Promise<T>;
+type Prettify<T> = Omit<T, never>;
+
+declare function toArray<T>(val?: Nullable<Arrayable<T>>): Arrayable<T>;
 
-export { camelCase, capitalize, kekabCase };
+export { type AnyFn, type Arrayable, type Awaitable, type MayBe, type Nullable, type Prettify, cAF, capitalize, days, hours, isBrowser, minutes, rAF, seconds, toArray, unique, waitFor, warnOnce, weeks };

package/dist/index.js

@@ -0,0 +1,178 @@
+// src/env/isBrowser.ts
+var isBrowser = () => typeof document !== "undefined";
+
+// node_modules/.pnpm/scule@1.3.0/node_modules/scule/dist/index.mjs
+var NUMBER_CHAR_RE = /\d/;
+var STR_SPLITTERS = ["-", "_", "/", "."];
+function isUppercase(char = "") {
+  if (NUMBER_CHAR_RE.test(char)) {
+    return void 0;
+  }
+  return char !== char.toLowerCase();
+}
+function splitByCase(str, separators) {
+  const splitters = separators ?? STR_SPLITTERS;
+  const parts = [];
+  if (!str || typeof str !== "string") {
+    return parts;
+  }
+  let buff = "";
+  let previousUpper;
+  let previousSplitter;
+  for (const char of str) {
+    const isSplitter = splitters.includes(char);
+    if (isSplitter === true) {
+      parts.push(buff);
+      buff = "";
+      previousUpper = void 0;
+      continue;
+    }
+    const isUpper = isUppercase(char);
+    if (previousSplitter === false) {
+      if (previousUpper === false && isUpper === true) {
+        parts.push(buff);
+        buff = char;
+        previousUpper = isUpper;
+        continue;
+      }
+      if (previousUpper === true && isUpper === false && buff.length > 1) {
+        const lastChar = buff.at(-1);
+        parts.push(buff.slice(0, Math.max(0, buff.length - 1)));
+        buff = lastChar + char;
+        previousUpper = isUpper;
+        continue;
+      }
+    }
+    buff += char;
+    previousUpper = isUpper;
+    previousSplitter = isSplitter;
+  }
+  parts.push(buff);
+  return parts;
+}
+function upperFirst(str) {
+  return str ? str[0].toUpperCase() + str.slice(1) : "";
+}
+function lowerFirst(str) {
+  return str ? str[0].toLowerCase() + str.slice(1) : "";
+}
+function pascalCase(str, opts) {
+  return str ? (Array.isArray(str) ? str : splitByCase(str)).map((p) => upperFirst(opts?.normalize ? p.toLowerCase() : p)).join("") : "";
+}
+function camelCase(str, opts) {
+  return lowerFirst(pascalCase(str || "", opts));
+}
+function kebabCase(str, joiner) {
+  return str ? (Array.isArray(str) ? str : splitByCase(str)).map((p) => p.toLowerCase()).join(joiner ?? "-") : "";
+}
+function snakeCase(str) {
+  return kebabCase(str || "", "_");
+}
+function flatCase(str) {
+  return kebabCase(str || "", "");
+}
+function trainCase(str, opts) {
+  return (Array.isArray(str) ? str : splitByCase(str)).filter(Boolean).map((p) => upperFirst(opts?.normalize ? p.toLowerCase() : p)).join("-");
+}
+var titleCaseExceptions = /^(a|an|and|as|at|but|by|for|if|in|is|nor|of|on|or|the|to|with)$/i;
+function titleCase(str, opts) {
+  return (Array.isArray(str) ? str : splitByCase(str)).filter(Boolean).map(
+    (p) => titleCaseExceptions.test(p) ? p.toLowerCase() : upperFirst(opts?.normalize ? p.toLowerCase() : p)
+  ).join(" ");
+}
+
+// src/case.ts
+var capitalize = upperFirst;
+
+// src/misc/raf.ts
+var root = isBrowser() ? window : globalThis;
+var prev = Date.now();
+function mockRAF(fn) {
+  const curr = Date.now();
+  const ms = Math.max(0, 16 - (curr - prev));
+  const id = setTimeout(fn, ms);
+  prev = curr + ms;
+  return id;
+}
+function rAF(fn) {
+  const raf = root.requestAnimationFrame || mockRAF;
+  return raf.call(root, fn);
+}
+function cAF(id) {
+  const caf = root.cancelAnimationFrame || root.clearTimeout;
+  return caf.call(root, id);
+}
+
+// src/misc/time.ts
+var ONE_SECOND = 1e3;
+var ONE_MINUTE = 60 * ONE_SECOND;
+var ONE_HOUR = 60 * ONE_MINUTE;
+var ONE_DAY = 24 * ONE_HOUR;
+var ONE_WEEK = 7 * ONE_DAY;
+function seconds(count) {
+  return count * ONE_SECOND;
+}
+function minutes(count) {
+  return count * ONE_MINUTE;
+}
+function hours(count) {
+  return count * ONE_HOUR;
+}
+function days(count) {
+  return count * ONE_DAY;
+}
+function weeks(count) {
+  return count * ONE_WEEK;
+}
+
+// src/misc/waitFor.ts
+function waitFor(ms) {
+  return new Promise((resolve) => setTimeout(resolve, ms));
+}
+
+// src/misc/warnOnce.ts
+var warned = /* @__PURE__ */ new Set();
+var warnOnce = (message) => {
+  if (warned.has(message)) {
+    return;
+  }
+  warned.add(message);
+  console.warn(message);
+};
+
+// src/array/unique.ts
+function unique(val) {
+  return Array.from(new Set(val));
+}
+
+// src/array/toArray.ts
+function toArray(val) {
+  val = val ?? [];
+  return Array.isArray(val) ? val : [val];
+}
+export {
+  cAF,
+  camelCase,
+  capitalize,
+  days,
+  flatCase,
+  hours,
+  isBrowser,
+  isUppercase,
+  kebabCase,
+  lowerFirst,
+  minutes,
+  pascalCase,
+  rAF,
+  seconds,
+  snakeCase,
+  splitByCase,
+  titleCase,
+  toArray,
+  trainCase,
+  unique,
+  upperFirst,
+  waitFor,
+  warnOnce,
+  weeks
+};

package/package.json

@@ -1,50 +1,75 @@
 {
   "name": "@ntnyq/utils",
-  "version": "0.0.2",
-  "publishConfig": {
-    "access": "public"
-  },
-  "description": "",
-  "keywords": [],
+  "type": "module",
+  "version": "0.1.0",
+  "description": "Common used utils.",
+  "keywords": [
+    "utils"
+  ],
   "license": "MIT",
   "author": {
     "name": "ntnyq",
     "email": "ntnyq13@gmail.com"
   },
-  "homepage": "https://github.com/ntnyq/ntnyq-utils#readme",
-  "repository": {
-    "type": "git",
-    "url": "ntnyq/ntnyq-utils",
-    "directory": "packages/utils"
+  "homepage": "https://github.com/ntnyq/utils#readme",
+  "bugs": {
+    "url": "https://github.com/ntnyq/utils/issues"
   },
+  "repository": "ntnyq/utils",
   "exports": {
+    "./package.json": "./package.json",
     ".": {
-      "types": "./dist/index.d.ts",
-      "require": "./dist/index.cjs",
-      "import": "./dist/index.mjs"
-    },
-    "./*": "./*"
-  },
-  "main": "./dist/index.cjs",
-  "module": "./dist/index.mjs",
-  "types": "./dist/index.d.ts",
-  "typesVersions": {
-    "*": {
-      "*": [
-        "./dist/*",
-        "./dist/index.d.ts"
-      ]
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
     }
   },
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
   "files": [
     "dist"
   ],
   "sideEffects": false,
-  "bugs": {
-    "url": "https://github.com/ntnyq/ntnyq-utils/issues"
+  "dependencies": {
+    "scule": "^1.3.0"
+  },
+  "devDependencies": {
+    "@ntnyq/eslint-config": "^3.0.0-beta.13",
+    "@ntnyq/prettier-config": "^1.21.3",
+    "@vitest/coverage-v8": "^2.1.1",
+    "bumpp": "^9.5.2",
+    "eslint": "^9.10.0",
+    "husky": "^9.1.6",
+    "nano-staged": "^0.8.0",
+    "npm-run-all2": "^6.2.3",
+    "pnpm": "^9.10.0",
+    "prettier": "^3.3.3",
+    "tsup": "^8.3.0",
+    "typescript": "^5.6.2",
+    "vitest": "^2.1.1"
+  },
+  "engines": {
+    "node": ">=18.18.0"
+  },
+  "prettier": "@ntnyq/prettier-config",
+  "nano-staged": {
+    "*.{js,ts,mjs,cjs,json,md,yml,yaml}": "eslint --fix"
   },
   "scripts": {
-    "build": "unbuild",
-    "dev": "unbuild --stub"
+    "build": "tsup",
+    "coverage": "vitest --coverage",
+    "dev": "tsup --watch src",
+    "lint": "eslint .",
+    "release": "run-s release:check release:publish",
+    "release:check": "run-s lint typecheck test",
+    "release:publish": "bumpp && pnpm publish",
+    "test": "vitest",
+    "typecheck": "tsc --noEmit"
   }
 }

package/dist/index.mjs

@@ -1,13 +0,0 @@
-function kekabCase(input) {
-  return input.replace(/([a-z])([A-Z])/g, "$1-$2").replace(/[\s_]+/g, "-").toLowerCase();
-}
-
-function camelCase(input) {
-  return input.replace(/[._-](\w)/g, (_, c) => c ? c.toUpperCase() : "");
-}
-
-function capitalize(input) {
-  return `${input.charAt(0).toUpperCase()}${input.slice(1)}`;
-}
-
-export { camelCase, capitalize, kekabCase };