README.md

@docgeni/toolkit

Toolkit for Docgeni or cli tools

Usage

const { toolkit } = require('@docgeni/toolkit');

toolkit.initialize({ baseDir: __dirname});
toolkit.print.info(`Hey, I'm Docgeni!`);
toolkit.print.success(`success`);

Here's what's available inside the toolkit object you see all over Docgeni.

Name	Description	3rd party lib
print	tools to print output to the command line	chalk, ora
strings	some string helpers like case conversion, etc.	camelcase, pluralize
template	code generation from templates	handlebars
fs	ability to copy, move & delete files & directories	fs-extra
timestamp	format timestamp
utils	some utils functions like isString, isFunction, keyBy

Accessing Toolkit Directly

You can access almost all of Docgeni 's toolkit tools without toolkit.

const { Print, fs, strings } = require('@docgeni/toolkit');
// or
const { Print } = require('@docgeni/toolkit/print');
const * as fs = require('@docgeni/toolkit/filesystem');
const * as strings = require('@docgeni/toolkit/strings');

const print = new Print();
print.info(`Hey, I'm Docgeni!`);
fs.dir('/tmp/peter');
print.error('error);