@fgv/ts-utils-jest 1.9.5 → 2.0.1-alpha.0

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.
Files changed (179) hide show
  1. package/CHANGELOG.json +28 -0
  2. package/CHANGELOG.md +12 -0
  3. package/README.md +1 -1
  4. package/dist/ts-utils-jest.d.ts +69 -0
  5. package/{helpers → lib/helpers}/fsHelpers.d.ts +21 -5
  6. package/lib/helpers/fsHelpers.d.ts.map +1 -0
  7. package/lib/helpers/fsHelpers.js +170 -0
  8. package/lib/helpers/fsHelpers.js.map +1 -0
  9. package/lib/helpers/index.d.ts +2 -0
  10. package/lib/helpers/index.d.ts.map +1 -0
  11. package/{helpers → lib/helpers}/index.js +1 -1
  12. package/lib/helpers/index.js.map +1 -0
  13. package/lib/index.d.ts +4 -0
  14. package/lib/index.d.ts.map +1 -0
  15. package/lib/index.js +50 -0
  16. package/lib/index.js.map +1 -0
  17. package/{matchers → lib/matchers}/index.d.ts +1 -0
  18. package/lib/matchers/index.d.ts.map +1 -0
  19. package/lib/matchers/index.js +20 -0
  20. package/lib/matchers/index.js.map +1 -0
  21. package/{matchers → lib/matchers}/toFail/index.d.ts +1 -0
  22. package/lib/matchers/toFail/index.d.ts.map +1 -0
  23. package/lib/matchers/toFail/index.js +25 -0
  24. package/lib/matchers/toFail/index.js.map +1 -0
  25. package/{matchers → lib/matchers}/toFail/predicate.d.ts +2 -1
  26. package/lib/matchers/toFail/predicate.d.ts.map +1 -0
  27. package/lib/matchers/toFail/predicate.js +9 -0
  28. package/lib/matchers/toFail/predicate.js.map +1 -0
  29. package/{matchers → lib/matchers}/toFailTest/index.d.ts +1 -0
  30. package/lib/matchers/toFailTest/index.d.ts.map +1 -0
  31. package/lib/matchers/toFailTest/index.js +30 -0
  32. package/lib/matchers/toFailTest/index.js.map +1 -0
  33. package/lib/matchers/toFailTest/predicate.d.ts +3 -0
  34. package/lib/matchers/toFailTest/predicate.d.ts.map +1 -0
  35. package/lib/matchers/toFailTest/predicate.js +12 -0
  36. package/lib/matchers/toFailTest/predicate.js.map +1 -0
  37. package/{matchers → lib/matchers}/toFailTestAndMatchSnapshot/index.d.ts +1 -0
  38. package/lib/matchers/toFailTestAndMatchSnapshot/index.d.ts.map +1 -0
  39. package/lib/matchers/toFailTestAndMatchSnapshot/index.js +26 -0
  40. package/lib/matchers/toFailTestAndMatchSnapshot/index.js.map +1 -0
  41. package/{matchers → lib/matchers}/toFailTestAndMatchSnapshot/predicate.d.ts +2 -1
  42. package/lib/matchers/toFailTestAndMatchSnapshot/predicate.d.ts.map +1 -0
  43. package/lib/matchers/toFailTestAndMatchSnapshot/predicate.js +15 -0
  44. package/lib/matchers/toFailTestAndMatchSnapshot/predicate.js.map +1 -0
  45. package/{matchers → lib/matchers}/toFailTestWith/index.d.ts +2 -1
  46. package/lib/matchers/toFailTestWith/index.d.ts.map +1 -0
  47. package/lib/matchers/toFailTestWith/index.js +31 -0
  48. package/lib/matchers/toFailTestWith/index.js.map +1 -0
  49. package/{matchers → lib/matchers}/toFailTestWith/predicate.d.ts +2 -1
  50. package/lib/matchers/toFailTestWith/predicate.d.ts.map +1 -0
  51. package/lib/matchers/toFailTestWith/predicate.js +30 -0
  52. package/lib/matchers/toFailTestWith/predicate.js.map +1 -0
  53. package/{matchers → lib/matchers}/toFailWith/index.d.ts +2 -1
  54. package/lib/matchers/toFailWith/index.d.ts.map +1 -0
  55. package/lib/matchers/toFailWith/index.js +29 -0
  56. package/lib/matchers/toFailWith/index.js.map +1 -0
  57. package/{matchers → lib/matchers}/toFailWith/predicate.d.ts +2 -1
  58. package/lib/matchers/toFailWith/predicate.d.ts.map +1 -0
  59. package/lib/matchers/toFailWith/predicate.js +20 -0
  60. package/lib/matchers/toFailWith/predicate.js.map +1 -0
  61. package/{matchers → lib/matchers}/toFailWithDetail/index.d.ts +2 -1
  62. package/lib/matchers/toFailWithDetail/index.d.ts.map +1 -0
  63. package/lib/matchers/toFailWithDetail/index.js +29 -0
  64. package/lib/matchers/toFailWithDetail/index.js.map +1 -0
  65. package/{matchers → lib/matchers}/toFailWithDetail/predicate.d.ts +2 -1
  66. package/lib/matchers/toFailWithDetail/predicate.d.ts.map +1 -0
  67. package/lib/matchers/toFailWithDetail/predicate.js +26 -0
  68. package/lib/matchers/toFailWithDetail/predicate.js.map +1 -0
  69. package/{matchers → lib/matchers}/toHaveBeenCalledWithArgumentsMatching/index.d.ts +2 -1
  70. package/lib/matchers/toHaveBeenCalledWithArgumentsMatching/index.d.ts.map +1 -0
  71. package/lib/matchers/toHaveBeenCalledWithArgumentsMatching/index.js +71 -0
  72. package/lib/matchers/toHaveBeenCalledWithArgumentsMatching/index.js.map +1 -0
  73. package/lib/matchers/toHaveBeenCalledWithArgumentsMatching/predicate.d.ts +8 -0
  74. package/lib/matchers/toHaveBeenCalledWithArgumentsMatching/predicate.d.ts.map +1 -0
  75. package/lib/matchers/toHaveBeenCalledWithArgumentsMatching/predicate.js +16 -0
  76. package/lib/matchers/toHaveBeenCalledWithArgumentsMatching/predicate.js.map +1 -0
  77. package/{matchers → lib/matchers}/toSucceed/index.d.ts +1 -0
  78. package/lib/matchers/toSucceed/index.d.ts.map +1 -0
  79. package/lib/matchers/toSucceed/index.js +25 -0
  80. package/lib/matchers/toSucceed/index.js.map +1 -0
  81. package/{matchers → lib/matchers}/toSucceed/predicate.d.ts +2 -1
  82. package/lib/matchers/toSucceed/predicate.d.ts.map +1 -0
  83. package/lib/matchers/toSucceed/predicate.js +9 -0
  84. package/lib/matchers/toSucceed/predicate.js.map +1 -0
  85. package/{matchers → lib/matchers}/toSucceedAndMatchInlineSnapshot/index.d.ts +1 -0
  86. package/lib/matchers/toSucceedAndMatchInlineSnapshot/index.d.ts.map +1 -0
  87. package/lib/matchers/toSucceedAndMatchInlineSnapshot/index.js +26 -0
  88. package/lib/matchers/toSucceedAndMatchInlineSnapshot/index.js.map +1 -0
  89. package/{matchers → lib/matchers}/toSucceedAndMatchSnapshot/index.d.ts +1 -0
  90. package/lib/matchers/toSucceedAndMatchSnapshot/index.d.ts.map +1 -0
  91. package/lib/matchers/toSucceedAndMatchSnapshot/index.js +25 -0
  92. package/lib/matchers/toSucceedAndMatchSnapshot/index.js.map +1 -0
  93. package/{matchers → lib/matchers}/toSucceedAndSatisfy/index.d.ts +2 -1
  94. package/lib/matchers/toSucceedAndSatisfy/index.d.ts.map +1 -0
  95. package/lib/matchers/toSucceedAndSatisfy/index.js +53 -0
  96. package/lib/matchers/toSucceedAndSatisfy/index.js.map +1 -0
  97. package/{matchers → lib/matchers}/toSucceedAndSatisfy/predicate.d.ts +2 -1
  98. package/lib/matchers/toSucceedAndSatisfy/predicate.d.ts.map +1 -0
  99. package/lib/matchers/toSucceedAndSatisfy/predicate.js +21 -0
  100. package/lib/matchers/toSucceedAndSatisfy/predicate.js.map +1 -0
  101. package/{matchers → lib/matchers}/toSucceedWith/index.d.ts +3 -2
  102. package/lib/matchers/toSucceedWith/index.d.ts.map +1 -0
  103. package/lib/matchers/toSucceedWith/index.js +29 -0
  104. package/lib/matchers/toSucceedWith/index.js.map +1 -0
  105. package/{matchers → lib/matchers}/toSucceedWith/predicate.d.ts +2 -1
  106. package/lib/matchers/toSucceedWith/predicate.d.ts.map +1 -0
  107. package/lib/matchers/toSucceedWith/predicate.js +16 -0
  108. package/lib/matchers/toSucceedWith/predicate.js.map +1 -0
  109. package/{matchers → lib/matchers}/toSucceedWithDetail/index.d.ts +2 -1
  110. package/lib/matchers/toSucceedWithDetail/index.d.ts.map +1 -0
  111. package/lib/matchers/toSucceedWithDetail/index.js +29 -0
  112. package/lib/matchers/toSucceedWithDetail/index.js.map +1 -0
  113. package/{matchers → lib/matchers}/toSucceedWithDetail/predicate.d.ts +2 -1
  114. package/lib/matchers/toSucceedWithDetail/predicate.d.ts.map +1 -0
  115. package/lib/matchers/toSucceedWithDetail/predicate.js +21 -0
  116. package/lib/matchers/toSucceedWithDetail/predicate.js.map +1 -0
  117. package/{resolvers → lib/resolvers}/cli.d.ts +1 -0
  118. package/lib/resolvers/cli.d.ts.map +1 -0
  119. package/lib/resolvers/cli.js +41 -0
  120. package/lib/resolvers/cli.js.map +1 -0
  121. package/{resolvers → lib/resolvers}/ide.d.ts +1 -0
  122. package/lib/resolvers/ide.d.ts.map +1 -0
  123. package/lib/resolvers/ide.js +41 -0
  124. package/lib/resolvers/ide.js.map +1 -0
  125. package/lib/ts-utils.d.ts +2 -0
  126. package/lib/ts-utils.d.ts.map +1 -0
  127. package/{ts-utils.js → lib/ts-utils.js} +1 -1
  128. package/lib/ts-utils.js.map +1 -0
  129. package/lib/tsdoc-metadata.json +11 -0
  130. package/{types → lib/types}/index.d.ts +20 -19
  131. package/lib/types/index.d.ts.map +1 -0
  132. package/lib/types/index.js +4 -0
  133. package/lib/types/index.js.map +1 -0
  134. package/{utils → lib/utils}/matcherHelpers.d.ts +1 -0
  135. package/lib/utils/matcherHelpers.d.ts.map +1 -0
  136. package/lib/utils/matcherHelpers.js +54 -0
  137. package/lib/utils/matcherHelpers.js.map +1 -0
  138. package/{utils → lib/utils}/snapshotResolver.d.ts +1 -0
  139. package/lib/utils/snapshotResolver.d.ts.map +1 -0
  140. package/lib/utils/snapshotResolver.js +19 -0
  141. package/lib/utils/snapshotResolver.js.map +1 -0
  142. package/package.json +56 -53
  143. package/helpers/fsHelpers.js +0 -164
  144. package/helpers/index.d.ts +0 -1
  145. package/index.d.ts +0 -2
  146. package/index.js +0 -27
  147. package/matchers/index.js +0 -34
  148. package/matchers/toFail/index.js +0 -29
  149. package/matchers/toFail/predicate.js +0 -9
  150. package/matchers/toFailTest/index.js +0 -30
  151. package/matchers/toFailTest/predicate.d.ts +0 -2
  152. package/matchers/toFailTest/predicate.js +0 -12
  153. package/matchers/toFailTestAndMatchSnapshot/index.js +0 -25
  154. package/matchers/toFailTestAndMatchSnapshot/predicate.js +0 -15
  155. package/matchers/toFailTestWith/index.js +0 -31
  156. package/matchers/toFailTestWith/predicate.js +0 -30
  157. package/matchers/toFailWith/index.js +0 -29
  158. package/matchers/toFailWith/predicate.js +0 -20
  159. package/matchers/toFailWithDetail/index.js +0 -29
  160. package/matchers/toFailWithDetail/predicate.js +0 -26
  161. package/matchers/toHaveBeenCalledWithArgumentsMatching/index.js +0 -71
  162. package/matchers/toHaveBeenCalledWithArgumentsMatching/predicate.d.ts +0 -7
  163. package/matchers/toHaveBeenCalledWithArgumentsMatching/predicate.js +0 -16
  164. package/matchers/toSucceed/index.js +0 -29
  165. package/matchers/toSucceed/predicate.js +0 -9
  166. package/matchers/toSucceedAndMatchInlineSnapshot/index.js +0 -26
  167. package/matchers/toSucceedAndMatchSnapshot/index.js +0 -25
  168. package/matchers/toSucceedAndSatisfy/index.js +0 -53
  169. package/matchers/toSucceedAndSatisfy/predicate.js +0 -21
  170. package/matchers/toSucceedWith/index.js +0 -29
  171. package/matchers/toSucceedWith/predicate.js +0 -16
  172. package/matchers/toSucceedWithDetail/index.js +0 -29
  173. package/matchers/toSucceedWithDetail/predicate.js +0 -21
  174. package/resolvers/cli.js +0 -41
  175. package/resolvers/ide.js +0 -41
  176. package/ts-utils.d.ts +0 -1
  177. package/types/index.js +0 -4
  178. package/utils/matcherHelpers.js +0 -56
  179. package/utils/snapshotResolver.js +0 -19
