kmdr-parser v2.7.3

Kmdr Schema Parser/Validator

A parser/validator for kmdr specs in YAML or JSON format

Installation

With npm

npm install kmdr-parser -g

With yarn

yarn global add kmdr-parser

Usage

CLI

$ kmdr-parser -h
Usage: kmdr-parser [options] <file> [files...]

Options:
  -v, --version            Output the current version
  -l, --log-level <level>  Set the log level (default: "info")
  -h, --help               output usage information

Validating a schema

$ kmdr-parser examples/en/kmdr.yaml
[INFO] Opening file examples/en/kmdr.yaml...
[INFO] The schema examples/en/kmdr.yaml is VALID! It contains { options: 1, subcommands: 2, examples: 0 }

The CLI also takes multiple file names to validate

$ kmdr-parser examples/en/kmdr.yaml
[INFO] Opening file examples/en/kmdr.yaml...
[INFO] The schema examples/en/kmdr.yaml is VALID! It contains { options: 1, subcommands: 2, examples: 0 }
[INFO] Opening file examples/en/kmdr.yaml...
[INFO] The schema examples/en/kmdr.yaml is VALID! It contains { options: 1, subcommands: 2, examples: 0 }
[INFO] Opening file examples/en/rmdir.yaml...
[WARN] The schema examples/en/rmdir.yaml is VALID, but it has 1 warning(s)!
[WARN] Option field "summary" at path [ 'rmdir' ]: Field must end with a letter character (a-z) "Remove DIRECTORY and its ancestors; e.g., 'rmdir -p a/b/c' is similar to 'rmdir a/b/c a/b a'"

API

import Schema from "kmdr-parser";

const schema = {
  name: "kmdr",
  summary: "The CLI tool for explaining shell commands from your terminal"
};

try {
  const kmdrSchema = new Schema(schema);
} catch (err) {
  console.error(err);
}

Schema

Every program explained by kmdr has a schema with key-value pairs defining the properties of commands.

The option object

The subcommand object

A programs subcommands encapsulate specialized tasks that a program can do. Subcommands usually follow immediately after the program name in a command. Some examples are:

• npm uninstall: remove is a sub command of the program npm
• yarn install: install is a sub command of the program yarn
• docker images: images is a sub command of docker
• git commit: commit is a sub command of docker

A subcommand can have 0 or more subcommands available for execution:

• docker network create: docker has a subcommand network and network has a subcommand create
• git submodule add: git has a subcommand submodule and submodule has a subcommand add

Subcommands have similar key-value pairs to programs. In Table 2.0 we see that there are some new key-value pairs and different key-value pairs are marked as required when compared to the program key-value pair set.

The example object

The environment object