forked from jest-community/vscode-jest
-
Notifications
You must be signed in to change notification settings - Fork 0
/
helpers.ts
213 lines (187 loc) · 6.52 KB
/
helpers.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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
import { platform } from 'os';
import { existsSync, readFileSync, mkdirSync, writeFileSync } from 'fs';
import { normalize, join } from 'path';
import { ExtensionContext } from 'vscode';
import { PluginResourceSettings, hasUserSetPathToJest } from './Settings';
import { TestIdentifier } from './TestResults';
import { TestStats } from './types';
/**
* Known binary names of `react-scripts` forks
*/
const createReactAppBinaryNames = [
'react-scripts',
'react-native-scripts',
'react-scripts-ts',
'react-app-rewired',
];
/**
* File extension for npm binaries
*/
export const nodeBinExtension: string = platform() === 'win32' ? '.cmd' : '';
/**
* Resolves the location of an npm binary
*
* Returns the path if it exists, or `undefined` otherwise
*/
function getLocalPathForExecutable(rootPath: string, executable: string): string | undefined {
const absolutePath = normalize(
join(rootPath, 'node_modules', '.bin', executable + nodeBinExtension)
);
return existsSync(absolutePath) ? absolutePath : undefined;
}
/**
* Tries to read the test command from the scripts section within `package.json`
*
* Returns the test command in case of success,
* `undefined` if there was an exception while reading and parsing `package.json`
* `null` if there is no test script
*/
export function getTestCommand(rootPath: string): string | undefined | null {
try {
const packagePath = join(rootPath, 'package.json');
const packageJSON = JSON.parse(readFileSync(packagePath, 'utf8'));
if (packageJSON && packageJSON.scripts && packageJSON.scripts.test) {
return packageJSON.scripts.test;
}
return null;
} catch {
return undefined;
}
}
/**
* Checks if the supplied test command could have been generated by create-react-app
*/
export function isCreateReactAppTestCommand(testCommand?: string | null): boolean {
return (
!!testCommand &&
createReactAppBinaryNames.some((binary) => testCommand.includes(`${binary} test`))
);
}
/**
* Checks if the project in `rootPath` was bootstrapped by `create-react-app`.
*/
function isBootstrappedWithCreateReactApp(rootPath: string): boolean {
const testCommand = getTestCommand(rootPath);
if (testCommand === undefined) {
// In case parsing `package.json` failed or was unconclusive,
// fallback to checking for the presence of the binaries in `./node_modules/.bin`
return createReactAppBinaryNames.some(
(binary) => getLocalPathForExecutable(rootPath, binary) !== undefined
);
}
return isCreateReactAppTestCommand(testCommand);
}
/**
* Handles getting the jest runner, handling the OS and project specific work too
*
* @returns {string}
*/
// tslint:disable-next-line no-shadowed-variable
export function pathToJest({ pathToJest, rootPath }: PluginResourceSettings): string {
if (pathToJest && hasUserSetPathToJest(pathToJest)) {
return normalize(pathToJest);
}
if (isBootstrappedWithCreateReactApp(rootPath)) {
return 'npm test --';
}
const p = getLocalPathForExecutable(rootPath, 'jest') || 'jest' + nodeBinExtension;
return `"${p}"`;
}
/**
* Handles getting the path to config file
*
* @returns {string}
*/
export function pathToConfig(pluginSettings: PluginResourceSettings): string {
if (pluginSettings.pathToConfig) {
return normalize(pluginSettings.pathToConfig);
}
return '';
}
/**
* Taken From https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions
*/
export function escapeRegExp(str: string): string {
return str.replace(/[.*+?^${}()|[\]\\]/g, '\\$&'); // $& means the whole matched string
}
/**
* ANSI colors/characters cleaning based on http://stackoverflow.com/questions/25245716/remove-all-ansi-colors-styles-from-strings
*/
export function cleanAnsi(str: string): string {
return str.replace(
// eslint-disable-next-line no-control-regex
/[\u001b\u009b][[()#;?]*(?:[0-9]{1,4}(?:;[0-9]{0,4})*)?[0-9A-ORZcf-nqry=><]/g,
''
);
}
export type IdStringType = 'display' | 'display-reverse' | 'full-name';
export function testIdString(type: IdStringType, identifier: TestIdentifier): string {
if (!identifier.ancestorTitles.length) {
return identifier.title;
}
const parts = [...identifier.ancestorTitles, identifier.title];
switch (type) {
case 'display':
return parts.join(' > ');
case 'display-reverse':
return parts.reverse().join(' < ');
case 'full-name':
return parts.join(' ');
}
}
/** convert the upper-case drive letter filePath to lower-case. If path does not contain upper-case drive letter, returns undefined. */
// note: this should probably be replaced by vscode.URI.file(filePath).fsPath ...
export function toLowerCaseDriveLetter(filePath: string): string | undefined {
const match = filePath.match(/^([A-Z]:\\)(.*)$/);
if (match) {
return `${match[1].toLowerCase()}${match[2]}`;
}
}
/** convert the lower-case drive letter filePath (like vscode.URI.fsPath) to lower-case. If path does not contain lower-case drive letter, returns undefined. */
export function toUpperCaseDriveLetter(filePath: string): string | undefined {
const match = filePath.match(/^([a-z]:\\)(.*)$/);
if (match) {
return `${match[1].toUpperCase()}${match[2]}`;
}
}
/**
* convert vscode.URI.fsPath to the actual file system file-path, i.e. convert drive letter to upper-case for windows
* @param filePath
*/
export function toFilePath(filePath: string): string {
return toUpperCaseDriveLetter(filePath) || filePath;
}
/**
* Generate path to icon used in decorations
* NOTE: Should not be called repeatedly for the performance reasons. Cache your results.
*/
export function prepareIconFile(
context: ExtensionContext,
iconName: string,
source: string,
color?: string
): string {
const iconsPath = join('generated-icons');
const resolvePath = (...args: string[]): string => {
return context.asAbsolutePath(join(...args));
};
const resultIconPath = resolvePath(iconsPath, `${iconName}.svg`);
let result = source.toString();
if (color) {
result = result.replace('fill="currentColor"', `fill="${color}"`);
}
if (!existsSync(resultIconPath) || readFileSync(resultIconPath).toString() !== result) {
if (!existsSync(resolvePath(iconsPath))) {
mkdirSync(resolvePath(iconsPath));
}
writeFileSync(resultIconPath, result);
}
return resultIconPath;
}
const SurroundingQuoteRegex = /^["']+|["']+$/g;
export const removeSurroundingQuote = (command: string): string =>
command.replace(SurroundingQuoteRegex, '');
// TestStats
export const emptyTestStats = (): TestStats => {
return { success: 0, fail: 0, unknown: 0 };
};