package/CHANGELOG.json ADDED
@@ -0,0 +1,28 @@
1
+ {
2
+ "name": "@fgv/ts-utils-jest",
3
+ "entries": [
4
+ {
5
+ "version": "2.0.0",
6
+ "tag": "@fgv/ts-utils-jest_v2.0.0",
7
+ "date": "Mon, 10 Apr 2023 03:33:11 GMT",
8
+ "comments": {
9
+ "major": [
10
+ {
11
+ "comment": "initial checking"
12
+ },
13
+ {
14
+ "comment": "refactor"
15
+ }
16
+ ],
17
+ "dependency": [
18
+ {
19
+ "comment": "Updating dependency \"@fgv/ts-utils\" to `2.0.0`"
20
+ },
21
+ {
22
+ "comment": "Updating dependency \"@fgv/ts-utils\" from `^1.9.4` to `^2.0.0`"
23
+ }
24
+ ]
25
+ }
26
+ }
27
+ ]
28
+ }
package/CHANGELOG.md ADDED
@@ -0,0 +1,12 @@
1
+ # Change Log - @fgv/ts-utils-jest
2
+
3
+ This log was last generated on Mon, 10 Apr 2023 03:33:11 GMT and should not be manually modified.
4
+
5
+ ## 2.0.0
6
+ Mon, 10 Apr 2023 03:33:11 GMT
7
+
8
+ ### Breaking changes
9
+
10
+ - initial checking
11
+ - refactor
12
+
package/README.md CHANGED
@@ -36,7 +36,7 @@ Also includes a handful of custom matchers to simplify the testing of other cust
36
36
 
