@ansi-tools/parser 1.0.0 → 1.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -2,18 +2,9 @@
2
2
 
3
3
  Parser for ANSI escape sequences.
4
4
 
5
- ## Supported sequence types
6
-
7
- - **CSI** (Control Sequence Introducer): `\x1b[...`
8
- - **OSC** (Operating System Command): `\x1b]...`
9
- - **DCS** (Device Control String): `\x1bP...`
10
- - **ESC** (Escape): `\x1b...`
11
- - **DEC** (DEC Private Mode): `\x1b[?...`
12
- - **STRING** (APC/PM/SOS): `\x1b_...`, `\x1b^...`, `\x1bX...`
13
- - **PRIVATE** (Private sequences): `\x1b[<...`, `\x1b[=...`, `\x1b[>...`
14
-
15
5
  ## Features
16
6
 
7
+ - ✅ Supports CSI, OSC, DCS, ESC, APC, SOS, PM, etc.
17
8
  - ✅ Handles 7-bit (`\x1b` or `\u001b`) and 8-bit (`\u009b`) introducers
18
9
  - ✅ Handles octal (`\033`) and shorthand `\e` introducers (only escaped)
19
10
  - ✅ Multiple string terminators (`\x1b\\`, `\x07`)
@@ -44,8 +35,8 @@ There is a difference between escaped and unescaped input. Only with an escaped
44
35
  input string the raw input and the positions can be preserved in the tokens and
45
36
  control codes. See the example below for the default and the `/escaped` import.
46
37
 
47
- The default and unescaped tokenization is roughly ~30% faster. Use this default
48
- if you just need the control codes.
38
+ The default and unescaped tokenization is roughly ~30% faster. Use this if you
39
+ just need the control codes.
49
40
 
50
41
  ## Examples
51
42
 
@@ -152,11 +143,15 @@ function parse(input: string): CODE[];
152
143
 
153
144
  function* tokenizer(input: string): Generator<TOKEN>;
154
145
  function* parser(tokens: Generator<TOKEN>): Generator<CODE>;
