@ainc/fs 0.1.11 → 0.1.15

package/dist/writeStream.js

@@ -1,20 +1,20 @@
-/**
- *****************************************
- * Created by edonet@163.com
- * Created on 2021-05-22 11:32:52
- *****************************************
- */
-'use strict';
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.writeStream = void 0;
-/**
- *****************************************
- * 加载依赖
- *****************************************
- */
-const fs = require("fs");
-function writeStream(path, options) {
-    return fs.createWriteStream(path, options);
-}
-exports.writeStream = writeStream;
+/**
+ *****************************************
+ * Created by edonet@163.com
+ * Created on 2021-05-22 11:32:52
+ *****************************************
+ */
+'use strict';
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.writeStream = void 0;
+/**
+ *****************************************
+ * 加载依赖
+ *****************************************
+ */
+const fs = require("fs");
+function writeStream(path, options) {
+    return fs.createWriteStream(path, options);
+}
+exports.writeStream = writeStream;
 //# sourceMappingURL=writeStream.js.map

package/dist/writeStream.js.map

@@ -1 +1 @@
-{"version":3,"file":"writeStream.js","sourceRoot":"","sources":["../src/writeStream.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,YAAY,CAAC;;;AAGb;;;;GAIG;AACH,yBAAyB;AA2BzB,SAAS,WAAW,CAAC,IAAY,EAAE,OAA0B;IACzD,OAAO,EAAE,CAAC,iBAAiB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;AAC/C,CAAC;AAQQ,kCAAW"}
+{"version":3,"file":"writeStream.js","sourceRoot":"","sources":["../src/writeStream.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,YAAY,CAAC;;;AAGb;;;;GAIG;AACH,yBAAyB;AA2BzB,SAAS,WAAW,CAAC,IAAY,EAAE,OAAkC;IACjE,OAAO,EAAE,CAAC,iBAAiB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;AAC/C,CAAC;AAQQ,kCAAW"}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@ainc/fs",
-    "version": "0.1.11",
+    "version": "0.1.15",
     "description": "file system",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",
@@ -16,16 +16,16 @@
         "start": "yarn watch",
         "build": "yarn compile",
         "watch": "yarn compile --watch",
-        "compile": "tsc -p ./esconfig.json",
+        "compile": "esc -p ./src",
         "prepublishOnly": "yarn build",
         "test": "jest",
         "clean": "rm -rf ./dist"
     },
-    "repository": "git@edonet:repo/ainc/fs.git",
+    "repository": "git@absock.net:repo/ainc/fs.git",
     "author": "edonet <edonet@163.com>",
     "license": "MIT",
     "devDependencies": {
-        "@types/jest": "^26.0.22",
-        "@types/node": "^14.14.37"
+        "@types/jest": "^27.4.0",
+        "@types/node": "^17.0.5"
     }
 }

package/src/helpers/FileResolver.ts

