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

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 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)
 
 

package/lib/cjs/index.cjs

@@ -54,14 +54,16 @@ class PathResolver {
         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);
@@ -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;

package/lib/esm/index.mjs

@@ -48,14 +48,16 @@ class PathResolver {
         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);
@@ -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;

package/lib/types/index.d.ts

@@ -27,8 +27,8 @@ declare class PathResolver 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;
@@ -61,7 +61,7 @@ declare class WorkspacePathResolver implements IWorkspacePathResolver {
     constructor(root: string, pathResolver: IPathResolver);
     ensureSafePath(filepath: string, message?: string | undefined): void | never;
     isSafePath(filepath: string): boolean;
-    relative(filepath: string): string | never;
+    relative(filepath: string, preferSlash?: boolean): string | never;
     resolve(filepath: string): string | never;
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@guanghechen/path",
-  "version": "1.0.0-alpha.6",
+  "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.5",
+    "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.5/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": "e42cabded60b75856018c6f216d08b3d830a29b2"
+  "gitHead": "38989b3735fe6981d74cadb63568657247b77e14"
 }