37
37
  With npm:
38
38
  ```sh
39
- npm install --save-dev ts-utils-jest
39
+ npm install --save-dev @fgv/ts-utils-jest
40
40
  ```
41
41
 
42
42
  ## Setup
@@ -0,0 +1,69 @@
1
+ /// <reference types="jest" />
2
+ /// <reference types="node" />
3
+
4
+ /**
5
+ * @public
6
+ */
7
+ declare interface IMockFileConfig {
8
+ path: string;
9
+ backingFile?: string;
10
+ payload?: string;
11
+ writable?: boolean;
12
+ }
13
+
14
+ /**
15
+ * @public
16
+ */
17
+ declare interface IMockFileSystemOptions {
18
+ mockWriteOnly?: boolean;
19
+ allowUnknownMockWrite?: boolean;
20
+ }
21
+
22
+ /**
23
+ * @public
24
+ */
25
+ declare class MockFileSystem {
26
+ protected readonly _options?: IMockFileSystemOptions;
27
+ protected readonly _config: Map<string, IMockFileConfig>;
28
+ protected readonly _data: Map<string, string>;
29
+ protected readonly _realReadFileSync: ReadFunc;
30
+ protected readonly _extraWrites: string[];
31
+ constructor(configs: Iterable<IMockFileConfig>, options?: IMockFileSystemOptions);
32
+ readMockFileSync(wanted: string): string;
33
+ writeMockFileSync(wanted: string, body: string): void;
34
+ getExtraFilesWritten(): string[];
35
+ tryGetPayload(want: string): string | undefined;
36
+ reset(): void;
37
+ startSpies(): ReadWriteSpies;
38
+ }
39
+
40
+ declare namespace MockFs {
41
+ export {
42
+ IMockFileConfig,
43
+ ReadWriteSpies,
44
+ IMockFileSystemOptions,
45
+ MockFileSystem
46
+ }
47
+ }
48
+ export { MockFs }
49
+
50
+ /**
51
+ * @public
52
+ */
53
+ declare type ReadFunc = (path: string | number | Buffer | URL, options?: {
54
+ encoding?: null;
55
+ flag?: string;
56
+ } | null) => Buffer;
57
+
58
+ /**
59
+ * @public
60
+ */
61
+ declare class ReadWriteSpies {
62
+ readonly read: jest.SpyInstance;
63
+ readonly write: jest.SpyInstance;
64
+ constructor(read: jest.SpyInstance, write: jest.SpyInstance);
65
+ clear(): void;
66
+ restore(): void;
67
+ }
68
+
69
+ export { }
@@ -1,11 +1,17 @@
1
1
  /// <reference types="jest" />
2
2
  /// <reference types="node" />
