@ceale/util 1.4.0 → 1.6.0

package/README.md

@@ -1,9 +1,3 @@
 # @ceale/util
 
-To install dependencies:
-
-```bash
-npm install
-# or
-bun install
-```
+小工具集

package/dist/cjs/index.js

@@ -29,40 +29,174 @@ var __export = (target, all) => {
 // src/index.ts
 var exports_src = {};
 __export(exports_src, {
-  UrlUtil: () => UrlUtil,
-  StringUtil: () => StringUtil
+  uri: () => uri,
+  css: () => css
 });
 module.exports = __toCommonJS(exports_src);
 
 // src/string.ts
-var StringUtil = (str) => ({
-  string: str,
-  toString: () => str,
-  valueOf: () => str,
-  removeStart: (searchString) => str.startsWith(searchString) ? str.slice(searchString.length) : str,
-  removeEnd: (searchString) => str.endsWith(searchString) ? str.slice(0, -searchString.length) : str,
-  removeStartAll(searchString) {
-    while (str.startsWith(searchString)) {
-      str = str.slice(searchString.length);
+Object.defineProperty(String.prototype, "removePrefix", {
+  value: function(prefix) {
+    return this.startsWith(prefix) ? this.slice(prefix.length) : this;
+  },
+  writable: true,
+  configurable: true,
+  enumerable: false
+});
+Object.defineProperty(String.prototype, "removeSuffix", {
+  value: function(suffix) {
+    return this.endsWith(suffix) ? this.slice(0, -suffix.length) : this;
+  },
+  writable: true,
+  configurable: true,
+  enumerable: false
+});
+Object.defineProperty(String.prototype, "removeAllPrefixes", {
+  value: function(prefix) {
+    if (prefix.length === 0)
+      return this;
+    let str = this;
+    while (str.startsWith(prefix)) {
+      str = str.slice(prefix.length);
     }
     return str;
   },
-  removeEndAll(searchString) {
-    while (str.endsWith(searchString)) {
-      str = str.slice(0, -searchString.length);
+  writable: true,
+  configurable: true,
+  enumerable: false
+});
+Object.defineProperty(String.prototype, "removeAllSuffixes", {
+  value: function(suffix) {
+    if (suffix.length === 0)
+      return this;
+    let str = this;
+    while (str.endsWith(suffix)) {
+      str = str.slice(0, -suffix.length);
     }
     return str;
-  }
+  },
+  writable: true,
+  configurable: true,
+  enumerable: false
+});
+Object.defineProperty(String.prototype, "toCamelCase", {
+  value: function() {
+    return this.replace(/-([a-z])/g, (_, letter) => letter.toUpperCase());
+  },
+  writable: true,
+  configurable: true,
+  enumerable: false
 });
-// src/url.ts
-var UrlUtil;
-((UrlUtil) => {
-  UrlUtil.join = (...path) => {
-    return path.filter((p) => p !== "").map((p, index) => {
+Object.defineProperty(String.prototype, "toKebabCase", {
+  value: function() {
+    return this.replace(/([a-z0-9])([A-Z])/g, "$1-$2").toLowerCase();
+  },
+  writable: true,
+  configurable: true,
+  enumerable: false
+});
+// src/uri.ts
+var uri;
+((uri) => {
+  const leftSlash = /^\/(?=[^\/])/g;
+  const rightSlash = /(?<=[^\/])\/$/g;
+  const innerSlash = /(?<=[^\/])\/(?=[^\/])/g;
+  uri.join = (...path) => {
+    return path.filter((path2) => path2.length > 0).map((path2, index, pathArray) => {
       if (index === 0) {
-        return StringUtil(p).removeEnd("/");
+        return path2.replace(rightSlash, "").split(innerSlash);
+      } else if (index === pathArray.length - 1) {
+        return path2.replace(leftSlash, "").split(innerSlash);
+      } else {
+        return path2.replace(leftSlash, "").replace(rightSlash, "").split(innerSlash);
+      }
+    }).flat().reduce((stack, path2) => {
+      if (path2 === "." || path2 === "/." || path2 === "./") {
+        return stack;
+      } else if (path2 === ".." || path2 === "/.." || path2 === "../") {
+        stack.pop();
+        return stack;
+      } else {
+        stack.push(path2);
+        return stack;
+      }
+    }, []).reduce((path2, segment) => {
+      if (path2.length === 0) {
+        return path2 + segment;
+      } else if (path2.endsWith("/") || segment.startsWith("/")) {
+        return path2 + segment;
+      } else {
+        return path2 + "/" + segment;
       }
-      return "/" + StringUtil(p).removeStart("/");
-    }).join("");
+    }, "");
+  };
+})(uri ||= {});
+// src/class.ts
+Object.defineProperty(Function.prototype, "isDirectSubclass", {
+  value: function(potentialChild) {
+    if (typeof potentialChild !== "function" || typeof this !== "function") {
+      return false;
+    }
+    return Object.getPrototypeOf(potentialChild) === this;
+  },
+  writable: true,
+  configurable: true,
+  enumerable: false
+});
+Object.defineProperty(Function.prototype, "isSubclass", {
+  value: function(potentialDescendant) {
+    if (typeof potentialDescendant !== "function" || typeof this !== "function") {
+      return false;
+    }
+    let current = potentialDescendant;
+    while (typeof current === "function") {
+      if (current === this) {
+        return true;
+      }
+      current = Object.getPrototypeOf(current);
+      if (current === Function.prototype)
+        break;
+    }
+    return false;
+  },
+  writable: true,
+  configurable: true,
+  enumerable: false
+});
+Object.defineProperty(Function.prototype, "isDirectInstance", {
+  value: function(potentialInstance) {
+    if (typeof this !== "function" || potentialInstance === null || typeof potentialInstance !== "object") {
+      return false;
+    }
+    return Object.getPrototypeOf(potentialInstance).constructor === this;
+  },
+  writable: true,
+  configurable: true,
+  enumerable: false
+});
+Object.defineProperty(Function.prototype, "isInstance", {
+  value: function(potentialInstance) {
+    return typeof this === "function" && potentialInstance instanceof this;
+  },
+  writable: true,
+  configurable: true,
+  enumerable: false
+});
+// src/css.ts
+var css;
+((css) => {
+  css.rule = (rule2) => {
+    return Object.entries(rule2).map(([key, value]) => `${key.toKebabCase()}: ${value};`).join(`
+`);
+  };
+  css.selector = (selector2, rule2) => {
+    return selector2 + "{" + rule2 + "}";
+  };
+  css.at = (identifier, rule2) => {
+    return identifier + (rule2 ? "{" + rule2 + "}" : "");
+  };
+  css.join = (...rules) => {
+    return rules.join(`
+`);
   };
-})(UrlUtil ||= {});
+})(css ||= {});

package/dist/esm/index.js

@@ -1,36 +1,170 @@
 // src/string.ts
-var StringUtil = (str) => ({
-  string: str,
-  toString: () => str,
-  valueOf: () => str,
-  removeStart: (searchString) => str.startsWith(searchString) ? str.slice(searchString.length) : str,
-  removeEnd: (searchString) => str.endsWith(searchString) ? str.slice(0, -searchString.length) : str,
-  removeStartAll(searchString) {
-    while (str.startsWith(searchString)) {
-      str = str.slice(searchString.length);
+Object.defineProperty(String.prototype, "removePrefix", {
+  value: function(prefix) {
+    return this.startsWith(prefix) ? this.slice(prefix.length) : this;
+  },
+  writable: true,
+  configurable: true,
+  enumerable: false
+});
+Object.defineProperty(String.prototype, "removeSuffix", {
+  value: function(suffix) {
+    return this.endsWith(suffix) ? this.slice(0, -suffix.length) : this;
+  },
+  writable: true,
+  configurable: true,
+  enumerable: false
+});
+Object.defineProperty(String.prototype, "removeAllPrefixes", {
+  value: function(prefix) {
+    if (prefix.length === 0)
+      return this;
+    let str = this;
+    while (str.startsWith(prefix)) {
+      str = str.slice(prefix.length);
     }
     return str;
   },
-  removeEndAll(searchString) {
-    while (str.endsWith(searchString)) {
-      str = str.slice(0, -searchString.length);
+  writable: true,
+  configurable: true,
+  enumerable: false
+});
+Object.defineProperty(String.prototype, "removeAllSuffixes", {
+  value: function(suffix) {
+    if (suffix.length === 0)
+      return this;
+    let str = this;
+    while (str.endsWith(suffix)) {
+      str = str.slice(0, -suffix.length);
     }
     return str;
-  }
+  },
+  writable: true,
+  configurable: true,
+  enumerable: false
+});
+Object.defineProperty(String.prototype, "toCamelCase", {
+  value: function() {
+    return this.replace(/-([a-z])/g, (_, letter) => letter.toUpperCase());
+  },
+  writable: true,
+  configurable: true,
+  enumerable: false
 });
-// src/url.ts
-var UrlUtil;
-((UrlUtil) => {
-  UrlUtil.join = (...path) => {
-    return path.filter((p) => p !== "").map((p, index) => {
+Object.defineProperty(String.prototype, "toKebabCase", {
+  value: function() {
+    return this.replace(/([a-z0-9])([A-Z])/g, "$1-$2").toLowerCase();
+  },
+  writable: true,
+  configurable: true,
+  enumerable: false
+});
+// src/uri.ts
+var uri;
+((uri) => {
+  const leftSlash = /^\/(?=[^\/])/g;
+  const rightSlash = /(?<=[^\/])\/$/g;
+  const innerSlash = /(?<=[^\/])\/(?=[^\/])/g;
+  uri.join = (...path) => {
+    return path.filter((path2) => path2.length > 0).map((path2, index, pathArray) => {
       if (index === 0) {
-        return StringUtil(p).removeEnd("/");
+        return path2.replace(rightSlash, "").split(innerSlash);
+      } else if (index === pathArray.length - 1) {
+        return path2.replace(leftSlash, "").split(innerSlash);
+      } else {
+        return path2.replace(leftSlash, "").replace(rightSlash, "").split(innerSlash);
+      }
+    }).flat().reduce((stack, path2) => {
+      if (path2 === "." || path2 === "/." || path2 === "./") {
+        return stack;
+      } else if (path2 === ".." || path2 === "/.." || path2 === "../") {
+        stack.pop();
+        return stack;
+      } else {
+        stack.push(path2);
+        return stack;
+      }
+    }, []).reduce((path2, segment) => {
+      if (path2.length === 0) {
+        return path2 + segment;
+      } else if (path2.endsWith("/") || segment.startsWith("/")) {
+        return path2 + segment;
+      } else {
+        return path2 + "/" + segment;
       }
-      return "/" + StringUtil(p).removeStart("/");
-    }).join("");
+    }, "");
+  };
+})(uri ||= {});
+// src/class.ts
+Object.defineProperty(Function.prototype, "isDirectSubclass", {
+  value: function(potentialChild) {
+    if (typeof potentialChild !== "function" || typeof this !== "function") {
+      return false;
+    }
+    return Object.getPrototypeOf(potentialChild) === this;
+  },
+  writable: true,
+  configurable: true,
+  enumerable: false
+});
+Object.defineProperty(Function.prototype, "isSubclass", {
+  value: function(potentialDescendant) {
+    if (typeof potentialDescendant !== "function" || typeof this !== "function") {
+      return false;
+    }
+    let current = potentialDescendant;
+    while (typeof current === "function") {
+      if (current === this) {
+        return true;
+      }
+      current = Object.getPrototypeOf(current);
+      if (current === Function.prototype)
+        break;
+    }
+    return false;
+  },
+  writable: true,
+  configurable: true,
+  enumerable: false
+});
+Object.defineProperty(Function.prototype, "isDirectInstance", {
+  value: function(potentialInstance) {
+    if (typeof this !== "function" || potentialInstance === null || typeof potentialInstance !== "object") {
+      return false;
+    }
+    return Object.getPrototypeOf(potentialInstance).constructor === this;
+  },
+  writable: true,
+  configurable: true,
+  enumerable: false
+});
+Object.defineProperty(Function.prototype, "isInstance", {
+  value: function(potentialInstance) {
+    return typeof this === "function" && potentialInstance instanceof this;
+  },
+  writable: true,
+  configurable: true,
+  enumerable: false
+});
+// src/css.ts
+var css;
+((css) => {
+  css.rule = (rule2) => {
+    return Object.entries(rule2).map(([key, value]) => `${key.toKebabCase()}: ${value};`).join(`
+`);
+  };
+  css.selector = (selector2, rule2) => {
+    return selector2 + "{" + rule2 + "}";
+  };
+  css.at = (identifier, rule2) => {
+    return identifier + (rule2 ? "{" + rule2 + "}" : "");
+  };
+  css.join = (...rules) => {
+    return rules.join(`
+`);
   };
-})(UrlUtil ||= {});
+})(css ||= {});
 export {
-  UrlUtil,
-  StringUtil
+  uri,
+  css
 };

package/dist/types/class.d.ts

@@ -0,0 +1,32 @@
+type AnyClass = new (...args: any[]) => any;
+declare global {
+    interface Function {
+        /**
+         * 检查 `potentialChild` 是否是当前类的直接子类
+         * @param potentialChild 潜在的子类构造函数
+         * @returns 如果是直接子类，则返回 `true`；否则返回 `false`
+         */
+        isDirectSubclass(this: AnyClass, potentialChild: unknown): boolean;
+        /**
+         * 检查 `potentialDescendant` 是否是当前类的子孙类或当前类本身
+         * @param potentialDescendant 潜在的子孙类或类本身
+         * @returns 如果是子孙类或类本身，则返回 `true`；否则返回 `false`
+         */
+        isSubclass(this: AnyClass, potentialDescendant: unknown): boolean;
+        /**
+         * 检查 `potentialInstance` 是否由当前类直接构造
+         * 判断依据: `Object.getPrototypeOf(potentialInstance).constructor === this`
+         * @param potentialInstance 潜在的实例对象
+         * @returns 如果是由当前类直接创建的实例，则返回 `true`；否则返回 `false`
+         */
+        isDirectInstance(this: AnyClass, potentialInstance: unknown): boolean;
+        /**
+         * 检查 `potentialInstance` 是否是当前类或其任何子类的实例
+         * 内部使用 `instanceof` 操作符
+         * @param potentialInstance 潜在的实例对象
+         * @returns 如果是实例，则返回 `true`；否则返回 `false`
+         */
+        isInstance(this: AnyClass, potentialInstance: unknown): boolean;
+    }
+}
+export {};

package/dist/types/css.d.ts

@@ -0,0 +1,77 @@
+import type { CSSProperties } from "vue";
+import type { AtRules } from "csstype";
+export declare namespace css {
+    const RuleValueSymbol: unique symbol;
+    type RuleValue = string & {
+        [RuleValueSymbol]: never;
+    };
+    const RuleBlockValueSymbol: unique symbol;
+    type RuleBlockValue = string & {
+        [RuleBlockValueSymbol]: never;
+    };
+    const AtValueSymbol: unique symbol;
+    type AtValue = string & {
+        [AtValueSymbol]: never;
+    };
+    /**
+     * 从一个样式对象，创建一个 CSS 规则字符串
+     * @param styles 一个样式对象，使用 Vue 的 `CSSProperties` 类型，同时允许自定义属性
+     * @returns 返回类型为`RuleValue`的字符串，可以传入`css.selector()`和`css.at()`
+     *
+     * @example
+     * css.rule({
+     *     backgroundColor: "red",
+     *     fontSize: "16px",
+     *     "--my-custom-var": "blue"
+     * })
+     */
+    export const rule: (rule: CSSProperties & {
+        [key: string]: string;
+    }) => RuleValue;
+    /**
+     * 根据选择器和 CSS 规则，创建一个 CSS 规则块字符串
+     * @param selector CSS 选择器字符串
+     * @param rule CSS 规则，类型为`RuleValue`的字符串
+     * @returns 返回类型为`RuleBlockValue`的字符串，可以传入`css.at()`和`css.join()`
+     *
+     * @example
+     * css.selector(
+     *     "#my-element",
+     *     css.rule({
+     *         color: "blue"
+     *     })
+     * ) // -> "#my-element { color: blue; }"
+     */
+    export const selector: (selector: string, rule: RuleValue) => RuleBlockValue;
+    /**
+     * 根据 @ 规则和可选的 CSS 规则或规则块，创建一个  @ 规则块字符串
+     * @param identifier @ 规则，如 "@media (min-width: 768px)"
+     * @param rule 可选，类型为`RuleValue`的字符串，或类型为`SelectorValue`的字符串
+     * @returns 返回类型为`AtValue`的字符串，可以传入`css.join()`
+     *
+     * @example
+     * css.at(
+     *     "@font-face",
+     *     css.rule({
+     *         scr: "..."
+     *     })
+     * ) // -> "@font-face { scr: "..."; }"
+     *
+     * @example
+     * css.at(
+     *     "@media (min-width: 768px)",
+     *     css.selector(
+     *         "#my-element",
+     *         css.rule(...)
+     *     )
+     * ) // -> "@media (min-width: 768px) { #my-element { ... } }"
+     */
+    export const at: (identifier: AtRules | (string & {}), rule?: RuleValue | RuleBlockValue) => AtValue;
+    /**
+     * 拼接 CSS 规则块和 @ 规则块，返回一个字符串
+     * @param rules CSS 规则块和 @ 规则块，类型为`RuleBlockValue`或`AtValue`的字符串
+     * @returns 返回标准的字符串
+     */
+    export const join: (...rules: (RuleBlockValue | AtValue)[]) => string;
+    export {};
+}

package/dist/types/index.d.ts

@@ -1,2 +1,4 @@
 export * from "./string";
-export * from "./url";
+export * from "./uri";
+export * from "./class";
+export * from "./css";

package/dist/types/string.d.ts

@@ -1,9 +1,39 @@
-export declare const StringUtil: (str: string) => {
-    string: string;
-    toString: () => string;
-    valueOf: () => string;
-    removeStart: (searchString: string) => string;
-    removeEnd: (searchString: string) => string;
-    removeStartAll(searchString: string): string;
-    removeEndAll(searchString: string): string;
-};
+declare global {
+    interface String {
+        /**
+         * 移除字符串的前缀`prefix`，如果不以`prefix`开头，则返回原字符串
+         * @param prefix 指定字符串
+         * @returns 移除后的字符串
+         */
+        removePrefix(prefix: string): string;
+        /**
+         * 移除字符串的后缀`suffix`，如果不以`suffix`结尾，则返回原字符串
+         * @param suffix 待匹配的串
+         * @returns 移除后的字符串
+         */
+        removeSuffix(suffix: string): string;
+        /**
+         * 移除字符串连续出现的若干个前缀`prefix`，如果不以`prefix`开头，则返回原字符串
+         * @param prefix 待匹配的串
+         * @returns 移除后的字符串
+         */
+        removeAllPrefixes(prefix: string): string;
+        /**
+         * 移除字符串连续出现的若干个后缀`suffix`，如果不以`suffix`结尾，则返回原字符串
+         * @param suffix 待匹配的串
+         * @returns 移除后的字符串
+         */
+        removeAllSuffixes(suffix: string): string;
+        /**
+         * 将字符串转为驼峰命名
+         * @returns 驼峰命名的字符串
+         */
+        toCamelCase(): string;
+        /**
+         * 将字符串转为连字符命名
+         * @returns 连字符命名的字符串
+         */
+        toKebabCase(): string;
+    }
+}
+export {};

package/dist/types/uri.d.ts

@@ -0,0 +1,24 @@
+export declare namespace uri {
+    /**
+     * 拼接路径字符串：
+     * - 解析路径中的 `.` 和 `..`
+     * - 保留 URL 协议头 (如 `http://`) 和协议自适应的开头 (如 `//domain`)
+     * - 保留主动传入的连续斜杠 (如 `a//b`)
+     *
+     * @param path 若干个要拼接的路径片段
+     * @returns 拼接后的路径字符串
+     *
+     * @example
+     * // 基础拼接
+     * uri.join('/a/', 'b', '/c') // -> "/a/b/c"
+     *
+     * @example
+     * // 路径解析
+     * uri.join('/a/b/../c') // -> "/a/c"
+     *
+     * @example
+     * // 保留协议头
+     * uri.join("http://example.com", "a") // -> "http://example.com/a"
+     */
+    const join: (...path: string[]) => string;
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ceale/util",
   "author": "Ceale",
-  "version": "1.4.0",
+  "version": "1.6.0",
   "module": "index.ts",
   "type": "module",
   "main": "dist/esm/index.js",
@@ -14,7 +14,7 @@
     "build": "bun run build:esm && bun run build:cjs && bun run build:ts",
     "build:esm": "bun build --outdir=dist/esm/ --format=esm --target=node src/index.ts",
     "build:cjs": "bun build --outdir=dist/cjs/ --format=cjs --target=node src/index.ts",
-    "build:ts": "tsc --outDir dist/ts/"
+    "build:ts": "tsc --project tsconfig.build.json"
   },
   "exports": {
     ".": {
@@ -29,5 +29,9 @@
   },
   "peerDependencies": {
     "typescript": "^5"
+  },
+  "dependencies": {
+    "@types/vue": "^2.0.0",
+    "csstype": "^3.1.3"
   }
 }

package/dist/types/url.d.ts

@@ -1,3 +0,0 @@
-export declare namespace UrlUtil {
-    const join: (...path: string[]) => string;
-}