chore(filesystem): move several path* utility functions to deepkit/core

packages/core/index.ts

@@ -24,3 +24,4 @@ export * from './src/reflection.js';
 export * from './src/url.js';
 export * from './src/array.js';
 export * from './src/types.js';
+export * from './src/path.js';

packages/core/src/path.ts

@@ -0,0 +1,43 @@
+
+/**
+ * Normalizes the given path.
+ * Removes duplicate slashes, removes trailing slashes, adds a leading slash.
+ */
+export function pathNormalize(path: string): string {
+    path = path[0] !== '/' ? '/' + path : path;
+    path = path.length > 1 && path[path.length - 1] === '/' ? path.slice(0, -1) : path;
+    return path.replace(/\/+/g, '/');
+}
+
+/**
+ * Returns the directory (dirname) of the given path.
+ */
+export function pathDirectory(path: string): string {
+    if (path === '/') return '/';
+    const lastSlash = path.lastIndexOf('/');
+    return lastSlash <= 0 ? '/' : path.slice(0, lastSlash);
+}
+
+/**
+ * Returns the basename of the given path.
+ */
+export function pathBasename(path: string): string {
+    const lastSlash = path.lastIndexOf('/');
+    return lastSlash === -1 ? path : path.slice(lastSlash + 1);
+}
+
+/**
+ * Returns the extension of the given path.
+ */
+export function pathExtension(path: string): string {
+    const basename = pathBasename(path);
+    const lastDot = basename.lastIndexOf('.');
+    return lastDot === -1 ? '' : basename.slice(lastDot + 1);
+}
+
+export function pathJoin(...paths: string[]): string {
+    return '/' + paths
+        .map(v => pathNormalize(v).slice(1))
+        .filter(v => !!v)
+        .join('/');
+}

packages/filesystem-aws-s3/src/s3-adapter.ts