3
- export interface MockFileConfig {
3
+ /**
4
+ * @public
5
+ */
6
+ export interface IMockFileConfig {
4
7
  path: string;
5
8
  backingFile?: string;
6
9
  payload?: string;
7
10
  writable?: boolean;
8
11
  }
12
+ /**
13
+ * @public
14
+ */
9
15
  export declare class ReadWriteSpies {
10
16
  readonly read: jest.SpyInstance;
11
17
  readonly write: jest.SpyInstance;
@@ -13,21 +19,30 @@ export declare class ReadWriteSpies {
13
19
  clear(): void;
14
20
  restore(): void;
15
21
  }
16
- export interface MockFileSystemOptions {
22
+ /**
23
+ * @public
24
+ */
25
+ export interface IMockFileSystemOptions {
17
26
  mockWriteOnly?: boolean;
18
27
  allowUnknownMockWrite?: boolean;
19
28
  }
29
+ /**
30
+ * @public
31
+ */
20
32
  type ReadFunc = (path: string | number | Buffer | URL, options?: {
21
33
  encoding?: null;
22
34
  flag?: string;
23
35
  } | null) => Buffer;
36
+ /**
37
+ * @public
38
+ */
24
39
  export declare class MockFileSystem {
25
- protected readonly _options?: MockFileSystemOptions;
26
- protected readonly _config: Map<string, MockFileConfig>;
40
+ protected readonly _options?: IMockFileSystemOptions;
41
+ protected readonly _config: Map<string, IMockFileConfig>;
27
42
  protected readonly _data: Map<string, string>;
28
43
  protected readonly _realReadFileSync: ReadFunc;
29
44
  protected readonly _extraWrites: string[];
30
- constructor(configs: Iterable<MockFileConfig>, options?: MockFileSystemOptions);
45
+ constructor(configs: Iterable<IMockFileConfig>, options?: IMockFileSystemOptions);
31
46
  readMockFileSync(wanted: string): string;
32
47
  writeMockFileSync(wanted: string, body: string): void;
33
48
  getExtraFilesWritten(): string[];
@@ -36,3 +51,4 @@ export declare class MockFileSystem {
36
51
  startSpies(): ReadWriteSpies;
37
52
  }
38
53
  export {};
54
+ //# sourceMappingURL=fsHelpers.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"fsHelpers.d.ts","sourceRoot":"","sources":["../../src/helpers/fsHelpers.ts"],"names":[],"mappings":";;AAyBA;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED;;GAEG;AACH,qBAAa,cAAc;IACzB,SAAgB,IAAI,EAAE,IAAI,CAAC,WAAW,CAAC;IACvC,SAAgB,KAAK,EAAE,IAAI,CAAC,WAAW,CAAC;gBAErB,IAAI,EAAE,IAAI,CAAC,WAAW,EAAE,KAAK,EAAE,IAAI,CAAC,WAAW;IAK3D,KAAK,IAAI,IAAI;IAKb,OAAO,IAAI,IAAI;CAIvB;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,qBAAqB,CAAC,EAAE,OAAO,CAAC;CACjC;AAED;;GAEG;AAEH,KAAK,QAAQ,GAAG,CACd,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,GAAG,EAEpC,OAAO,CAAC,EAAE;IAAE,QAAQ,CAAC,EAAE,IAAI,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAA;CAAE,GAAG,IAAI,KAChD,MAAM,CAAC;AAEZ;;GAEG;AACH,qBAAa,cAAc;IACzB,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,sBAAsB,CAAC;IACrD,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,GAAG,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;IACzD,SAAS,CAAC,QAAQ,CAAC,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC9C,SAAS,CAAC,QAAQ,CAAC,iBAAiB,EAAE,QAAQ,CAAC;IAC/C,SAAS,CAAC,QAAQ,CAAC,YAAY,EAAE,MAAM,EAAE,CAAM;gBAE5B,OAAO,EAAE,QAAQ,CAAC,eAAe,CAAC,EAAE,OAAO,CAAC,EAAE,sBAAsB;IAiBhF,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM;IA0BxC,iBAAiB,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI;IAcrD,oBAAoB,IAAI,MAAM,EAAE;IAGhC,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAI/C,KAAK,IAAI,IAAI;IAiBb,UAAU,IAAI,cAAc;CAgBpC"}
@@ -0,0 +1,170 @@
1
+ "use strict";
2
+ /*
3
+ * Copyright (c) 2020 Erik Fortune
4
+ *
5
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ * of this software and associated documentation files (the "Software"), to deal
7
+ * in the Software without restriction, including without limitation the rights
8
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ * copies of the Software, and to permit persons to whom the Software is
10
+ * furnished to do so, subject to the following conditions:
11
+ *
12
+ * The above copyright notice and this permission notice shall be included in all
13
+ * copies or substantial portions of the Software.
14
+ *
15
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ * SOFTWARE.
22
+ */
23
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
24
+ if (k2 === undefined) k2 = k;
25
+ var desc = Object.getOwnPropertyDescriptor(m, k);
26
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
27
+ desc = { enumerable: true, get: function() { return m[k]; } };
28
+ }
29
+ Object.defineProperty(o, k2, desc);
30
+ }) : (function(o, m, k, k2) {
31
+ if (k2 === undefined) k2 = k;
32
+ o[k2] = m[k];
33
+ }));
34
+ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
35
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
36
+ }) : function(o, v) {
37
+ o["default"] = v;
38
+ });
39
+ var __importStar = (this && this.__importStar) || function (mod) {
40
+ if (mod && mod.__esModule) return mod;
41
+ var result = {};
42
+ if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
43
+ __setModuleDefault(result, mod);
44
+ return result;
45
+ };
46
+ var __importDefault = (this && this.__importDefault) || function (mod) {
47
+ return (mod && mod.__esModule) ? mod : { "default": mod };
48
+ };
49
+ Object.defineProperty(exports, "__esModule", { value: true });
50
+ exports.MockFileSystem = exports.ReadWriteSpies = void 0;
51
+ const fs_1 = __importDefault(require("fs"));
52
+ const path = __importStar(require("path"));
53
+ /**
54
+ * @public
55
+ */
56
+ class ReadWriteSpies {
57
+ constructor(read, write) {
58
+ this.read = read;
59
+ this.write = write;
60
+ }
61
+ clear() {
62
+ this.read.mockClear();
63
+ this.write.mockClear();
64
+ }
65
+ restore() {
66
+ this.read.mockRestore();
67
+ this.write.mockRestore();
68
+ }
69
+ }
70
+ exports.ReadWriteSpies = ReadWriteSpies;
71
+ /**
72
+ * @public
73
+ */
74
+ class MockFileSystem {
75
+ constructor(configs, options) {
76
+ this._extraWrites = [];
77
+ this._config = new Map();
78
+ this._data = new Map();
79
+ this._options = options;
80
+ this._realReadFileSync = fs_1.default.readFileSync;
81
+ for (const config of configs) {
82
+ const fullPath = path.resolve(config.path);
83
+ this._config.set(fullPath, config);
84
+ if (config.backingFile) {
85
+ this.readMockFileSync(fullPath);
86
+ }
87
+ else if (config.payload) {
88
+ this._data.set(fullPath, config.payload);
89
+ }
90
+ }
91
+ }
92
+ readMockFileSync(wanted) {
93
+ var _a;
94
+ const fullPathWanted = path.resolve(wanted);
95
+ if (!this._data.has(fullPathWanted)) {
96
+ const config = this._config.get(fullPathWanted);
97
+ if ((config === null || config === void 0 ? void 0 : config.backingFile) === undefined) {
98
+ if (((_a = this._options) === null || _a === void 0 ? void 0 : _a.mockWriteOnly) !== true) {
99
+ throw new Error(`Mock file not found: ${wanted}`);
100
+ }
101
+ const body = this._realReadFileSync(fullPathWanted).toString();
102
+ this._data.set(fullPathWanted, body);
103
+ }
104
+ else {
105
+ const fullBackingPath = path.resolve(config.backingFile);
106
+ const body = this._realReadFileSync(fullBackingPath).toString();
107
+ this._data.set(fullPathWanted, body);
108
+ }
109
+ }
110
+ const payload = this._data.get(fullPathWanted);
111
+ // not actually reproducible right now
112
+ // istanbul ignore next
113
+ if (payload === undefined) {
114
+ throw new Error(`Mock file ${wanted} payload is undefined.`);
115
+ }
116
+ return payload;
117
+ }
118
+ writeMockFileSync(wanted, body) {
119
+ var _a;
120
+ const fullPathWanted = path.resolve(wanted);
121
+ const config = this._config.get(fullPathWanted);
122
+ if (config === undefined) {
123
+ if (((_a = this._options) === null || _a === void 0 ? void 0 : _a.allowUnknownMockWrite) !== true) {
124
+ throw new Error(`Mock path not found: ${wanted}`);
125
+ }
126
+ this._extraWrites.push(fullPathWanted);
127
+ }
128
+ else if (config.writable !== true) {
129
+ throw new Error(`Mock permission denied: ${wanted}`);
130
+ }
131
+ this._data.set(fullPathWanted, body);
132
+ }
133
+ getExtraFilesWritten() {
134
+ return Array.from(this._extraWrites);
135
+ }
136
+ tryGetPayload(want) {
137
+ return this._data.get(path.resolve(want));
138
+ }
139
+ reset() {
140
+ const writable = Array.from(this._config.values()).filter((c) => c.writable === true);
141
+ for (const config of writable) {
142
+ this._data.delete(path.resolve(config.path));
143
+ if (config.backingFile) {
144
+ this.readMockFileSync(path.resolve(config.path));
145
+ }
146
+ else if (config.payload) {
147
+ this._data.set(path.resolve(config.path), config.payload);
148
+ }
149
+ }
150
+ for (const path of this._extraWrites) {
151
+ this._data.delete(path);
152
+ }
153
+ this._extraWrites.splice(0, this._extraWrites.length);
154
+ }
155
+ startSpies() {
156
+ return new ReadWriteSpies(jest.spyOn(fs_1.default, 'readFileSync').mockImplementation((wanted) => {
157
+ if (typeof wanted !== 'string') {
158
+ throw new Error('readFileSync mock supports only string parameters');
159
+ }
160
+ return this.readMockFileSync(wanted);
161
+ }), jest.spyOn(fs_1.default, 'writeFileSync').mockImplementation((wanted, payload) => {
162
+ if (typeof wanted !== 'string' || typeof payload !== 'string') {
163
+ throw new Error('writeFileSync mock supports only string parameters');
164
+ }
165
+ return this.writeMockFileSync(wanted, payload);
166
+ }));
167
+ }
168
+ }
169
+ exports.MockFileSystem = MockFileSystem;
170
+ //# sourceMappingURL=fsHelpers.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"fsHelpers.js","sourceRoot":"","sources":["../../src/helpers/fsHelpers.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,4CAAoB;AACpB,2CAA6B;AAY7B;;GAEG;AACH,MAAa,cAAc;IAIzB,YAAmB,IAAsB,EAAE,KAAuB;QAChE,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;IAEM,KAAK;QACV,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;QACtB,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,CAAC;IACzB,CAAC;IAEM,OAAO;QACZ,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;QACxB,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC;IAC3B,CAAC;CACF;AAlBD,wCAkBC;AAoBD;;GAEG;AACH,MAAa,cAAc;IAOzB,YAAmB,OAAkC,EAAE,OAAgC;QAFpE,iBAAY,GAAa,EAAE,CAAC;QAG7C,IAAI,CAAC,OAAO,GAAG,IAAI,GAAG,EAA2B,CAAC;QAClD,IAAI,CAAC,KAAK,GAAG,IAAI,GAAG,EAAkB,CAAC;QACvC,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QACxB,IAAI,CAAC,iBAAiB,GAAG,YAAE,CAAC,YAAY,CAAC;QAEzC,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE;YAC5B,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;YAC3C,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;YACnC,IAAI,MAAM,CAAC,WAAW,EAAE;gBACtB,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;aACjC;iBAAM,IAAI,MAAM,CAAC,OAAO,EAAE;gBACzB,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;aAC1C;SACF;IACH,CAAC;IAEM,gBAAgB,CAAC,MAAc;;QACpC,MAAM,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAC5C,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,cAAc,CAAC,EAAE;YACnC,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;YAChD,IAAI,CAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,WAAW,MAAK,SAAS,EAAE;gBACrC,IAAI,CAAA,MAAA,IAAI,CAAC,QAAQ,0CAAE,aAAa,MAAK,IAAI,EAAE;oBACzC,MAAM,IAAI,KAAK,CAAC,wBAAwB,MAAM,EAAE,CAAC,CAAC;iBACnD;gBACD,MAAM,IAAI,GAAG,IAAI,CAAC,iBAAiB,CAAC,cAAc,CAAC,CAAC,QAAQ,EAAE,CAAC;gBAC/D,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC;aACtC;iBAAM;gBACL,MAAM,eAAe,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;gBACzD,MAAM,IAAI,GAAG,IAAI,CAAC,iBAAiB,CAAC,eAAe,CAAC,CAAC,QAAQ,EAAE,CAAC;gBAChE,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC;aACtC;SACF;QAED,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;QAC/C,sCAAsC;QACtC,uBAAuB;QACvB,IAAI,OAAO,KAAK,SAAS,EAAE;YACzB,MAAM,IAAI,KAAK,CAAC,aAAa,MAAM,wBAAwB,CAAC,CAAC;SAC9D;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;IAEM,iBAAiB,CAAC,MAAc,EAAE,IAAY;;QACnD,MAAM,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAC5C,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;QAChD,IAAI,MAAM,KAAK,SAAS,EAAE;YACxB,IAAI,CAAA,MAAA,IAAI,CAAC,QAAQ,0CAAE,qBAAqB,MAAK,IAAI,EAAE;gBACjD,MAAM,IAAI,KAAK,CAAC,wBAAwB,MAAM,EAAE,CAAC,CAAC;aACnD;YACD,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;SACxC;aAAM,IAAI,MAAM,CAAC,QAAQ,KAAK,IAAI,EAAE;YACnC,MAAM,IAAI,KAAK,CAAC,2BAA2B,MAAM,EAAE,CAAC,CAAC;SACtD;QACD,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC;IACvC,CAAC;IAEM,oBAAoB;QACzB,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IACvC,CAAC;IACM,aAAa,CAAC,IAAY;QAC/B,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;IAC5C,CAAC;IAEM,KAAK;QACV,MAAM,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,KAAK,IAAI,CAAC,CAAC;QACtF,KAAK,MAAM,MAAM,IAAI,QAAQ,EAAE;YAC7B,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;YAC7C,IAAI,MAAM,CAAC,WAAW,EAAE;gBACtB,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;aAClD;iBAAM,IAAI,MAAM,CAAC,OAAO,EAAE;gBACzB,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;aAC3D;SACF;QAED,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,YAAY,EAAE;YACpC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;SACzB;QACD,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,EAAE,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;IACxD,CAAC;IAEM,UAAU;QACf,OAAO,IAAI,cAAc,CACvB,IAAI,CAAC,KAAK,CAAC,YAAE,EAAE,cAAc,CAAC,CAAC,kBAAkB,CAAC,CAAC,MAAe,EAAE,EAAE;YACpE,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE;gBAC9B,MAAM,IAAI,KAAK,CAAC,mDAAmD,CAAC,CAAC;aACtE;YACD,OAAO,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC;QACvC,CAAC,CAAC,EACF,IAAI,CAAC,KAAK,CAAC,YAAE,EAAE,eAAe,CAAC,CAAC,kBAAkB,CAAC,CAAC,MAAe,EAAE,OAAgB,EAAE,EAAE;YACvF,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE;gBAC7D,MAAM,IAAI,KAAK,CAAC,oDAAoD,CAAC,CAAC;aACvE;YACD,OAAO,IAAI,CAAC,iBAAiB,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QACjD,CAAC,CAAC,CACH,CAAC;IACJ,CAAC;CACF;AAxGD,wCAwGC","sourcesContent":["/*\n * Copyright (c) 2020 Erik Fortune\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in all\n * copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\n\nimport fs from 'fs';\nimport * as path from 'path';\n\n/**\n * @public\n */\nexport interface IMockFileConfig {\n path: string;\n backingFile?: string;\n payload?: string;\n writable?: boolean;\n}\n\n/**\n * @public\n */\nexport class ReadWriteSpies {\n public readonly read: jest.SpyInstance;\n public readonly write: jest.SpyInstance;\n\n public constructor(read: jest.SpyInstance, write: jest.SpyInstance) {\n this.read = read;\n this.write = write;\n }\n\n public clear(): void {\n this.read.mockClear();\n this.write.mockClear();\n }\n\n public restore(): void {\n this.read.mockRestore();\n this.write.mockRestore();\n }\n}\n\n/**\n * @public\n */\nexport interface IMockFileSystemOptions {\n mockWriteOnly?: boolean;\n allowUnknownMockWrite?: boolean;\n}\n\n/**\n * @public\n */\n// eslint-disable-next-line @rushstack/no-new-null\ntype ReadFunc = (\n path: string | number | Buffer | URL,\n // eslint-disable-next-line @rushstack/no-new-null\n options?: { encoding?: null; flag?: string } | null\n) => Buffer;\n\n/**\n * @public\n */\nexport class MockFileSystem {\n protected readonly _options?: IMockFileSystemOptions;\n protected readonly _config: Map<string, IMockFileConfig>;\n protected readonly _data: Map<string, string>;\n protected readonly _realReadFileSync: ReadFunc;\n protected readonly _extraWrites: string[] = [];\n\n public constructor(configs: Iterable<IMockFileConfig>, options?: IMockFileSystemOptions) {\n this._config = new Map<string, IMockFileConfig>();\n this._data = new Map<string, string>();\n this._options = options;\n this._realReadFileSync = fs.readFileSync;\n\n for (const config of configs) {\n const fullPath = path.resolve(config.path);\n this._config.set(fullPath, config);\n if (config.backingFile) {\n this.readMockFileSync(fullPath);\n } else if (config.payload) {\n this._data.set(fullPath, config.payload);\n }\n }\n }\n\n public readMockFileSync(wanted: string): string {\n const fullPathWanted = path.resolve(wanted);\n if (!this._data.has(fullPathWanted)) {\n const config = this._config.get(fullPathWanted);\n if (config?.backingFile === undefined) {\n if (this._options?.mockWriteOnly !== true) {\n throw new Error(`Mock file not found: ${wanted}`);\n }\n const body = this._realReadFileSync(fullPathWanted).toString();\n this._data.set(fullPathWanted, body);\n } else {\n const fullBackingPath = path.resolve(config.backingFile);\n const body = this._realReadFileSync(fullBackingPath).toString();\n this._data.set(fullPathWanted, body);\n }\n }\n\n const payload = this._data.get(fullPathWanted);\n // not actually reproducible right now\n // istanbul ignore next\n if (payload === undefined) {\n throw new Error(`Mock file ${wanted} payload is undefined.`);\n }\n return payload;\n }\n\n public writeMockFileSync(wanted: string, body: string): void {\n const fullPathWanted = path.resolve(wanted);\n const config = this._config.get(fullPathWanted);\n if (config === undefined) {\n if (this._options?.allowUnknownMockWrite !== true) {\n throw new Error(`Mock path not found: ${wanted}`);\n }\n this._extraWrites.push(fullPathWanted);\n } else if (config.writable !== true) {\n throw new Error(`Mock permission denied: ${wanted}`);\n }\n this._data.set(fullPathWanted, body);\n }\n\n public getExtraFilesWritten(): string[] {\n return Array.from(this._extraWrites);\n }\n public tryGetPayload(want: string): string | undefined {\n return this._data.get(path.resolve(want));\n }\n\n public reset(): void {\n const writable = Array.from(this._config.values()).filter((c) => c.writable === true);\n for (const config of writable) {\n this._data.delete(path.resolve(config.path));\n if (config.backingFile) {\n this.readMockFileSync(path.resolve(config.path));\n } else if (config.payload) {\n this._data.set(path.resolve(config.path), config.payload);\n }\n }\n\n for (const path of this._extraWrites) {\n this._data.delete(path);\n }\n this._extraWrites.splice(0, this._extraWrites.length);\n }\n\n public startSpies(): ReadWriteSpies {\n return new ReadWriteSpies(\n jest.spyOn(fs, 'readFileSync').mockImplementation((wanted: unknown) => {\n if (typeof wanted !== 'string') {\n throw new Error('readFileSync mock supports only string parameters');\n }\n return this.readMockFileSync(wanted);\n }),\n jest.spyOn(fs, 'writeFileSync').mockImplementation((wanted: unknown, payload: unknown) => {\n if (typeof wanted !== 'string' || typeof payload !== 'string') {\n throw new Error('writeFileSync mock supports only string parameters');\n }\n return this.writeMockFileSync(wanted, payload);\n })\n );\n }\n}\n"]}
@@ -0,0 +1,2 @@
1
+ export * from './fsHelpers';
2
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/helpers/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC"}
@@ -15,4 +15,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
15
15
  };
