/
errorOnPrivate.ts
83 lines (71 loc) · 2.68 KB
/
errorOnPrivate.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
/**
* Copyright (c) Facebook, Inc. and its affiliates. All Rights Reserved.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/
import type {Global} from '@jest/types';
import {ErrorWithStack} from 'jest-util';
type DisabledGlobalKeys = 'fail' | 'pending' | 'spyOn' | 'spyOnProperty';
// prettier-ignore
const disabledGlobals: Record<DisabledGlobalKeys, string> = {
fail: 'Illegal usage of global `fail`, prefer throwing an error, or the `done.fail` callback.',
pending: 'Illegal usage of global `pending`, prefer explicitly skipping a test using `test.skip`',
spyOn: 'Illegal usage of global `spyOn`, prefer `jest.spyOn`.',
spyOnProperty: 'Illegal usage of global `spyOnProperty`, prefer `jest.spyOn`.',
};
type DisabledJasmineMethodsKeys =
| 'addMatchers'
| 'any'
| 'anything'
| 'arrayContaining'
| 'createSpy'
| 'objectContaining'
| 'stringMatching';
// prettier-ignore
const disabledJasmineMethods: Record<DisabledJasmineMethodsKeys, string> = {
addMatchers: 'Illegal usage of `jasmine.addMatchers`, prefer `expect.extends`.',
any: 'Illegal usage of `jasmine.any`, prefer `expect.any`.',
anything: 'Illegal usage of `jasmine.anything`, prefer `expect.anything`.',
arrayContaining: 'Illegal usage of `jasmine.arrayContaining`, prefer `expect.arrayContaining`.',
createSpy: 'Illegal usage of `jasmine.createSpy`, prefer `jest.fn`.',
objectContaining: 'Illegal usage of `jasmine.objectContaining`, prefer `expect.objectContaining`.',
stringMatching: 'Illegal usage of `jasmine.stringMatching`, prefer `expect.stringMatching`.',
};
export function installErrorOnPrivate(global: Global.Global): void {
const jasmine = global.jasmine;
(Object.keys(disabledGlobals) as Array<DisabledGlobalKeys>).forEach(
functionName => {
global[functionName] = () => {
throwAtFunction(disabledGlobals[functionName], global[functionName]);
};
},
);
(
Object.keys(disabledJasmineMethods) as Array<DisabledJasmineMethodsKeys>
).forEach(methodName => {
// @ts-expect-error
jasmine[methodName] = () => {
throwAtFunction(disabledJasmineMethods[methodName], jasmine[methodName]);
};
});
function set() {
throwAtFunction(
'Illegal usage of `jasmine.DEFAULT_TIMEOUT_INTERVAL`, prefer `jest.setTimeout`.',
set,
);
}
const original = jasmine.DEFAULT_TIMEOUT_INTERVAL;
Object.defineProperty(jasmine, 'DEFAULT_TIMEOUT_INTERVAL', {
configurable: true,
enumerable: true,
get: () => original,
set,
});
}
function throwAtFunction(
message: string,
fn: (...args: Array<any>) => unknown,
) {
throw new ErrorWithStack(message, fn);
}