Skip to content

Latest commit

 

History

History
86 lines (63 loc) · 3.88 KB

usage.md

File metadata and controls

86 lines (63 loc) · 3.88 KB
Raw

CLI Usage

Install

npm install -g hbml

Commands

hbml [command]

All commands including hbml can have the -h or --help flags passed to print help information.

The hbml command also accepts the -V or --version flag which will result in version information being printed. It also accepts the help command as an alias for hbml -h.

Build

hbml build {project}|([source]... [-o path] [-s=skip_opt]...)

This takes in paths to directories or files and build the hbml files into html files. If a directory if given as part of the specified source paths, every hbml file under that directory is built. If no source files are given, the current working directory is used. The -o flag is used to specify file output path and defaults to the current working directory.

If project is specified after build, it looks for the hbml.json config file in the current working directory and uses the arguments from that.

The -s flag is for skipping errors. The available values for this are:

Value Description
not_found Will skip over file not found errors with a warning
write Will skip over errors in writing output html with a warning
parse Will skip over errors in parsing HBML into HTML with a warning

The final output of any file is $PWD/<output prefix path>/<source file path> if the given file is relative, otherwise it will write to <source file path>/<source file name>.html

Lint

hbml lint {project}|([source]... [-c file] [-o path] [-p] [-s=skip_opt]...)

Lints all specified files. Source files are specified the same way as for the build command with the same assumptions if none are given.

If project is specified after lint, it looks for the hbml.json config file in the current working directory and uses the arguments from that.

The -c flag is for specifying a config file to use (see the config section). If none is given, it will look for a hbml.json file in the current directory for config. If this is not found, it will assume the default configuration specified in the config section.

The -o flag is to specify a custom output instead of overwriting the existing files. The -p flag is equivalent to -o linted but takes lower precedent i.e. if both -o and -p are specified where -o has a usable value, the given value is used insteadof linted. Specifying both flags will result in a warning being emitted.

The -s flag is the same for hbml build

Config

Place a hbml.json file in your project root directory with the following format. None of the values are required. The comments represent the required type if the value is given, and the value in brackets represents the default value

{
  "lint": {
    "src": ["list", "of", "paths"], // string[] (["."])
    "output": "output prefix", // string (".")
    "config": {
      "indent": {
        "character": "space or tab", // " " or "\t" ("\t")
        "count": "number of characters per indent" // number (1)
      },
      "pre_tag_space": "spaces before bracket or >", // number (1)
      "post_tag_space": "spaces after >", // number (1)
      "inline_same_line": "make > elements all on the same line", // boolean (true)
      "keep_implicit": "keeps implicit 'div's and 'span's", // boolean (true)
      "void_inline": "make void elements inline" // boolean (true)
    }
  },
  "build": {
    "src": ["list", "of", "paths"], // string[] (["."])
    "output": "output prefix", // string (".")
    "allow": {
      "not_found": "ignore file not found errors", // boolean (false)
      "write": "ignore file write errors", // boolean (false)
      "parse": "ignore file parsing errors" // boolean (false)
    }
  }
}