cspell-io 6.1.3 → 6.2.0

package/dist/file/FetchError.d.ts

@@ -0,0 +1,10 @@
+/// <reference types="node" />
+/// <reference types="node" />
+export declare class FetchUrlError extends Error implements NodeJS.ErrnoException {
+    readonly code: string | undefined;
+    readonly status: number | undefined;
+    readonly url: URL;
+    constructor(message: string, code: string | undefined, status: number | undefined, url: URL);
+    static create(url: URL, status: number, message?: string): FetchUrlError;
+}
+//# sourceMappingURL=FetchError.d.ts.map

package/dist/file/FetchError.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FetchUrlError = void 0;
+class FetchUrlError extends Error {
+    constructor(message, code, status, url) {
+        super(message);
+        this.code = code;
+        this.status = status;
+        this.url = url;
+        this.name = 'FetchUrlError';
+    }
+    static create(url, status, message) {
+        if (status === 404)
+            return new FetchUrlError(message || 'URL not found.', 'ENOENT', status, url);
+        if (status >= 400 && status < 500)
+            return new FetchUrlError(message || 'Permission denied.', 'EACCES', status, url);
+        return new FetchUrlError(message || 'Fatal Error', 'ECONNREFUSED', status, url);
+    }
+}
+exports.FetchUrlError = FetchUrlError;
+//# sourceMappingURL=FetchError.js.map

package/dist/file/fetch.d.ts

@@ -0,0 +1,6 @@
+/// <reference types="node" />
+import type { Headers } from 'node-fetch';
+import nodeFetch from 'node-fetch';
+export declare const fetch: typeof nodeFetch;
+export declare function fetchHead(request: string | URL): Promise<Headers>;
+//# sourceMappingURL=fetch.d.ts.map

package/dist/file/fetch.js

@@ -0,0 +1,14 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fetchHead = exports.fetch = void 0;
+const node_fetch_1 = __importDefault(require("node-fetch"));
+exports.fetch = node_fetch_1.default;
+async function fetchHead(request) {
+    const r = await (0, exports.fetch)(request, { method: 'HEAD' });
+    return r.headers;
+}
+exports.fetchHead = fetchHead;
+//# sourceMappingURL=fetch.js.map

package/dist/file/fileReader.d.ts

@@ -1,4 +1,5 @@
 /// <reference types="node" />
-export declare function readFile(filename: string, encoding?: BufferEncoding): Promise<string>;
+/// <reference types="node" />
+export declare function readFile(filename: string | URL, encoding?: BufferEncoding): Promise<string>;
 export declare function readFileSync(filename: string, encoding?: BufferEncoding): string;
 //# sourceMappingURL=fileReader.d.ts.map

package/dist/file/fileReader.js

@@ -28,11 +28,35 @@ exports.readFileSync = exports.readFile = void 0;
 // cSpell:words zlib iconv
 const fs = __importStar(require("fs"));
 const zlib = __importStar(require("zlib"));
+const fetch_1 = require("./fetch");
+const FetchError_1 = require("./FetchError");
+const util_1 = require("./util");
+const url_1 = require("url");
 const defaultEncoding = 'utf8';
