@zokugun/fs-path 0.1.0

package/lib/esm/types.d.mts

@@ -0,0 +1,34 @@
+import { type Target } from '@zokugun/fs-path-sanitize';
+import { type DResult } from '@zokugun/xtry';
+export type PlatformPath = {
+    readonly delimiter: ';' | ':';
+    readonly separator: '\\' | '/';
+    readonly posix: PlatformPath;
+    readonly win32: PlatformPath;
+    absolute: (...paths: string[]) => string;
+    dir: (path: string) => string;
+    extension: (path: string) => string;
+    isAbsolute: (path: string) => boolean;
+    isInDir: (file: string, dir: string) => boolean;
+    isInDirs: (file: string, directories: string[]) => boolean;
+    isSafePath: (path: string, options?: {
+        parent?: string | null;
+        parents?: string | string[] | null;
+        target?: Target | 'auto';
+    }) => boolean;
+    isSafeSegment: (segment: string, target?: Target | 'auto') => boolean;
+    join: (...paths: string[]) => string;
+    leaf: (path: string, suffix?: string) => string;
+    matchesGlob?: (path: string, pattern: string) => boolean;
+    normalize: (path: string) => string;
+    parent: (file: string) => string;
+    relative: (from: string, to: string) => string;
+    resolve: (...paths: string[]) => string;
+    sanitize: (path: string, options?: {
+        parent?: string | null;
+        parents?: string | string[] | null;
+        replacement?: string | null;
+        target?: Target | 'auto';
+    }) => DResult<string>;
+    untildify: (path: string) => string;
+};

package/lib/esm/types.mjs

@@ -0,0 +1 @@
+export {};

package/lib/esm/untildify.d.mts

@@ -0,0 +1,3 @@
+import type path from 'node:path';
+import { type PlatformPath } from './types.mjs';
+export declare function untildify(_nodePath: path.PlatformPath, _localPath: PlatformPath): (path: string) => string;

package/lib/esm/untildify.mjs

@@ -0,0 +1,22 @@
+import { isString } from '@zokugun/is-it-type';
+import { getHome } from './utils/get-home.mjs';
+import { getUserHome } from './utils/get-user-home.mjs';
+const TILDE_REGEX = /^~(?=$|\/|\\)/;
+const USER_REGEX = /^~([^/\\]+)(.*)$/;
+export function untildify(_nodePath, _localPath) {
+    return (path) => {
+        const homedir = getHome();
+        if (isString(homedir) && TILDE_REGEX.test(path)) {
+            return homedir + path.slice(1);
+        }
+        const match = USER_REGEX.exec(path);
+        if (match) {
+            const [, username, rest] = match;
+            const userHome = getUserHome(username);
+            if (isString(userHome)) {
+                return userHome + rest;
+            }
+        }
+        return path;
+    };
+}

package/lib/esm/utils/get-home.d.mts

@@ -0,0 +1 @@
+export declare function getHome(): string;

package/lib/esm/utils/get-home.mjs

@@ -0,0 +1,6 @@
+import os from 'node:os';
+let $home;
+export function getHome() {
+    $home ??= os.homedir();
+    return $home;
+}

package/lib/esm/utils/get-user-home.d.mts

@@ -0,0 +1 @@
+export declare function getUserHome(username: string): string | null;

package/lib/esm/utils/get-user-home.mjs

@@ -0,0 +1,12 @@
+import os from 'node:os';
+import { getHome } from './get-home.mjs';
+let $username;
+export function getUserHome(username) {
+    $username ??= os.userInfo().username;
+    if (username === $username) {
+        return getHome();
+    }
+    else {
+        return null;
+    }
+}

package/package.json

@@ -0,0 +1,83 @@
+{
+	"name": "@zokugun/fs-path",
+	"description": "Path utilities complementing the builtin path module",
+	"version": "0.1.0",
+	"author": {
+		"name": "Baptiste Augrain",
+		"email": "daiyam@zokugun.org"
+	},
+	"license": "MIT",
+	"homepage": "https://github.com/zokugun/node-fs-path",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/zokugun/node-fs-path.git"
+	},
+	"bugs": {
+		"url": "https://github.com/zokugun/node-fs-path/discussions/categories/issue-triage"
+	},
+	"type": "module",
+	"main": "lib/cjs/index.cjs",
+	"module": "lib/esm/index.mjs",
+	"scripts": {
+		"audit:fix": "npm audit fix --min-release-age=0",
+		"build": "npm run clean && npm run build:lib",
+		"build:lib": "tsc-leda generate",
+		"build:package": "tsc-leda update-package && npm run lint:package",
+		"ci:lint": "zizmor .",
+		"ci:lint:fix": "zizmor . --fix=all",
+		"clean": "rimraf lib; rimraf .src; rimraf .test",
+		"compile:src": "tsc -p src",
+		"compile:test": "tsc -p test",
+		"lint": "xo",
+		"lint:all": "npm audit && npm run lint:package && npm run ci:lint && npm run lint",
+		"lint:fix": "xo --fix",
+		"lint:package": "fixpack || true",
+		"prepack": "npm run build",
+		"prepare": "husky; npm run lint:package",
+		"release": "release-it",
+		"test": "vitest run --reporter tree",
+		"test:coverage": "vitest run --reporter tree --coverage --coverage.reporter text",
+		"test:ui": "vitest --ui --coverage",
+		"test:watch": "vitest",
+		"update:artifacts": "artifact update",
+		"update:ci": "PINACT_MIN_AGE=7 pinact run --update",
+		"update:deps": "taze --all",
+		"watch:build": "tsc-watch -p src --onSuccess 'npm run build'",
+		"watch:src": "tsc-watch -p src",
+		"watch:test": "tsc-watch -p test"
+	},
+	"dependencies": {
+		"@zokugun/fs-path-sanitize": "0.1.0",
+		"@zokugun/is-it-type": "0.8.1",
+		"@zokugun/xtry": "0.11.6"
+	},
+	"devDependencies": {
+		"@commitlint/cli": "20.5.3",
+		"@commitlint/config-conventional": "20.5.3",
+		"@types/node": "20.19.39",
+		"@vitest/coverage-v8": "4.1.5",
+		"@vitest/ui": "4.1.5",
+		"@zokugun/fs-extra-plus": "0.4.1",
+		"@zokugun/tsc-leda": "0.4.1",
+		"fixpack": "4.0.0",
+		"globby": "16.2.0",
+		"husky": "9.1.7",
+		"lint-staged": "16.4.0",
+		"release-it": "20.0.1",
+		"rimraf": "6.1.3",
+		"taze": "19.14.1",
+		"tsc-watch": "7.2.0",
+		"typescript": "5.9.3",
+		"vitest": "4.1.5",
+		"xo": "0.60.0"
+	},
+	"overrides": {
+		"ajv": {
+			"fast-uri": "3.1.2"
+		},
+		"@inquirer/core": {
+			"mute-stream": "3.0.0"
+		}
+	},
+	"keywords": []
+}