Skip to main content

@dallmo/util-yaml

overview

  • a simple yaml file reader ;
  • re-written in typescript, migrated from nodejs to base only on deno standard libraries ;
  • published on both deno land and jsr ;

dependencies

all of deno standard library.

usage

1. running on deno, import via deno module

  1. nothing to add via CLI.

  2. create 2 files :

// this assumes the latest version
import { dallmo_util_yaml } from "https://deno.land/x/dallmo_util_yaml/mod.ts";

const config_file = "config.yaml";
const config_obj = await dallmo_util_yaml( config_file );
  console.log( config_obj );
  1. run the test file
deno run --allow-read test-via-deno-modules.ts

2. running on deno, import via jsr

  1. in CLI, add the module with :
deno add @dallmo/util-yaml
  1. create 2 files :
import { dallmo_util_yaml } from "@dallmo/util-yaml";

const config_file = "config.yaml";
const config_obj = await dallmo_util_yaml( config_file );
  console.log( config_obj );
  1. run the test file
deno run --allow-read test-via-jsr.ts

test

to run test codes :

  1. switch to the project root folder, i.e. [root]/ ;
  2. run deno task scripts :
  • to test with dependencies via deno modules :
    • run deno task test-deno ;
  • to test with dependencies via jsr :
    • run deno task test-jsr ;