zhegu 3.8.0

package/CHANGELOG.md

@@ -0,0 +1,47 @@
+# Changelog
+
+## 2024-03-22 v3.2.1
+
+- rename to `searchDirUp`, prev version not relased as `searchDirUp`
+
+## 2024-03-22 v3.2.0
+
+- feat: add `searchDirUp`
+
+## 2024-03-19 v3.1.0
+
+- turn to async to fix broken cjs build
+
+## 2024-03-19 v3.0.2
+
+- add package.json `main` & `types` field for used in cjs env like nestjs.
+
+## 2024-03-17 v3.0.1
+
+- add tests, pass tests
+
+## 2024-03-06 v3.0.0
+
+- rm previous content
+- add `lnsfSafe` symlink function
+
+## 2016-08-30 v2.0.0
+
+- rm `req.endAsync`
+
+## 2016-03-09 v1.2.0
+
+- update `promise.ify`, include bug fix
+
+## 2016-03-09 v1.1.0
+
+- instead `bluebird` with native Promise, and use `promise.ify`
+- remove co
+
+## unknown date v1.0.0
+
+- it's 1.0
+
+## 2016-03-06 v0.1.0
+
+- 其他都使用这个了

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Magicdawn(magicdawn@qq.com)
+
+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/README.md

@@ -0,0 +1,31 @@
+# needle-kit
+
+> Arya's needle, little but powerful.
+
+[![Build Status](https://img.shields.io/github/actions/workflow/status/magicdawn/needle-kit/ci.yml?style=flat-square&branch=main)](https://github.com/magicdawn/needle-kit/actions/workflows/ci.yml)
+[![Coverage Status](https://img.shields.io/codecov/c/github/magicdawn/needle-kit.svg?style=flat-square)](https://codecov.io/gh/magicdawn/needle-kit)
+[![npm version](https://img.shields.io/npm/v/needle-kit.svg?style=flat-square)](https://www.npmjs.com/package/needle-kit)
+[![npm downloads](https://img.shields.io/npm/dm/needle-kit.svg?style=flat-square)](https://www.npmjs.com/package/needle-kit)
+[![npm license](https://img.shields.io/npm/l/needle-kit.svg?style=flat-square)](http://magicdawn.mit-license.org)
+
+![](https://raw.githubusercontent.com/magicdawn/magicdawn/master/images/202403061424318.png)
+
+## Install
+
+```sh
+$ pnpm add needle-kit
+```
+
+## API
+
+```js
+const needleKit = require('needle-kit')
+```
+
+## Changelog
+
+[CHANGELOG.md](CHANGELOG.md)
+
+## License
+
+the MIT License http://magicdawn.mit-license.org

package/dist/index.d.ts

@@ -0,0 +1,104 @@
+import tildify from "tildify";
+import untildify from "untildify";
+import fg from "fast-glob";
+import PQueue from "p-queue";
+import shellEscape from "shell-escape";
+//#region src/fs/dir.d.ts
+/**
+ * search `searchName` in `currentPath`
+ * @example searchDirUp('/a/b/c/d', 'b') => '/a/b'
+ */
+export declare function searchDirUp(currentPath: string, searchName: string): string;
+/**
+ * Convert between `tilde path (~/foo)` and `absolute path (/Users/sindresorhus/foo)`
+ */
+export declare const HomeDir: {
+  /**
+   * Convert a tilde path to an absolute path: `~/dev` → `/Users/sindresorhus/dev`.
+   *
+   * Also expands `~username` when the username matches the current user.
+   */
+  expand: typeof untildify;
+  /**
+   * Convert an absolute path to a tilde path: `/Users/sindresorhus/dev` → `~/dev`.
+   */
+  fold: typeof tildify;
+};
+//#endregion
+//#region src/fs/glob.d.ts
+export declare function customFinderSort(files: string[]): string[];
+export declare function matchFromList(list: string[], pattern: string | string[], fgOptions?: Partial<fg.Options>): Promise<string[]>;
+//#endregion
+//#region src/fs/legacy-file.d.ts
+export declare function processLegacyFiles(targetFile: string, legacyFiles: string[]): Promise<void>;
+//#endregion
+//#region src/fs/local-file.d.ts
+export declare class LocalFile {
+  filePath: string;
+  /** 目录 */
+  dir: string;
+  /** 字段包含 name: 表示长名, 包括扩展名 */
+  basename: string;
+  /** 字段不含 name: 表示短名, 不包括扩展名 */
+  base: string;
+  /** 字段包含 name: 表示长名, 包括 . */
+  extname: string;
+  /** 字段不含 name: 表示短名, 不包括 . */
+  ext: string;
+  constructor(filePath: string);
+}
+export declare const localFile: (filePath: string) => LocalFile;
+//#endregion
+//#region src/fs/rename.d.ts
+export declare function transformFilename(file: string, { baseSuffix, transformBase, newExt }: {
+  baseSuffix?: string;
+  transformBase?: (base: string) => string;
+  newExt?: string;
+}): string;
+//#endregion
+//#region src/fs/symlink.d.ts
+/**
+ * `ln -sf`, but safe
+ *
+ * ## About Safe
+ * 1. if `path` not exists, create the symlink. (✅ safe)
+ * 2. if `path` exists as a symlink, delete existing symlink & create new one. (✅ safe)
+ * 3. if `path` exists as a normal file(not a symlink), an error will be thrown. (❌ not safe, since u may lost data)
+ *
+ * ## Features
+ * - `path` support tilde(~)
+ */
+export declare function lnsfSafe(target: string, path: string, { onExistingFile }?: {
+  onExistingFile?: 'delete' | 'throw';
+}): Promise<void>;
+/**
+ * `ln -sf`, but safe
+ *
+ * ## About Safe
+ * 1. if `path` not exists, create the symlink. (✅ safe)
+ * 2. if `path` exists as a symlink, delete existing symlink & create new one. (✅ safe)
+ * 3. if `path` exists as a normal file(not a symlink), an error will be thrown. (❌ not safe, since u may lost data)
+ *
+ * ## Features
+ * - `path` support tilde(~)
+ */
+export declare function lnsfSafeSync(target: string, path: string, { onExistingFile }?: {
+  onExistingFile?: 'delete' | 'throw';
+}): void;
+export declare function symlinkExists(symlinkPath: string): Promise<boolean>;
+export declare function symlinkExistsSync(symlinkPath: string): boolean;
+//#endregion
+//#region src/parallel.d.ts
+export declare function getConcurrency(): number;
+export declare function newPQueue(): PQueue<import("p-queue").PriorityQueue, import("p-queue").QueueAddOptions>;
+//#endregion
+//#region src/shell/index.d.ts
+/**
+ * @deprecated use shlex.quote instead
+ */
+export declare function escapeShellArg(val: string): string;
+/**
+ * @deprecated use shlex.quote instead
+ */
+export declare const escapeShellArgs: typeof shellEscape;
+//#endregion

package/dist/index.js

@@ -0,0 +1,212 @@
+import tildify from "tildify";
+import untildify from "untildify";
+import path, { dirname } from "node:path";
+import { finderSort } from "@magicdawn/finder-sort";
+import fg from "fast-glob";
+import mm from "micromatch";
+import { isDirectory, isFile, isSymlink } from "path-type";
+import fse, { ensureDir, ensureDirSync } from "fs-extra";
+import memoize from "memoize";
+import { lstatSync, rmSync, symlinkSync } from "node:fs";
+import { lstat, rm, symlink } from "node:fs/promises";
+import { availableParallelism } from "node:os";
+import PQueue from "p-queue";
+import z from "zod";
+import shellEscape from "shell-escape";
+//#region src/fs/dir.ts
+/**
+* search `searchName` in `currentPath`
+* @example searchDirUp('/a/b/c/d', 'b') => '/a/b'
+*/
+function searchDirUp(currentPath, searchName) {
+	const parts = currentPath.split("/");
+	if (!parts.includes(searchName)) throw new Error(`searchName(${searchName}) not in currentPath(${currentPath})`);
+	while (parts.length && parts.at(-1) !== searchName) parts.pop();
+	return parts.join("/");
+}
+/**
+* Convert between `tilde path (~/foo)` and `absolute path (/Users/sindresorhus/foo)`
+*/
+const HomeDir = {
+	/**
+	* Convert a tilde path to an absolute path: `~/dev` → `/Users/sindresorhus/dev`.
+	*
+	* Also expands `~username` when the username matches the current user.
+	*/
+	expand: untildify,
+	/**
+	* Convert an absolute path to a tilde path: `/Users/sindresorhus/dev` → `~/dev`.
+	*/
+	fold: tildify
+};
+//#endregion
+//#region src/fs/glob.ts
+function customFinderSort(files) {
+	return finderSort(files, { locale: "zh-CN" });
+}
+async function matchFromList(list, pattern, fgOptions) {
+	const hasSlash = [pattern].flat().some((p) => p.includes("/"));
+	const baseNameMatch = fgOptions?.baseNameMatch ?? !hasSlash;
+	const caseSensitive = fgOptions?.caseSensitiveMatch ?? true;
+	list = list.map((x) => path.resolve(x));
+	const queue = [];
+	for (const item of list) {
+		if (await isSymlink(item)) continue;
+		if (await isDirectory(item)) {
+			const files = await fg(pattern, {
+				cwd: item,
+				absolute: true,
+				onlyFiles: true,
+				followSymbolicLinks: false,
+				caseSensitiveMatch: caseSensitive,
+				baseNameMatch,
+				...fgOptions
+			});
+			queue.push(...customFinderSort(files));
+		} else if (await isFile(item)) queue.push(...mm([item], pattern, {
+			basename: baseNameMatch,
+			nocase: !caseSensitive
+		}));
+	}
+	return queue;
+}
+//#endregion
+//#region src/fs/legacy-file.ts
+async function processLegacyFiles(targetFile, legacyFiles) {
+	for (const legacyFile of legacyFiles) if (await fse.exists(legacyFile)) {
+		if (!await fse.exists(targetFile)) await fse.rename(legacyFile, targetFile);
+		else await fse.rm(legacyFile);
+	}
+}
+//#endregion
+//#region src/fs/local-file.ts
+var LocalFile = class {
+	filePath;
+	/** 目录 */
+	dir;
+	/** 字段包含 name: 表示长名, 包括扩展名 */
+	basename;
+	/** 字段不含 name: 表示短名, 不包括扩展名 */
+	base;
+	/** 字段包含 name: 表示长名, 包括 . */
+	extname;
+	/** 字段不含 name: 表示短名, 不包括 . */
+	ext;
+	constructor(filePath) {
+		this.filePath = filePath;
+		this.filePath = path.resolve(filePath).normalize();
+		const file = this.filePath;
+		this.dir = path.dirname(file);
+		this.basename = path.basename(file);
+		this.base = path.basename(file, path.extname(file));
+		this.extname = path.extname(file);
+		this.ext = path.extname(file).slice(1);
+	}
+};
+const newLocalFile = (filePath) => new LocalFile(filePath);
+const localFile = memoize(newLocalFile);
+//#endregion
+//#region src/fs/rename.ts
+function transformFilename(file, { baseSuffix = "", transformBase, newExt }) {
+	const dir = path.dirname(file);
+	let ext = path.extname(file);
+	let base = path.basename(file, ext);
+	if (newExt) {
+		ext = newExt;
+		if (!ext.startsWith(".")) ext = `.${ext}`;
+	}
+	if (baseSuffix) base += baseSuffix;
+	if (transformBase) base = transformBase(base);
+	return path.join(dir, base + ext);
+}
+//#endregion
+//#region src/fs/symlink.ts
+/**
+* `ln -sf`, but safe
+*
+* ## About Safe
+* 1. if `path` not exists, create the symlink. (✅ safe)
+* 2. if `path` exists as a symlink, delete existing symlink & create new one. (✅ safe)
+* 3. if `path` exists as a normal file(not a symlink), an error will be thrown. (❌ not safe, since u may lost data)
+*
+* ## Features
+* - `path` support tilde(~)
+*/
+async function lnsfSafe(target, path, { onExistingFile = "throw" } = {}) {
+	if (path.startsWith("~")) path = untildify(path);
+	await ensureDir(dirname(path));
+	if (!await symlinkExists(path)) {
+		await symlink(target, path);
+		return;
+	}
+	if ((await lstat(path)).isSymbolicLink()) await rm(path);
+	else if (onExistingFile === "delete") await rm(path);
+	else throw new Error(`path (${path}) in \`symlink(target,path)\` exists, it's a normal file(none symlink)`);
+	await symlink(target, path);
+}
+/**
+* `ln -sf`, but safe
+*
+* ## About Safe
+* 1. if `path` not exists, create the symlink. (✅ safe)
+* 2. if `path` exists as a symlink, delete existing symlink & create new one. (✅ safe)
+* 3. if `path` exists as a normal file(not a symlink), an error will be thrown. (❌ not safe, since u may lost data)
+*
+* ## Features
+* - `path` support tilde(~)
+*/
+function lnsfSafeSync(target, path, { onExistingFile = "throw" } = {}) {
+	if (path.startsWith("~")) path = untildify(path);
+	ensureDirSync(dirname(path));
+	if (!symlinkExistsSync(path)) {
+		symlinkSync(target, path);
+		return;
+	}
+	if (lstatSync(path).isSymbolicLink()) rmSync(path);
+	else if (onExistingFile === "delete") rmSync(path);
+	else throw new Error(`path (${path}) in \`symlink(target,path)\` exists, it's a normal file(none symlink)`);
+	symlinkSync(target, path);
+}
+async function symlinkExists(symlinkPath) {
+	try {
+		await lstat(symlinkPath);
+	} catch {
+		return false;
+	}
+	return true;
+}
+function symlinkExistsSync(symlinkPath) {
+	try {
+		lstatSync(symlinkPath);
+	} catch {
+		return false;
+	}
+	return true;
+}
+//#endregion
+//#region src/parallel.ts
+function getConcurrency() {
+	let concurrency = availableParallelism();
+	if (process.env.UV_THREADPOOL_SIZE) {
+		const parsed = z.coerce.number().min(concurrency).safeParse(process.env.UV_THREADPOOL_SIZE);
+		if (parsed.success) concurrency = parsed.data;
+	}
+	return concurrency;
+}
+function newPQueue() {
+	return new PQueue({ concurrency: getConcurrency() });
+}
+//#endregion
+//#region src/shell/index.ts
+/**
+* @deprecated use shlex.quote instead
+*/
+function escapeShellArg(val) {
+	return shellEscape([val]);
+}
+/**
+* @deprecated use shlex.quote instead
+*/
+const escapeShellArgs = shellEscape;
+//#endregion
+export { HomeDir, LocalFile, customFinderSort, escapeShellArg, escapeShellArgs, getConcurrency, lnsfSafe, lnsfSafeSync, localFile, matchFromList, newPQueue, processLegacyFiles, searchDirUp, symlinkExists, symlinkExistsSync, transformFilename };

package/package.json

@@ -0,0 +1,92 @@
+{
+  "name": "zhegu",
+  "type": "module",
+  "version": "3.8.0",
+  "description": "Arya's needle, little but powerful.",
+  "author": "magicdawn",
+  "license": "MIT",
+  "homepage": "https://github.com/magicdawn/zhegu",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/magicdawn/zhegu.git"
+  },
+  "bugs": {
+    "url": "https://github.com/magicdawn/zhegu/issues"
+  },
+  "keywords": [
+    "needle",
+    "kit"
+  ],
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "CHANGELOG.md",
+    "LICENSE",
+    "README.md",
+    "dist/",
+    "package.json"
+  ],
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org",
+    "access": "public"
+  },
+  "engines": {
+    "node": ">=20"
+  },
+  "dependencies": {
+    "@humanfs/node": "^0.17.0",
+    "@magicdawn/finder-sort": "^0.4.0",
+    "fast-glob": "^3.3.3",
+    "fs-extra": "^11.4.0",
+    "memoize": "^11.0.0",
+    "micromatch": "^4.0.8",
+    "p-queue": "^9.3.3",
+    "path-type": "^6.0.0",
+    "shell-escape": "^0.2.0",
+    "tildify": "^3.0.0",
+    "untildify": "^6.0.0",
+    "zod": "^4.6.2"
+  },
+  "devDependencies": {
+    "@magicdawn/eslint-config": "^1.6.17",
+    "@magicdawn/prettier-config": "^0.1.0",
+    "@types/fs-extra": "^11.0.4",
+    "@types/micromatch": "^4.0.10",
+    "@types/node": "^26.5.1",
+    "@types/shell-escape": "^0.2.3",
+    "@typescript-eslint/eslint-plugin": "^8.70.0",
+    "@typescript-eslint/parser": "^8.70.0",
+    "@typescript/native-preview": "7.0.0-dev.20260707.2",
+    "@vitest/coverage-v8": "^5.0.0",
+    "eslint": "^10.10.0",
+    "eslint-config-prettier": "^10.1.8",
+    "husky": "^9.1.7",
+    "lint-staged": "^17.5.1",
+    "prettier": "^3.9.6",
+    "tsdown": "^0.23.0",
+    "typescript": "^6.0.3",
+    "vitest": "^5.0.0"
+  },
+  "lint-staged": {
+    "*": [
+      "eslint --fix --no-warn-ignored",
+      "prettier --write --ignore-unknown"
+    ]
+  },
+  "scripts": {
+    "test": "vitest run",
+    "test:dev": "vitest",
+    "test-cover": "vitest run --coverage",
+    "dev": "tsdown --watch",
+    "build": "tsdown",
+    "typeswrong": "attw --pack .",
+    "typecheck": "tsgo --noEmit"
+  }
+}