@anjianshi/utils 2.2.7 → 2.3.0

package/env-node/fs.d.ts

@@ -0,0 +1,19 @@
+/**
+ * 确认一个路径是否存在且是文件
+ */
+export declare function isFileExists(filepath: string): Promise<boolean>;
+/**
+ * 确认一个路径是否存在且是文件夹
+ */
+export declare function isDirectoryExists(dirpath: string): Promise<boolean>;
+/**
+ * 返回当前文件的绝对路径
+ * 需要传入当前文件的 ImportMeta 对象（可通过 import.meta 取得）
+ */
+export declare function getFilePath(fileUrl: string | ImportMeta): string;
+/**
+ * 返回文件所处目录的绝对路径
+ */
+export declare function getDirectoryPath(fileUrl: string | ImportMeta): string;
+/** 确保目录存在，如果不存在就创建（会递归创建上级目录） */
+export declare function mkdirp(dirpath: string, mode?: number | string): Promise<void>;

package/env-node/fs.js

@@ -0,0 +1,48 @@
+import * as fs from 'node:fs';
+import * as path from 'node:path';
+import { fileURLToPath } from 'node:url';
+/**
+ * 确认一个路径是否存在且是文件
+ */
+export async function isFileExists(filepath) {
+    try {
+        const res = await fs.promises.stat(filepath);
+        return res.isFile();
+    }
+    catch (e) {
+        return false;
+    }
+}
+/**
+ * 确认一个路径是否存在且是文件夹
+ */
+export async function isDirectoryExists(dirpath) {
+    try {
+        const res = await fs.promises.stat(dirpath);
+        return res.isDirectory();
+    }
+    catch (e) {
+        return false;
+    }
+}
+/**
+ * 返回当前文件的绝对路径
+ * 需要传入当前文件的 ImportMeta 对象（可通过 import.meta 取得）
+ */
+export function getFilePath(fileUrl) {
+    if (typeof fileUrl !== 'string')
+        fileUrl = fileUrl.url;
+    return fileURLToPath(new URL(fileUrl));
+}
+/**
+ * 返回文件所处目录的绝对路径
+ */
+export function getDirectoryPath(fileUrl) {
+    return path.dirname(getFilePath(fileUrl));
+}
+/** 确保目录存在，如果不存在就创建（会递归创建上级目录） */
+export async function mkdirp(dirpath, mode) {
+    if (!(await isDirectoryExists(dirpath))) {
+        await fs.promises.mkdir(dirpath, { recursive: true, mode });
+    }
+}

package/env-node/index.d.ts

@@ -1,17 +1,5 @@
 /**
- * 确认一个路径是否存在且是文件
+ * Node 环境下的工具函数
  */
-export declare function isFileExists(filepath: string): Promise<boolean>;
-/**
- * 确认一个路径是否存在且是文件夹
- */
-export declare function isDirectoryExists(dirpath: string): Promise<boolean>;
-/**
- * 返回当前文件的绝对路径
- * 需要传入当前文件的 ImportMeta 对象（可通过 import.meta 取得）
- */
-export declare function getFilePath(fileUrl: string | ImportMeta): string;
-/**
- * 返回文件所处目录的绝对路径
- */
-export declare function getFileDir(fileUrl: string | ImportMeta): string;
+export * from './fs.js';
+export * from './random.js';

package/env-node/index.js

@@ -1,45 +1,5 @@
 /**
  * Node 环境下的工具函数
  */
-import * as fs from 'node:fs';
-import * as path from 'node:path';
-import { fileURLToPath } from 'node:url';
-/**
- * 确认一个路径是否存在且是文件
- */
-export async function isFileExists(filepath) {
-    try {
-        const res = await fs.promises.stat(filepath);
-        return res.isFile();
-    }
-    catch (e) {
-        return false;
-    }
-}
-/**
- * 确认一个路径是否存在且是文件夹
- */
-export async function isDirectoryExists(dirpath) {
-    try {
-        const res = await fs.promises.stat(dirpath);
-        return res.isDirectory();
-    }
-    catch (e) {
-        return false;
-    }
-}
-/**
- * 返回当前文件的绝对路径
- * 需要传入当前文件的 ImportMeta 对象（可通过 import.meta 取得）
- */
-export function getFilePath(fileUrl) {
-    if (typeof fileUrl !== 'string')
-        fileUrl = fileUrl.url;
-    return fileURLToPath(new URL(fileUrl));
-}
-/**
- * 返回文件所处目录的绝对路径
- */
-export function getFileDir(fileUrl) {
-    return path.dirname(getFilePath(fileUrl));
-}
+export * from './fs.js';
+export * from './random.js';

