@anjianshi/utils 1.3.0 → 1.3.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 安坚实
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@anjianshi/utils",
-  "version": "1.3.0",
+  "version": "1.3.2",
   "description": "Common JavaScript Utils",
   "homepage": "https://github.com/anjianshi/js-utils",
   "bugs": {
@@ -32,7 +32,7 @@
     "@anjianshi/presets-eslint-node": "^1.0.3",
     "@anjianshi/presets-eslint-typescript": "^1.0.3",
     "@anjianshi/presets-prettier": "^1.0.0",
-    "@anjianshi/presets-typescript": "^1.0.1",
+    "@anjianshi/presets-typescript": "^1.0.2",
     "@types/debug": "^4.1.9",
     "@types/lodash": "^4.14.199",
     "@types/node": "^20.8.6",

package/src/url.ts

@@ -131,6 +131,40 @@ export function combineUrl(origUrl: string, query: StringifyQuery = {}, hash: st
   return newUrl
 }
 
+/**
+ * 移除路径中所有非必须的 "/"
+ * 清理后的字符串只有这几种可能的格式：''、'abc'、'abc/def'
+ * 例如 /abc/def 和 abc/def/ 都会变成 abc/def
+ *
+ * 注意：此操作不会统一大小写，因此不保证处理后两个字符串在代码层面全等（a === b）
+ */
+export function clearSlash(path: string) {
+  if (path.startsWith('/')) path = path.slice(1)
+  if (path.endsWith('/')) path = path.slice(0, -1)
+  path = path.replace(/\/+/g, '/')
+  return path
+}
+
+/**
+ * 合并几段路径，保证合并处只有一个斜杠
+ */
+export function joinPath(...nodes: string[]) {
+  // - node 为 '' 时忽略 node
+  // - path 可能的格式：'' 'a' 'a/' ‘/a/'
+  //   - path 为 ''，则 node 开头 '/' 保持原样
+  //   - 否则，根据 path 结尾有没有 '/'，决定 node 开头带不带 '/'
+  // - node 开头、结尾若有多个 '/' 均替换成单个
+  return nodes.reduce((path, node) => {
+    if (!node) return path
+    type Matched = RegExpExecArray & { 1: string; 2: string; 3: string }
+    const [, origPrefix, content, origSuffix] = /^(\/*)(.*?)(\/*)$/.exec(node)! as Matched
+    const prefix = (path === '' ? !!origPrefix : !path.endsWith('/')) ? '/' : ''
+    const suffix = origSuffix ? '/' : ''
+    const result = `${path}${prefix}${content}${suffix}`
+    return result
+  }, '')
+}
+
 /**
  * decodeURIComponent() 对于不规范编码的字符串可能会报错（例如字符串里出现了“%”）
  * 用此函数代替可避免此问题

package/url.d.ts

@@ -56,6 +56,18 @@ export declare function splitUrl(url: string, bare?: boolean): {
  * hash    string    带不带开头的 '#' 皆可。会代替 url 已有的 hash。
  */
 export declare function combineUrl(origUrl: string, query?: StringifyQuery, hash?: string): string;
+/**
+ * 移除路径中所有非必须的 "/"
+ * 清理后的字符串只有这几种可能的格式：''、'abc'、'abc/def'
+ * 例如 /abc/def 和 abc/def/ 都会变成 abc/def
+ *
+ * 注意：此操作不会统一大小写，因此不保证处理后两个字符串在代码层面全等（a === b）
+ */
+export declare function clearSlash(path: string): string;
+/**
+ * 合并几段路径，保证合并处只有一个斜杠
+ */
+export declare function joinPath(...nodes: string[]): string;
 /**
  * decodeURIComponent() 对于不规范编码的字符串可能会报错（例如字符串里出现了“%”）
  * 用此函数代替可避免此问题

package/url.js

@@ -95,6 +95,40 @@ export function combineUrl(origUrl, query = {}, hash = '') {
         newUrl += `#${newHash}`;
     return newUrl;
 }
+/**
+ * 移除路径中所有非必须的 "/"
+ * 清理后的字符串只有这几种可能的格式：''、'abc'、'abc/def'
+ * 例如 /abc/def 和 abc/def/ 都会变成 abc/def
+ *
+ * 注意：此操作不会统一大小写，因此不保证处理后两个字符串在代码层面全等（a === b）
+ */
+export function clearSlash(path) {
+    if (path.startsWith('/'))
+        path = path.slice(1);
+    if (path.endsWith('/'))
+        path = path.slice(0, -1);
+    path = path.replace(/\/+/g, '/');
+    return path;
+}
+/**
+ * 合并几段路径，保证合并处只有一个斜杠
+ */
+export function joinPath(...nodes) {
+    // - node 为 '' 时忽略 node
+    // - path 可能的格式：'' 'a' 'a/' ‘/a/'
+    //   - path 为 ''，则 node 开头 '/' 保持原样
+    //   - 否则，根据 path 结尾有没有 '/'，决定 node 开头带不带 '/'
+    // - node 开头、结尾若有多个 '/' 均替换成单个
+    return nodes.reduce((path, node) => {
+        if (!node)
+            return path;
+        const [, origPrefix, content, origSuffix] = /^(\/*)(.*?)(\/*)$/.exec(node);
+        const prefix = (path === '' ? !!origPrefix : !path.endsWith('/')) ? '/' : '';
+        const suffix = origSuffix ? '/' : '';
+        const result = `${path}${prefix}${content}${suffix}`;
+        return result;
+    }, '');
+}
 /**
  * decodeURIComponent() 对于不规范编码的字符串可能会报错（例如字符串里出现了“%”）
  * 用此函数代替可避免此问题

package/validators/array.d.ts

@@ -16,5 +16,5 @@ export type TupleOptions = {
     tuple: Validator[];
 };
 export declare class ArrayValidator extends Validator<ArrayOptions | TupleOptions> {
-    validate(field: string, value: unknown): import("../lang/may-success.js").Failed<void> | import("../lang/may-success.js").Success<unknown>;
+    validate(field: string, value: unknown): import("@/lang/may-success.js").Failed<void> | import("@/lang/may-success.js").Success<unknown>;
 }

package/validators/boolean.d.ts

@@ -1,4 +1,4 @@
 import { Validator } from './base.js';
 export declare class BooleanValidator extends Validator {
-    validate(field: string, value: unknown): import("../lang/may-success.js").Failed<void> | import("../lang/may-success.js").Success<unknown>;
+    validate(field: string, value: unknown): import("@/lang/may-success.js").Failed<void> | import("@/lang/may-success.js").Success<unknown>;
 }

package/validators/number.d.ts

@@ -11,5 +11,5 @@ export interface NumberOptions {
 }
 export declare class NumberValidator extends Validator<NumberOptions> {
     constructor(options?: Partial<BaseOptions & NumberOptions>);
-    validate(field: string, value: unknown): import("../lang/may-success.js").Failed<void> | import("../lang/may-success.js").Success<unknown>;
+    validate(field: string, value: unknown): import("@/lang/may-success.js").Failed<void> | import("@/lang/may-success.js").Success<unknown>;
 }

package/validators/object.d.ts

@@ -16,5 +16,5 @@ export type RecordOptions = {
     max?: number;
 };
 export declare class ObjectValidator extends Validator<StructOptions | RecordOptions> {
-    validate(field: string, value: unknown): import("../lang/may-success.js").Failed<void> | import("../lang/may-success.js").Success<unknown>;
+    validate(field: string, value: unknown): import("@/lang/may-success.js").Failed<void> | import("@/lang/may-success.js").Success<unknown>;
 }

package/validators/string.d.ts

@@ -13,5 +13,5 @@ export interface StringOptions {
 }
 export declare class StringValidator extends Validator<StringOptions> {
     constructor(options?: Partial<BaseOptions & StringOptions>);
-    validate(field: string, value: unknown): import("../lang/may-success.js").Failed<void> | import("../lang/may-success.js").Success<unknown>;
+    validate(field: string, value: unknown): import("@/lang/may-success.js").Failed<void> | import("@/lang/may-success.js").Success<unknown>;
 }