@@ -0,0 +1,282 @@
+/**
+ *****************************************
+ * Created by edonet@163.com
+ * Created on 2021-06-19 00:16:40
+ *****************************************
+ */
+'use strict';
+
+
+/**
+ *****************************************
+ * 加载依赖
+ *****************************************
+ */
+import * as path from 'path';
+import * as Module from 'module';
+import { relative } from '@/relative';
+import { mapdir } from '@/supdir';
+import { json } from '@/json';
+import { isRelativePath } from '@/isRelativePath';
+import { safeCall } from './safeCall';
+import { match } from './match';
+import { normalizePath } from './normalizePath';
+
+
+/**
+ *****************************************
+ * 声明属性
+ *****************************************
+ */
+declare module 'module' {
+    export const _extensions: Extensions;
+    export function _nodeModulePaths(basePath: string): string[];
+    export function _resolveFilename(id: string, parent?: Module, isMain?: boolean): void | string;
+}
+
+
+/**
+ *****************************************
+ * 扩展解析函数
+ *****************************************
+ */
+type Extensions = Record<string, () => void>;
+
+
+/**
+ *****************************************
+ * 解析模块目录
+ *****************************************
+ */
+function resolveModules(context: string, modules: string[]): (resolveFrom: string, paths: string[]) => string[] {
+    const rules: [number, string][] = [];
+
+    // 生成解析规则
+    modules.forEach(value => {
+
+        // 处理绝对路径
+        if (path.isAbsolute(value)) {
+            return rules.push([0, value]);
+        }
+
+        // 处理相对路径
+        if (isRelativePath(value)) {
+            return rules.push([0, path.resolve(context, value)]);
+        }
+
+        // 处理模块路径
+        if (value) {
+            rules.push([value === 'node_modules' ? 1 : 2, value]);
+        }
+    });
+
+    // 返回解析函数
+    return (resolveFrom, paths) => {
+        const result: string[] = [];
+
+        // 添加路径
+        function add(value: string): void {
+            result.includes(value) || result.push(value);
+        }
+
+        // 遍历规则
+        rules.forEach(([type, value]) => {
+            switch (type) {
+                case 0:
+                    return add(value);
+                case 1:
+                    return paths.forEach(add);
+                default:
+                    return mapdir(resolveFrom, (dir) => add(path.join(dir, value)));
+            }
+        });
+
+        // 返回结果
+        return result;
+    };
+}
+
+
+/**
+ *****************************************
+ * 模块解析器
+ *****************************************
+ */
+interface Resolver {
+    paths: string[];
+    resolve(id: string, context?: string): void | string;
+}
+
+
+/**
+ *****************************************
+ * 配置项
+ *****************************************
+ */
+export interface Options {
+    context?: string;
+    modules?: string[];
+    extensions?: string[];
+    mainFields?: string[];
+    useRelativePath?: boolean;
+}
+
+
+/**
+ *****************************************
+ * 解析函数
+ *****************************************
+ */
+export type Handler = (id: string, context?: string) => void | string;
+
+
+/**
+ *****************************************
+ * 文件解析器
+ *****************************************
+ */
+export interface FileResolver {
+    resolvePath: Handler;
+    resolveFile: Handler;
+    resolveModule: Handler;
+    wrapHandler(handler: Handler): Handler;
+}
+
+
+/**
+ *****************************************
+ * 创建路径解析器
+ *****************************************
+ */
+export function createFileResolver(options: Options = {}): FileResolver {
+    const exts = options.extensions || ['.js', '.ts', '.mjs', '.jsx', '.tsx', '.json'];
+    const cached = new Map<string, Resolver>();
+    const mainFields = options.mainFields || ['main'];
+    const basePath = options.context || process.cwd();
+    const useRelativePath = !!options.useRelativePath;
+    const resolvePaths = resolveModules(basePath, options.modules || ['node_modules']);
+
+    // 执行函数函数
+    function invokeHandler<T>(resolve: () => T): void | T {
+        const extensions = Module._extensions;
+        const keys = Object.keys(extensions);
+        const cached: Extensions = {};
+
+        // 添加扩展函数
+        keys.forEach(key => (cached[key] = extensions[key], delete extensions[key]));
+        exts.forEach(key => (extensions[key] = cached[key] || cached['.js']));
+
+        // 解析文件
+        const result = safeCall(resolve);
+
+        // 清空扩展函数
+        exts.forEach(key => (delete extensions[key]));
+        keys.forEach(key => (extensions[key] = cached[key]));
+
+        // 返回结果
+        return result;
+    }
+
+    // 创建解析器
+    function createResolver(context: string): Resolver {
+        const filename = path.join(context, 'noop.js');
+        const module = new Module(filename);
+        const paths = resolvePaths(context, Module._nodeModulePaths(context));
+
+        // 更新模块信息
+        module.filename = filename;
+        module.paths = paths;
+        module.loaded = true;
+
+        // 创建解析器
+        const resolver: Resolver = {
+            paths,
+            resolve(id) {
+                return invokeHandler(() => Module._resolveFilename(id, module, false));
+            },
+        };
+
+        // 生成缓存
+        cached.set(context, resolver);
+
+        // 返回解析函数
+        return resolver;
+    }
+
+    // 解析函数
+    function resolvePath(id: string, context?: string): void | string {
+        if (path.isAbsolute(id) || isRelativePath(id)) {
+            return resolveFile(id, context);
+        } else {
+            return resolveModule(id, context);
+        }
+    }
+
+    // 解析文件路径
+    function resolveFile(id: string, context?: string): void | string {
+        const resolveFrom = path.resolve(basePath, context || '');
+        const resolver = cached.get(resolveFrom) || createResolver(resolveFrom);
+        const data = normalizePath(id);
+        const resolvedPath = resolver.resolve(data.path);
+
+        // 解析失败
+        if (!resolvedPath) {
+            return;
+        }
+
+        // 返回解析结果
+        if (!useRelativePath) {
+            return resolvedPath + data.query + data.hash;
+        }
+
+        // 解析相对路径
+        return isRelativePath(data.path) ? id : relative(resolveFrom, id);
+    }
+
+    // 解析模块路径
+    function resolveModule(id: string, context?: string): void | string {
+        const resolveFrom = path.resolve(basePath, context || '');
+        const resolver = cached.get(resolveFrom) || createResolver(resolveFrom);
+        const data = normalizePath(id);
+        const resolvedPath = match(mainFields, (name) => {
+
+            // 使用默认解析
+            if (name === 'main') {
+                return resolver.resolve(id);
+            }
+
+            // 获取包配置信息
+            return match(resolver.paths, (dir) => {
+                const pkg = json<Record<string, string>>(path.join(dir, id, 'package.json'));
+
+                // 存在配置
+                if (pkg?.[name]) {
+                    return resolver.resolve(path.resolve(dir, id, pkg[name]));
+                }
+            });
+        });
+
+        // 解析失败
+        if (!resolvedPath) {
+            return;
+        }
+
+        // 返回结果
+        return useRelativePath ? id : `${resolvedPath}${data.query}${data.hash}`;
+    }
+
+    // 包裹函数
+    function wrapHandler(resolve: Handler): Handler {
+        return (id, context) => {
+            if (path.isAbsolute(id) || isRelativePath(id)) {
+                return resolveFile(id, context);
+            } else {
+                return resolve(id, context);
+            }
+        };
+    }
+
+    // 返回结果
+    return { resolvePath, resolveFile, resolveModule, wrapHandler };
+}
+

