@guanghechen/path 1.0.0-alpha.13 → 1.0.0-alpha.15

package/CHANGELOG.md

@@ -3,6 +3,25 @@
 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.15](https://github.com/guanghechen/sora/compare/@guanghechen/path@1.0.0-alpha.14...@guanghechen/path@1.0.0-alpha.15) (2024-01-17)
+
+
+### Performance Improvements
+
+* 🎨 support preferSlash option ([cf67725](https://github.com/guanghechen/sora/commit/cf67725983902912d31033bdd652ea8dbb36dd3b))
+
+
+
+
+
+# [1.0.0-alpha.14](https://github.com/guanghechen/sora/compare/@guanghechen/path@1.0.0-alpha.13...@guanghechen/path@1.0.0-alpha.14) (2023-12-04)
+
+**Note:** Version bump only for package @guanghechen/path
+
+
+
+
+
 # [1.0.0-alpha.13](https://github.com/guanghechen/sora/compare/@guanghechen/path@1.0.0-alpha.12...@guanghechen/path@1.0.0-alpha.13) (2023-12-02)
 
 **Note:** Version bump only for package @guanghechen/path

package/lib/cjs/index.cjs

@@ -11,6 +11,10 @@ var path__default = /*#__PURE__*/_interopDefault(path);
 
 const clazz$1 = 'PathResolver';
 class PathResolver {
+    defaultPreferSlash;
+    constructor(params = {}) {
+        this.defaultPreferSlash = params.preferSlash ?? false;
+    }
     basename(filepath) {
         this.ensureAbsolute(filepath);
         const p = this.normalize(filepath);
@@ -54,13 +58,15 @@ class PathResolver {
         this.ensureAbsolute(filepath);
         return this._internalNormalize(filepath);
     }
-    relative(from, to, preferSlash = false) {
+    relative(from, to, preferSlash_) {
+        const preferSlash = preferSlash_ ?? this.defaultPreferSlash;
         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}`);
         const relativePath = this._internalRelative(from, to);
         return preferSlash ? relativePath.replaceAll('\\', '/') : relativePath;
     }
-    safeRelative(root, filepath, preferSlash = false) {
+    safeRelative(root, filepath, preferSlash_) {
+        const preferSlash = preferSlash_ ?? this.defaultPreferSlash;
         this.ensureSafeRelative(root, filepath);
         const relativePath = this._internalSafeRelative(root, filepath);
         return preferSlash ? relativePath.replaceAll('\\', '/') : relativePath;

package/lib/esm/index.mjs

@@ -5,6 +5,10 @@ export * from '@guanghechen/path.types';
 
 const clazz$1 = 'PathResolver';
 class PathResolver {
+    defaultPreferSlash;
+    constructor(params = {}) {
+        this.defaultPreferSlash = params.preferSlash ?? false;
+    }
     basename(filepath) {
         this.ensureAbsolute(filepath);
         const p = this.normalize(filepath);
@@ -48,13 +52,15 @@ class PathResolver {
         this.ensureAbsolute(filepath);
         return this._internalNormalize(filepath);
     }
-    relative(from, to, preferSlash = false) {
+    relative(from, to, preferSlash_) {
+        const preferSlash = preferSlash_ ?? this.defaultPreferSlash;
         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}`);
         const relativePath = this._internalRelative(from, to);
         return preferSlash ? relativePath.replaceAll('\\', '/') : relativePath;
     }
-    safeRelative(root, filepath, preferSlash = false) {
+    safeRelative(root, filepath, preferSlash_) {
+        const preferSlash = preferSlash_ ?? this.defaultPreferSlash;
         this.ensureSafeRelative(root, filepath);
         const relativePath = this._internalSafeRelative(root, filepath);
         return preferSlash ? relativePath.replaceAll('\\', '/') : relativePath;

package/lib/types/index.d.ts

@@ -1,4 +1,4 @@
-import { IPathResolver, IWorkspacePathResolver } from '@guanghechen/path.types';
+import { IPathResolver, IPathResolverParams, IWorkspacePathResolver } from '@guanghechen/path.types';
 export * from '@guanghechen/path.types';
 
 /**
@@ -19,6 +19,8 @@ declare function locateNearestFilepath(currentDir: string, filenames: string | R
 declare function findNearestFilepath(currentDir: string, predicate: (filepath: string) => boolean): string | null;
 
 declare class PathResolver implements IPathResolver {
+    protected readonly defaultPreferSlash: boolean;
+    constructor(params?: IPathResolverParams);
     basename(filepath: string): string;
     ensureAbsolute(filepath: string, message?: string | undefined): void | never;
     ensureSafeRelative(root: string, filepath: string, message?: string | undefined): void | never;
@@ -27,8 +29,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, preferSlash?: boolean): string | never;
-    safeRelative(root: string, filepath: string, preferSlash?: boolean): 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;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@guanghechen/path",
-  "version": "1.0.0-alpha.13",
+  "version": "1.0.0-alpha.15",
   "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.12",
+    "url": "https://github.com/guanghechen/sora/tree/@guanghechen/path@1.0.0-alpha.14",
     "directory": "packages/path"
   },
-  "homepage": "https://github.com/guanghechen/sora/tree/@guanghechen/path@1.0.0-alpha.12/packages/path#readme",
+  "homepage": "https://github.com/guanghechen/sora/tree/@guanghechen/path@1.0.0-alpha.14/packages/path#readme",
   "type": "module",
   "exports": {
     ".": {
@@ -40,7 +40,7 @@
     "test": "node --experimental-vm-modules ../../node_modules/.bin/jest --config ../../jest.config.mjs --rootDir ."
   },
   "dependencies": {
-    "@guanghechen/path.types": "^1.0.0-alpha.10"
+    "@guanghechen/path.types": "^1.0.0-alpha.12"
   },
-  "gitHead": "b50ff950f423d8e70d0b3f622a24e1fbd2ce483a"
+  "gitHead": "655e50971a501392dd4d234953ea45b8e08e2f79"
 }