@guanghechen/path 1.0.0-alpha.5 → 1.0.0-alpha.7

package/CHANGELOG.md

@@ -3,6 +3,28 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [1.0.0-alpha.7](https://github.com/guanghechen/sora/compare/@guanghechen/path@1.0.0-alpha.6...@guanghechen/path@1.0.0-alpha.7) (2023-10-16)
+
+
+### Performance Improvements
+
+* 🎨 support 'preferSlash' option for 'relativexx' funcs ([e59d415](https://github.com/guanghechen/sora/commit/e59d415df8272f6a5b8afed1f57152e4b44c89b8))
+
+
+
+
+
+# [1.0.0-alpha.6](https://github.com/guanghechen/sora/compare/@guanghechen/path@1.0.0-alpha.5...@guanghechen/path@1.0.0-alpha.6) (2023-10-16)
+
+
+### Performance Improvements
+
+* :art:  refactor @guanghechen/path ([8952da3](https://github.com/guanghechen/sora/commit/8952da3154a042a10e76b356da7461a1f8ad8582))
+
+
+
+
+
 # [1.0.0-alpha.5](https://github.com/guanghechen/sora/compare/@guanghechen/path@1.0.0-alpha.4...@guanghechen/path@1.0.0-alpha.5) (2023-10-16)
 
 

package/lib/cjs/index.cjs

@@ -9,8 +9,8 @@ function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
 
 var path__default = /*#__PURE__*/_interopDefault(path);
 
-const clazz$1 = 'PhysicalPathResolver';
-class PhysicalPathResolver {
+const clazz$1 = 'PathResolver';
+class PathResolver {
     basename(filepath) {
         this.ensureAbsolute(filepath);
         const p = this.normalize(filepath);
@@ -54,14 +54,16 @@ class PhysicalPathResolver {
         this.ensureAbsolute(filepath);
         return this._internalNormalize(filepath);
     }
-    relative(from, to) {
+    relative(from, to, preferSlash = false) {
         this.ensureAbsolute(from, `[${clazz$1}.relative] from is not an absolute path: ${from}`);
         this.ensureAbsolute(to, `[${clazz$1}.relative] to is not an absolute path: ${to}`);
-        return this._internalRelative(from, to);
+        const relativePath = this._internalRelative(from, to);
+        return preferSlash ? relativePath.replaceAll('\\', '/') : relativePath;
     }
-    safeRelative(root, filepath) {
+    safeRelative(root, filepath, preferSlash = false) {
         this.ensureSafeRelative(root, filepath);
-        return this._internalSafeRelative(root, filepath);
+        const relativePath = this._internalSafeRelative(root, filepath);
+        return preferSlash ? relativePath.replaceAll('\\', '/') : relativePath;
     }
     safeResolve(root, filepath) {
         this.ensureSafeRelative(root, filepath);
@@ -92,8 +94,8 @@ class PhysicalPathResolver {
     }
 }
 
-const clazz = 'VirtualPathResolver';
-class VirtualPathResolver {
+const clazz = 'UrlPathResolver';
+class UrlPathResolver {
     basename(filepath) {
         this.ensureAbsolute(filepath);
         const p = this.normalize(filepath);
@@ -240,9 +242,9 @@ class WorkspacePathResolver {
         const { root, pathResolver } = this;
         return pathResolver.isSafeRelative(root, filepath);
     }
-    relative(filepath) {
+    relative(filepath, preferSlash) {
         const { root, pathResolver } = this;
-        return pathResolver.safeRelative(root, filepath);
+        return pathResolver.safeRelative(root, filepath, preferSlash);
     }
     resolve(filepath) {
         const { root, pathResolver } = this;
@@ -250,32 +252,16 @@ class WorkspacePathResolver {
     }
 }
 
-class PhysicalWorkspacePathResolver extends WorkspacePathResolver {
-    constructor(root) {
-        const pathResolver = new PhysicalPathResolver();
-        super(root, pathResolver);
-    }
-}
-
-class VirtualWorkspacePathResolver extends WorkspacePathResolver {
-    constructor(root) {
-        const pathResolver = new VirtualPathResolver();
-        super(root, pathResolver);
-    }
-}
-
-const physicalPathResolver = new PhysicalPathResolver();
-const virtualPathResolver = new VirtualPathResolver();
+const pathResolver = new PathResolver();
+const urlPathResolver = new UrlPathResolver();
 
-exports.PhysicalPathResolver = PhysicalPathResolver;
-exports.PhysicalWorkspacePathResolver = PhysicalWorkspacePathResolver;
-exports.VirtualPathResolver = VirtualPathResolver;
-exports.VirtualWorkspacePathResolver = VirtualWorkspacePathResolver;
+exports.PathResolver = PathResolver;
+exports.UrlPathResolver = UrlPathResolver;
 exports.WorkspacePathResolver = WorkspacePathResolver;
 exports.findNearestFilepath = findNearestFilepath;
 exports.locateNearestFilepath = locateNearestFilepath;
-exports.physicalPathResolver = physicalPathResolver;
-exports.virtualPathResolver = virtualPathResolver;
+exports.pathResolver = pathResolver;
+exports.urlPathResolver = urlPathResolver;
 Object.keys(path_types).forEach(function (k) {
     if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
         enumerable: true,

package/lib/esm/index.mjs

@@ -3,8 +3,8 @@ import { existsSync, readdirSync } from 'node:fs';
 import { fileURLToPath } from 'node:url';
 export * from '@guanghechen/path.types';
 
-const clazz$1 = 'PhysicalPathResolver';
-class PhysicalPathResolver {
+const clazz$1 = 'PathResolver';
+class PathResolver {
     basename(filepath) {
         this.ensureAbsolute(filepath);
         const p = this.normalize(filepath);
@@ -48,14 +48,16 @@ class PhysicalPathResolver {
         this.ensureAbsolute(filepath);
         return this._internalNormalize(filepath);
     }
-    relative(from, to) {
+    relative(from, to, preferSlash = false) {
         this.ensureAbsolute(from, `[${clazz$1}.relative] from is not an absolute path: ${from}`);
         this.ensureAbsolute(to, `[${clazz$1}.relative] to is not an absolute path: ${to}`);
-        return this._internalRelative(from, to);
+        const relativePath = this._internalRelative(from, to);
+        return preferSlash ? relativePath.replaceAll('\\', '/') : relativePath;
     }
-    safeRelative(root, filepath) {
+    safeRelative(root, filepath, preferSlash = false) {
         this.ensureSafeRelative(root, filepath);
-        return this._internalSafeRelative(root, filepath);
+        const relativePath = this._internalSafeRelative(root, filepath);
+        return preferSlash ? relativePath.replaceAll('\\', '/') : relativePath;
     }
     safeResolve(root, filepath) {
         this.ensureSafeRelative(root, filepath);
@@ -86,8 +88,8 @@ class PhysicalPathResolver {
     }
 }
 
-const clazz = 'VirtualPathResolver';
-class VirtualPathResolver {
+const clazz = 'UrlPathResolver';
+class UrlPathResolver {
     basename(filepath) {
         this.ensureAbsolute(filepath);
         const p = this.normalize(filepath);
@@ -234,9 +236,9 @@ class WorkspacePathResolver {
         const { root, pathResolver } = this;
         return pathResolver.isSafeRelative(root, filepath);
     }
-    relative(filepath) {
+    relative(filepath, preferSlash) {
         const { root, pathResolver } = this;
-        return pathResolver.safeRelative(root, filepath);
+        return pathResolver.safeRelative(root, filepath, preferSlash);
     }
     resolve(filepath) {
         const { root, pathResolver } = this;
@@ -244,21 +246,7 @@ class WorkspacePathResolver {
     }
 }
 
-class PhysicalWorkspacePathResolver extends WorkspacePathResolver {
-    constructor(root) {
-        const pathResolver = new PhysicalPathResolver();
-        super(root, pathResolver);
-    }
-}
-
-class VirtualWorkspacePathResolver extends WorkspacePathResolver {
-    constructor(root) {
-        const pathResolver = new VirtualPathResolver();
-        super(root, pathResolver);
-    }
-}
-
-const physicalPathResolver = new PhysicalPathResolver();
-const virtualPathResolver = new VirtualPathResolver();
+const pathResolver = new PathResolver();
+const urlPathResolver = new UrlPathResolver();
 
-export { PhysicalPathResolver, PhysicalWorkspacePathResolver, VirtualPathResolver, VirtualWorkspacePathResolver, WorkspacePathResolver, findNearestFilepath, locateNearestFilepath, physicalPathResolver, virtualPathResolver };
+export { PathResolver, UrlPathResolver, WorkspacePathResolver, findNearestFilepath, locateNearestFilepath, pathResolver, urlPathResolver };

package/lib/types/index.d.ts

@@ -18,7 +18,7 @@ declare function locateNearestFilepath(currentDir: string, filenames: string | R
  */
 declare function findNearestFilepath(currentDir: string, predicate: (filepath: string) => boolean): string | null;
 
-declare class PhysicalPathResolver implements IPathResolver {
+declare class PathResolver implements IPathResolver {
     basename(filepath: string): string;
     ensureAbsolute(filepath: string, message?: string | undefined): void | never;
     ensureSafeRelative(root: string, filepath: string, message?: string | undefined): void | never;
@@ -27,8 +27,8 @@ declare class PhysicalPathResolver implements IPathResolver {
     isSafeRelative(root: string, filepath: string): boolean;
     join(filepath: string, ...pathPieces: string[]): string | never;
     normalize(filepath: string): string | never;
-    relative(from: string, to: string): string | never;
-    safeRelative(root: string, filepath: string): string;
+    relative(from: string, to: string, preferSlash?: boolean): string | never;
+    safeRelative(root: string, filepath: string, preferSlash?: boolean): string;
     safeResolve(root: string, filepath: string): string;
     protected _internalNormalize(filepath: string): string;
     protected _internalRelative(from_: string, to_: string): string;
@@ -36,21 +36,7 @@ declare class PhysicalPathResolver implements IPathResolver {
     protected _internalSafeResolve(root: string, filepath_: string): string;
 }
 
-declare class WorkspacePathResolver implements IWorkspacePathResolver {
-    readonly root: string;
-    readonly pathResolver: IPathResolver;
-    constructor(root: string, pathResolver: IPathResolver);
-    ensureSafePath(filepath: string, message?: string | undefined): void | never;
-    isSafePath(filepath: string): boolean;
-    relative(filepath: string): string | never;
-    resolve(filepath: string): string | never;
-}
-
-declare class PhysicalWorkspacePathResolver extends WorkspacePathResolver implements IWorkspacePathResolver {
-    constructor(root: string);
-}
-
-declare class VirtualPathResolver implements IPathResolver {
+declare class UrlPathResolver implements IPathResolver {
     basename(filepath: string): string;
     ensureAbsolute(filepath: string, message?: string | undefined): void | never;
     ensureSafeRelative(root: string, filepath: string, message?: string | undefined): void;
@@ -69,11 +55,17 @@ declare class VirtualPathResolver implements IPathResolver {
     protected _internalSafeResolve(root: string, filepath_: string): string;
 }
 
-declare class VirtualWorkspacePathResolver extends WorkspacePathResolver implements IWorkspacePathResolver {
-    constructor(root: string);
+declare class WorkspacePathResolver implements IWorkspacePathResolver {
+    readonly root: string;
+    readonly pathResolver: IPathResolver;
+    constructor(root: string, pathResolver: IPathResolver);
+    ensureSafePath(filepath: string, message?: string | undefined): void | never;
+    isSafePath(filepath: string): boolean;
+    relative(filepath: string, preferSlash?: boolean): string | never;
+    resolve(filepath: string): string | never;
 }
 
-declare const physicalPathResolver: IPathResolver;
-declare const virtualPathResolver: IPathResolver;
+declare const pathResolver: IPathResolver;
+declare const urlPathResolver: IPathResolver;
 
-export { PhysicalPathResolver, PhysicalWorkspacePathResolver, VirtualPathResolver, VirtualWorkspacePathResolver, WorkspacePathResolver, findNearestFilepath, locateNearestFilepath, physicalPathResolver, virtualPathResolver };
+export { PathResolver, UrlPathResolver, WorkspacePathResolver, findNearestFilepath, locateNearestFilepath, pathResolver, urlPathResolver };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@guanghechen/path",
-  "version": "1.0.0-alpha.5",
+  "version": "1.0.0-alpha.7",
   "description": "Path utils.",
   "author": {
     "name": "guanghechen",
@@ -8,10 +8,10 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/guanghechen/sora/tree/@guanghechen/path@1.0.0-alpha.4",
+    "url": "https://github.com/guanghechen/sora/tree/@guanghechen/path@1.0.0-alpha.6",
     "directory": "packages/path"
   },
-  "homepage": "https://github.com/guanghechen/sora/tree/@guanghechen/path@1.0.0-alpha.4/packages/path#readme",
+  "homepage": "https://github.com/guanghechen/sora/tree/@guanghechen/path@1.0.0-alpha.6/packages/path#readme",
   "type": "module",
   "exports": {
     ".": {
@@ -43,7 +43,7 @@
     "test": "node --experimental-vm-modules ../../node_modules/.bin/jest --config ../../jest.config.mjs --rootDir ."
   },
   "dependencies": {
-    "@guanghechen/path.types": "^1.0.0-alpha.4"
+    "@guanghechen/path.types": "^1.0.0-alpha.5"
   },
-  "gitHead": "5970cec8f9021212fd2009f40f65f0abf5ba77ec"
+  "gitHead": "38989b3735fe6981d74cadb63568657247b77e14"
 }