package/env-node/random.d.ts

@@ -0,0 +1,12 @@
+/**
+ * 返回随机数，包含 min 和 max
+ */
+export declare function getRandomInt(min: number, max: number): number;
+/**
+ * 返回随机字符串
+ */
+export declare function getRandomString(length?: number, seed?: string): string;
+/**
+ * 从给定的选择中随机选中一项
+ */
+export declare function choiceRandom<T>(choices: T[]): NonNullable<T>;

package/env-node/random.js

@@ -0,0 +1,25 @@
+/**
+ * 类似 lang/random.ts，但基于 Node.js 的 crypto 模块，提供密码级的随机数。
+ */
+import crypto from 'node:crypto';
+/**
+ * 返回随机数，包含 min 和 max
+ */
+export function getRandomInt(min, max) {
+    return crypto.randomInt(min, max + 1);
+}
+/**
+ * 返回随机字符串
+ */
+export function getRandomString(length = 6, seed = '0123456789abcdefghijklmnopqrstuvwxyz') {
+    let result = '';
+    while (result.length < length)
+        result += seed[getRandomInt(0, seed.length - 1)];
+    return result;
+}
+/**
+ * 从给定的选择中随机选中一项
+ */
+export function choiceRandom(choices) {
+    return choices[getRandomInt(0, choices.length - 1)];
+}

package/env-react/emotion.d.ts

@@ -0,0 +1,18 @@
+/**
+ * 通过 React Hook 把 emotion css 转换成 className
+ * （不再需要 <ClassName>）
+ *
+ * 使用前提：
+ * 1. 只支持浏览器渲染
+ * 2. 用 EmotionCacheProvider 包裹 App 根元素
+ *
+ * 来自：
+ * https://github.com/emotion-js/emotion/issues/1853#issuecomment-623349622
+ */
+import { type EmotionCache } from '@emotion/react';
+import { type CSSInterpolation } from '@emotion/serialize';
+export declare const useEmotionCache: () => EmotionCache | undefined;
+export declare const EmotionCacheProvider: import("react").FC<{
+    children: React.ReactNode;
+} & import("react").ClassAttributes<any>>;
+export declare function useEmotionClassName(): (...args: CSSInterpolation[]) => string;

package/env-react/emotion.jsx

@@ -0,0 +1,34 @@
+/**
+ * 通过 React Hook 把 emotion css 转换成 className
+ * （不再需要 <ClassName>）
+ *
+ * 使用前提：
+ * 1. 只支持浏览器渲染
+ * 2. 用 EmotionCacheProvider 包裹 App 根元素
+ *
+ * 来自：
+ * https://github.com/emotion-js/emotion/issues/1853#issuecomment-623349622
+ */
+import { withEmotionCache } from '@emotion/react';
+import { serializeStyles } from '@emotion/serialize';
+import { insertStyles } from '@emotion/utils';
+import { createContext, useContext, useCallback } from 'react';
+const CacheContext = createContext(undefined);
+export const useEmotionCache = () => useContext(CacheContext);
+export const EmotionCacheProvider = withEmotionCache(({ children }, cache) => {
+    return <CacheContext.Provider value={cache}>{children}</CacheContext.Provider>;
+});
+export function useEmotionClassName() {
+    const cache = useEmotionCache();
+    return useCallback((...args) => {
+        if (!cache) {
+            if (process.env.NODE_ENV === 'production') {
+                return 'emotion-cache-missing';
+            }
+            throw new Error('No emotion cache found!');
+        }
+        const serialized = serializeStyles(args, cache.registered);
+        insertStyles(cache, serialized, false);
+        return cache.key + '-' + serialized.name;
+    }, [cache]);
+}

package/lang/index.d.ts

