@janiscommerce/yml-builder

yml-builder

A package for build a single yml file from multiple source files.

Installation

npm install @janiscommerce/yml-builder

Usage (command line)

npx @janiscommerce/yml-builder -i sourceDir -o outputFile.yml

Important:

• The source files must be .yml or .yaml any other file types will be skipped.
• The input path and output file path starts from the current working directory.
• The output file will be replaced if it exists.
• The output directory will be recursively created if not exists.
• If there is not any source files in the specified input directory or not exists, an empty file will be generated.

Options:

--input, -i   the path to your sources directory
--output, -o  the path to the file that will be generated

Examples

npx @janiscommerce/yml-builder -i permissions/src -o permissions/permissions.yml

# Will get the source files from /path/to/root/permissions/src
# Will generate the output file into /path/to/root/permissions/permissions.yml

Usage (as module)

const YmlBuilder = require('@janiscommerce/yml-builder');

API

new YmlBuilder(input, output)

Constructs the YmlBuilder instance, configuring the input [String] and output [String] path.

async execute(input, output)

Builds the ymls from the input path into the output file path. Optionally you can specify the input [String] and output [String] path, by default it will be obtained from the constructor config.

Examples

const YmlBuilder = require('@janiscommerce/yml-builder');

const ymlBuilder = new YmlBuilder('input-dir', 'output-file.yml');

(async () => {

	await ymlBuilder.execute(); // It will run the build process...

})();