mirror of
https://github.com/denoland/std.git
synced 2024-11-22 04:59:05 +00:00
d13ef17a5d
This commit improves docs of the front-matter module. Specifically, the following things are done: - Use `@example` where appropriate to render the examples more beautifully - Split the big example attached to `createExtractor` function into smaller pieces so that each one has minimal yet meaningful example - Add `@returns` to the `test` function - Deduplicate `Format` type definition - Add a brief description to `Format` type Towards #3764 --------- Co-authored-by: Asher Gomez <ashersaupingomez@gmail.com>
72 lines
1.8 KiB
TypeScript
72 lines
1.8 KiB
TypeScript
// Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.
|
|
|
|
import { test } from "./test.ts";
|
|
import { extract } from "./any.ts";
|
|
import {
|
|
runExtractJsonTests,
|
|
runExtractTomlTests,
|
|
runExtractTypeErrorTests,
|
|
runExtractYamlTests1,
|
|
runExtractYamlTests2,
|
|
runTestInvalidInputTests,
|
|
runTestValidInputTests,
|
|
} from "./_test_utils.ts";
|
|
|
|
// YAML //
|
|
|
|
Deno.test("test() handles valid input", () => {
|
|
runTestValidInputTests("yaml", test);
|
|
});
|
|
|
|
Deno.test("test() handles invalid input", () => {
|
|
runTestInvalidInputTests("yaml", test);
|
|
});
|
|
|
|
Deno.test("extract() extracts type error on invalid input", () => {
|
|
runExtractTypeErrorTests("yaml", extract);
|
|
});
|
|
|
|
Deno.test("extract() parses yaml delineate by `---`", async () => {
|
|
await runExtractYamlTests1(extract);
|
|
});
|
|
|
|
Deno.test("extract() parses yaml delineate by `---yaml`", async () => {
|
|
await runExtractYamlTests2(extract);
|
|
});
|
|
|
|
// JSON //
|
|
|
|
Deno.test("test() handles valid json input", () => {
|
|
runTestValidInputTests("json", test);
|
|
});
|
|
|
|
Deno.test("test() handles invalid json input", () => {
|
|
runTestInvalidInputTests("json", test);
|
|
});
|
|
|
|
Deno.test("extract() extracts type error on invalid json input", () => {
|
|
runExtractTypeErrorTests("json", extract);
|
|
});
|
|
|
|
Deno.test("extract() parses json delineate by ---json", async () => {
|
|
await runExtractJsonTests(extract);
|
|
});
|
|
|
|
// TOML //
|
|
|
|
Deno.test("test() test valid input true", () => {
|
|
runTestValidInputTests("toml", test);
|
|
});
|
|
|
|
Deno.test("test() handles invalid toml input false", () => {
|
|
runTestInvalidInputTests("toml", test);
|
|
});
|
|
|
|
Deno.test("extract() extracts type error on invalid toml input", () => {
|
|
runExtractTypeErrorTests("toml", extract);
|
|
});
|
|
|
|
Deno.test("extract() parses toml delineate by ---toml", async () => {
|
|
await runExtractTomlTests(extract);
|
|
});
|