@ntnyq/utils 0.6.0 → 0.6.2

package/dist/index.cjs

@@ -22,6 +22,9 @@ var index_exports = {};
 __export(index_exports, {
   Color: () => Color,
   NOOP: () => NOOP,
+  RE_BLOCK_COMMENT: () => RE_BLOCK_COMMENT,
+  RE_COMMENTS: () => RE_COMMENTS,
+  RE_LINE_COMMENT: () => RE_LINE_COMMENT,
   at: () => at,
   cAF: () => cAF,
   chunk: () => chunk,
@@ -33,7 +36,7 @@ __export(index_exports, {
   enhance: () => enhance,
   ensurePrefix: () => ensurePrefix,
   ensureSuffix: () => ensureSuffix,
-  escapeHtml: () => escapeHtml,
+  escapeHTML: () => escapeHTML,
   flattenArrayable: () => flattenArrayable,
   getObjectType: () => getObjectType,
   hasOwn: () => hasOwn,
@@ -46,6 +49,7 @@ __export(index_exports, {
   isBoolean: () => isBoolean,
   isBrowser: () => isBrowser,
   isDeepEqual: () => isDeepEqual,
+  isElementVisibleInViewport: () => isElementVisibleInViewport,
   isEmptyArray: () => isEmptyArray,
   isEmptyMap: () => isEmptyMap,
   isEmptyObject: () => isEmptyObject,
@@ -71,6 +75,7 @@ __export(index_exports, {
   isRegExp: () => isRegExp,
   isSet: () => isSet,
   isString: () => isString,
+  isTruthy: () => isTruthy,
   isUndefined: () => isUndefined,
   isWhitespaceString: () => isWhitespaceString,
   isZero: () => isZero,
@@ -89,11 +94,14 @@ __export(index_exports, {
   randomRGBColor: () => randomRGBColor,
   randomString: () => randomString,
   resolveSubOptions: () => resolveSubOptions,
+  scrollElementIntoView: () => scrollElementIntoView,
   seconds: () => seconds,
   slash: () => slash,
+  slugify: () => slugify,
   sortObject: () => sortObject,
   throttle: () => throttle,
   toArray: () => toArray,
+  unescapeHTML: () => unescapeHTML,
   unindent: () => unindent,
   unique: () => unique,
   uniqueBy: () => uniqueBy,
@@ -103,6 +111,24 @@ __export(index_exports, {
 });
 module.exports = __toCommonJS(index_exports);
 
+// src/fn/noop.ts
+function noop() {
+}
+var NOOP = noop;
+
+// src/fn/once.ts
+function once(func) {
+  let called = false;
+  return function(...args) {
+    if (called) {
+      return false;
+    }
+    called = true;
+    func.apply(this, args);
+    return true;
+  };
+}
+
 // src/is/isDeepEqual.ts
 function isDeepEqual(value1, value2) {
   const type1 = getObjectType(value1);
@@ -181,6 +207,9 @@ function isBigInt(value) {
 function isBoolean(value) {
   return typeof value === "boolean";
 }
+function isTruthy(value) {
+  return Boolean(value);
+}
 function isFunction(value) {
   return typeof value === "function";
 }
@@ -233,27 +262,68 @@ function isIterable(value) {
   return isFunction(value?.[Symbol.iterator]);
 }
 
-// src/fn/noop.ts
-var noop = () => {
-};
-var NOOP = noop;
+// src/dom/scrollIntoView.ts
+function scrollElementIntoView(element, options = {}) {
+  const body = document.body;
+  const { parent = body, ...scrollIntoViewOptions } = options;
+  if (parent === body) {
+    parent.scrollIntoView(scrollIntoViewOptions);
+    return;
+  }
+  const parentRect = parent.getBoundingClientRect();
+  const elementRect = element.getBoundingClientRect();
+  const isHorizontal = parent.scrollWidth > parent.scrollHeight;
+  const isOutOfView = isHorizontal ? elementRect.left < parentRect.left || elementRect.right > parentRect.right : elementRect.top < parentRect.top || elementRect.bottom > parentRect.bottom;
+  if (isOutOfView) {
+    parent.scrollIntoView(scrollIntoViewOptions);
+  }
+}
 
-// src/fn/once.ts
-function once(func) {
-  let called = false;
-  return function(...args) {
-    if (called) {
-      return false;
-    }
-    called = true;
-    func.apply(this, args);
-    return true;
-  };
+// src/dom/isVisibleInViewport.ts
+function isElementVisibleInViewport(element, targetWindow = window) {
+  const { top, left, bottom, right } = element.getBoundingClientRect();
+  const { innerWidth, innerHeight } = targetWindow;
+  return (top >= 0 && top <= innerHeight || bottom >= 0 && bottom <= innerHeight) && (left >= 0 && left <= innerWidth || right >= 0 && right <= innerWidth);
 }
 
 // src/env/isBrowser.ts
 var isBrowser = () => typeof document !== "undefined";
 
+// src/html/escape.ts
+var htmlEscapeMap = {
+  "&": "&amp;",
+  "<": "&lt;",
+  ">": "&gt;",
+  "'": "&#39;",
+  '"': "&quot;"
+};
+var htmlEscapeRegexp = /[&<>'"]/g;
+function escapeHTML(str) {
+  return str.replace(
+    htmlEscapeRegexp,
+    (char) => htmlEscapeMap[char]
+  );
+}
+var htmlUnescapeMap = {
+  "&amp;": "&",
+  "&#38;": "&",
+  "&lt;": "<",
+  "&#60;": "<",
+  "&gt;": ">",
+  "&#62;": ">",
+  "&apos;": "'",
+  "&#39;": "'",
+  "&quot;": '"',
+  "&#34;": '"'
+};
+var htmlUnescapeRegexp = /&(amp|#38|lt|#60|gt|#62|apos|#39|quot|#34);/g;
+function unescapeHTML(str) {
+  return str.replace(
+    htmlUnescapeRegexp,
+    (char) => htmlUnescapeMap[char]
+  );
+}
+
 // src/misc/raf.ts
 var root = isBrowser() ? window : globalThis;
 var prev = Date.now();
@@ -365,11 +435,6 @@ function warnOnce(message) {
   console.warn(message);
 }
 
-// src/html/escapeHtml.ts
-function escapeHtml(unsafe) {
-  return unsafe.replace(/&/g, "&amp;").replace(/</g, "&lt;").replace(/>/g, "&gt;").replace(/"/g, "&quot;").replace(/'/g, "&#39;");
-}
-
 // src/array/at.ts
 function at(array, index) {
   const length = array.length;
@@ -475,6 +540,14 @@ function randomString(length = 16, chars = "0123456789abcdefghijklmnopqrstuvwxyz
   return result.join("");
 }
 
+// src/string/slugify.ts
+var rControl = /[\u0000-\u001F]/g;
+var rSpecial = /[\s~`!@#$%^&*()\-_+=[\]{}|\\;:"'“”‘’<>,.?/]+/g;
+var rCombining = /[\u0300-\u036F]/g;
+function slugify(str) {
+  return str.normalize("NFKD").replace(rCombining, "").replace(rControl, "").replace(rSpecial, "-").replace(/-{2,}/g, "-").replace(/^-+|-+$/g, "").replace(/^(\d)/, "_$1").toLowerCase();
+}
+
 // src/string/unindent.ts
 var _RE_FULL_WS = /^\s*$/;
 function unindent(input) {
@@ -520,6 +593,10 @@ function normalizeHexString(hex) {
   return hex.length === 6 ? hex : hex.replace(/./g, "$&$&");
 }
 var Color = class _Color {
+  red = 0;
+  green = 0;
+  blue = 0;
+  alpha = 1;
   constructor(red = 0, green = 0, blue = 0, alpha = 1) {
     this.red = red;
     this.green = green;
@@ -621,6 +698,17 @@ function enhance(module2, extra) {
   });
 }
 
+// src/module/interopDefault.ts
+async function interopDefault(mod) {
+  const resolved = await mod;
+  return resolved.default || resolved;
+}
+
+// src/module/resolveSubOptions.ts
+function resolveSubOptions(options, key) {
+  return typeof options[key] === "boolean" ? {} : options[key] || {};
+}
+
 // src/object/omit.ts
 function omit(object, ...keys) {
   keys.forEach((key) => delete object[key]);
@@ -720,20 +808,17 @@ function sortObject(obj, options = {}) {
   return sortKeys(obj);
 }
 
-// src/module/interopDefault.ts
-async function interopDefault(mod) {
-  const resolved = await mod;
-  return resolved.default || resolved;
-}
-
-// src/module/resolveSubOptions.ts
-function resolveSubOptions(options, key) {
-  return typeof options[key] === "boolean" ? {} : options[key] || {};
-}
+// src/constants/regexp.ts
+var RE_COMMENTS = /(?:<!--|\/\*)([\s\S]*?)(?:-->|\*\/)/g;
+var RE_LINE_COMMENT = /\/\/.*/;
+var RE_BLOCK_COMMENT = /\/\*[\s\S]*?\*\//g;
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   Color,
   NOOP,
+  RE_BLOCK_COMMENT,
+  RE_COMMENTS,
+  RE_LINE_COMMENT,
   at,
   cAF,
   chunk,
@@ -745,7 +830,7 @@ function resolveSubOptions(options, key) {
   enhance,
   ensurePrefix,
   ensureSuffix,
-  escapeHtml,
+  escapeHTML,
   flattenArrayable,
   getObjectType,
   hasOwn,
@@ -758,6 +843,7 @@ function resolveSubOptions(options, key) {
   isBoolean,
   isBrowser,
   isDeepEqual,
+  isElementVisibleInViewport,
   isEmptyArray,
   isEmptyMap,
   isEmptyObject,
@@ -783,6 +869,7 @@ function resolveSubOptions(options, key) {
   isRegExp,
   isSet,
   isString,
+  isTruthy,
   isUndefined,
   isWhitespaceString,
   isZero,
@@ -801,11 +888,14 @@ function resolveSubOptions(options, key) {
   randomRGBColor,
   randomString,
   resolveSubOptions,
+  scrollElementIntoView,
   seconds,
   slash,
+  slugify,
   sortObject,
   throttle,
   toArray,
+  unescapeHTML,
   unindent,
   unique,
   uniqueBy,

package/dist/index.d.cts

@@ -1,3 +1,14 @@
+/**
+ * A function that does nothing.
+ */
+declare function noop(): void;
+/**
+ * Alias of {@link noop}.
+ */
+declare const NOOP: typeof noop;
+
+declare function once<T extends unknown[]>(func: (...args: T) => void): (this: unknown, ...args: T) => boolean;
+
 /**
  * check if two values are deeply equal
  */
@@ -29,6 +40,7 @@ declare function isNaN(value: unknown): value is typeof Number.NaN;
 declare function isInteger(value: unknown): value is number;
 declare function isBigInt(value: unknown): value is bigint;
 declare function isBoolean(value: unknown): value is boolean;
+declare function isTruthy<T>(value: T | undefined): value is T;
 declare function isFunction(value: unknown): value is Function;
 declare function isArray(value: unknown): value is unknown[];
 declare function isEmptyArray(value: unknown): value is [];
@@ -45,16 +57,21 @@ declare function isNativePromise<T = unknown>(value: unknown): value is Promise<
 declare function isPromise<T = unknown>(value: unknown): value is Promise<T>;
 declare function isIterable<T = unknown>(value: unknown): value is Iterable<T>;
 
+interface Options extends ScrollIntoViewOptions {
+    /**
+     * @default `document.body`
+     */
+    parent?: HTMLElement;
+}
 /**
- * A function that does nothing.
- */
-declare const noop: () => void;
-/**
- * Alias of {@link noop}.
+ * Scroll element into view if it is out of view.
+ *
+ * @param element - element to scroll
+ * @param options - scroll options
  */
-declare const NOOP: typeof noop;
+declare function scrollElementIntoView(element: HTMLElement, options?: Options): void;
 
-declare function once<T extends unknown[]>(func: (...args: T) => void): (this: unknown, ...args: T) => boolean;
+declare function isElementVisibleInViewport(element: HTMLElement, targetWindow?: Window): boolean;
 
 /**
  * @file env.ts
@@ -66,6 +83,15 @@ declare function once<T extends unknown[]>(func: (...args: T) => void): (this: u
  */
 declare const isBrowser: () => boolean;
 
+/**
+ * Escape html chars
+ */
+declare function escapeHTML(str: string): string;
+/**
+ * Unescape html chars
+ */
+declare function unescapeHTML(str: string): string;
+
 /**
  * @file raf.ts
  */
@@ -139,10 +165,13 @@ declare function debounce<T extends ((...args: any[]) => undefined | void) | und
     cancel: () => void;
 };
 
+/**
+ * Warn message only once
+ *
+ * @param message - warning message
+ */
 declare function warnOnce(message: string): void;
 
-declare function escapeHtml(unsafe: string): string;
-
 /**
  * Get array item by index, negative for backward
  * @param array - given array
@@ -261,6 +290,12 @@ declare function mergeArrayable<T>(...args: Nullable<Arrayable<T>>[]): Array<T>;
  */
 declare function intersect<T>(a: T[], b: T[]): T[];
 
+/**
+ * Check if values of two arrays are equal
+ * @param array1 - array 1
+ * @param array2 - array 2
+ * @returns `true` if equal
+ */
 declare function isArrayEqual(array1: unknown[], array2: unknown[]): boolean;
 
 declare class Color {
@@ -320,61 +355,67 @@ declare function randomHexColor(): string;
  */
 declare function enhance<T extends Record<PropertyKey, any>, E extends Record<PropertyKey, any>>(module: T, extra: E): T;
 
-interface CreatePadStringOptions {
-    length: number;
-    char: string;
-}
-declare function createPadString(options: CreatePadStringOptions): (value: string) => string;
-
-type JoinableValue = string | number | null | undefined;
-interface JoinOptions {
-    /**
-     * @default ''
-     */
-    separator?: string;
-}
-/**
- * Joins an array of strings or numbers into a single string.
- * @param array - An array of strings or numbers.
- * @param options - An object of options.
- * @returns A string.
- */
-declare function join(array: JoinableValue[], options?: JoinOptions): string;
-
-/**
- * Replace backslash to slash
- */
-declare function slash(input: string): string;
-
 /**
- * randome a string useing given chars
+ * Interop default export from a module
  *
- * @param length - string length
- * @param chars - string chars
- * @returns random string
+ * @param mod - The module
+ * @returns The default export
+ *
+ * @example
+ *
+ * ```ts
+ * import { interopDefault } from '@ntnyq/utils'
+ *
+ * const { unindent } = await interopDefault(import('@ntnyq/utils'))
+ * ```
  */
-declare function randomString(length?: number, chars?: string): string;
+declare function interopDefault<T>(mod: Awaitable<T>): Promise<InteropModuleDefault<T>>;
 
 /**
- * Remove common leading whitespace from a template string
- * Empty lines at the beginning and end of the template string are also removed.
- * @param input - template string
+ * Resolve sub options `boolean | Options` to `Options`
+ * @param options - core options
+ * @param key - sub options key
+ * @returns resolved sub options
  *
  * @example
  *
  * ```ts
- * const str = unindent`
- *   if (foo) {
- *     bar()
+ * import { resolveSubOptions } from '@ntnyq/utils'
+ *
+ * interface Options {
+ *   compile?: boolean | {
+ *     include?: string[]
+ *     exclude?: string[]
  *   }
- * `
+ * }
+ *
+ * const options: Options = {
+ *   compile: true
+ * }
+ *
+ * console.log(resolveSubOptions(options, 'compile'))
+ *
+ * // => {}
  * ```
  */
-declare function unindent(input: TemplateStringsArray | string): string;
-
-declare function ensurePrefix(input: string, prefix: string): string;
+declare function resolveSubOptions<T extends Record<string, any>, K extends keyof T>(options: T, key: K): Partial<ResolvedOptions<T[K]>>;
 
-declare function ensureSuffix(input: string, suffix: string): string;
+interface RamdomNumberOptions {
+    /**
+     * include max value
+     *
+     * @default false
+     */
+    includeMax?: boolean;
+}
+/**
+ * random an integer by given range
+ *
+ * @param min - min value
+ * @param max - max value
+ * @returns random integer in range
+ */
+declare function randomNumber(min: number, max?: number, options?: RamdomNumberOptions): number;
 
 declare function omit<T, K extends keyof T>(object: T, ...keys: K[]): Omit<T, K>;
 
@@ -462,66 +503,80 @@ interface SortObjectOptions {
  */
 declare function sortObject<T extends Record<string, any>>(obj: T, options?: SortObjectOptions): T;
 
+interface CreatePadStringOptions {
+    length: number;
+    char: string;
+}
+declare function createPadString(options: CreatePadStringOptions): (value: string) => string;
+
+type JoinableValue = string | number | null | undefined;
+interface JoinOptions {
+    /**
+     * @default ''
+     */
+    separator?: string;
+}
 /**
- * Interop default export from a module
- *
- * @param mod - The module
- * @returns The default export
- *
- * @example
- *
- * ```ts
- * import { interopDefault } from '@ntnyq/utils'
+ * Joins an array of strings or numbers into a single string.
+ * @param array - An array of strings or numbers.
+ * @param options - An object of options.
+ * @returns A string.
+ */
+declare function join(array: JoinableValue[], options?: JoinOptions): string;
+
+/**
+ * Replace backslash to slash
+ */
+declare function slash(input: string): string;
+
+/**
+ * randome a string useing given chars
  *
- * const { unindent } = await interopDefault(import('@ntnyq/utils'))
- * ```
+ * @param length - string length
+ * @param chars - string chars
+ * @returns random string
  */
-declare function interopDefault<T>(mod: Awaitable<T>): Promise<InteropModuleDefault<T>>;
+declare function randomString(length?: number, chars?: string): string;
 
 /**
- * Resolve sub options `boolean | Options` to `Options`
- * @param options - core options
- * @param key - sub options key
- * @returns resolved sub options
+ * Default slugify function
+ */
+declare function slugify(str: string): string;
+
+/**
+ * Remove common leading whitespace from a template string
+ * Empty lines at the beginning and end of the template string are also removed.
+ * @param input - template string
  *
  * @example
  *
  * ```ts
- * import { resolveSubOptions } from '@ntnyq/utils'
- *
- * interface Options {
- *   compile?: boolean | {
- *     include?: string[]
- *     exclude?: string[]
+ * const str = unindent`
+ *   if (foo) {
+ *     bar()
  *   }
- * }
- *
- * const options: Options = {
- *   compile: true
- * }
- *
- * console.log(resolveSubOptions(options, 'compile'))
- *
- * // => {}
+ * `
  * ```
  */
-declare function resolveSubOptions<T extends Record<string, any>, K extends keyof T>(options: T, key: K): Partial<ResolvedOptions<T[K]>>;
+declare function unindent(input: TemplateStringsArray | string): string;
+
+declare function ensurePrefix(input: string, prefix: string): string;
+
+declare function ensureSuffix(input: string, suffix: string): string;
 
-interface RamdomNumberOptions {
-    /**
-     * include max value
-     *
-     * @default false
-     */
-    includeMax?: boolean;
-}
 /**
- * random an integer by given range
+ * 注释正则
  *
- * @param min - min value
- * @param max - max value
- * @returns random integer in range
+ * 匹配 \<!-- 或 /* 开头的注释，直到 --> 或 *\/ 结尾
  */
-declare function randomNumber(min: number, max?: number, options?: RamdomNumberOptions): number;
+declare const RE_COMMENTS: RegExp;
+/**
+ * JavaScript line comment
+ */
+declare const RE_LINE_COMMENT: RegExp;
+/**
+ * JavaScript block comment
+ */
+declare const RE_BLOCK_COMMENT: RegExp;
 
-export { type AnyFn, type Arrayable, type Awaitable, type Callable, type CleanObjectOptions, Color, type CreatePadStringOptions, type InteropModuleDefault, type JsonArray, type JsonObject, type JsonPrimitive, type JsonValue, type LiteralUnion, type MayBe, NOOP, type NonEmptyObject, type NonEmptyString, type Nullable, type Overwrite, type Prettify, type PrettifyV2, type PrimitiveType, type RamdomNumberOptions, type ResolvedOptions, type SortObjectOptions, type ThrottleDebounceOptions, type Whitespace, at, cAF, chunk, clamp, cleanObject, createPadString, days, debounce, enhance, ensurePrefix, ensureSuffix, escapeHtml, flattenArrayable, getObjectType, hasOwn, hours, interopDefault, intersect, isArray, isArrayEqual, isBigInt, isBoolean, isBrowser, isDeepEqual, isEmptyArray, isEmptyMap, isEmptyObject, isEmptySet, isEmptyString, isEmptyStringOrWhitespace, isError, isFunction, isInteger, isIterable, isMap, isNaN, isNativePromise, isNil, isNonEmptyArray, isNonEmptyString, isNull, isNullOrUndefined, isNumber, isNumbericString, isObject, isPromise, isRegExp, isSet, isString, isUndefined, isWhitespaceString, isZero, join, last, mergeArrayable, minutes, noop, omit, once, pick, rAF, randomHexColor, randomNumber, randomRGBAColor, randomRGBColor, randomString, resolveSubOptions, seconds, slash, sortObject, throttle, toArray, unindent, unique, uniqueBy, waitFor, warnOnce, weeks };
+export { type AnyFn, type Arrayable, type Awaitable, type Callable, type CleanObjectOptions, Color, type CreatePadStringOptions, type InteropModuleDefault, type JsonArray, type JsonObject, type JsonPrimitive, type JsonValue, type LiteralUnion, type MayBe, NOOP, type NonEmptyObject, type NonEmptyString, type Nullable, type Overwrite, type Prettify, type PrettifyV2, type PrimitiveType, RE_BLOCK_COMMENT, RE_COMMENTS, RE_LINE_COMMENT, type RamdomNumberOptions, type ResolvedOptions, type SortObjectOptions, type ThrottleDebounceOptions, type Whitespace, at, cAF, chunk, clamp, cleanObject, createPadString, days, debounce, enhance, ensurePrefix, ensureSuffix, escapeHTML, flattenArrayable, getObjectType, hasOwn, hours, interopDefault, intersect, isArray, isArrayEqual, isBigInt, isBoolean, isBrowser, isDeepEqual, isElementVisibleInViewport, isEmptyArray, isEmptyMap, isEmptyObject, isEmptySet, isEmptyString, isEmptyStringOrWhitespace, isError, isFunction, isInteger, isIterable, isMap, isNaN, isNativePromise, isNil, isNonEmptyArray, isNonEmptyString, isNull, isNullOrUndefined, isNumber, isNumbericString, isObject, isPromise, isRegExp, isSet, isString, isTruthy, isUndefined, isWhitespaceString, isZero, join, last, mergeArrayable, minutes, noop, omit, once, pick, rAF, randomHexColor, randomNumber, randomRGBAColor, randomRGBColor, randomString, resolveSubOptions, scrollElementIntoView, seconds, slash, slugify, sortObject, throttle, toArray, unescapeHTML, unindent, unique, uniqueBy, waitFor, warnOnce, weeks };

package/dist/index.d.ts

@@ -1,3 +1,14 @@
+/**
+ * A function that does nothing.
+ */
+declare function noop(): void;
+/**
+ * Alias of {@link noop}.
+ */
+declare const NOOP: typeof noop;
+
+declare function once<T extends unknown[]>(func: (...args: T) => void): (this: unknown, ...args: T) => boolean;
+
 /**
  * check if two values are deeply equal
  */
@@ -29,6 +40,7 @@ declare function isNaN(value: unknown): value is typeof Number.NaN;
 declare function isInteger(value: unknown): value is number;
 declare function isBigInt(value: unknown): value is bigint;
 declare function isBoolean(value: unknown): value is boolean;
+declare function isTruthy<T>(value: T | undefined): value is T;
 declare function isFunction(value: unknown): value is Function;
 declare function isArray(value: unknown): value is unknown[];
 declare function isEmptyArray(value: unknown): value is [];
@@ -45,16 +57,21 @@ declare function isNativePromise<T = unknown>(value: unknown): value is Promise<
 declare function isPromise<T = unknown>(value: unknown): value is Promise<T>;
 declare function isIterable<T = unknown>(value: unknown): value is Iterable<T>;
 
+interface Options extends ScrollIntoViewOptions {
+    /**
+     * @default `document.body`
+     */
+    parent?: HTMLElement;
+}
 /**
- * A function that does nothing.
- */
-declare const noop: () => void;
-/**
- * Alias of {@link noop}.
+ * Scroll element into view if it is out of view.
+ *
+ * @param element - element to scroll
+ * @param options - scroll options
  */
-declare const NOOP: typeof noop;
+declare function scrollElementIntoView(element: HTMLElement, options?: Options): void;
 
-declare function once<T extends unknown[]>(func: (...args: T) => void): (this: unknown, ...args: T) => boolean;
+declare function isElementVisibleInViewport(element: HTMLElement, targetWindow?: Window): boolean;
 
 /**
  * @file env.ts
@@ -66,6 +83,15 @@ declare function once<T extends unknown[]>(func: (...args: T) => void): (this: u
  */
 declare const isBrowser: () => boolean;
 
+/**
+ * Escape html chars
+ */
+declare function escapeHTML(str: string): string;
+/**
+ * Unescape html chars
+ */
+declare function unescapeHTML(str: string): string;
+
 /**
  * @file raf.ts
  */
@@ -139,10 +165,13 @@ declare function debounce<T extends ((...args: any[]) => undefined | void) | und
     cancel: () => void;
 };
 
+/**
+ * Warn message only once
+ *
+ * @param message - warning message
+ */
 declare function warnOnce(message: string): void;
 
-declare function escapeHtml(unsafe: string): string;
-
 /**
  * Get array item by index, negative for backward
  * @param array - given array
@@ -261,6 +290,12 @@ declare function mergeArrayable<T>(...args: Nullable<Arrayable<T>>[]): Array<T>;
  */
 declare function intersect<T>(a: T[], b: T[]): T[];
 
+/**
+ * Check if values of two arrays are equal
+ * @param array1 - array 1
+ * @param array2 - array 2
+ * @returns `true` if equal
+ */
 declare function isArrayEqual(array1: unknown[], array2: unknown[]): boolean;
 
 declare class Color {
@@ -320,61 +355,67 @@ declare function randomHexColor(): string;
  */
 declare function enhance<T extends Record<PropertyKey, any>, E extends Record<PropertyKey, any>>(module: T, extra: E): T;
 
-interface CreatePadStringOptions {
-    length: number;
-    char: string;
-}
-declare function createPadString(options: CreatePadStringOptions): (value: string) => string;
-
-type JoinableValue = string | number | null | undefined;
-interface JoinOptions {
-    /**
-     * @default ''
-     */
-    separator?: string;
-}
-/**
- * Joins an array of strings or numbers into a single string.
- * @param array - An array of strings or numbers.
- * @param options - An object of options.
- * @returns A string.
- */
-declare function join(array: JoinableValue[], options?: JoinOptions): string;
-
-/**
- * Replace backslash to slash
- */
-declare function slash(input: string): string;
-
 /**
- * randome a string useing given chars
+ * Interop default export from a module
  *
- * @param length - string length
- * @param chars - string chars
- * @returns random string
+ * @param mod - The module
+ * @returns The default export
+ *
+ * @example
+ *
+ * ```ts
+ * import { interopDefault } from '@ntnyq/utils'
+ *
+ * const { unindent } = await interopDefault(import('@ntnyq/utils'))
+ * ```
  */
-declare function randomString(length?: number, chars?: string): string;
+declare function interopDefault<T>(mod: Awaitable<T>): Promise<InteropModuleDefault<T>>;
 
 /**
- * Remove common leading whitespace from a template string
- * Empty lines at the beginning and end of the template string are also removed.
- * @param input - template string
+ * Resolve sub options `boolean | Options` to `Options`
+ * @param options - core options
+ * @param key - sub options key
+ * @returns resolved sub options
  *
  * @example
  *
  * ```ts
- * const str = unindent`
- *   if (foo) {
- *     bar()
+ * import { resolveSubOptions } from '@ntnyq/utils'
+ *
+ * interface Options {
+ *   compile?: boolean | {
+ *     include?: string[]
+ *     exclude?: string[]
  *   }
- * `
+ * }
+ *
+ * const options: Options = {
+ *   compile: true
+ * }
+ *
+ * console.log(resolveSubOptions(options, 'compile'))
+ *
+ * // => {}
  * ```
  */
-declare function unindent(input: TemplateStringsArray | string): string;
-
-declare function ensurePrefix(input: string, prefix: string): string;
+declare function resolveSubOptions<T extends Record<string, any>, K extends keyof T>(options: T, key: K): Partial<ResolvedOptions<T[K]>>;
 
-declare function ensureSuffix(input: string, suffix: string): string;
+interface RamdomNumberOptions {
+    /**
+     * include max value
+     *
+     * @default false
+     */
+    includeMax?: boolean;
+}
+/**
+ * random an integer by given range
+ *
+ * @param min - min value
+ * @param max - max value
+ * @returns random integer in range
+ */
+declare function randomNumber(min: number, max?: number, options?: RamdomNumberOptions): number;
 
 declare function omit<T, K extends keyof T>(object: T, ...keys: K[]): Omit<T, K>;
 
@@ -462,66 +503,80 @@ interface SortObjectOptions {
  */
 declare function sortObject<T extends Record<string, any>>(obj: T, options?: SortObjectOptions): T;
 
+interface CreatePadStringOptions {
+    length: number;
+    char: string;
+}
+declare function createPadString(options: CreatePadStringOptions): (value: string) => string;
+
+type JoinableValue = string | number | null | undefined;
+interface JoinOptions {
+    /**
+     * @default ''
+     */
+    separator?: string;
+}
 /**
- * Interop default export from a module
- *
- * @param mod - The module
- * @returns The default export
- *
- * @example
- *
- * ```ts
- * import { interopDefault } from '@ntnyq/utils'
+ * Joins an array of strings or numbers into a single string.
+ * @param array - An array of strings or numbers.
+ * @param options - An object of options.
+ * @returns A string.
+ */
+declare function join(array: JoinableValue[], options?: JoinOptions): string;
+
+/**
+ * Replace backslash to slash
+ */
+declare function slash(input: string): string;
+
+/**
+ * randome a string useing given chars
  *
- * const { unindent } = await interopDefault(import('@ntnyq/utils'))
- * ```
+ * @param length - string length
+ * @param chars - string chars
+ * @returns random string
  */
-declare function interopDefault<T>(mod: Awaitable<T>): Promise<InteropModuleDefault<T>>;
+declare function randomString(length?: number, chars?: string): string;
 
 /**
- * Resolve sub options `boolean | Options` to `Options`
- * @param options - core options
- * @param key - sub options key
- * @returns resolved sub options
+ * Default slugify function
+ */
+declare function slugify(str: string): string;
+
+/**
+ * Remove common leading whitespace from a template string
+ * Empty lines at the beginning and end of the template string are also removed.
+ * @param input - template string
  *
  * @example
  *
  * ```ts
- * import { resolveSubOptions } from '@ntnyq/utils'
- *
- * interface Options {
- *   compile?: boolean | {
- *     include?: string[]
- *     exclude?: string[]
+ * const str = unindent`
+ *   if (foo) {
+ *     bar()
  *   }
- * }
- *
- * const options: Options = {
- *   compile: true
- * }
- *
- * console.log(resolveSubOptions(options, 'compile'))
- *
- * // => {}
+ * `
  * ```
  */
-declare function resolveSubOptions<T extends Record<string, any>, K extends keyof T>(options: T, key: K): Partial<ResolvedOptions<T[K]>>;
+declare function unindent(input: TemplateStringsArray | string): string;
+
+declare function ensurePrefix(input: string, prefix: string): string;
+
+declare function ensureSuffix(input: string, suffix: string): string;
 
-interface RamdomNumberOptions {
-    /**
-     * include max value
-     *
-     * @default false
-     */
-    includeMax?: boolean;
-}
 /**
- * random an integer by given range
+ * 注释正则
  *
- * @param min - min value
- * @param max - max value
- * @returns random integer in range
+ * 匹配 \<!-- 或 /* 开头的注释，直到 --> 或 *\/ 结尾
  */
-declare function randomNumber(min: number, max?: number, options?: RamdomNumberOptions): number;
+declare const RE_COMMENTS: RegExp;
+/**
+ * JavaScript line comment
+ */
+declare const RE_LINE_COMMENT: RegExp;
+/**
+ * JavaScript block comment
+ */
+declare const RE_BLOCK_COMMENT: RegExp;
 
-export { type AnyFn, type Arrayable, type Awaitable, type Callable, type CleanObjectOptions, Color, type CreatePadStringOptions, type InteropModuleDefault, type JsonArray, type JsonObject, type JsonPrimitive, type JsonValue, type LiteralUnion, type MayBe, NOOP, type NonEmptyObject, type NonEmptyString, type Nullable, type Overwrite, type Prettify, type PrettifyV2, type PrimitiveType, type RamdomNumberOptions, type ResolvedOptions, type SortObjectOptions, type ThrottleDebounceOptions, type Whitespace, at, cAF, chunk, clamp, cleanObject, createPadString, days, debounce, enhance, ensurePrefix, ensureSuffix, escapeHtml, flattenArrayable, getObjectType, hasOwn, hours, interopDefault, intersect, isArray, isArrayEqual, isBigInt, isBoolean, isBrowser, isDeepEqual, isEmptyArray, isEmptyMap, isEmptyObject, isEmptySet, isEmptyString, isEmptyStringOrWhitespace, isError, isFunction, isInteger, isIterable, isMap, isNaN, isNativePromise, isNil, isNonEmptyArray, isNonEmptyString, isNull, isNullOrUndefined, isNumber, isNumbericString, isObject, isPromise, isRegExp, isSet, isString, isUndefined, isWhitespaceString, isZero, join, last, mergeArrayable, minutes, noop, omit, once, pick, rAF, randomHexColor, randomNumber, randomRGBAColor, randomRGBColor, randomString, resolveSubOptions, seconds, slash, sortObject, throttle, toArray, unindent, unique, uniqueBy, waitFor, warnOnce, weeks };
+export { type AnyFn, type Arrayable, type Awaitable, type Callable, type CleanObjectOptions, Color, type CreatePadStringOptions, type InteropModuleDefault, type JsonArray, type JsonObject, type JsonPrimitive, type JsonValue, type LiteralUnion, type MayBe, NOOP, type NonEmptyObject, type NonEmptyString, type Nullable, type Overwrite, type Prettify, type PrettifyV2, type PrimitiveType, RE_BLOCK_COMMENT, RE_COMMENTS, RE_LINE_COMMENT, type RamdomNumberOptions, type ResolvedOptions, type SortObjectOptions, type ThrottleDebounceOptions, type Whitespace, at, cAF, chunk, clamp, cleanObject, createPadString, days, debounce, enhance, ensurePrefix, ensureSuffix, escapeHTML, flattenArrayable, getObjectType, hasOwn, hours, interopDefault, intersect, isArray, isArrayEqual, isBigInt, isBoolean, isBrowser, isDeepEqual, isElementVisibleInViewport, isEmptyArray, isEmptyMap, isEmptyObject, isEmptySet, isEmptyString, isEmptyStringOrWhitespace, isError, isFunction, isInteger, isIterable, isMap, isNaN, isNativePromise, isNil, isNonEmptyArray, isNonEmptyString, isNull, isNullOrUndefined, isNumber, isNumbericString, isObject, isPromise, isRegExp, isSet, isString, isTruthy, isUndefined, isWhitespaceString, isZero, join, last, mergeArrayable, minutes, noop, omit, once, pick, rAF, randomHexColor, randomNumber, randomRGBAColor, randomRGBColor, randomString, resolveSubOptions, scrollElementIntoView, seconds, slash, slugify, sortObject, throttle, toArray, unescapeHTML, unindent, unique, uniqueBy, waitFor, warnOnce, weeks };

package/dist/index.js

@@ -1,3 +1,21 @@
+// src/fn/noop.ts
+function noop() {
+}
+var NOOP = noop;
+
+// src/fn/once.ts
+function once(func) {
+  let called = false;
+  return function(...args) {
+    if (called) {
+      return false;
+    }
+    called = true;
+    func.apply(this, args);
+    return true;
+  };
+}
+
 // src/is/isDeepEqual.ts
 function isDeepEqual(value1, value2) {
   const type1 = getObjectType(value1);
@@ -76,6 +94,9 @@ function isBigInt(value) {
 function isBoolean(value) {
   return typeof value === "boolean";
 }
+function isTruthy(value) {
+  return Boolean(value);
+}
 function isFunction(value) {
   return typeof value === "function";
 }
@@ -128,27 +149,68 @@ function isIterable(value) {
   return isFunction(value?.[Symbol.iterator]);
 }
 
-// src/fn/noop.ts
-var noop = () => {
-};
-var NOOP = noop;
+// src/dom/scrollIntoView.ts
+function scrollElementIntoView(element, options = {}) {
+  const body = document.body;
+  const { parent = body, ...scrollIntoViewOptions } = options;
+  if (parent === body) {
+    parent.scrollIntoView(scrollIntoViewOptions);
+    return;
+  }
+  const parentRect = parent.getBoundingClientRect();
+  const elementRect = element.getBoundingClientRect();
+  const isHorizontal = parent.scrollWidth > parent.scrollHeight;
+  const isOutOfView = isHorizontal ? elementRect.left < parentRect.left || elementRect.right > parentRect.right : elementRect.top < parentRect.top || elementRect.bottom > parentRect.bottom;
+  if (isOutOfView) {
+    parent.scrollIntoView(scrollIntoViewOptions);
+  }
+}
 
-// src/fn/once.ts
-function once(func) {
-  let called = false;
-  return function(...args) {
-    if (called) {
-      return false;
-    }
-    called = true;
-    func.apply(this, args);
-    return true;
-  };
+// src/dom/isVisibleInViewport.ts
+function isElementVisibleInViewport(element, targetWindow = window) {
+  const { top, left, bottom, right } = element.getBoundingClientRect();
+  const { innerWidth, innerHeight } = targetWindow;
+  return (top >= 0 && top <= innerHeight || bottom >= 0 && bottom <= innerHeight) && (left >= 0 && left <= innerWidth || right >= 0 && right <= innerWidth);
 }
 
 // src/env/isBrowser.ts
 var isBrowser = () => typeof document !== "undefined";
 
+// src/html/escape.ts
+var htmlEscapeMap = {
+  "&": "&amp;",
+  "<": "&lt;",
+  ">": "&gt;",
+  "'": "&#39;",
+  '"': "&quot;"
+};
+var htmlEscapeRegexp = /[&<>'"]/g;
+function escapeHTML(str) {
+  return str.replace(
+    htmlEscapeRegexp,
+    (char) => htmlEscapeMap[char]
+  );
+}
+var htmlUnescapeMap = {
+  "&amp;": "&",
+  "&#38;": "&",
+  "&lt;": "<",
+  "&#60;": "<",
+  "&gt;": ">",
+  "&#62;": ">",
+  "&apos;": "'",
+  "&#39;": "'",
+  "&quot;": '"',
+  "&#34;": '"'
+};
+var htmlUnescapeRegexp = /&(amp|#38|lt|#60|gt|#62|apos|#39|quot|#34);/g;
+function unescapeHTML(str) {
+  return str.replace(
+    htmlUnescapeRegexp,
+    (char) => htmlUnescapeMap[char]
+  );
+}
+
 // src/misc/raf.ts
 var root = isBrowser() ? window : globalThis;
 var prev = Date.now();
@@ -260,11 +322,6 @@ function warnOnce(message) {
   console.warn(message);
 }
 
-// src/html/escapeHtml.ts
-function escapeHtml(unsafe) {
-  return unsafe.replace(/&/g, "&amp;").replace(/</g, "&lt;").replace(/>/g, "&gt;").replace(/"/g, "&quot;").replace(/'/g, "&#39;");
-}
-
 // src/array/at.ts
 function at(array, index) {
   const length = array.length;
@@ -370,6 +427,14 @@ function randomString(length = 16, chars = "0123456789abcdefghijklmnopqrstuvwxyz
   return result.join("");
 }
 
+// src/string/slugify.ts
+var rControl = /[\u0000-\u001F]/g;
+var rSpecial = /[\s~`!@#$%^&*()\-_+=[\]{}|\\;:"'“”‘’<>,.?/]+/g;
+var rCombining = /[\u0300-\u036F]/g;
+function slugify(str) {
+  return str.normalize("NFKD").replace(rCombining, "").replace(rControl, "").replace(rSpecial, "-").replace(/-{2,}/g, "-").replace(/^-+|-+$/g, "").replace(/^(\d)/, "_$1").toLowerCase();
+}
+
 // src/string/unindent.ts
 var _RE_FULL_WS = /^\s*$/;
 function unindent(input) {
@@ -415,6 +480,10 @@ function normalizeHexString(hex) {
   return hex.length === 6 ? hex : hex.replace(/./g, "$&$&");
 }
 var Color = class _Color {
+  red = 0;
+  green = 0;
+  blue = 0;
+  alpha = 1;
   constructor(red = 0, green = 0, blue = 0, alpha = 1) {
     this.red = red;
     this.green = green;
@@ -516,6 +585,17 @@ function enhance(module, extra) {
   });
 }
 
+// src/module/interopDefault.ts
+async function interopDefault(mod) {
+  const resolved = await mod;
+  return resolved.default || resolved;
+}
+
+// src/module/resolveSubOptions.ts
+function resolveSubOptions(options, key) {
+  return typeof options[key] === "boolean" ? {} : options[key] || {};
+}
+
 // src/object/omit.ts
 function omit(object, ...keys) {
   keys.forEach((key) => delete object[key]);
@@ -615,19 +695,16 @@ function sortObject(obj, options = {}) {
   return sortKeys(obj);
 }
 
-// src/module/interopDefault.ts
-async function interopDefault(mod) {
-  const resolved = await mod;
-  return resolved.default || resolved;
-}
-
-// src/module/resolveSubOptions.ts
-function resolveSubOptions(options, key) {
-  return typeof options[key] === "boolean" ? {} : options[key] || {};
-}
+// src/constants/regexp.ts
+var RE_COMMENTS = /(?:<!--|\/\*)([\s\S]*?)(?:-->|\*\/)/g;
+var RE_LINE_COMMENT = /\/\/.*/;
+var RE_BLOCK_COMMENT = /\/\*[\s\S]*?\*\//g;
 export {
   Color,
   NOOP,
+  RE_BLOCK_COMMENT,
+  RE_COMMENTS,
+  RE_LINE_COMMENT,
   at,
   cAF,
   chunk,
@@ -639,7 +716,7 @@ export {
   enhance,
   ensurePrefix,
   ensureSuffix,
-  escapeHtml,
+  escapeHTML,
   flattenArrayable,
   getObjectType,
   hasOwn,
@@ -652,6 +729,7 @@ export {
   isBoolean,
   isBrowser,
   isDeepEqual,
+  isElementVisibleInViewport,
   isEmptyArray,
   isEmptyMap,
   isEmptyObject,
@@ -677,6 +755,7 @@ export {
   isRegExp,
   isSet,
   isString,
+  isTruthy,
   isUndefined,
   isWhitespaceString,
   isZero,
@@ -695,11 +774,14 @@ export {
   randomRGBColor,
   randomString,
   resolveSubOptions,
+  scrollElementIntoView,
   seconds,
   slash,
+  slugify,
   sortObject,
   throttle,
   toArray,
+  unescapeHTML,
   unindent,
   unique,
   uniqueBy,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ntnyq/utils",
   "type": "module",
-  "version": "0.6.0",
+  "version": "0.6.2",
   "description": "Common used utils.",
   "keywords": [
     "utils"
@@ -37,18 +37,18 @@
   ],
   "sideEffects": false,
   "devDependencies": {
-    "@ntnyq/eslint-config": "^4.0.0-beta.7",
+    "@ntnyq/eslint-config": "^4.0.2",
     "@ntnyq/prettier-config": "^2.0.0",
-    "@vitest/coverage-v8": "^3.0.6",
-    "bumpp": "^10.0.3",
-    "eslint": "^9.20.1",
+    "@vitest/coverage-v8": "^3.0.9",
+    "bumpp": "^10.1.0",
+    "eslint": "^9.23.0",
     "husky": "^9.1.7",
     "nano-staged": "^0.8.0",
     "npm-run-all2": "^7.0.2",
-    "prettier": "^3.5.1",
-    "tsup": "^8.3.6",
-    "typescript": "^5.7.3",
-    "vitest": "^3.0.6"
+    "prettier": "^3.5.3",
+    "tsup": "^8.4.0",
+    "typescript": "^5.8.2",
+    "vitest": "^3.0.9"
   },
   "engines": {
     "node": ">=18.18.0"
@@ -60,10 +60,11 @@
     "build": "tsup",
     "coverage": "vitest --coverage",
     "dev": "tsup --watch src",
-    "lint": "eslint .",
-    "release": "run-s release:check release:publish",
+    "lint": "eslint",
+    "release": "run-s release:check release:version release:publish",
     "release:check": "run-s lint typecheck test",
-    "release:publish": "bumpp && pnpm publish",
+    "release:publish": "pnpm publish",
+    "release:version": "bumpp",
     "test": "vitest",
     "typecheck": "tsc --noEmit"
   }