@@ -1,4 +1,5 @@
-import { FilesystemAdapter, FilesystemError, FilesystemFile, FileVisibility, pathDirectory, Reporter } from '@deepkit/filesystem';
+import { FilesystemAdapter, FilesystemError, FilesystemFile, FileVisibility, Reporter } from '@deepkit/filesystem';
+import { pathDirectory } from '@deepkit/core';
 import {
     CopyObjectCommand,
     DeleteObjectsCommand,

packages/filesystem-ftp/src/ftp-adapter.ts

@@ -1,4 +1,5 @@
-import { FilesystemAdapter, FilesystemFile, FileType, FileVisibility, pathBasename, pathDirectory, Reporter, resolveFilesystemPath } from '@deepkit/filesystem';
+import { FilesystemAdapter, FilesystemFile, FileType, FileVisibility, Reporter, resolveFilesystemPath } from '@deepkit/filesystem';
+import { pathDirectory, pathBasename } from '@deepkit/core';
 import { Client, FileInfo, UnixPermissions } from 'basic-ftp';
 import type { ConnectionOptions as TLSConnectionOptions } from 'tls';
 import { Readable, Writable } from 'stream';

packages/filesystem-google/src/google-adapter.ts

@@ -1,4 +1,5 @@
-import { FilesystemAdapter, FilesystemFile, FileVisibility, pathDirectory, pathNormalize, Reporter, resolveFilesystemPath } from '@deepkit/filesystem';
+import { FilesystemAdapter, FilesystemFile, FileVisibility, Reporter, resolveFilesystemPath } from '@deepkit/filesystem';
+import { pathDirectory, pathNormalize } from '@deepkit/core';
 import { Bucket, File, Storage, StorageOptions } from '@google-cloud/storage';
 import { fixAsyncOperation } from '@deepkit/core';
 

packages/filesystem-sftp/src/sftp-adapter.ts

@@ -1,4 +1,5 @@
-import { FileType, FileVisibility, pathBasename, pathDirectory, Reporter, resolveFilesystemPath, FilesystemAdapter, FilesystemFile } from '@deepkit/filesystem';
+import { FileType, FileVisibility, Reporter, resolveFilesystemPath, FilesystemAdapter, FilesystemFile } from '@deepkit/filesystem';
+import { pathDirectory, pathBasename } from '@deepkit/core';
 import Client, { ConnectOptions, FileInfo } from 'ssh2-sftp-client';
 import { Readable } from 'stream';
 import { asyncOperation } from '@deepkit/core';

packages/filesystem/src/filesystem.ts

@@ -1,4 +1,4 @@
-import { asyncOperation, Inject, isFunction } from '@deepkit/core';
+import { asyncOperation, Inject, isFunction, pathBasename, pathExtension, pathJoin, pathNormalize } from '@deepkit/core';
 import { readFile } from 'fs/promises';
 
 export type FileType = 'file' | 'directory';
@@ -305,13 +305,6 @@ export function resolveFilesystemPath(path: FilesystemPath): string {
     return path.path;
 }
 
-export function pathJoin(...paths: string[]): string {
-    return '/' + paths
-        .map(v => pathNormalize(v).slice(1))
-        .filter(v => !!v)
-        .join('/');
-}
-
 export interface FilesystemOptions {
     /**
      * Default visibility for new files.
@@ -565,6 +558,8 @@ export class Filesystem {
      * Reads the contents of the given path as binary.
      *
      * Returns a Progress object that can be used to track the progress of the operation.
+     *
+     * @throws Error if the file does not exist.
      */
     read(path: FilesystemPath): Operation<Uint8Array> {
         path = resolveFilesystemPath(path);
@@ -577,6 +572,8 @@ export class Filesystem {
      * Reads the contents of the given path as string.
      *
      * Returns a Progress object that can be used to track the progress of the operation.
+     *
+     * @throws Error if the file does not exist.
      */
     readAsText(path: FilesystemPath): Operation<string> {
         path = resolveFilesystemPath(path);
@@ -729,42 +726,6 @@ export class Filesystem {
     }
 }
 
-/**
- * Normalizes the given path.
- * Removes duplicate slashes, removes trailing slashes, adds a leading slash.
- */
-export function pathNormalize(path: string): string {
-    path = path[0] !== '/' ? '/' + path : path;
-    path = path.length > 1 && path[path.length - 1] === '/' ? path.slice(0, -1) : path;
-    return path.replace(/\/+/g, '/');
-}
-
-/**
- * Returns the directory (dirname) of the given path.
- */
-export function pathDirectory(path: string): string {
-    if (path === '/') return '/';
-    const lastSlash = path.lastIndexOf('/');
-    return lastSlash <= 0 ? '/' : path.slice(0, lastSlash);
-}
-
-/**
- * Returns the basename of the given path.
- */
-export function pathBasename(path: string): string {
-    const lastSlash = path.lastIndexOf('/');
-    return lastSlash === -1 ? path : path.slice(lastSlash + 1);
-}
-
-/**
- * Returns the extension of the given path.
- */
-export function pathExtension(path: string): string {
-    const basename = pathBasename(path);
-    const lastDot = basename.lastIndexOf('.');
-    return lastDot === -1 ? '' : basename.slice(lastDot + 1);
-}
-
 /**
  * A sorting comparator for FilesystemFile that sorts directories first, then by path.
  */

packages/filesystem/src/local-adapter.ts

@@ -1,4 +1,5 @@
-import { FileType, FileVisibility, pathDirectory, pathNormalize, Reporter, resolveFilesystemPath, FilesystemAdapter, FilesystemFile } from './filesystem.js';
+import { FileType, FileVisibility, Reporter, FilesystemAdapter, FilesystemFile } from './filesystem.js';
+import { pathDirectory, pathNormalize } from '@deepkit/core';
 import type * as fs from 'fs/promises';
 
 export interface FilesystemLocalAdapterOptions {

packages/filesystem/src/memory-adapter.ts

@@ -1,4 +1,5 @@
-import { FilesystemAdapter, FilesystemFile, FilesystemFileNotFound, FileVisibility, pathDirectories, pathDirectory, Reporter } from './filesystem.js';
+import { pathDirectory } from '@deepkit/core';
+import { FilesystemAdapter, FilesystemFile, FilesystemFileNotFound, FileVisibility, pathDirectories, Reporter } from './filesystem.js';
 
 export interface FilesystemMemoryAdapterOptions {
 }

packages/filesystem/tests/filesystem.spec.ts

@@ -19,7 +19,7 @@ test('url', async () => {
     }
 
     //this test is about URL mapping feature from Filesystem
-    const url = await filesystem.publicUrl('/file1.txt');
+    const url = filesystem.publicUrl('/file1.txt');
     expect(url).toBe('http://localhost/assets/file1.txt');
 
     await filesystem.close();