document-ir 0.0.7 → 0.0.8

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/package.json CHANGED
@@ -2,7 +2,7 @@
2
2
  "module": "./esm/index.js",
3
3
  "main": "./script/index.js",
4
4
  "name": "document-ir",
5
- "version": "0.0.7",
5
+ "version": "0.0.8",
6
6
  "description": "Intermediate representation and transformers for documents",
7
7
  "license": "MIT",
8
8
  "repository": {
@@ -18,12 +18,7 @@
18
18
  "require": "./script/index.js"
19
19
  }
20
20
  },
21
- "scripts": {
22
- "test": "node test_runner.js"
23
- },
24
21
  "devDependencies": {
25
- "@types/node": "^18.11.9",
26
- "picocolors": "^1.0.0",
27
- "@deno/shim-deno": "~0.16.1"
22
+ "@types/node": "^18.11.9"
28
23
  }
29
24
  }
@@ -1 +0,0 @@
1
- export {};
@@ -1,2 +0,0 @@
1
- import { DocumentNode } from "./types.js";
2
- export declare const ExampleDocument: DocumentNode;
@@ -1 +0,0 @@
1
- export {};
@@ -1 +0,0 @@
1
- export {};
@@ -1 +0,0 @@
1
- export {};
@@ -1 +0,0 @@
1
- export {};
@@ -1 +0,0 @@
1
- export {};
@@ -1,5 +0,0 @@
1
- import { Deno } from "@deno/shim-deno";
2
- export { Deno } from "@deno/shim-deno";
3
- export declare const dntGlobalThis: Omit<typeof globalThis, "Deno"> & {
4
- Deno: typeof Deno;
5
- };
@@ -1,270 +0,0 @@
1
- /** RGB 8-bits per channel. Each in range `0->255` or `0x00->0xff` */
2
- interface Rgb {
3
- r: number;
4
- g: number;
5
- b: number;
6
- }
7
- /**
8
- * Set changing text color to enabled or disabled
9
- * @param value
10
- */
11
- export declare function setColorEnabled(value: boolean): void;
12
- /** Get whether text color change is enabled or disabled. */
13
- export declare function getColorEnabled(): boolean;
14
- /**
15
- * Reset the text modified
16
- * @param str text to reset
17
- */
18
- export declare function reset(str: string): string;
19
- /**
20
- * Make the text bold.
21
- * @param str text to make bold
22
- */
23
- export declare function bold(str: string): string;
24
- /**
25
- * The text emits only a small amount of light.
26
- * @param str text to dim
27
- */
28
- export declare function dim(str: string): string;
29
- /**
30
- * Make the text italic.
31
- * @param str text to make italic
32
- */
33
- export declare function italic(str: string): string;
34
- /**
35
- * Make the text underline.
36
- * @param str text to underline
37
- */
38
- export declare function underline(str: string): string;
39
- /**
40
- * Invert background color and text color.
41
- * @param str text to invert its color
42
- */
43
- export declare function inverse(str: string): string;
44
- /**
45
- * Make the text hidden.
46
- * @param str text to hide
47
- */
48
- export declare function hidden(str: string): string;
49
- /**
50
- * Put horizontal line through the center of the text.
51
- * @param str text to strike through
52
- */
53
- export declare function strikethrough(str: string): string;
54
- /**
55
- * Set text color to black.
56
- * @param str text to make black
57
- */
58
- export declare function black(str: string): string;
59
- /**
60
- * Set text color to red.
61
- * @param str text to make red
62
- */
63
- export declare function red(str: string): string;
64
- /**
65
- * Set text color to green.
66
- * @param str text to make green
67
- */
68
- export declare function green(str: string): string;
69
- /**
70
- * Set text color to yellow.
71
- * @param str text to make yellow
72
- */
73
- export declare function yellow(str: string): string;
74
- /**
75
- * Set text color to blue.
76
- * @param str text to make blue
77
- */
78
- export declare function blue(str: string): string;
79
- /**
80
- * Set text color to magenta.
81
- * @param str text to make magenta
82
- */
83
- export declare function magenta(str: string): string;
84
- /**
85
- * Set text color to cyan.
86
- * @param str text to make cyan
87
- */
88
- export declare function cyan(str: string): string;
89
- /**
90
- * Set text color to white.
91
- * @param str text to make white
92
- */
93
- export declare function white(str: string): string;
94
- /**
95
- * Set text color to gray.
96
- * @param str text to make gray
97
- */
98
- export declare function gray(str: string): string;
99
- /**
100
- * Set text color to bright black.
101
- * @param str text to make bright-black
102
- */
103
- export declare function brightBlack(str: string): string;
104
- /**
105
- * Set text color to bright red.
106
- * @param str text to make bright-red
107
- */
108
- export declare function brightRed(str: string): string;
109
- /**
110
- * Set text color to bright green.
111
- * @param str text to make bright-green
112
- */
113
- export declare function brightGreen(str: string): string;
114
- /**
115
- * Set text color to bright yellow.
116
- * @param str text to make bright-yellow
117
- */
118
- export declare function brightYellow(str: string): string;
119
- /**
120
- * Set text color to bright blue.
121
- * @param str text to make bright-blue
122
- */
123
- export declare function brightBlue(str: string): string;
124
- /**
125
- * Set text color to bright magenta.
126
- * @param str text to make bright-magenta
127
- */
128
- export declare function brightMagenta(str: string): string;
129
- /**
130
- * Set text color to bright cyan.
131
- * @param str text to make bright-cyan
132
- */
133
- export declare function brightCyan(str: string): string;
134
- /**
135
- * Set text color to bright white.
136
- * @param str text to make bright-white
137
- */
138
- export declare function brightWhite(str: string): string;
139
- /**
140
- * Set background color to black.
141
- * @param str text to make its background black
142
- */
143
- export declare function bgBlack(str: string): string;
144
- /**
145
- * Set background color to red.
146
- * @param str text to make its background red
147
- */
148
- export declare function bgRed(str: string): string;
149
- /**
150
- * Set background color to green.
151
- * @param str text to make its background green
152
- */
153
- export declare function bgGreen(str: string): string;
154
- /**
155
- * Set background color to yellow.
156
- * @param str text to make its background yellow
157
- */
158
- export declare function bgYellow(str: string): string;
159
- /**
160
- * Set background color to blue.
161
- * @param str text to make its background blue
162
- */
163
- export declare function bgBlue(str: string): string;
164
- /**
165
- * Set background color to magenta.
166
- * @param str text to make its background magenta
167
- */
168
- export declare function bgMagenta(str: string): string;
169
- /**
170
- * Set background color to cyan.
171
- * @param str text to make its background cyan
172
- */
173
- export declare function bgCyan(str: string): string;
174
- /**
175
- * Set background color to white.
176
- * @param str text to make its background white
177
- */
178
- export declare function bgWhite(str: string): string;
179
- /**
180
- * Set background color to bright black.
181
- * @param str text to make its background bright-black
182
- */
183
- export declare function bgBrightBlack(str: string): string;
184
- /**
185
- * Set background color to bright red.
186
- * @param str text to make its background bright-red
187
- */
188
- export declare function bgBrightRed(str: string): string;
189
- /**
190
- * Set background color to bright green.
191
- * @param str text to make its background bright-green
192
- */
193
- export declare function bgBrightGreen(str: string): string;
194
- /**
195
- * Set background color to bright yellow.
196
- * @param str text to make its background bright-yellow
197
- */
198
- export declare function bgBrightYellow(str: string): string;
199
- /**
200
- * Set background color to bright blue.
201
- * @param str text to make its background bright-blue
202
- */
203
- export declare function bgBrightBlue(str: string): string;
204
- /**
205
- * Set background color to bright magenta.
206
- * @param str text to make its background bright-magenta
207
- */
208
- export declare function bgBrightMagenta(str: string): string;
209
- /**
210
- * Set background color to bright cyan.
211
- * @param str text to make its background bright-cyan
212
- */
213
- export declare function bgBrightCyan(str: string): string;
214
- /**
215
- * Set background color to bright white.
216
- * @param str text to make its background bright-white
217
- */
218
- export declare function bgBrightWhite(str: string): string;
219
- /**
220
- * Set text color using paletted 8bit colors.
221
- * https://en.wikipedia.org/wiki/ANSI_escape_code#8-bit
222
- * @param str text color to apply paletted 8bit colors to
223
- * @param color code
224
- */
225
- export declare function rgb8(str: string, color: number): string;
226
- /**
227
- * Set background color using paletted 8bit colors.
228
- * https://en.wikipedia.org/wiki/ANSI_escape_code#8-bit
229
- * @param str text color to apply paletted 8bit background colors to
230
- * @param color code
231
- */
232
- export declare function bgRgb8(str: string, color: number): string;
233
- /**
234
- * Set text color using 24bit rgb.
235
- * `color` can be a number in range `0x000000` to `0xffffff` or
236
- * an `Rgb`.
237
- *
238
- * To produce the color magenta:
239
- *
240
- * ```ts
241
- * import { rgb24 } from "https://deno.land/std@$STD_VERSION/fmt/colors.ts";
242
- * rgb24("foo", 0xff00ff);
243
- * rgb24("foo", {r: 255, g: 0, b: 255});
244
- * ```
245
- * @param str text color to apply 24bit rgb to
246
- * @param color code
247
- */
248
- export declare function rgb24(str: string, color: number | Rgb): string;
249
- /**
250
- * Set background color using 24bit rgb.
251
- * `color` can be a number in range `0x000000` to `0xffffff` or
252
- * an `Rgb`.
253
- *
254
- * To produce the color magenta:
255
- *
256
- * ```ts
257
- * import { bgRgb24 } from "https://deno.land/std@$STD_VERSION/fmt/colors.ts";
258
- * bgRgb24("foo", 0xff00ff);
259
- * bgRgb24("foo", {r: 255, g: 0, b: 255});
260
- * ```
261
- * @param str text color to apply 24bit rgb to
262
- * @param color code
263
- */
264
- export declare function bgRgb24(str: string, color: number | Rgb): string;
265
- /**
266
- * Remove ANSI escape codes from the string.
267
- * @param string to remove ANSI escape codes from
268
- */
269
- export declare function stripColor(string: string): string;
270
- export {};
@@ -1,26 +0,0 @@
1
- export declare enum DiffType {
2
- removed = "removed",
3
- common = "common",
4
- added = "added"
5
- }
6
- export interface DiffResult<T> {
7
- type: DiffType;
8
- value: T;
9
- details?: Array<DiffResult<T>>;
10
- }
11
- /**
12
- * Renders the differences between the actual and expected values
13
- * @param A Actual value
14
- * @param B Expected value
15
- */
16
- export declare function diff<T>(A: T[], B: T[]): Array<DiffResult<T>>;
17
- /**
18
- * Renders the differences between the actual and expected strings
19
- * Partially inspired from https://github.com/kpdecker/jsdiff
20
- * @param A Actual string
21
- * @param B Expected string
22
- */
23
- export declare function diffstr(A: string, B: string): DiffResult<string>[];
24
- export declare function buildMessage(diffResult: ReadonlyArray<DiffResult<string>>, { stringDiff }?: {
25
- stringDiff?: boolean | undefined;
26
- }): string[];
@@ -1 +0,0 @@
1
- export declare function format(v: unknown): string;
@@ -1,284 +0,0 @@
1
- export declare class AssertionError extends Error {
2
- name: string;
3
- constructor(message: string);
4
- }
5
- /**
6
- * Deep equality comparison used in assertions
7
- * @param c actual value
8
- * @param d expected value
9
- */
10
- export declare function equal(c: unknown, d: unknown): boolean;
11
- /** Make an assertion, error will be thrown if `expr` does not have truthy value. */
12
- export declare function assert(expr: unknown, msg?: string): asserts expr;
13
- /** Make an assertion, error will be thrown if `expr` have truthy value. */
14
- type Falsy = false | 0 | 0n | "" | null | undefined;
15
- export declare function assertFalse(expr: unknown, msg?: string): asserts expr is Falsy;
16
- /**
17
- * Make an assertion that `actual` and `expected` are equal, deeply. If not
18
- * deeply equal, then throw.
19
- *
20
- * Type parameter can be specified to ensure values under comparison have the same type.
21
- *
22
- * @example
23
- * ```ts
24
- * import { assertEquals } from "https://deno.land/std@$STD_VERSION/testing/asserts.ts";
25
- *
26
- * Deno.test("example", function (): void {
27
- * assertEquals("world", "world");
28
- * assertEquals({ hello: "world" }, { hello: "world" });
29
- * });
30
- * ```
31
- */
32
- export declare function assertEquals<T>(actual: T, expected: T, msg?: string): void;
33
- /**
34
- * Make an assertion that `actual` and `expected` are not equal, deeply.
35
- * If not then throw.
36
- *
37
- * Type parameter can be specified to ensure values under comparison have the same type.
38
- *
39
- * @example
40
- * ```ts
41
- * import { assertNotEquals } from "https://deno.land/std@$STD_VERSION/testing/asserts.ts";
42
- *
43
- * assertNotEquals<number>(1, 2)
44
- * ```
45
- */
46
- export declare function assertNotEquals<T>(actual: T, expected: T, msg?: string): void;
47
- /**
48
- * Make an assertion that `actual` and `expected` are strictly equal. If
49
- * not then throw.
50
- *
51
- * @example
52
- * ```ts
53
- * import { assertStrictEquals } from "https://deno.land/std@$STD_VERSION/testing/asserts.ts";
54
- *
55
- * Deno.test("isStrictlyEqual", function (): void {
56
- * const a = {};
57
- * const b = a;
58
- * assertStrictEquals(a, b);
59
- * });
60
- *
61
- * // This test fails
62
- * Deno.test("isNotStrictlyEqual", function (): void {
63
- * const a = {};
64
- * const b = {};
65
- * assertStrictEquals(a, b);
66
- * });
67
- * ```
68
- */
69
- export declare function assertStrictEquals<T>(actual: unknown, expected: T, msg?: string): asserts actual is T;
70
- /**
71
- * Make an assertion that `actual` and `expected` are not strictly equal.
72
- * If the values are strictly equal then throw.
73
- *
74
- * ```ts
75
- * import { assertNotStrictEquals } from "https://deno.land/std@$STD_VERSION/testing/asserts.ts";
76
- *
77
- * assertNotStrictEquals(1, 1)
78
- * ```
79
- */
80
- export declare function assertNotStrictEquals<T>(actual: T, expected: T, msg?: string): void;
81
- /**
82
- * Make an assertion that `actual` and `expected` are almost equal numbers through
83
- * a given tolerance. It can be used to take into account IEEE-754 double-precision
84
- * floating-point representation limitations.
85
- * If the values are not almost equal then throw.
86
- *
87
- * @example
88
- * ```ts
89
- * import { assertAlmostEquals, assertThrows } from "https://deno.land/std@$STD_VERSION/testing/asserts.ts";
90
- *
91
- * assertAlmostEquals(0.1, 0.2);
92
- *
93
- * // Using a custom tolerance value
94
- * assertAlmostEquals(0.1 + 0.2, 0.3, 1e-16);
95
- * assertThrows(() => assertAlmostEquals(0.1 + 0.2, 0.3, 1e-17));
96
- * ```
97
- */
98
- export declare function assertAlmostEquals(actual: number, expected: number, tolerance?: number, msg?: string): void;
99
- type AnyConstructor = new (...args: any[]) => any;
100
- type GetConstructorType<T extends AnyConstructor> = T extends new (...args: any) => infer C ? C : never;
101
- /**
102
- * Make an assertion that `obj` is an instance of `type`.
103
- * If not then throw.
104
- */
105
- export declare function assertInstanceOf<T extends AnyConstructor>(actual: unknown, expectedType: T, msg?: string): asserts actual is GetConstructorType<T>;
106
- /**
107
- * Make an assertion that `obj` is not an instance of `type`.
108
- * If so, then throw.
109
- */
110
- export declare function assertNotInstanceOf<A, T>(actual: A, unexpectedType: new (...args: any[]) => T, msg?: string): asserts actual is Exclude<A, T>;
111
- /**
112
- * Make an assertion that actual is not null or undefined.
113
- * If not then throw.
114
- */
115
- export declare function assertExists<T>(actual: T, msg?: string): asserts actual is NonNullable<T>;
116
- /**
117
- * Make an assertion that actual includes expected. If not
118
- * then throw.
119
- */
120
- export declare function assertStringIncludes(actual: string, expected: string, msg?: string): void;
121
- /**
122
- * Make an assertion that `actual` includes the `expected` values.
123
- * If not then an error will be thrown.
124
- *
125
- * Type parameter can be specified to ensure values under comparison have the same type.
126
- *
127
- * @example
128
- * ```ts
129
- * import { assertArrayIncludes } from "https://deno.land/std@$STD_VERSION/testing/asserts.ts";
130
- *
131
- * assertArrayIncludes<number>([1, 2], [2])
132
- * ```
133
- */
134
- export declare function assertArrayIncludes<T>(actual: ArrayLike<T>, expected: ArrayLike<T>, msg?: string): void;
135
- /**
136
- * Make an assertion that `actual` match RegExp `expected`. If not
137
- * then throw.
138
- */
139
- export declare function assertMatch(actual: string, expected: RegExp, msg?: string): void;
140
- /**
141
- * Make an assertion that `actual` not match RegExp `expected`. If match
142
- * then throw.
143
- */
144
- export declare function assertNotMatch(actual: string, expected: RegExp, msg?: string): void;
145
- /**
146
- * Make an assertion that `actual` object is a subset of `expected` object, deeply.
147
- * If not, then throw.
148
- */
149
- export declare function assertObjectMatch(actual: Record<PropertyKey, any>, expected: Record<PropertyKey, unknown>, msg?: string): void;
150
- /**
151
- * Forcefully throws a failed assertion
152
- */
153
- export declare function fail(msg?: string): never;
154
- /**
155
- * Make an assertion that `error` is an `Error`.
156
- * If not then an error will be thrown.
157
- * An error class and a string that should be included in the
158
- * error message can also be asserted.
159
- */
160
- export declare function assertIsError<E extends Error = Error>(error: unknown, ErrorClass?: new (...args: any[]) => E, msgIncludes?: string, msg?: string): asserts error is E;
161
- /**
162
- * Executes a function, expecting it to throw. If it does not, then it
163
- * throws.
164
- *
165
- * @example
166
- * ```ts
167
- * import { assertThrows } from "https://deno.land/std@$STD_VERSION/testing/asserts.ts";
168
- *
169
- * Deno.test("doesThrow", function (): void {
170
- * assertThrows((): void => {
171
- * throw new TypeError("hello world!");
172
- * });
173
- * });
174
- *
175
- * // This test will not pass.
176
- * Deno.test("fails", function (): void {
177
- * assertThrows((): void => {
178
- * console.log("Hello world");
179
- * });
180
- * });
181
- * ```
182
- */
183
- export declare function assertThrows(fn: () => unknown, msg?: string): unknown;
184
- /**
185
- * Executes a function, expecting it to throw. If it does not, then it
186
- * throws. An error class and a string that should be included in the
187
- * error message can also be asserted.
188
- *
189
- * @example
190
- *
191
- * ```ts
192
- * import { assertThrows } from "https://deno.land/std@$STD_VERSION/testing/asserts.ts";
193
- *
194
- * Deno.test("doesThrow", function (): void {
195
- * assertThrows((): void => {
196
- * throw new TypeError("hello world!");
197
- * }, TypeError);
198
- * assertThrows(
199
- * (): void => {
200
- * throw new TypeError("hello world!");
201
- * },
202
- * TypeError,
203
- * "hello",
204
- * );
205
- * });
206
- *
207
- * // This test will not pass.
208
- * Deno.test("fails", function (): void {
209
- * assertThrows((): void => {
210
- * console.log("Hello world");
211
- * });
212
- * });
213
- * ```
214
- */
215
- export declare function assertThrows<E extends Error = Error>(fn: () => unknown, ErrorClass: new (...args: any[]) => E, msgIncludes?: string, msg?: string): E;
216
- /**
217
- * Executes a function which returns a promise, expecting it to reject.
218
- *
219
- * @example
220
- * ```ts
221
- * import { assertRejects } from "https://deno.land/std@$STD_VERSION/testing/asserts.ts";
222
- *
223
- * Deno.test("doesThrow", async function () {
224
- * await assertRejects(
225
- * async () => {
226
- * throw new TypeError("hello world!");
227
- * },
228
- * );
229
- * await assertRejects(
230
- * async () => {
231
- * return Promise.reject(new Error());
232
- * },
233
- * );
234
- * });
235
- *
236
- * // This test will not pass.
237
- * Deno.test("fails", async function () {
238
- * await assertRejects(
239
- * async () => {
240
- * console.log("Hello world");
241
- * },
242
- * );
243
- * });
244
- * ```
245
- */
246
- export declare function assertRejects(fn: () => PromiseLike<unknown>, msg?: string): Promise<unknown>;
247
- /**
248
- * Executes a function which returns a promise, expecting it to reject.
249
- * If it does not, then it throws. An error class and a string that should be
250
- * included in the error message can also be asserted.
251
- *
252
- * @example
253
- * ```ts
254
- * import { assertRejects } from "https://deno.land/std@$STD_VERSION/testing/asserts.ts";
255
- *
256
- * Deno.test("doesThrow", async function () {
257
- * await assertRejects(async () => {
258
- * throw new TypeError("hello world!");
259
- * }, TypeError);
260
- * await assertRejects(
261
- * async () => {
262
- * throw new TypeError("hello world!");
263
- * },
264
- * TypeError,
265
- * "hello",
266
- * );
267
- * });
268
- *
269
- * // This test will not pass.
270
- * Deno.test("fails", async function () {
271
- * await assertRejects(
272
- * async () => {
273
- * console.log("Hello world");
274
- * },
275
- * );
276
- * });
277
- * ```
278
- */
279
- export declare function assertRejects<E extends Error = Error>(fn: () => PromiseLike<unknown>, ErrorClass: new (...args: any[]) => E, msgIncludes?: string, msg?: string): Promise<E>;
280
- /** Use this to stub out methods that will throw when invoked. */
281
- export declare function unimplemented(msg?: string): never;
282
- /** Use this to assert unreachable code. */
283
- export declare function unreachable(): never;
284
- export {};
@@ -1 +0,0 @@
1
- export {};
@@ -1,2 +0,0 @@
1
- import { DocumentNode } from "./types.js";
2
- export declare const ExampleDocument: DocumentNode;
@@ -1 +0,0 @@
1
- export {};
@@ -1 +0,0 @@
1
- export {};
@@ -1 +0,0 @@
1
- export {};
@@ -1 +0,0 @@
1
- export {};
@@ -1 +0,0 @@
1
- export {};
@@ -1,5 +0,0 @@
1
- import { Deno } from "@deno/shim-deno";
2
- export { Deno } from "@deno/shim-deno";
3
- export declare const dntGlobalThis: Omit<typeof globalThis, "Deno"> & {
4
- Deno: typeof Deno;
5
- };
@@ -1,270 +0,0 @@
1
- /** RGB 8-bits per channel. Each in range `0->255` or `0x00->0xff` */
2
- interface Rgb {
3
- r: number;
4
- g: number;
5
- b: number;
6
- }
7
- /**
8
- * Set changing text color to enabled or disabled
9
- * @param value
10
- */
11
- export declare function setColorEnabled(value: boolean): void;
12
- /** Get whether text color change is enabled or disabled. */
13
- export declare function getColorEnabled(): boolean;
14
- /**
15
- * Reset the text modified
16
- * @param str text to reset
17
- */
18
- export declare function reset(str: string): string;
19
- /**
20
- * Make the text bold.
21
- * @param str text to make bold
22
- */
23
- export declare function bold(str: string): string;
24
- /**
25
- * The text emits only a small amount of light.
26
- * @param str text to dim
27
- */
28
- export declare function dim(str: string): string;
29
- /**
30
- * Make the text italic.
31
- * @param str text to make italic
32
- */
33
- export declare function italic(str: string): string;
34
- /**
35
- * Make the text underline.
36
- * @param str text to underline
37
- */
38
- export declare function underline(str: string): string;
39
- /**
40
- * Invert background color and text color.
41
- * @param str text to invert its color
42
- */
43
- export declare function inverse(str: string): string;
44
- /**
45
- * Make the text hidden.
46
- * @param str text to hide
47
- */
48
- export declare function hidden(str: string): string;
49
- /**
50
- * Put horizontal line through the center of the text.
51
- * @param str text to strike through
52
- */
53
- export declare function strikethrough(str: string): string;
54
- /**
55
- * Set text color to black.
56
- * @param str text to make black
57
- */
58
- export declare function black(str: string): string;
59
- /**
60
- * Set text color to red.
61
- * @param str text to make red
62
- */
63
- export declare function red(str: string): string;
64
- /**
65
- * Set text color to green.
66
- * @param str text to make green
67
- */
68
- export declare function green(str: string): string;
69
- /**
70
- * Set text color to yellow.
71
- * @param str text to make yellow
72
- */
73
- export declare function yellow(str: string): string;
74
- /**
75
- * Set text color to blue.
76
- * @param str text to make blue
77
- */
78
- export declare function blue(str: string): string;
79
- /**
80
- * Set text color to magenta.
81
- * @param str text to make magenta
82
- */
83
- export declare function magenta(str: string): string;
84
- /**
85
- * Set text color to cyan.
86
- * @param str text to make cyan
87
- */
88
- export declare function cyan(str: string): string;
89
- /**
90
- * Set text color to white.
91
- * @param str text to make white
92
- */
93
- export declare function white(str: string): string;
94
- /**
95
- * Set text color to gray.
96
- * @param str text to make gray
97
- */
98
- export declare function gray(str: string): string;
99
- /**
100
- * Set text color to bright black.
101
- * @param str text to make bright-black
102
- */
103
- export declare function brightBlack(str: string): string;
104
- /**
105
- * Set text color to bright red.
106
- * @param str text to make bright-red
107
- */
108
- export declare function brightRed(str: string): string;
109
- /**
110
- * Set text color to bright green.
111
- * @param str text to make bright-green
112
- */
113
- export declare function brightGreen(str: string): string;
114
- /**
115
- * Set text color to bright yellow.
116
- * @param str text to make bright-yellow
117
- */
118
- export declare function brightYellow(str: string): string;
119
- /**
120
- * Set text color to bright blue.
121
- * @param str text to make bright-blue
122
- */
123
- export declare function brightBlue(str: string): string;
124
- /**
125
- * Set text color to bright magenta.
126
- * @param str text to make bright-magenta
127
- */
128
- export declare function brightMagenta(str: string): string;
129
- /**
130
- * Set text color to bright cyan.
131
- * @param str text to make bright-cyan
132
- */
133
- export declare function brightCyan(str: string): string;
134
- /**
135
- * Set text color to bright white.
136
- * @param str text to make bright-white
137
- */
138
- export declare function brightWhite(str: string): string;
139
- /**
140
- * Set background color to black.
141
- * @param str text to make its background black
142
- */
143
- export declare function bgBlack(str: string): string;
144
- /**
145
- * Set background color to red.
146
- * @param str text to make its background red
147
- */
148
- export declare function bgRed(str: string): string;
149
- /**
150
- * Set background color to green.
151
- * @param str text to make its background green
152
- */
153
- export declare function bgGreen(str: string): string;
154
- /**
155
- * Set background color to yellow.
156
- * @param str text to make its background yellow
157
- */
158
- export declare function bgYellow(str: string): string;
159
- /**
160
- * Set background color to blue.
161
- * @param str text to make its background blue
162
- */
163
- export declare function bgBlue(str: string): string;
164
- /**
165
- * Set background color to magenta.
166
- * @param str text to make its background magenta
167
- */
168
- export declare function bgMagenta(str: string): string;
169
- /**
170
- * Set background color to cyan.
171
- * @param str text to make its background cyan
172
- */
173
- export declare function bgCyan(str: string): string;
174
- /**
175
- * Set background color to white.
176
- * @param str text to make its background white
177
- */
178
- export declare function bgWhite(str: string): string;
179
- /**
180
- * Set background color to bright black.
181
- * @param str text to make its background bright-black
182
- */
183
- export declare function bgBrightBlack(str: string): string;
184
- /**
185
- * Set background color to bright red.
186
- * @param str text to make its background bright-red
187
- */
188
- export declare function bgBrightRed(str: string): string;
189
- /**
190
- * Set background color to bright green.
191
- * @param str text to make its background bright-green
192
- */
193
- export declare function bgBrightGreen(str: string): string;
194
- /**
195
- * Set background color to bright yellow.
196
- * @param str text to make its background bright-yellow
197
- */
198
- export declare function bgBrightYellow(str: string): string;
199
- /**
200
- * Set background color to bright blue.
201
- * @param str text to make its background bright-blue
202
- */
203
- export declare function bgBrightBlue(str: string): string;
204
- /**
205
- * Set background color to bright magenta.
206
- * @param str text to make its background bright-magenta
207
- */
208
- export declare function bgBrightMagenta(str: string): string;
209
- /**
210
- * Set background color to bright cyan.
211
- * @param str text to make its background bright-cyan
212
- */
213
- export declare function bgBrightCyan(str: string): string;
214
- /**
215
- * Set background color to bright white.
216
- * @param str text to make its background bright-white
217
- */
218
- export declare function bgBrightWhite(str: string): string;
219
- /**
220
- * Set text color using paletted 8bit colors.
221
- * https://en.wikipedia.org/wiki/ANSI_escape_code#8-bit
222
- * @param str text color to apply paletted 8bit colors to
223
- * @param color code
224
- */
225
- export declare function rgb8(str: string, color: number): string;
226
- /**
227
- * Set background color using paletted 8bit colors.
228
- * https://en.wikipedia.org/wiki/ANSI_escape_code#8-bit
229
- * @param str text color to apply paletted 8bit background colors to
230
- * @param color code
231
- */
232
- export declare function bgRgb8(str: string, color: number): string;
233
- /**
234
- * Set text color using 24bit rgb.
235
- * `color` can be a number in range `0x000000` to `0xffffff` or
236
- * an `Rgb`.
237
- *
238
- * To produce the color magenta:
239
- *
240
- * ```ts
241
- * import { rgb24 } from "https://deno.land/std@$STD_VERSION/fmt/colors.ts";
242
- * rgb24("foo", 0xff00ff);
243
- * rgb24("foo", {r: 255, g: 0, b: 255});
244
- * ```
245
- * @param str text color to apply 24bit rgb to
246
- * @param color code
247
- */
248
- export declare function rgb24(str: string, color: number | Rgb): string;
249
- /**
250
- * Set background color using 24bit rgb.
251
- * `color` can be a number in range `0x000000` to `0xffffff` or
252
- * an `Rgb`.
253
- *
254
- * To produce the color magenta:
255
- *
256
- * ```ts
257
- * import { bgRgb24 } from "https://deno.land/std@$STD_VERSION/fmt/colors.ts";
258
- * bgRgb24("foo", 0xff00ff);
259
- * bgRgb24("foo", {r: 255, g: 0, b: 255});
260
- * ```
261
- * @param str text color to apply 24bit rgb to
262
- * @param color code
263
- */
264
- export declare function bgRgb24(str: string, color: number | Rgb): string;
265
- /**
266
- * Remove ANSI escape codes from the string.
267
- * @param string to remove ANSI escape codes from
268
- */
269
- export declare function stripColor(string: string): string;
270
- export {};
@@ -1,26 +0,0 @@
1
- export declare enum DiffType {
2
- removed = "removed",
3
- common = "common",
4
- added = "added"
5
- }
6
- export interface DiffResult<T> {
7
- type: DiffType;
8
- value: T;
9
- details?: Array<DiffResult<T>>;
10
- }
11
- /**
12
- * Renders the differences between the actual and expected values
13
- * @param A Actual value
14
- * @param B Expected value
15
- */
16
- export declare function diff<T>(A: T[], B: T[]): Array<DiffResult<T>>;
17
- /**
18
- * Renders the differences between the actual and expected strings
19
- * Partially inspired from https://github.com/kpdecker/jsdiff
20
- * @param A Actual string
21
- * @param B Expected string
22
- */
23
- export declare function diffstr(A: string, B: string): DiffResult<string>[];
24
- export declare function buildMessage(diffResult: ReadonlyArray<DiffResult<string>>, { stringDiff }?: {
25
- stringDiff?: boolean | undefined;
26
- }): string[];
@@ -1 +0,0 @@
1
- export declare function format(v: unknown): string;
@@ -1,284 +0,0 @@
1
- export declare class AssertionError extends Error {
2
- name: string;
3
- constructor(message: string);
4
- }
5
- /**
6
- * Deep equality comparison used in assertions
7
- * @param c actual value
8
- * @param d expected value
9
- */
10
- export declare function equal(c: unknown, d: unknown): boolean;
11
- /** Make an assertion, error will be thrown if `expr` does not have truthy value. */
12
- export declare function assert(expr: unknown, msg?: string): asserts expr;
13
- /** Make an assertion, error will be thrown if `expr` have truthy value. */
14
- type Falsy = false | 0 | 0n | "" | null | undefined;
15
- export declare function assertFalse(expr: unknown, msg?: string): asserts expr is Falsy;
16
- /**
17
- * Make an assertion that `actual` and `expected` are equal, deeply. If not
18
- * deeply equal, then throw.
19
- *
20
- * Type parameter can be specified to ensure values under comparison have the same type.
21
- *
22
- * @example
23
- * ```ts
24
- * import { assertEquals } from "https://deno.land/std@$STD_VERSION/testing/asserts.ts";
25
- *
26
- * Deno.test("example", function (): void {
27
- * assertEquals("world", "world");
28
- * assertEquals({ hello: "world" }, { hello: "world" });
29
- * });
30
- * ```
31
- */
32
- export declare function assertEquals<T>(actual: T, expected: T, msg?: string): void;
33
- /**
34
- * Make an assertion that `actual` and `expected` are not equal, deeply.
35
- * If not then throw.
36
- *
37
- * Type parameter can be specified to ensure values under comparison have the same type.
38
- *
39
- * @example
40
- * ```ts
41
- * import { assertNotEquals } from "https://deno.land/std@$STD_VERSION/testing/asserts.ts";
42
- *
43
- * assertNotEquals<number>(1, 2)
44
- * ```
45
- */
46
- export declare function assertNotEquals<T>(actual: T, expected: T, msg?: string): void;
47
- /**
48
- * Make an assertion that `actual` and `expected` are strictly equal. If
49
- * not then throw.
50
- *
51
- * @example
52
- * ```ts
53
- * import { assertStrictEquals } from "https://deno.land/std@$STD_VERSION/testing/asserts.ts";
54
- *
55
- * Deno.test("isStrictlyEqual", function (): void {
56
- * const a = {};
57
- * const b = a;
58
- * assertStrictEquals(a, b);
59
- * });
60
- *
61
- * // This test fails
62
- * Deno.test("isNotStrictlyEqual", function (): void {
63
- * const a = {};
64
- * const b = {};
65
- * assertStrictEquals(a, b);
66
- * });
67
- * ```
68
- */
69
- export declare function assertStrictEquals<T>(actual: unknown, expected: T, msg?: string): asserts actual is T;
70
- /**
71
- * Make an assertion that `actual` and `expected` are not strictly equal.
72
- * If the values are strictly equal then throw.
73
- *
74
- * ```ts
75
- * import { assertNotStrictEquals } from "https://deno.land/std@$STD_VERSION/testing/asserts.ts";
76
- *
77
- * assertNotStrictEquals(1, 1)
78
- * ```
79
- */
80
- export declare function assertNotStrictEquals<T>(actual: T, expected: T, msg?: string): void;
81
- /**
82
- * Make an assertion that `actual` and `expected` are almost equal numbers through
83
- * a given tolerance. It can be used to take into account IEEE-754 double-precision
84
- * floating-point representation limitations.
85
- * If the values are not almost equal then throw.
86
- *
87
- * @example
88
- * ```ts
89
- * import { assertAlmostEquals, assertThrows } from "https://deno.land/std@$STD_VERSION/testing/asserts.ts";
90
- *
91
- * assertAlmostEquals(0.1, 0.2);
92
- *
93
- * // Using a custom tolerance value
94
- * assertAlmostEquals(0.1 + 0.2, 0.3, 1e-16);
95
- * assertThrows(() => assertAlmostEquals(0.1 + 0.2, 0.3, 1e-17));
96
- * ```
97
- */
98
- export declare function assertAlmostEquals(actual: number, expected: number, tolerance?: number, msg?: string): void;
99
- type AnyConstructor = new (...args: any[]) => any;
100
- type GetConstructorType<T extends AnyConstructor> = T extends new (...args: any) => infer C ? C : never;
101
- /**
102
- * Make an assertion that `obj` is an instance of `type`.
103
- * If not then throw.
104
- */
105
- export declare function assertInstanceOf<T extends AnyConstructor>(actual: unknown, expectedType: T, msg?: string): asserts actual is GetConstructorType<T>;
106
- /**
107
- * Make an assertion that `obj` is not an instance of `type`.
108
- * If so, then throw.
109
- */
110
- export declare function assertNotInstanceOf<A, T>(actual: A, unexpectedType: new (...args: any[]) => T, msg?: string): asserts actual is Exclude<A, T>;
111
- /**
112
- * Make an assertion that actual is not null or undefined.
113
- * If not then throw.
114
- */
115
- export declare function assertExists<T>(actual: T, msg?: string): asserts actual is NonNullable<T>;
116
- /**
117
- * Make an assertion that actual includes expected. If not
118
- * then throw.
119
- */
120
- export declare function assertStringIncludes(actual: string, expected: string, msg?: string): void;
121
- /**
122
- * Make an assertion that `actual` includes the `expected` values.
123
- * If not then an error will be thrown.
124
- *
125
- * Type parameter can be specified to ensure values under comparison have the same type.
126
- *
127
- * @example
128
- * ```ts
129
- * import { assertArrayIncludes } from "https://deno.land/std@$STD_VERSION/testing/asserts.ts";
130
- *
131
- * assertArrayIncludes<number>([1, 2], [2])
132
- * ```
133
- */
134
- export declare function assertArrayIncludes<T>(actual: ArrayLike<T>, expected: ArrayLike<T>, msg?: string): void;
135
- /**
136
- * Make an assertion that `actual` match RegExp `expected`. If not
137
- * then throw.
138
- */
139
- export declare function assertMatch(actual: string, expected: RegExp, msg?: string): void;
140
- /**
141
- * Make an assertion that `actual` not match RegExp `expected`. If match
142
- * then throw.
143
- */
144
- export declare function assertNotMatch(actual: string, expected: RegExp, msg?: string): void;
145
- /**
146
- * Make an assertion that `actual` object is a subset of `expected` object, deeply.
147
- * If not, then throw.
148
- */
149
- export declare function assertObjectMatch(actual: Record<PropertyKey, any>, expected: Record<PropertyKey, unknown>, msg?: string): void;
150
- /**
151
- * Forcefully throws a failed assertion
152
- */
153
- export declare function fail(msg?: string): never;
154
- /**
155
- * Make an assertion that `error` is an `Error`.
156
- * If not then an error will be thrown.
157
- * An error class and a string that should be included in the
158
- * error message can also be asserted.
159
- */
160
- export declare function assertIsError<E extends Error = Error>(error: unknown, ErrorClass?: new (...args: any[]) => E, msgIncludes?: string, msg?: string): asserts error is E;
161
- /**
162
- * Executes a function, expecting it to throw. If it does not, then it
163
- * throws.
164
- *
165
- * @example
166
- * ```ts
167
- * import { assertThrows } from "https://deno.land/std@$STD_VERSION/testing/asserts.ts";
168
- *
169
- * Deno.test("doesThrow", function (): void {
170
- * assertThrows((): void => {
171
- * throw new TypeError("hello world!");
172
- * });
173
- * });
174
- *
175
- * // This test will not pass.
176
- * Deno.test("fails", function (): void {
177
- * assertThrows((): void => {
178
- * console.log("Hello world");
179
- * });
180
- * });
181
- * ```
182
- */
183
- export declare function assertThrows(fn: () => unknown, msg?: string): unknown;
184
- /**
185
- * Executes a function, expecting it to throw. If it does not, then it
186
- * throws. An error class and a string that should be included in the
187
- * error message can also be asserted.
188
- *
189
- * @example
190
- *
191
- * ```ts
192
- * import { assertThrows } from "https://deno.land/std@$STD_VERSION/testing/asserts.ts";
193
- *
194
- * Deno.test("doesThrow", function (): void {
195
- * assertThrows((): void => {
196
- * throw new TypeError("hello world!");
197
- * }, TypeError);
198
- * assertThrows(
199
- * (): void => {
200
- * throw new TypeError("hello world!");
201
- * },
202
- * TypeError,
203
- * "hello",
204
- * );
205
- * });
206
- *
207
- * // This test will not pass.
208
- * Deno.test("fails", function (): void {
209
- * assertThrows((): void => {
210
- * console.log("Hello world");
211
- * });
212
- * });
213
- * ```
214
- */
215
- export declare function assertThrows<E extends Error = Error>(fn: () => unknown, ErrorClass: new (...args: any[]) => E, msgIncludes?: string, msg?: string): E;
216
- /**
217
- * Executes a function which returns a promise, expecting it to reject.
218
- *
219
- * @example
220
- * ```ts
221
- * import { assertRejects } from "https://deno.land/std@$STD_VERSION/testing/asserts.ts";
222
- *
223
- * Deno.test("doesThrow", async function () {
224
- * await assertRejects(
225
- * async () => {
226
- * throw new TypeError("hello world!");
227
- * },
228
- * );
229
- * await assertRejects(
230
- * async () => {
231
- * return Promise.reject(new Error());
232
- * },
233
- * );
234
- * });
235
- *
236
- * // This test will not pass.
237
- * Deno.test("fails", async function () {
238
- * await assertRejects(
239
- * async () => {
240
- * console.log("Hello world");
241
- * },
242
- * );
243
- * });
244
- * ```
245
- */
246
- export declare function assertRejects(fn: () => PromiseLike<unknown>, msg?: string): Promise<unknown>;
247
- /**
248
- * Executes a function which returns a promise, expecting it to reject.
249
- * If it does not, then it throws. An error class and a string that should be
250
- * included in the error message can also be asserted.
251
- *
252
- * @example
253
- * ```ts
254
- * import { assertRejects } from "https://deno.land/std@$STD_VERSION/testing/asserts.ts";
255
- *
256
- * Deno.test("doesThrow", async function () {
257
- * await assertRejects(async () => {
258
- * throw new TypeError("hello world!");
259
- * }, TypeError);
260
- * await assertRejects(
261
- * async () => {
262
- * throw new TypeError("hello world!");
263
- * },
264
- * TypeError,
265
- * "hello",
266
- * );
267
- * });
268
- *
269
- * // This test will not pass.
270
- * Deno.test("fails", async function () {
271
- * await assertRejects(
272
- * async () => {
273
- * console.log("Hello world");
274
- * },
275
- * );
276
- * });
277
- * ```
278
- */
279
- export declare function assertRejects<E extends Error = Error>(fn: () => PromiseLike<unknown>, ErrorClass: new (...args: any[]) => E, msgIncludes?: string, msg?: string): Promise<E>;
280
- /** Use this to stub out methods that will throw when invoked. */
281
- export declare function unimplemented(msg?: string): never;
282
- /** Use this to assert unreachable code. */
283
- export declare function unreachable(): never;
284
- export {};