-function readFile(filename, encoding = defaultEncoding) {
+async function readFile(filename, encoding) {
+    const url = (0, util_1.toURL)(filename);
+    if (!(0, util_1.isSupportedURL)(url)) {
+        throw new Error('Unsupported network protocol');
+    }
+    return (0, util_1.isFileURL)(url) ? _readFile(url, encoding) : _fetchURL(url, encoding);
+}
+exports.readFile = readFile;
+function _readFile(url, encoding) {
+    // Convert it to a string because Yarn2 cannot handle URLs.
+    const filename = (0, url_1.fileURLToPath)(url);
+    return _read(() => fs.createReadStream(filename), (0, util_1.isZipped)(filename), encoding);
+}
+async function _fetchURL(url, encoding) {
+    const response = await (0, fetch_1.fetch)(url);
+    if (!response.ok) {
+        throw FetchError_1.FetchUrlError.create(url, response.status);
+    }
+    return _read(() => response.body, (0, util_1.isZipped)(url), encoding);
+}
+function _read(getStream, isZipped, encoding = defaultEncoding) {
     return new Promise((resolve, reject) => {
         const data = [];
-        const stream = prepareFileStream(filename, encoding, reject);
+        const stream = prepareFileStream(getStream, isZipped, encoding, reject);
         let resolved = false;
         function complete() {
             resolve(data.join(''));
@@ -44,14 +68,12 @@ function readFile(filename, encoding = defaultEncoding) {
         stream.on('end', complete);
     });
 }
-exports.readFile = readFile;
-const isZipped = /\.gz$/i;
-function prepareFileStream(filename, encoding, fnError) {
+function prepareFileStream(getStream, isZipped, encoding, fnError) {
     const pipes = [];
-    if (isZipped.test(filename)) {
+    if (isZipped) {
         pipes.push(zlib.createGunzip());
     }
-    const fileStream = fs.createReadStream(filename);
+    const fileStream = getStream();
     fileStream.on('error', fnError);
     const stream = pipes.reduce((s, p) => s.pipe(p).on('error', fnError), fileStream);
     stream.setEncoding(encoding);
@@ -59,7 +81,7 @@ function prepareFileStream(filename, encoding, fnError) {
 }
 function readFileSync(filename, encoding = defaultEncoding) {
     const rawData = fs.readFileSync(filename);
-    const data = isZipped.test(filename) ? zlib.gunzipSync(rawData) : rawData;
+    const data = (0, util_1.isZipped)(filename) ? zlib.gunzipSync(rawData) : rawData;
     return data.toString(encoding);
 }
 exports.readFileSync = readFileSync;

package/dist/file/index.d.ts

@@ -1,3 +1,5 @@
-export * from './fileReader';
-export * from './fileWriter';
+export { readFile, readFileSync } from './fileReader';
+export { writeToFile, writeToFileIterable, writeToFileIterableP } from './fileWriter';
+export { getStat, getStatSync } from './stat';
+export type { Stats } from './stat';
 //# sourceMappingURL=index.d.ts.map

package/dist/file/index.js

@@ -1,19 +1,14 @@
 "use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./fileReader"), exports);
-__exportStar(require("./fileWriter"), exports);
+exports.getStatSync = exports.getStat = exports.writeToFileIterableP = exports.writeToFileIterable = exports.writeToFile = exports.readFileSync = exports.readFile = void 0;
+var fileReader_1 = require("./fileReader");
+Object.defineProperty(exports, "readFile", { enumerable: true, get: function () { return fileReader_1.readFile; } });
+Object.defineProperty(exports, "readFileSync", { enumerable: true, get: function () { return fileReader_1.readFileSync; } });
+var fileWriter_1 = require("./fileWriter");
+Object.defineProperty(exports, "writeToFile", { enumerable: true, get: function () { return fileWriter_1.writeToFile; } });
+Object.defineProperty(exports, "writeToFileIterable", { enumerable: true, get: function () { return fileWriter_1.writeToFileIterable; } });
+Object.defineProperty(exports, "writeToFileIterableP", { enumerable: true, get: function () { return fileWriter_1.writeToFileIterableP; } });
+var stat_1 = require("./stat");
+Object.defineProperty(exports, "getStat", { enumerable: true, get: function () { return stat_1.getStat; } });
+Object.defineProperty(exports, "getStatSync", { enumerable: true, get: function () { return stat_1.getStatSync; } });
 //# sourceMappingURL=index.js.map

package/dist/file/stat.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Copied from the Node definition to avoid a dependency upon a specific version of Node
+ */
+interface StatsBase<T> {
+    size: T;
+    mtimeMs: T;
+    eTag?: string | undefined;
+}
+export declare function getStat(filenameOrUri: string): Promise<Stats | Error>;
+export declare function getStatSync(uri: string): Stats | Error;
+export declare type Stats = StatsBase<number>;
+export {};
+//# sourceMappingURL=stat.d.ts.map

package/dist/file/stat.js

@@ -0,0 +1,48 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getStatSync = exports.getStat = void 0;
+const fs_1 = require("fs");
+const util_1 = require("util");
+const fetch_1 = require("./fetch");
+const util_2 = require("./util");
+async function getStat(filenameOrUri) {
+    if ((0, util_2.isUrlLike)(filenameOrUri)) {
+        const url = (0, util_2.toURL)(filenameOrUri);
+        if (!(0, util_2.isFileURL)(url)) {
+            try {
+                const headers = await (0, fetch_1.fetchHead)(url);
+                return {
+                    size: Number.parseInt(headers.get('content-length') || '0', 10),
+                    mtimeMs: 0,
+                    eTag: headers.get('etag') || undefined,
+                };
+            }
+            catch (e) {
+                return toError(e);
+            }
+        }
+    }
+    return fs_1.promises.stat(filenameOrUri).catch((e) => toError(e));
+}
+exports.getStat = getStat;
+function getStatSync(uri) {
+    try {
+        return (0, fs_1.statSync)(uri);
+    }
+    catch (e) {
+        return toError(e);
+    }
+}
+exports.getStatSync = getStatSync;
+function toError(e) {
+    if (isErrnoException(e) || e instanceof Error)
+        return e;
+    return new Error((0, util_1.format)(e));
+}
+function isErrnoException(e) {
+    if (!e || typeof e !== 'object')
+        return false;
+    const err = e;
+    return err.message !== undefined && err.name !== undefined;
+}
+//# sourceMappingURL=stat.js.map

package/dist/file/util.d.ts

@@ -0,0 +1,8 @@
+/// <reference types="node" />
+import { URL } from 'url';
+export declare function isZipped(filename: string | URL): boolean;
+export declare function isUrlLike(filename: string | URL): boolean;
+export declare function isSupportedURL(url: URL): boolean;
+export declare function isFileURL(url: URL): boolean;
+export declare function toURL(filename: string | URL): URL;
+//# sourceMappingURL=util.d.ts.map

package/dist/file/util.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toURL = exports.isFileURL = exports.isSupportedURL = exports.isUrlLike = exports.isZipped = void 0;
+const url_1 = require("url");
+const isZippedRegExp = /\.gz($|[?#])/i;
+const isURLRegExp = /^\w{2,64}:\/\//i;
+const supportedProtocols = { 'file:': true, 'http:': true, 'https:': true };
+function isZipped(filename) {
+    const path = typeof filename === 'string' ? filename : filename.pathname;
+    return isZippedRegExp.test(path);
+}
+exports.isZipped = isZipped;
+function isUrlLike(filename) {
+    return filename instanceof url_1.URL || isURLRegExp.test(filename);
+}
+exports.isUrlLike = isUrlLike;
+function isSupportedURL(url) {
+    return !!supportedProtocols[url.protocol];
+}
+exports.isSupportedURL = isSupportedURL;
+function isFileURL(url) {
+    return url.protocol === 'file:';
+}
+exports.isFileURL = isFileURL;
+function toURL(filename) {
+    return filename instanceof url_1.URL ? filename : isUrlLike(filename) ? new url_1.URL(filename) : (0, url_1.pathToFileURL)(filename);
+}
+exports.toURL = toURL;
+//# sourceMappingURL=util.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cspell-io",
-  "version": "6.1.3",
+  "version": "6.2.0",
   "description": "A library of useful I/O functions used across various cspell tools.",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -41,9 +41,13 @@
     "@types/fs-extra": "^9.0.13",
     "@types/node": "^18.0.0",
     "fs-extra": "^10.1.0",
-    "jest": "^28.1.1",
+    "jest": "^28.1.2",
     "lorem-ipsum": "^2.0.8",
     "rimraf": "^3.0.2"
   },
-  "gitHead": "e96b313542f2ec0a38ac04d1422d97e724ded3a6"
+  "dependencies": {
+    "@types/node-fetch": "^2.6.2",
+    "node-fetch": "^2.6.7"
+  },
+  "gitHead": "ef9bf8e390692145b067843dbcc44a6dc2d9aa31"
 }