@@ -4,3 +4,4 @@ export * from './string.js';
 export * from './object.js';
 export * from './time.js';
 export * from './async.js';
+export * from './random.js';

package/lang/index.js

@@ -4,3 +4,4 @@ export * from './string.js';
 export * from './object.js';
 export * from './time.js';
 export * from './async.js';
+export * from './random.js';

package/lang/random.d.ts

@@ -0,0 +1,12 @@
+/**
+ * 返回随机数，包含 min 和 max
+ */
+export declare function getRandomInt(min: number, max: number): number;
+/**
+ * 返回随机字符串
+ */
+export declare function getRandomString(length?: number, seed?: string): string;
+/**
+ * 从给定的选择中随机选中一项
+ */
+export declare function choiceRandom<T>(choices: T[]): NonNullable<T>;

package/lang/random.js

@@ -0,0 +1,23 @@
+/**
+ * 返回随机数，包含 min 和 max
+ */
+export function getRandomInt(min, max) {
+    const minCeiled = Math.ceil(min);
+    const maxFloored = Math.floor(max);
+    return Math.floor(Math.random() * (maxFloored - minCeiled + 1) + minCeiled);
+}
+/**
+ * 返回随机字符串
+ */
+export function getRandomString(length = 6, seed = '0123456789abcdefghijklmnopqrstuvwxyz') {
+    let result = '';
+    while (result.length < length)
+        result += seed[getRandomInt(0, seed.length - 1)];
+    return result;
+}
+/**
+ * 从给定的选择中随机选中一项
+ */
+export function choiceRandom(choices) {
+    return choices[getRandomInt(0, choices.length - 1)];
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@anjianshi/utils",
-  "version": "2.2.7",
+  "version": "2.3.0",
   "description": "Common JavaScript Utils",
   "homepage": "https://github.com/anjianshi/js-packages/utils",
   "bugs": {
@@ -21,19 +21,25 @@
   },
   "devDependencies": {
     "@types/lodash": "^4.17.7",
-    "@types/node": "^20.15.0",
+    "@types/node": "^20.16.2",
+    "@types/react": "^18.3.5",
     "dotenv": "^16.4.5",
     "typeorm": "^0.3.20",
     "typescript": "^5.5.4",
     "vconsole": "^3.15.1",
     "@anjianshi/presets-eslint-node": "4.0.8",
-    "@anjianshi/presets-eslint-typescript": "5.0.5",
     "@anjianshi/presets-typescript": "3.2.2",
-    "@anjianshi/presets-prettier": "3.0.1"
+    "@anjianshi/presets-eslint-typescript": "5.0.5",
+    "@anjianshi/presets-prettier": "3.0.1",
+    "@anjianshi/presets-eslint-react": "4.0.7"
   },
   "peerDependencies": {
+    "@emotion/react": "^11.13.3",
+    "@emotion/serialize": "^1.3.1",
+    "@emotion/utils": "^1.4.0",
     "chalk": "^5.3.0",
-    "dayjs": "^1.11.10"
+    "dayjs": "^1.11.10",
+    "react": "^18.3.1"
   },
   "peerDependenciesMeta": {
     "chalk": {
@@ -41,6 +47,18 @@
     },
     "dayjs": {
       "optional": true
+    },
+    "@emotion/react": {
+      "optional": true
+    },
+    "@emotion/serialize": {
+      "optional": true
+    },
+    "@emotion/utils": {
+      "optional": true
+    },
+    "react": {
+      "optional": true
     }
   },
   "eslintIgnore": [],

package/url.d.ts

@@ -32,10 +32,8 @@ export { parseQuery };
  * - 数组会多次赋值：{ a: [1,2,3] } => 'a=1&a=2&a=3'，不支持嵌套数组
  * - encode 为 true 时会对 value 执行 encodeURIComponent（默认为 true）
  */
-type StringifyVal = string | number | boolean;
-type StringifyQuery = {
-    [key: string]: StringifyVal | StringifyVal[] | undefined;
-};
+export type StringifyVal = string | number | boolean;
+export type StringifyQuery = Record<string, StringifyVal | StringifyVal[] | undefined>;
 export declare function stringifyQuery(obj: StringifyQuery, encode?: boolean): string;
 /**
  * 拆分 URL 的各个部分