16
16
  Object.defineProperty(exports, "__esModule", { value: true });
17
17
  __exportStar(require("./fsHelpers"), exports);
18
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvaGVscGVycy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7Ozs7Ozs7Ozs7Ozs7O0FBQUEsOENBQTRCIiwic291cmNlc0NvbnRlbnQiOlsiZXhwb3J0ICogZnJvbSAnLi9mc0hlbHBlcnMnO1xuIl19
18
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/helpers/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8CAA4B","sourcesContent":["export * from './fsHelpers';\n"]}
package/lib/index.d.ts ADDED
@@ -0,0 +1,4 @@
1
+ import './types';
2
+ import * as MockFs from './helpers/fsHelpers';
3
+ export { MockFs };
4
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,SAAS,CAAC;AAEjB,OAAO,KAAK,MAAM,MAAM,qBAAqB,CAAC;AAC9C,OAAO,EAAE,MAAM,EAAE,CAAC"}
package/lib/index.js ADDED
@@ -0,0 +1,50 @@
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
14
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
15
+ }) : function(o, v) {
16
+ o["default"] = v;
17
+ });
18
+ var __importStar = (this && this.__importStar) || function (mod) {
19
+ if (mod && mod.__esModule) return mod;
20
+ var result = {};
21
+ if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
22
+ __setModuleDefault(result, mod);
23
+ return result;
24
+ };
25
+ var __importDefault = (this && this.__importDefault) || function (mod) {
26
+ return (mod && mod.__esModule) ? mod : { "default": mod };
27
+ };
28
+ Object.defineProperty(exports, "__esModule", { value: true });
29
+ exports.MockFs = void 0;
30
+ const matchers_1 = __importDefault(require("./matchers"));
31
+ require("./types");
32
+ const MockFs = __importStar(require("./helpers/fsHelpers"));
33
+ exports.MockFs = MockFs;
34
+ // eslint-disable-next-line no-undef
35
+ function isJestGlobal(g) {
36
+ return g.hasOwnProperty('expect');
37
+ }
38
+ // istanbul ignore else
39
+ if (isJestGlobal(global)) {
40
+ global.expect.extend(matchers_1.default);
41
+ }
42
+ else {
43
+ /* eslint-disable no-console */
44
+ console.error([
45
+ "Unable to find Jest's global expect",
46
+ 'Please check that you have added ts-utils-jest correctly to your jest configuration.'
47
+ ].join('\n'));
48
+ /* eslint-enable no-console */
49
+ }
50
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,0DAAkC;AAClC,mBAAiB;AAEjB,4DAA8C;AACrC,wBAAM;AAKf,oCAAoC;AACpC,SAAS,YAAY,CAAC,CAAgB;IACpC,OAAO,CAAC,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;AACpC,CAAC;AAED,uBAAuB;AACvB,IAAI,YAAY,CAAC,MAAM,CAAC,EAAE;IACxB,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,kBAAQ,CAAC,CAAC;CAChC;KAAM;IACL,+BAA+B;IAC/B,OAAO,CAAC,KAAK,CACX;QACE,qCAAqC;QACrC,sFAAsF;KACvF,CAAC,IAAI,CAAC,IAAI,CAAC,CACb,CAAC;IACF,8BAA8B;CAC/B","sourcesContent":["import matchers from './matchers';\nimport './types';\n\nimport * as MockFs from './helpers/fsHelpers';\nexport { MockFs };\n\n// eslint-disable-next-line no-undef\ntype JestGlobal = typeof global & { expect: jest.Expect };\n\n// eslint-disable-next-line no-undef\nfunction isJestGlobal(g: typeof global): g is JestGlobal {\n return g.hasOwnProperty('expect');\n}\n\n// istanbul ignore else\nif (isJestGlobal(global)) {\n global.expect.extend(matchers);\n} else {\n /* eslint-disable no-console */\n console.error(\n [\n \"Unable to find Jest's global expect\",\n 'Please check that you have added ts-utils-jest correctly to your jest configuration.'\n ].join('\\n')\n );\n /* eslint-enable no-console */\n}\n"]}
@@ -15,3 +15,4 @@ declare const _default: {
15
15
  toFail: <T_11 extends import("@fgv/ts-utils").Result<unknown>>(received: T_11) => jest.CustomMatcherResult;
16
16
  };