package/src/helpers/compose.ts

@@ -0,0 +1,49 @@
+/**
+ *****************************************
+ * Created by edonet@163.com
+ * Created on 2021-12-16 22:20:04
+ *****************************************
+ */
+'use strict';
+
+
+/**
+ *****************************************
+ * 解析规则
+ *****************************************
+ */
+type Handler = (...args: any[]) => void | unknown;
+
+
+/**
+ *****************************************
+ * 组合函数
+ *****************************************
+ */
+export function compose<T extends Handler>(rules: T[]): T {
+
+    // 无处理函数
+    if (rules.length === 0) {
+        return (() => undefined) as T;
+    }
+
+    // 单一处理函数
+    if (rules.length === 1) {
+        return rules[0];
+    }
+
+    // 复合处理函数
+    function composed(...args: any[]): void | unknown {
+        for (let idx = 0, len = rules.length; idx < len; idx++) {
+            const result = rules[idx](...args);
+
+            // 解析成功
+            if (result) {
+                return result;
+            }
+        }
+    }
+
+    // 返回结果
+    return composed as T;
+}

package/src/helpers/each.ts

@@ -0,0 +1,19 @@
+/**
+ *****************************************
+ * Created by edonet@163.com
+ * Created on 2021-12-18 16:52:32
+ *****************************************
+ */
+'use strict';
+
+
+/**
+ *****************************************
+ * 遍历对象
+ *****************************************
+ */
+export function each<T>(target: T, handler: (value: T[keyof T], key: string) => void): void {
+    if (target && typeof target === 'object') {
+        Object.keys(target).forEach(key => handler(target[key as keyof T], key));
+    }
+}

package/src/helpers/match.ts

@@ -0,0 +1,31 @@
+/**
+ *****************************************
+ * Created by edonet@163.com
+ * Created on 2021-12-16 00:10:41
+ *****************************************
+ */
+'use strict';
+
+
+/**
+ *****************************************
+ * 匹配列表
+ *****************************************
+ */
+export function match<T, P>(list: T[], handler: (data: T, index: number) => void | P): void | P {
+
+    // 处理只有一个元素的情况
+    if (list.length === 1) {
+        return handler(list[0], 0);
+    }
+
+    // 处理列表
+    for (let idx = 0, len = list.length; idx < len; idx ++) {
+        const result = handler(list[idx], idx);
+
+        // 返回结果
+        if (typeof result !== 'undefined') {
+            return result;
+        }
+    }
+}

package/src/helpers/normalizePath.ts

@@ -0,0 +1,51 @@
+/**
+ *****************************************
+ * Created by edonet@163.com
+ * Created on 2021-12-18 11:16:21
+ *****************************************
+ */
+'use strict';
+
+
+/**
+ *****************************************
+ * 路径信息
+ *****************************************
+ */
+export interface PathInformation {
+    path: string;
+    query: string;
+    hash: string;
+}
+
+
+/**
+ *****************************************
+ * 切分字符
+ *****************************************
+ */
+export function split(str: string, sep: string): [string, string] {
+    const idx = str.indexOf(sep);
+
+    // 未找到分割字符串
+    if (idx === -1) {
+        return [str, ''];
+    }
+
+    // 分割字符串
+    return [str.substring(0, idx), str.substring(idx)];
+}
+
+
+/**
+ *****************************************
+ * 格式化路径
+ *****************************************
+ */
+export function normalizePath(id: string): PathInformation {
+    const [str, hash] = split(id, '#');
+    const [path, query] = split(str, '?');
+
+    // 返回结果
+    return { path, query, hash };
+}

package/src/helpers/safeCall.ts

