@ainc/fs 0.1.13 → 0.1.14

package/README.md

@@ -42,6 +42,7 @@ import * as fs from '@ainc/fs';
 * findFile(name: string, dir = '.', options?: Options): string[];
 * json(file: string): object | null;
 * json(file: string, data: object): object | null;
+* parseJSON<T>(source: string, options?: Options): T;
 * resolveFile(file: string, options?: Options): void | string;
 * resolveAlias(options: Options): ResolvePath;
 * isAbsolutePath(source: string): boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@ainc/fs",
-    "version": "0.1.13",
+    "version": "0.1.14",
     "description": "file system",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",
@@ -25,7 +25,7 @@
     "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/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';

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;
+}