17
17
  export default _default;
18
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/matchers/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAcA,wBAcE"}
@@ -0,0 +1,20 @@
1
+ "use strict";
2
+ var __importDefault = (this && this.__importDefault) || function (mod) {
3
+ return (mod && mod.__esModule) ? mod : { "default": mod };
4
+ };
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ const toFail_1 = __importDefault(require("./toFail"));
7
+ const toFailTest_1 = __importDefault(require("./toFailTest"));
8
+ const toFailTestAndMatchSnapshot_1 = __importDefault(require("./toFailTestAndMatchSnapshot"));
9
+ const toFailTestWith_1 = __importDefault(require("./toFailTestWith"));
10
+ const toFailWith_1 = __importDefault(require("./toFailWith"));
11
+ const toFailWithDetail_1 = __importDefault(require("./toFailWithDetail"));
12
+ const toHaveBeenCalledWithArgumentsMatching_1 = __importDefault(require("./toHaveBeenCalledWithArgumentsMatching"));
13
+ const toSucceed_1 = __importDefault(require("./toSucceed"));
14
+ const toSucceedAndMatchInlineSnapshot_1 = __importDefault(require("./toSucceedAndMatchInlineSnapshot"));
15
+ const toSucceedAndMatchSnapshot_1 = __importDefault(require("./toSucceedAndMatchSnapshot"));
16
+ const toSucceedAndSatisfy_1 = __importDefault(require("./toSucceedAndSatisfy"));
17
+ const toSucceedWith_1 = __importDefault(require("./toSucceedWith"));
18
+ const toSucceedWithDetail_1 = __importDefault(require("./toSucceedWithDetail"));
19
+ exports.default = Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign({}, toFail_1.default), toFailTest_1.default), toFailTestAndMatchSnapshot_1.default), toFailTestWith_1.default), toFailWith_1.default), toFailWithDetail_1.default), toHaveBeenCalledWithArgumentsMatching_1.default), toSucceed_1.default), toSucceedAndMatchInlineSnapshot_1.default), toSucceedAndMatchSnapshot_1.default), toSucceedAndSatisfy_1.default), toSucceedWith_1.default), toSucceedWithDetail_1.default);
20
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/matchers/index.ts"],"names":[],"mappings":";;;;;AAAA,sDAA8B;AAC9B,8DAAsC;AACtC,8FAAsE;AACtE,sEAA8C;AAC9C,8DAAsC;AACtC,0EAAkD;AAClD,oHAA4F;AAC5F,4DAAoC;AACpC,wGAAgF;AAChF,4FAAoE;AACpE,gFAAwD;AACxD,oEAA4C;AAC5C,gFAAwD;AAExD,4MACK,gBAAM,GACN,oBAAU,GACV,oCAA0B,GAC1B,wBAAc,GACd,oBAAU,GACV,0BAAgB,GAChB,+CAAqC,GACrC,mBAAS,GACT,yCAA+B,GAC/B,mCAAyB,GACzB,6BAAmB,GACnB,uBAAa,GACb,6BAAmB,EACtB","sourcesContent":["import ToFail from './toFail';\nimport ToFailTest from './toFailTest';\nimport ToFailTestAndMatchSnapshot from './toFailTestAndMatchSnapshot';\nimport ToFailTestWith from './toFailTestWith';\nimport ToFailWith from './toFailWith';\nimport ToFailWithDetail from './toFailWithDetail';\nimport ToHaveBeenCalledWithArgumentsMatching from './toHaveBeenCalledWithArgumentsMatching';\nimport ToSucceed from './toSucceed';\nimport ToSucceedAndMatchInlineSnapshot from './toSucceedAndMatchInlineSnapshot';\nimport ToSucceedAndMatchSnapshot from './toSucceedAndMatchSnapshot';\nimport ToSucceedAndSatisfy from './toSucceedAndSatisfy';\nimport ToSucceedWith from './toSucceedWith';\nimport toSucceedWithDetail from './toSucceedWithDetail';\n\nexport default {\n ...ToFail,\n ...ToFailTest,\n ...ToFailTestAndMatchSnapshot,\n ...ToFailTestWith,\n ...ToFailWith,\n ...ToFailWithDetail,\n ...ToHaveBeenCalledWithArgumentsMatching,\n ...ToSucceed,\n ...ToSucceedAndMatchInlineSnapshot,\n ...ToSucceedAndMatchSnapshot,\n ...ToSucceedAndSatisfy,\n ...ToSucceedWith,\n ...toSucceedWithDetail\n};\n"]}
@@ -13,3 +13,4 @@ declare const _default: {
13
13
  toFail: <T extends Result<unknown>>(received: T) => jest.CustomMatcherResult;
14
14
  };
