cspell-io 8.1.2 → 8.2.0

package/dist/esm/node/file/url.js

@@ -1,7 +1,8 @@
 import path from 'path';
 import { pathToFileURL } from 'url';
 const isZippedRegExp = /\.gz($|[?#])/i;
-const isURLRegExp = /^(\w{2,64}:\/\/|data:)/i;
+const isURLRegExp = /^([\w-]{2,64}:\/\/|data:)/i;
+const isWindowsPath = /^[a-z]:[\\/]/i;
 const supportedProtocols = { 'file:': true, 'http:': true, 'https:': true };
 export function isZipped(filename) {
     const path = typeof filename === 'string' ? filename : filename.pathname;
@@ -30,7 +31,7 @@ export function toFileURL(filenameOrUrl, relativeTo) {
     return isUrlLike(filenameOrUrl)
         ? new URL(filenameOrUrl)
         : relativeTo && isUrlLike(relativeTo)
-            ? new URL(normalizePath(filenameOrUrl), relativeTo)
+            ? new URL(normalizePathForUrl(filenameOrUrl), relativeTo)
             : relativeTo
                 ? pathToFileURL(path.resolve(relativeTo.toString(), filenameOrUrl))
                 : pathToFileURL(filenameOrUrl);
@@ -42,7 +43,7 @@ export function toFileURL(filenameOrUrl, relativeTo) {
  * @returns a URL
  */
 export function toURL(filenameOrUrl, relativeTo) {
-    return typeof filenameOrUrl !== 'string' ? filenameOrUrl : new URL(filenameOrUrl, relativeTo);
+    return filenameOrUrl instanceof URL ? filenameOrUrl : new URL(filenameOrUrl, relativeTo);
 }
 const regMatchFilename = /filename=([^;,]*)/;
 /**
@@ -67,15 +68,21 @@ export function urlBasename(url) {
 }
 /**
  * Try to determine the parent directory URL of the uri.
+ * If it is not a hierarchical URL, then it will return the URL.
  * @param url - url to extract the dirname from.
  * @returns a URL
  */
 export function urlDirname(url) {
     url = toURL(url);
     if (url.protocol === 'data:') {
-        return new URL('data:');
+        return url;
+    }
+    try {
+        return new URL(url.pathname.endsWith('/') ? '..' : '.', url);
+    }
+    catch (e) {
+        return url;
     }
-    return new URL(url.pathname.endsWith('/') ? '..' : '.', url);
 }
 /**
  * return the basename of a path, removing the trailing `/` if present.
@@ -87,7 +94,13 @@ export function basename(path) {
     const idx = path.lastIndexOf('/');
     return idx >= 0 ? path.slice(idx + 1) : path;
 }
-function normalizePath(filePath) {
-    return filePath.split(path.sep).join('/');
+export function normalizePathForUrl(filePath) {
+    const pathname = filePath.replace(/\\/g, '/');
+    const raw = pathname.replace(isWindowsPath, '/$&');
+    return raw
+        .split('/')
+        .map(encodeURIComponent)
+        .join('/')
+        .replace(/^\/([a-z])%3A/i, '/$1:');
 }
 //# sourceMappingURL=url.js.map

package/dist/esm/requests/RequestFsReadDirectory.d.ts

@@ -0,0 +1,9 @@
+import type { ServiceRequestFactoryRequestType } from '@cspell/cspell-service-bus';
+import type { DirEntry } from '../models/Stats.js';
+interface RequestParams {
+    readonly url: URL;
+}
+export declare const RequestFsReadDirectory: import("@cspell/cspell-service-bus").ServiceRequestFactory<import("@cspell/cspell-service-bus").ServiceRequest<"fs:readDir", RequestParams, Promise<DirEntry[]>>, RequestParams, "fs:readDir">;
+export type RequestFsReadDirectory = ServiceRequestFactoryRequestType<typeof RequestFsReadDirectory>;
+export {};
+//# sourceMappingURL=RequestFsReadDirectory.d.ts.map

package/dist/esm/requests/RequestFsReadDirectory.js

@@ -0,0 +1,4 @@
+import { requestFactory } from '@cspell/cspell-service-bus';
+const RequestType = 'fs:readDir';
+export const RequestFsReadDirectory = requestFactory(RequestType);
+//# sourceMappingURL=RequestFsReadDirectory.js.map

package/dist/esm/requests/RequestFsReadFile.d.ts

@@ -1,11 +1,11 @@
 import type { ServiceRequestFactoryRequestType } from '@cspell/cspell-service-bus';
 import type { BufferEncoding } from '../models/BufferEncoding.js';
-import type { FileResource } from '../models/FileResource.js';
+import type { TextFileResource } from '../models/FileResource.js';
 interface RequestParams {
     readonly url: URL;
     readonly encoding?: BufferEncoding | undefined;
 }
-export declare const RequestFsReadFile: import("@cspell/cspell-service-bus").ServiceRequestFactory<import("@cspell/cspell-service-bus").ServiceRequest<"fs:readFile", RequestParams, Promise<FileResource>>, RequestParams, "fs:readFile">;
+export declare const RequestFsReadFile: import("@cspell/cspell-service-bus").ServiceRequestFactory<import("@cspell/cspell-service-bus").ServiceRequest<"fs:readFile", RequestParams, Promise<TextFileResource>>, RequestParams, "fs:readFile">;
 export type RequestFsReadFile = ServiceRequestFactoryRequestType<typeof RequestFsReadFile>;
 export {};
 //# sourceMappingURL=RequestFsReadFile.d.ts.map

package/dist/esm/requests/RequestFsReadFileSync.d.ts

@@ -1,11 +1,11 @@
 import type { ServiceRequestFactoryRequestType } from '@cspell/cspell-service-bus';
 import type { BufferEncoding } from '../models/BufferEncoding.js';
-import type { FileResource } from '../models/FileResource.js';
+import type { TextFileResource } from '../models/FileResource.js';
 interface RequestParams {
     readonly url: URL;
     readonly encoding?: BufferEncoding | undefined;
 }
-export declare const RequestFsReadFileTextSync: import("@cspell/cspell-service-bus").ServiceRequestFactory<import("@cspell/cspell-service-bus").ServiceRequest<"fs:readFileSync", RequestParams, FileResource>, RequestParams, "fs:readFileSync">;
+export declare const RequestFsReadFileTextSync: import("@cspell/cspell-service-bus").ServiceRequestFactory<import("@cspell/cspell-service-bus").ServiceRequest<"fs:readFileSync", RequestParams, TextFileResource>, RequestParams, "fs:readFileSync">;
 export type RequestFsReadFileTextSync = ServiceRequestFactoryRequestType<typeof RequestFsReadFileTextSync>;
 export {};
 //# sourceMappingURL=RequestFsReadFileSync.d.ts.map

package/dist/esm/test/test.helper.d.ts

@@ -1,13 +1,25 @@
 export declare function pathToSample(...parts: string[]): string;
+export declare function pathToSampleURL(...parts: string[]): URL;
 export declare function pathToRoot(...parts: string[]): string;
+export declare function pathToRootURL(...parts: string[]): URL;
 export declare function makePathToFile(file: string): Promise<void>;
+/**
+ * Make the directories to the url. If the url ends with a `/` then it is treated as a directory.
+ * @param url - a URL
+ * @returns void
+ */
+export declare function makePathToURL(url: URL): Promise<void>;
 export declare function testNameToDir(testName: string): string;
 /**
- * Calculate a Uri for a path to a temporary directory that will be unique to the current test.
+ * Calculate a filepath for a path to a temporary directory that will be unique to the current test.
  * Note: if a text is not currently running, then it is the path for the test file.
- * @param baseFilename - name of file / directory wanted
- * @param testFilename - optional full path to a test file.
  * @returns full path to the requested temp file.
  */
 export declare function pathToTemp(...parts: string[]): string;
+/**
+ * Calculate a URL for a path to a temporary directory that will be unique to the current test.
+ * Note: if a text is not currently running, then it is the path for the test file.
+ * @returns a URL to the requested temp file.
+ */
+export declare function pathToTempURL(...parts: string[]): URL;
 //# sourceMappingURL=test.helper.d.ts.map

package/dist/esm/test/test.helper.js

@@ -1,29 +1,48 @@
 import { mkdir } from 'fs/promises';
 import * as path from 'path';
+import { fileURLToPath, pathToFileURL } from 'url';
 import { expect } from 'vitest';
 const mkdirp = async (p) => {
     await mkdir(p, { recursive: true });
 };
-const pathPackageRoot = path.join(__dirname, '../..');
-const pathSamples = path.join(pathPackageRoot, 'samples');
-const pathTemp = path.join(pathPackageRoot, 'temp');
+const pathPackageRoot = path.join(__dirname, '../../');
+const pathSamples = path.join(pathPackageRoot, 'samples/');
+const pathTemp = path.join(pathPackageRoot, 'temp/');
 export function pathToSample(...parts) {
-    return path.resolve(pathSamples, ...parts);
+    return resolve(pathSamples, ...parts);
+}
+export function pathToSampleURL(...parts) {
+    return pathToFileURL(pathToSample(...parts));
 }
 export function pathToRoot(...parts) {
-    return path.resolve(pathPackageRoot, ...parts);
+    return resolve(pathPackageRoot, ...parts);
+}
+export function pathToRootURL(...parts) {
+    return pathToFileURL(pathToRoot(...parts));
 }
 export function makePathToFile(file) {
     return mkdirp(path.dirname(file));
 }
+/**
+ * Make the directories to the url. If the url ends with a `/` then it is treated as a directory.
+ * @param url - a URL
+ * @returns void
+ */
+export function makePathToURL(url) {
+    const filePath = fileURLToPath(url);
+    return url.pathname.endsWith('/') ? mkdirp(filePath) : makePathToFile(filePath);
+}
+function resolve(...parts) {
+    const p = parts.join('/');
+    const suffix = /[/\\]$/.test(p) ? path.sep : '';
+    return path.normalize(path.resolve(...parts) + suffix);
+}
 export function testNameToDir(testName) {
     return `test_${testName.replace(/\s/g, '-').replace(/[^\w.-]/gi, '_')}_test`;
 }
 /**
- * Calculate a Uri for a path to a temporary directory that will be unique to the current test.
+ * Calculate a filepath for a path to a temporary directory that will be unique to the current test.
  * Note: if a text is not currently running, then it is the path for the test file.
- * @param baseFilename - name of file / directory wanted
- * @param testFilename - optional full path to a test file.
  * @returns full path to the requested temp file.
  */
 export function pathToTemp(...parts) {
@@ -33,6 +52,14 @@ export function pathToTemp(...parts) {
     expect.getState();
     const testName = testState.currentTestName || '.';
     const testDirName = testNameToDir(testName);
-    return path.resolve(pathTemp, testFile, testDirName, ...parts);
+    return resolve(pathTemp, testFile, testDirName, ...parts);
+}
+/**
+ * Calculate a URL for a path to a temporary directory that will be unique to the current test.
+ * Note: if a text is not currently running, then it is the path for the test file.
+ * @returns a URL to the requested temp file.
+ */
+export function pathToTempURL(...parts) {
+    return pathToFileURL(pathToTemp(...parts));
 }
 //# sourceMappingURL=test.helper.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cspell-io",
-  "version": "8.1.2",
+  "version": "8.2.0",
   "description": "A library of useful I/O functions used across various cspell tools.",
   "type": "module",
   "sideEffects": false,
@@ -48,10 +48,10 @@
   },
   "devDependencies": {
     "lorem-ipsum": "^2.0.8",
-    "typescript": "^5.3.2"
+    "typescript": "^5.3.3"
   },
   "dependencies": {
-    "@cspell/cspell-service-bus": "8.1.2"
+    "@cspell/cspell-service-bus": "8.2.0"
   },
-  "gitHead": "ba4eef94480562e7641298b32cb99723fd64aeca"
+  "gitHead": "3bcd6430bb33fb221d07030a60a2d61a2479e7ae"
 }