@@ -0,0 +1,21 @@
+/**
+ *****************************************
+ * Created by edonet@163.com
+ * Created on 2021-12-16 00:02:15
+ *****************************************
+ */
+'use strict';
+
+
+/**
+ *****************************************
+ * 安全执行
+ *****************************************
+ */
+export function safeCall<T>(handler: () => T): void | T {
+    try {
+        return handler();
+    } catch (err) {
+        return;
+    }
+}

package/src/helpers/split.ts

@@ -0,0 +1,25 @@
+/**
+ *****************************************
+ * Created by edonet@163.com
+ * Created on 2021-12-21 21:17:28
+ *****************************************
+ */
+'use strict';
+
+
+/**
+ *****************************************
+ * 分割字符串
+ *****************************************
+ */
+export function split(str: string, sep: string): [string, string?] {
+    const idx = str.indexOf(sep);
+
+    // 不包含匹配符
+    if (idx < 0) {
+        return [str];
+    }
+
+    // 分割配置字符
+    return [str.substring(0, idx), str.substring(idx + 1)];
+}

package/src/helpers/stripBOM.ts

@@ -0,0 +1,17 @@
+/**
+ *****************************************
+ * Created by edonet@163.com
+ * Created on 2022-01-01 20:53:11
+ *****************************************
+ */
+'use strict';
+
+
+/**
+ *****************************************
+ * 移除【BOM】标识
+ *****************************************
+ */
+export function stripBOM(content: string): string {
+    return content.charCodeAt(0) === 0xFEFF ? content.slice(1) : content;
+}

package/src/{normalizeJSON.ts → helpers/stripComments.ts}

@@ -100,7 +100,7 @@ function indexBlockCommentEnd(start: number, source: string): number {
  * 过滤注释
  *****************************************
  */
-export function normalizeJSON(content: string): string {
+export function stripComments(content: string): string {
     let result = '';
     let idx = 0;
     let len = content.length;

package/src/index.ts

@@ -25,6 +25,7 @@ export { isDirectory } from './isDirectory';
 export { indir } from './indir';
 export { json } from './json';
 export { jsonc } from './jsonc';
+export { parseJSON } from './parseJSON';
 export { copy } from './copy';
 export { cpdir } from './cpdir';
 export { find } from './find';
@@ -45,9 +46,7 @@ export { mapdir } from './mapdir';
 export { symlink } from './symlink';
 export { usedir } from './usedir';
 export { supdir } from './supdir';
-export { resolveFile } from './resolveFile';
-export { resolveModule } from './resolveModule';
-export { resolvePaths } from './resolvePaths';
+export { resolvePath } from './resolvePath';
 export { includePaths } from './includePaths';
 export { isAbsolutePath } from './isAbsolutePath';
 export { isRelativePath } from './isRelativePath';

package/src/json.ts

@@ -15,6 +15,7 @@
 import { stat } from './stat';
 import { readFile } from './readFile';
 import { writeFile } from './writeFile';
+import { stripBOM } from './helpers/stripBOM';
 
 
 /**
@@ -44,7 +45,7 @@ function json<T = Data>(...args: [string] | [string, T]): T | null {
         const stats = stat(name);
 
         if (stats && stats.isFile()) {
-            return JSON.parse(readFile(stats.path));
+            return JSON.parse(stripBOM(readFile(stats.path)));
         }
     }
 

package/src/jsonc.ts

@@ -15,7 +15,7 @@
 import { stat } from './stat';
 import { readFile } from './readFile';
 import { writeFile } from './writeFile';
-import { normalizeJSON } from './normalizeJSON';
+import { stripComments } from './helpers/stripComments';
 
 
 /**
@@ -45,7 +45,7 @@ function jsonc<T = Data>(...args: [string] | [string, T]): T | null {
         const stats = stat(name);
 
         if (stats && stats.isFile()) {
-            const content = normalizeJSON(readFile(stats.path));
+            const content = stripComments(readFile(stats.path));
 
             // 空白文件
             if (!content.trim()) {

package/src/parseJSON.ts

@@ -0,0 +1,40 @@
+/**
+ *****************************************
+ * Created by edonet@163.com
+ * Created on 2022-01-01 21:01:19
+ *****************************************
+ */
+'use strict';
+
+
+/**
+ *****************************************
+ * 加载依赖
+ *****************************************
+ */
+import { stripBOM } from './helpers/stripBOM';
+import { stripComments } from './helpers/stripComments';
+
+
+/**
+ *****************************************
+ * 选项
+ *****************************************
+ */
+interface Options {
+    comments?: boolean;
+}
+
+
+/**
+ *****************************************
+ * 解析【JSON】文件
+ *****************************************
+ */
+export function parseJSON<T>(content: string, options: Options = {}): T {
+    const normalized = options.comments ? stripComments(content) : stripBOM(content);
+    const source = normalized.trim();
+
+    // 解析内容
+    return source ? JSON.parse(source) : undefined;
+}