15
15
  export default _default;
16
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/matchers/toFail/index.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AAGvC,OAAO,CAAC,MAAM,CAAC;IAEb,UAAU,IAAI,CAAC;QAEb,UAAU,QAAQ,CAAC,CAAC,EAAE,CAAC;YACrB;;eAEG;YACH,MAAM,IAAI,CAAC,CAAC;SACb;KACF;CACF;;wDAmB4D,KAAK,mBAAmB;;AADrF,wBASE"}
@@ -0,0 +1,25 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ const matcherHelpers_1 = require("../../utils/matcherHelpers");
4
+ const predicate_1 = require("./predicate");
5
+ const jest_matcher_utils_1 = require("jest-matcher-utils");
6
+ function passMessage(received) {
7
+ return () => [
8
+ (0, jest_matcher_utils_1.matcherHint)(`.not.${predicate_1.matcherName}`),
9
+ (0, matcherHelpers_1.printExpectedResult)('failure', false),
10
+ (0, matcherHelpers_1.printReceivedResult)(received)
11
+ ].join('\n');
12
+ }
13
+ function failMessage(received) {
14
+ return () => [(0, jest_matcher_utils_1.matcherHint)(`${predicate_1.matcherName}`), (0, matcherHelpers_1.printExpectedResult)('failure', true), (0, matcherHelpers_1.printReceivedResult)(received)].join('\n');
15
+ }
16
+ exports.default = {
17
+ toFail: function (received) {
18
+ const pass = (0, predicate_1.predicate)(received);
19
+ if (pass) {
20
+ return { pass: true, message: passMessage(received) };
21
+ }
22
+ return { pass: false, message: failMessage(received) };
23
+ }
24
+ };
25
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/matchers/toFail/index.ts"],"names":[],"mappings":";;AAAA,+DAAsF;AACtF,2CAAqD;AAGrD,2DAAiD;AAejD,SAAS,WAAW,CAA4B,QAAW;IACzD,OAAO,GAAG,EAAE,CACV;QACE,IAAA,gCAAW,EAAC,QAAQ,uBAAW,EAAE,CAAC;QAClC,IAAA,oCAAmB,EAAC,SAAS,EAAE,KAAK,CAAC;QACrC,IAAA,oCAAmB,EAAC,QAAQ,CAAC;KAC9B,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACjB,CAAC;AAED,SAAS,WAAW,CAA4B,QAAW;IACzD,OAAO,GAAG,EAAE,CACV,CAAC,IAAA,gCAAW,EAAC,GAAG,uBAAW,EAAE,CAAC,EAAE,IAAA,oCAAmB,EAAC,SAAS,EAAE,IAAI,CAAC,EAAE,IAAA,oCAAmB,EAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CACvG,IAAI,CACL,CAAC;AACN,CAAC;AAED,kBAAe;IACb,MAAM,EAAE,UAAqC,QAAW;QACtD,MAAM,IAAI,GAAG,IAAA,qBAAS,EAAC,QAAQ,CAAC,CAAC;QACjC,IAAI,IAAI,EAAE;YACR,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,WAAW,CAAC,QAAQ,CAAC,EAAE,CAAC;SACvD;QAED,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,WAAW,CAAC,QAAQ,CAAC,EAAE,CAAC;IACzD,CAAC;CACF,CAAC","sourcesContent":["import { printExpectedResult, printReceivedResult } from '../../utils/matcherHelpers';\nimport { matcherName, predicate } from './predicate';\n\nimport { Result } from '@fgv/ts-utils';\nimport { matcherHint } from 'jest-matcher-utils';\n\ndeclare global {\n // eslint-disable-next-line @typescript-eslint/no-namespace\n namespace jest {\n // eslint-disable-next-line no-unused-vars, @typescript-eslint/no-unused-vars, @typescript-eslint/ban-types, @typescript-eslint/naming-convention\n interface Matchers<R, T> {\n /**\n * Use .toFail to verify that a Result<T> is a failure\n */\n toFail(): R;\n }\n }\n}\n\nfunction passMessage<T extends Result<unknown>>(received: T): () => string {\n return () =>\n [\n matcherHint(`.not.${matcherName}`),\n printExpectedResult('failure', false),\n printReceivedResult(received)\n ].join('\\n');\n}\n\nfunction failMessage<T extends Result<unknown>>(received: T): () => string {\n return () =>\n [matcherHint(`${matcherName}`), printExpectedResult('failure', true), printReceivedResult(received)].join(\n '\\n'\n );\n}\n\nexport default {\n toFail: function <T extends Result<unknown>>(received: T): jest.CustomMatcherResult {\n const pass = predicate(received);\n if (pass) {\n return { pass: true, message: passMessage(received) };\n }\n\n return { pass: false, message: failMessage(received) };\n }\n};\n"]}
@@ -1,3 +1,4 @@
1
1
  import { Result } from '../../ts-utils';
2
- export declare const matcherName = "toFail";
2
+ export declare const matcherName: string;
3
3
  export declare function predicate<T>(received: Result<T>): boolean;
4
+ //# sourceMappingURL=predicate.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"predicate.d.ts","sourceRoot":"","sources":["../../../src/matchers/toFail/predicate.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAExC,eAAO,MAAM,WAAW,EAAE,MAAiB,CAAC;AAE5C,wBAAgB,SAAS,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC,CAAC,GAAG,OAAO,CAEzD"}
@@ -0,0 +1,9 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.predicate = exports.matcherName = void 0;
4
+ exports.matcherName = 'toFail';
5
+ function predicate(received) {
6
+ return received.isFailure();
7
+ }
8
+ exports.predicate = predicate;
9
+ //# sourceMappingURL=predicate.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"predicate.js","sourceRoot":"","sources":["../../../src/matchers/toFail/predicate.ts"],"names":[],"mappings":";;;AAEa,QAAA,WAAW,GAAW,QAAQ,CAAC;AAE5C,SAAgB,SAAS,CAAI,QAAmB;IAC9C,OAAO,QAAQ,CAAC,SAAS,EAAE,CAAC;AAC9B,CAAC;AAFD,8BAEC","sourcesContent":["import { Result } from '../../ts-utils';\n\nexport const matcherName: string = 'toFail';\n\nexport function predicate<T>(received: Result<T>): boolean {\n return received.isFailure();\n}\n"]}
@@ -13,3 +13,4 @@ declare const _default: {
13
13
  toFailTest: <T>(cb: () => void) => jest.CustomMatcherResult;
14
14
  };
15
15
  export default _default;
16
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/matchers/toFailTest/index.ts"],"names":[],"mappings":"AAMA,OAAO,CAAC,MAAM,CAAC;IAEb,UAAU,IAAI,CAAC;QAEb,UAAU,QAAQ,CAAC,CAAC,EAAE,CAAC;YACrB;;;eAGG;YACH,UAAU,CAAC,CAAC,KAAK,CAAC,CAAC;SACpB;KACF;CACF;;wBAqB8B,MAAM,IAAI,KAAG,KAAK,mBAAmB;;AADpE,wBASE"}
@@ -0,0 +1,30 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ /* eslint-disable @typescript-eslint/no-unused-vars,no-unused-vars */
4
+ const predicate_1 = require("./predicate");
5
+ const jest_matcher_utils_1 = require("jest-matcher-utils");
6
+ const matcherHelpers_1 = require("../../utils/matcherHelpers");
7
+ function passMessage() {
8
+ return () => [
9
+ (0, jest_matcher_utils_1.matcherHint)(`.not.${predicate_1.matcherName}`, 'callback'),
10
+ (0, matcherHelpers_1.printExpectedResult)('failure', false),
11
+ ' Received: Test failed'
12
+ ].join('\n');
13
+ }
14
+ function failMessage() {
15
+ return () => [
16
+ (0, jest_matcher_utils_1.matcherHint)(`${predicate_1.matcherName}`, 'callback'),
17
+ (0, matcherHelpers_1.printExpectedResult)('failure', true),
18
+ ' Received: Test passed'
19
+ ].join('\n');
20
+ }
21
+ exports.default = {
22
+ toFailTest: function (cb) {
23
+ const pass = (0, predicate_1.predicate)(cb);
24
+ if (pass) {
25
+ return { pass: true, message: passMessage() };
26
+ }
27
+ return { pass: false, message: failMessage() };
28
+ }
29
+ };
30
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/matchers/toFailTest/index.ts"],"names":[],"mappings":";;AAAA,qEAAqE;AACrE,2CAAqD;AAErD,2DAAiD;AACjD,+DAAiE;AAgBjE,SAAS,WAAW;IAClB,OAAO,GAAG,EAAE,CACV;QACE,IAAA,gCAAW,EAAC,QAAQ,uBAAW,EAAE,EAAE,UAAU,CAAC;QAC9C,IAAA,oCAAmB,EAAC,SAAS,EAAE,KAAK,CAAC;QACrC,yBAAyB;KAC1B,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACjB,CAAC;AAED,SAAS,WAAW;IAClB,OAAO,GAAG,EAAE,CACV;QACE,IAAA,gCAAW,EAAC,GAAG,uBAAW,EAAE,EAAE,UAAU,CAAC;QACzC,IAAA,oCAAmB,EAAC,SAAS,EAAE,IAAI,CAAC;QACpC,yBAAyB;KAC1B,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACjB,CAAC;AAED,kBAAe;IACb,UAAU,EAAE,UAAa,EAAc;QACrC,MAAM,IAAI,GAAG,IAAA,qBAAS,EAAC,EAAE,CAAC,CAAC;QAC3B,IAAI,IAAI,EAAE;YACR,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,WAAW,EAAE,EAAE,CAAC;SAC/C;QAED,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,WAAW,EAAE,EAAE,CAAC;IACjD,CAAC;CACF,CAAC","sourcesContent":["/* eslint-disable @typescript-eslint/no-unused-vars,no-unused-vars */\nimport { matcherName, predicate } from './predicate';\n\nimport { matcherHint } from 'jest-matcher-utils';\nimport { printExpectedResult } from '../../utils/matcherHelpers';\n\ndeclare global {\n // eslint-disable-next-line @typescript-eslint/no-namespace\n namespace jest {\n // eslint-disable-next-line no-unused-vars, @typescript-eslint/no-unused-vars, @typescript-eslint/ban-types, @typescript-eslint/naming-convention\n interface Matchers<R, T> {\n /**\n * Use .toFailTest to test a custom matcher by\n * verifying that a test case fails.\n */\n toFailTest<T>(): R;\n }\n }\n}\n\nfunction passMessage<T>(): () => string {\n return () =>\n [\n matcherHint(`.not.${matcherName}`, 'callback'),\n printExpectedResult('failure', false),\n ' Received: Test failed'\n ].join('\\n');\n}\n\nfunction failMessage<T>(): () => string {\n return () =>\n [\n matcherHint(`${matcherName}`, 'callback'),\n printExpectedResult('failure', true),\n ' Received: Test passed'\n ].join('\\n');\n}\n\nexport default {\n toFailTest: function <T>(cb: () => void): jest.CustomMatcherResult {\n const pass = predicate(cb);\n if (pass) {\n return { pass: true, message: passMessage() };\n }\n\n return { pass: false, message: failMessage() };\n }\n};\n"]}
@@ -0,0 +1,3 @@
1
+ export declare const matcherName: string;
2
+ export declare function predicate<T>(cb: () => void): boolean;
3
+ //# sourceMappingURL=predicate.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"predicate.d.ts","sourceRoot":"","sources":["../../../src/matchers/toFailTest/predicate.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,WAAW,EAAE,MAAqB,CAAC;AAEhD,wBAAgB,SAAS,CAAC,CAAC,EAAE,EAAE,EAAE,MAAM,IAAI,GAAG,OAAO,CAGpD"}