json-brook 0.0.2 → 0.0.4

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # json-brook
 
+## 0.0.4
+
+### Patch Changes
+
+- 调整打包产物
+
+## 0.0.3
+
+### Patch Changes
+
+- 删除无效依赖
+
 ## 0.0.2
 
 ### Patch Changes

package/README.md

@@ -1,12 +1,40 @@
 # JsonBrook
 
-> 流式解析Json数据
+![演示视频](assets/showcase.gif)
+
+> 流式解析Json数据  
 > 实现上参考了[json-to-ast](https://github.com/vtrushin/json-to-ast)
 
-## 当前进度
+## 快速入门
+
+```typescript
+import { createJsonBrook } from "json-brook";
+
+const jsonBrook = createJsonBrook();
+
+const sample = `{
+  "string": "welcome to json brook",
+  "number": 20241102,
+  "boolean": true,
+  "array": ["a", "b", "c"],
+  "null": null
+}`;
+
+for (const char of sample) {
+  jsonBrook.write(char);
+  console.log(jsonBrook.getCurrent());
+}
+
+jsonBrook.end();
+console.log(jsonBrook.getCurrent());
+```
+
+## API
+`createJsonBrook` 返回一个JsonBrook实例，JsonBrook实例具有以下方法：
+* `write` 接受字符串并解析，如果解析失败会抛错
+* `end` 结束输入并解析Json数据(针对比较极端的纯数字形式解析，需要知道当前输入已结束)，如果解析失败会抛错
+* `getCurrent` 获取当前解析结果
+
+## 在线尝试
+[codesandbox](https://codesandbox.io/p/sandbox/4v5slw)
 
-- [x] token 解析
-- [x] ast 解析
-- [x] 生成数据
-- [ ] 添加单测
-- [ ] 新增主页

package/dist/es/index.js

@@ -617,5 +617,7 @@ function createJsonBrook() {
   };
 }
 export {
-  createJsonBrook
+  createJsonBrook,
+  createParser,
+  createTokenize
 };

package/dist/lib/index.js

@@ -20,7 +20,9 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var src_exports = {};
 __export(src_exports, {
-  createJsonBrook: () => createJsonBrook
+  createJsonBrook: () => createJsonBrook,
+  createParser: () => createParser,
+  createTokenize: () => createTokenize
 });
 module.exports = __toCommonJS(src_exports);
 
@@ -644,5 +646,7 @@ function createJsonBrook() {
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  createJsonBrook
+  createJsonBrook,
+  createParser,
+  createTokenize
 });

package/dist/types/index.d.ts

@@ -4,4 +4,111 @@ declare function createJsonBrook(): {
     end: () => void;
 };
 
-export { createJsonBrook };
+type SymbolValue = '{' | '}' | '[' | ']' | ':' | ',';
+type SymbolToken = {
+    type: 'Symbol';
+    value: SymbolValue;
+};
+type KeywordValue = 'true' | 'false' | 'null';
+type KeywordToken = {
+    type: 'Keyword';
+    value: boolean | null;
+};
+type KeywordCurrent = {
+    type: 'Keyword';
+    value: KeywordValue;
+    matchedIndex: number;
+};
+declare enum StringState {
+    Normal = 0,
+    Escape = 1
+}
+type StringToken = {
+    type: 'String';
+    value: string;
+};
+type StringCurrent = {
+    type: 'String';
+    state: StringState;
+    value: string;
+    escapeIndex: number;
+};
+declare enum NumberState {
+    Negative = 1,
+    Zero = 2,
+    Digit = 3,
+    Point = 4,
+    DigitFraction = 5,
+    Exp = 6,
+    ExpDigitOrSign = 7
+}
+type NumberToken = {
+    type: 'Number';
+    value: number;
+};
+type NumberCurrent = {
+    type: 'Number';
+    state: NumberState;
+    value: string;
+    passed: boolean;
+};
+type Token = SymbolToken | KeywordToken | StringToken | NumberToken;
+declare function createTokenize(): {
+    write: (char: string) => Token | Token[] | null;
+    end: () => NumberToken | null;
+};
+
+type RootNode = {
+    type: 'Root';
+    current: ObjectNode | ArrayNode | LiteralNode | null;
+};
+type LiteralNode = {
+    type: 'Literal';
+    value: string | number | boolean | null;
+};
+declare enum ArrayNodeState {
+    Start = 0,
+    Value = 1,
+    Comma = 2
+}
+type ArrayNode = {
+    type: 'Array';
+    children: (LiteralNode | ArrayNode | ObjectNode)[];
+    state: ArrayNodeState;
+    parent: RootNode | ArrayNode | PropertyNode;
+    current: ArrayNode | ObjectNode | null;
+};
+type IdentifierNode = {
+    type: 'Identifier';
+    value: string;
+};
+declare enum PropertyNodeState {
+    Key = 0,
+    Colon = 1,
+    Value = 2
+}
+type PropertyNode = {
+    type: 'Property';
+    key: IdentifierNode;
+    current: LiteralNode | ArrayNode | ObjectNode | null;
+    state: PropertyNodeState;
+    parent: ObjectNode;
+};
+declare enum ObjectNodeState {
+    Start = 0,
+    Property = 1,
+    Comma = 2
+}
+type ObjectNode = {
+    type: 'Object';
+    children: PropertyNode[];
+    state: ObjectNodeState;
+    parent: RootNode | ArrayNode | PropertyNode;
+    current: PropertyNode | null;
+};
+declare function createParser(): {
+    getRoot: () => LiteralNode | ArrayNode | ObjectNode | null;
+    write: (token: Token) => void;
+};
+
+export { type ArrayNode, ArrayNodeState, type IdentifierNode, type KeywordCurrent, type KeywordToken, type KeywordValue, type LiteralNode, type NumberCurrent, NumberState, type NumberToken, type ObjectNode, ObjectNodeState, type PropertyNode, PropertyNodeState, type RootNode, type StringCurrent, StringState, type StringToken, type SymbolToken, type SymbolValue, type Token, createJsonBrook, createParser, createTokenize };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "json-brook",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "description": "parse json data streamly",
   "keywords": [
     "json",
@@ -31,7 +31,6 @@
   "devDependencies": {
     "@biomejs/biome": "1.8.3",
     "@modern-js/module-tools": "2.60.3",
-    "@modern-js/plugin-rspress": "1.33.1",
     "@types/jest": "^29.5.14",
     "@types/node": "~16.11.7",
     "jest": "^29.7.0",