155
- ```
156
146
 
157
- ### CODE
147
+ type TOKEN = {
148
+ type: "INTRODUCER" | "DATA" | "FINAL" | "TEXT";
149
+ pos: number;
150
+ raw: string;
151
+ code?: string;
152
+ intermediate?: string;
153
+ };
158
154
 
159
- ```ts
160
155
  type CONTROL_CODE = {
161
156
  type: "CSI" | "DCS" | "DEC" | "ESC" | "OSC" | "SGR" | "STRING" | "PRIVATE";
162
157
  command: string;
@@ -165,25 +160,13 @@ type CONTROL_CODE = {
165
160
  pos: number;
166
161
  };
167
162
 
168
- type CONTROL_CODE_TEXT = {
163
+ type TEXT = {
169
164
  type: "TEXT";
170
165
  raw: string;
171
166
  pos: number;
172
167
  };
173
168
 
174
- type CODE = CONTROL_CODE | CONTROL_CODE_TEXT;
175
- ```
176
-
177
- ### TOKEN
178
-
179
- ```ts
180
- type TOKEN = {
181
- type: "INTRODUCER" | "DATA" | "FINAL" | "TEXT";
182
- pos: number;
183
- raw: string;
184
- code?: string;
185
- intermediate?: string;
186
- };
169
+ type CODE = CONTROL_CODE | TEXT;
187
170
  ```
188
171
 
189
172
  ## License
package/dist/escaped.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { APC, APC_OPEN, BACKSLASH, BELL, CODE, CODE_TYPES, CONTROL_CODE, CONTROL_CODE_TEXT, CSI, CSI_OPEN, DCS, DCS_OPEN, DEC_OPEN, ESC, OSC, OSC_OPEN, PM, PM_OPEN, PRIVATE_OPENERS, SOS, SOS_OPEN, ST, STRING_OPENERS, TOKEN, TOKEN_TYPES, parser } from "./parse-BtpkwNjf.js";
1
+ import { APC, APC_OPEN, BACKSLASH, BELL, CODE, CODE_TYPES, CONTROL_CODE, CSI, CSI_OPEN, DCS, DCS_OPEN, DEC_OPEN, ESC, OSC, OSC_OPEN, PM, PM_OPEN, PRIVATE_OPENERS, SOS, SOS_OPEN, ST, STRING_OPENERS, TEXT, TOKEN, TOKEN_TYPES, parser } from "./parse-Nkb7K322.js";
2
2
 
3
3
  //#region src/parse.escaped.d.ts
4
4
  declare function parse(input: string): CODE[];
@@ -7,4 +7,4 @@ declare function parse(input: string): CODE[];
7
7
  declare function tokenizer(input: string): Generator<TOKEN>;
8
8
  declare function tokenize(input: string): TOKEN[];
9
9
  //#endregion
10
- export { APC, APC_OPEN, BACKSLASH, BELL, CODE, CODE_TYPES, CONTROL_CODE, CONTROL_CODE_TEXT, CSI, CSI_OPEN, DCS, DCS_OPEN, DEC_OPEN, ESC, OSC, OSC_OPEN, PM, PM_OPEN, PRIVATE_OPENERS, SOS, SOS_OPEN, ST, STRING_OPENERS, TOKEN, TOKEN_TYPES, parse, parser, tokenize, tokenizer };
10
+ export { APC, APC_OPEN, BACKSLASH, BELL, CODE, CODE_TYPES, CONTROL_CODE, CSI, CSI_OPEN, DCS, DCS_OPEN, DEC_OPEN, ESC, OSC, OSC_OPEN, PM, PM_OPEN, PRIVATE_OPENERS, SOS, SOS_OPEN, ST, STRING_OPENERS, TEXT, TOKEN, TOKEN_TYPES, parse, parser, tokenize, tokenizer };
package/dist/escaped.js CHANGED
@@ -1,4 +1,4 @@
1
- import { APC, APC_OPEN, BACKSLASH, BELL, CODE_TYPES, CSI, CSI_OPEN, DCS, DCS_OPEN, DEC_OPEN, ESC, OSC, OSC_OPEN, PM, PM_OPEN, PRIVATE_OPENERS, SOS, SOS_OPEN, ST, STRING_OPENERS, TOKEN_TYPES, parser } from "./parse-DX-Po36R.js";
1
+ import { APC, APC_OPEN, BACKSLASH, BELL, CODE_TYPES, CSI, CSI_OPEN, DCS, DCS_OPEN, DEC_OPEN, ESC, OSC, OSC_OPEN, PM, PM_OPEN, PRIVATE_OPENERS, SOS, SOS_OPEN, ST, STRING_OPENERS, TOKEN_TYPES, parser } from "./parse-D-nJlcK3.js";
2
2
 
3
3
  //#region src/tokenize.escaped.ts
4
4
  const CSI_ESCAPED = "\\u009b";
@@ -121,7 +121,7 @@ function* tokenizer(input) {
121
121
  });
122
122
  i += len;
123
123
  setState("SEQUENCE", ESC);
124
- }
124
+ } else i += len;
125
125
  }
126
126
  break;
127
127
  }
package/dist/index.d.ts CHANGED
@@ -1,7 +1,7 @@
1
- import { APC, APC_OPEN, BACKSLASH, BELL, CODE, CODE_TYPES, CONTROL_CODE, CONTROL_CODE_TEXT, CSI, CSI_OPEN, DCS, DCS_OPEN, DEC_OPEN, ESC, OSC, OSC_OPEN, PM, PM_OPEN, PRIVATE_OPENERS, SOS, SOS_OPEN, ST, STRING_OPENERS, TOKEN, TOKEN_TYPES, parse, parser } from "./parse-BtpkwNjf.js";
1
+ import { APC, APC_OPEN, BACKSLASH, BELL, CODE, CODE_TYPES, CONTROL_CODE, CSI, CSI_OPEN, DCS, DCS_OPEN, DEC_OPEN, ESC, OSC, OSC_OPEN, PM, PM_OPEN, PRIVATE_OPENERS, SOS, SOS_OPEN, ST, STRING_OPENERS, TEXT, TOKEN, TOKEN_TYPES, parse, parser } from "./parse-Nkb7K322.js";
2
2
 
3
3
  //#region src/tokenize.d.ts
4
4
  declare function tokenizer(input: string): Generator<TOKEN>;
5
5
  declare function tokenize(input: string): TOKEN[];
6
6
  //#endregion
7
- export { APC, APC_OPEN, BACKSLASH, BELL, CODE, CODE_TYPES, CONTROL_CODE, CONTROL_CODE_TEXT, CSI, CSI_OPEN, DCS, DCS_OPEN, DEC_OPEN, ESC, OSC, OSC_OPEN, PM, PM_OPEN, PRIVATE_OPENERS, SOS, SOS_OPEN, ST, STRING_OPENERS, TOKEN, TOKEN_TYPES, parse, parser, tokenize, tokenizer };
7
+ export { APC, APC_OPEN, BACKSLASH, BELL, CODE, CODE_TYPES, CONTROL_CODE, CSI, CSI_OPEN, DCS, DCS_OPEN, DEC_OPEN, ESC, OSC, OSC_OPEN, PM, PM_OPEN, PRIVATE_OPENERS, SOS, SOS_OPEN, ST, STRING_OPENERS, TEXT, TOKEN, TOKEN_TYPES, parse, parser, tokenize, tokenizer };
package/dist/index.js CHANGED
@@ -1,3 +1,3 @@
1
- import { APC, APC_OPEN, BACKSLASH, BELL, CODE_TYPES, CSI, CSI_OPEN, DCS, DCS_OPEN, DEC_OPEN, ESC, OSC, OSC_OPEN, PM, PM_OPEN, PRIVATE_OPENERS, SOS, SOS_OPEN, ST, STRING_OPENERS, TOKEN_TYPES, parse, parser, tokenize, tokenizer } from "./parse-DX-Po36R.js";
1
+ import { APC, APC_OPEN, BACKSLASH, BELL, CODE_TYPES, CSI, CSI_OPEN, DCS, DCS_OPEN, DEC_OPEN, ESC, OSC, OSC_OPEN, PM, PM_OPEN, PRIVATE_OPENERS, SOS, SOS_OPEN, ST, STRING_OPENERS, TOKEN_TYPES, parse, parser, tokenize, tokenizer } from "./parse-D-nJlcK3.js";
2
2
 
3
3
  export { APC, APC_OPEN, BACKSLASH, BELL, CODE_TYPES, CSI, CSI_OPEN, DCS, DCS_OPEN, DEC_OPEN, ESC, OSC, OSC_OPEN, PM, PM_OPEN, PRIVATE_OPENERS, SOS, SOS_OPEN, ST, STRING_OPENERS, TOKEN_TYPES, parse, parser, tokenize, tokenizer };
@@ -369,7 +369,7 @@ function* tokenizer(input) {
369
369
  });
370
370
  i++;
371
371
  setState("SEQUENCE", ESC);
372
- }
372
+ } else i++;
373
373
  }
374
374
  }
375
375
  } else if (state === "SEQUENCE") {
@@ -51,15 +51,15 @@ type CONTROL_CODE = {
51
51
  params: string[];
52
52
  pos: number;
53
53
  };
54
- type CONTROL_CODE_TEXT = {
54
+ type TEXT = {
55
55
  type: "TEXT";
56
56
  raw: string;
57
57
  pos: number;
58
58
  };
59
- type CODE = CONTROL_CODE | CONTROL_CODE_TEXT;
59
+ type CODE = CONTROL_CODE | TEXT;
60
60
  //#endregion
61
61
  //#region src/parse.d.ts
62
62
  declare function parser(tokens: Generator<TOKEN>): Generator<CODE>;
63
63
  declare function parse(input: string): CODE[];
64
64
  //#endregion
65
- export { APC, APC_OPEN, BACKSLASH, BELL, CODE, CODE_TYPES, CONTROL_CODE, CONTROL_CODE_TEXT, CSI, CSI_OPEN, DCS, DCS_OPEN, DEC_OPEN, ESC, OSC, OSC_OPEN, PM, PM_OPEN, PRIVATE_OPENERS, SOS, SOS_OPEN, ST, STRING_OPENERS, TOKEN, TOKEN_TYPES, parse, parser };
65
+ export { APC, APC_OPEN, BACKSLASH, BELL, CODE, CODE_TYPES, CONTROL_CODE, CSI, CSI_OPEN, DCS, DCS_OPEN, DEC_OPEN, ESC, OSC, OSC_OPEN, PM, PM_OPEN, PRIVATE_OPENERS, SOS, SOS_OPEN, ST, STRING_OPENERS, TEXT, TOKEN, TOKEN_TYPES, parse, parser };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ansi-tools/parser",
3
- "version": "1.0.0",
3
+ "version": "1.0.2",
4
4
  "description": "Tokenize and parse strings containing ANSI escape sequences and control codes",
5
5
  "main": "./dist/index.js",
6
6
  "type": "module",
@@ -22,6 +22,7 @@
22
22
  "scripts": {
23
23
  "prebuild": "pnpm type-check && pnpm test",
24
24
  "build": "tsdown --dts src/index.ts src/escaped.ts",
25
+ "dev": "tsdown --dts src/index.ts src/escaped.ts --watch",
25
26
  "test": "node --test",
26
27
  "type-check": "tsc",
27
28
  "prepack": "pnpm build"