@ptkdev/all-shields-cli
Version:
Tool to help automate your badges of shields.io, badgen.net, fury.io, github action and snyk.io from .all-shieldsrc dotfile for your markdown files. You can use Liquid variables like {{name}} or {{version}} which refer to your package.json. Inspired by al
72 lines (71 loc) • 1.59 kB
TypeScript
/**
* DotFiles Interface
* =====================
*
* Manage package.json and .all-shieldsrc
*
* @contributors: Patryk Rzucidło [@ptkdev] <support@ptkdev.io> (https://ptk.dev)
*
* @license: MIT License
*
*/
/**
* ReadDotFiles Interface
* =====================
*
* Manage package.json and .all-shieldsrc
*
* @param {string} pkg - Get string of package.json
* @param {string} rc - Get string of .all-shieldsrc / .all-shieldsrc.json dotfiles
* @param {string} error - catch error
*
*/
export interface ReadDotfilesResponseInterface {
/**
* Read package.json
* =====================
* Get string of package.json
*
*/
pkg: string;
/**
* Read .all-shieldsrc
* =====================
* Get string of .all-shieldsrc / .all-shieldsrc.json dotfiles
*
*/
rc: string;
/**
* Error
* =====================
* Get error description from catch(err)
*
*/
error?: string;
}
/**
* MergeDotFiles Interface
* =====================
*
* Merge all-shieldsrc liquid variables from package.json keys
*
* @param {JSON} json - JSON object, result of merge from package.json and .all-shieldsrc
* @param {string} error - catch error
*
*/
export interface MergeDotfilesResponseInterface {
/**
* Read merge json
* =====================
* JSON of all-shieldsrc dotfile with liquid variables from package.json keys
*
*/
json: any;
/**
* Error
* =====================
* Get error description from catch(err)
*
*/
error?: string;
}