generated from MetaMask/metamask-module-template
-
-
Notifications
You must be signed in to change notification settings - Fork 7
/
file-utils.ts
43 lines (40 loc) · 1.25 KB
/
file-utils.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
import { promises as fs } from 'fs';
/**
* Reads the assumed JSON file at the given path, attempts to parse it, and
* returns the resulting object.
*
* Throws if failing to read or parse, or if the parsed JSON value is not a
* plain object.
*
* @param paths - The path segments pointing to the JSON file. Will be passed
* to path.join().
* @returns The object corresponding to the parsed JSON file.
*/
export async function readJsonObjectFile(
path: string,
): Promise<Record<string, unknown>> {
const obj = JSON.parse(await fs.readFile(path, 'utf8')) as Record<
string,
unknown
>;
if (!obj || typeof obj !== 'object' || Array.isArray(obj)) {
throw new Error(
`Assumed JSON file at path "${path}" parsed to a non-object value.`,
);
}
return obj;
}
/**
* Attempts to write the given JSON-like value to the file at the given path.
* Adds a newline to the end of the file.
*
* @param path - The path to write the JSON file to, including the file itself.
* @param jsonValue - The JSON-like value to write to the file. Make sure that
* JSON.stringify can handle it.
*/
export async function writeJsonFile(
path: string,
jsonValue: unknown,
): Promise<void> {
await fs.writeFile(path, `${JSON.stringify(jsonValue, null, 2)}\n`);
}