From 6565e5095eea1fcb1272d05da280f167176900e7 Mon Sep 17 00:00:00 2001 From: Axetroy Date: Thu, 14 Mar 2019 22:26:12 +0800 Subject: [PATCH] feat: add writeJson/writeJsonSync for fs modules (denoland/deno_std#271) Original: https://github.com/denoland/deno_std/commit/e9d104a424d50e772b64253914452ccf71a72188 --- fs/write_json.ts | 57 ++++++++++ fs/write_json_test.ts | 244 ++++++++++++++++++++++++++++++++++++++++++ test.ts | 1 + 3 files changed, 302 insertions(+) create mode 100644 fs/write_json.ts create mode 100644 fs/write_json_test.ts diff --git a/fs/write_json.ts b/fs/write_json.ts new file mode 100644 index 0000000000..f94489095e --- /dev/null +++ b/fs/write_json.ts @@ -0,0 +1,57 @@ +// Copyright 2018-2019 the Deno authors. All rights reserved. MIT license. +/* eslint-disable @typescript-eslint/no-explicit-any */ +import * as path from "./path/mod.ts"; +type Replacer = (key: string, value: any) => any; + +export interface WriteJsonOptions { + spaces?: number | string; + replacer?: Array | Replacer; +} + +/* Writes an object to a JSON file. */ +export async function writeJson( + filePath: string, + object: any, + options: WriteJsonOptions = {} +): Promise { + filePath = path.resolve(filePath); + + let contentRaw = ""; + + try { + contentRaw = JSON.stringify( + object, + options.replacer as string[], + options.spaces + ); + } catch (err) { + err.message = `${filePath}: ${err.message}`; + throw err; + } + + await Deno.writeFile(filePath, new TextEncoder().encode(contentRaw)); +} + +/* Writes an object to a JSON file. */ +export function writeJsonSync( + filePath: string, + object: any, + options: WriteJsonOptions = {} +): void { + filePath = path.resolve(filePath); + + let contentRaw = ""; + + try { + contentRaw = JSON.stringify( + object, + options.replacer as string[], + options.spaces + ); + } catch (err) { + err.message = `${filePath}: ${err.message}`; + throw err; + } + + Deno.writeFileSync(filePath, new TextEncoder().encode(contentRaw)); +} diff --git a/fs/write_json_test.ts b/fs/write_json_test.ts new file mode 100644 index 0000000000..acc3660010 --- /dev/null +++ b/fs/write_json_test.ts @@ -0,0 +1,244 @@ +// Copyright 2018-2019 the Deno authors. All rights reserved. MIT license. +import { test } from "../testing/mod.ts"; +import { + assertEquals, + assertThrowsAsync, + assertThrows +} from "../testing/asserts.ts"; +import { writeJson, writeJsonSync } from "./write_json.ts"; +import * as path from "./path/mod.ts"; + +const testdataDir = path.resolve("fs", "testdata"); + +test(async function writeJsonIfNotExists() { + const notExistsJsonFile = path.join(testdataDir, "file_not_exists.json"); + + await assertThrowsAsync( + async () => { + await writeJson(notExistsJsonFile, { a: "1" }); + throw new Error("should write success"); + }, + Error, + "should write success" + ); + + const content = await Deno.readFile(notExistsJsonFile); + + await Deno.remove(notExistsJsonFile); + + assertEquals(new TextDecoder().decode(content), `{"a":"1"}`); +}); + +test(async function writeJsonIfExists() { + const existsJsonFile = path.join(testdataDir, "file_write_exists.json"); + + await Deno.writeFile(existsJsonFile, new Uint8Array()); + + await assertThrowsAsync( + async () => { + await writeJson(existsJsonFile, { a: "1" }); + throw new Error("should write success"); + }, + Error, + "should write success" + ); + + const content = await Deno.readFile(existsJsonFile); + + await Deno.remove(existsJsonFile); + + assertEquals(new TextDecoder().decode(content), `{"a":"1"}`); +}); + +test(async function writeJsonIfExistsAnInvalidJson() { + const existsInvalidJsonFile = path.join( + testdataDir, + "file_write_invalid.json" + ); + + const invalidJsonContent = new TextEncoder().encode("[123}"); + await Deno.writeFile(existsInvalidJsonFile, invalidJsonContent); + + await assertThrowsAsync( + async () => { + await writeJson(existsInvalidJsonFile, { a: "1" }); + throw new Error("should write success"); + }, + Error, + "should write success" + ); + + const content = await Deno.readFile(existsInvalidJsonFile); + + await Deno.remove(existsInvalidJsonFile); + + assertEquals(new TextDecoder().decode(content), `{"a":"1"}`); +}); + +test(async function writeJsonWithSpaces() { + const existsJsonFile = path.join(testdataDir, "file_write_spaces.json"); + + const invalidJsonContent = new TextEncoder().encode(); + await Deno.writeFile(existsJsonFile, invalidJsonContent); + + await assertThrowsAsync( + async () => { + await writeJson(existsJsonFile, { a: "1" }, { spaces: 2 }); + throw new Error("should write success"); + }, + Error, + "should write success" + ); + + const content = await Deno.readFile(existsJsonFile); + + await Deno.remove(existsJsonFile); + + assertEquals(new TextDecoder().decode(content), `{\n "a": "1"\n}`); +}); + +test(async function writeJsonWithReplacer() { + const existsJsonFile = path.join(testdataDir, "file_write_replacer.json"); + + const invalidJsonContent = new TextEncoder().encode(); + await Deno.writeFile(existsJsonFile, invalidJsonContent); + + await assertThrowsAsync( + async () => { + await writeJson( + existsJsonFile, + { a: "1", b: "2", c: "3" }, + { + replacer: ["a"] + } + ); + throw new Error("should write success"); + }, + Error, + "should write success" + ); + + const content = await Deno.readFile(existsJsonFile); + + await Deno.remove(existsJsonFile); + + assertEquals(new TextDecoder().decode(content), `{"a":"1"}`); +}); + +test(function writeJsonSyncIfNotExists() { + const notExistsJsonFile = path.join(testdataDir, "file_not_exists_sync.json"); + + assertThrows( + () => { + writeJsonSync(notExistsJsonFile, { a: "1" }); + throw new Error("should write success"); + }, + Error, + "should write success" + ); + + const content = Deno.readFileSync(notExistsJsonFile); + + Deno.removeSync(notExistsJsonFile); + + assertEquals(new TextDecoder().decode(content), `{"a":"1"}`); +}); + +test(function writeJsonSyncIfExists() { + const existsJsonFile = path.join(testdataDir, "file_write_exists_sync.json"); + + Deno.writeFileSync(existsJsonFile, new Uint8Array()); + + assertThrows( + () => { + writeJsonSync(existsJsonFile, { a: "1" }); + throw new Error("should write success"); + }, + Error, + "should write success" + ); + + const content = Deno.readFileSync(existsJsonFile); + + Deno.removeSync(existsJsonFile); + + assertEquals(new TextDecoder().decode(content), `{"a":"1"}`); +}); + +test(function writeJsonSyncIfExistsAnInvalidJson() { + const existsInvalidJsonFile = path.join( + testdataDir, + "file_write_invalid_sync.json" + ); + + const invalidJsonContent = new TextEncoder().encode("[123}"); + Deno.writeFileSync(existsInvalidJsonFile, invalidJsonContent); + + assertThrows( + () => { + writeJsonSync(existsInvalidJsonFile, { a: "1" }); + throw new Error("should write success"); + }, + Error, + "should write success" + ); + + const content = Deno.readFileSync(existsInvalidJsonFile); + + Deno.removeSync(existsInvalidJsonFile); + + assertEquals(new TextDecoder().decode(content), `{"a":"1"}`); +}); + +test(function writeJsonWithSpaces() { + const existsJsonFile = path.join(testdataDir, "file_write_spaces_sync.json"); + + const invalidJsonContent = new TextEncoder().encode(); + Deno.writeFileSync(existsJsonFile, invalidJsonContent); + + assertThrows( + () => { + writeJsonSync(existsJsonFile, { a: "1" }, { spaces: 2 }); + throw new Error("should write success"); + }, + Error, + "should write success" + ); + + const content = Deno.readFileSync(existsJsonFile); + + Deno.removeSync(existsJsonFile); + + assertEquals(new TextDecoder().decode(content), `{\n "a": "1"\n}`); +}); + +test(function writeJsonWithReplacer() { + const existsJsonFile = path.join( + testdataDir, + "file_write_replacer_sync.json" + ); + + const invalidJsonContent = new TextEncoder().encode(); + Deno.writeFileSync(existsJsonFile, invalidJsonContent); + + assertThrows( + () => { + writeJsonSync( + existsJsonFile, + { a: "1", b: "2", c: "3" }, + { + replacer: ["a"] + } + ); + throw new Error("should write success"); + }, + Error, + "should write success" + ); + + const content = Deno.readFileSync(existsJsonFile); + + Deno.removeSync(existsJsonFile); + + assertEquals(new TextDecoder().decode(content), `{"a":"1"}`); +}); diff --git a/test.ts b/test.ts index 01a68cd76c..9034631a6a 100755 --- a/test.ts +++ b/test.ts @@ -19,6 +19,7 @@ import "./fs/ensure_dir_test.ts"; import "./fs/ensure_file_test.ts"; import "./fs/move_test.ts"; import "./fs/read_json_test.ts"; +import "./fs/write_json_test.ts"; import "./io/test.ts"; import "./http/server_test.ts"; import "./http/file_server_test.ts";