Create jest-compatible tests from YAML notation.

$ yaml2jest -h
$ yaml2jest help

$ yaml2jest -V
$ yaml2jest [build] <basename>[.yaml]
$ yaml2jest [build] <basename>[.yaml] -o <testbasename>[.test[s]][.[jt]s]
$ yaml2jest [build] <basename>[.yaml] -c <configbasename>[.json]
$ yaml2jest [build] <basename>[.yaml] -o <testbasename>[.test[s]][.[jt]s] -c <configbasename>[.json]

$ yamljest init [<configbasename>[.json]]

Use npm and install with -g switch to have the yaml2jest CLI.

$ npm i -g yaml2test

Create app-tests.yaml as follows:

- my application:
  - can:
    - create files and folders
    - read data from .csv files
  - should:
    - work as cli
    - work as an importable package
- tests for my application:
  - should be:
    - easy to read
    - error free

Get help:

$ yaml2jest -h

Usage: yaml2jest [options] [command]

Create tests from YAML notation

Options:
  -V, --version               output the version number
  -h, --help                  display help for command

Commands:
  build [options] <yamlfile>  build tests in a test file (default command)
  init [configname]           create settings file
  help [command]              display help for command

Get help of build -- yaml2jest's defauld sub-command:

$ yaml2jest help build

Usage: yaml2jest build [options] <yamlfile>

build tests in a test file (default command)

Options:
  -o, --output <testfile>  fullpath to test file to create (default: <yamlfile-basename>.test.js)
  -c, --config <filename>  configuration filename (default: "yaml2jest.json")
  -h, --help               display help for command

Example 1: Create test file from .yaml file:

$ yaml2jest app-tests

use app-tests.yaml file as source and generate app-tests.test.js file, which is a jest compatible test file.

Generated app-tests.test.js will look as follows:

describe("my application", () => {
    describe("can", () => {
        it.todo("create files and folders");
        it.todo("read data from .csv files");
    });
    describe("should", () => {
        it.todo("work as cli");
        it.todo("work as an importable package");
    });
});
describe("tests for my application", () => {
    describe("should be", () => {
        it.todo("easy to read");
        it.todo("error free");
    });
});

Example 2: Specify an output file (path and name of test file to generate)

$ yaml2jest app-tests -o my-app

use app-tests.yaml file as source and generate the output file my-app.app.test.js

Use the app-tests.yaml as described for CLI.

const {createSuite} = 'yaml2test`;
const yamljs = require('yamljs');

let items = yamljs.load('app-tests.yaml');
let code = createSuite(items);
console.log(code);

- test case 1
- test case 2

- Suite:
  - test case 1
  - test case 2

- Suite:
  - child suite 1:
    - test case 1
    - test case 2
  - child suite 2:
    - test case 3
    - test case 4

- Parent Suite 1:
    - child suite 1:
      - test case 1
      - test case 2
    - child suite 2:
      - test case 3
      - test case 4
    
- Parent Suite 2:
  - child suite 3:
    - test case 5
    - test case 6
  - child suite 4:
    - test case 7
    - test case 8

Suite:
  - test case 1
  - test case 2

Suite:
  child suite 1:
    - test case 1
    - test case 2
  child suite 2:
    - test case 3
    - test case 4

Parent Suite 1:
  child suite 1:
    - test case 1
    - test case 2
  child suite 2:
    - test case 3
    - test case 4
    
Parent Suite 2:
  child suite 3:
    - test case 5
    - test case 6
  child suite 4:
    - test case 7
    - test case 8