fmtconv

Convert between JSON and YAML format files.

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
fmtconv
101.1.02 years ago7 years agoMinified + gzip package size for fmtconv in KB

Readme

fmtconv
Greenkeeper badge Node.js(≥12.22) CI Coverage Status Standard - JavaScript Style Guide License
Convert between JSON and YAML format files.

NPM
fmtconv status

Features

  • x Support JSON/YAML format files.
  • x Convert with JSON/YAML format files.
  • x Transcode with JSON/YAML format strings.

Installation

CLI executable

npm install -g fmtconv

API install

npm install --save fmtconv

CLI Usage

$ fmtconv -h

  Usage: fmtconv [-h] [-v] [-c] [-o file] <-i file | file>

  Convert between JSON and YAML format files.

  Options:

    -h, --help           output usage information
    -V, --version        output the version number
    -o, --output <file>  output a JSON/YAML file
    -i, --input <file>   input a JSON/YAML file
    -c, --compact        compact JSON/YAML format string
    --debug              debug mode, such as print error tracks

API Usage

Here we cover the most 'useful' methods.
const fmtconv = require('fmtconv')

fmtconv (input:string, output:string)

Convert between JSON and YAML format files.

The first string sets an input file path, the second string sets an output file path.

.stringJSON2YAML (content:string)

Transcode JSON to YAML string.

.stringYAML2JSON (content:string)

Transcode YAML to JSON string.

License

The Apache License 2.0