@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
19 lines (18 loc) • 678 B
TypeScript
import type { MergeDotfilesResponseInterface } from "../types/dotfiles.type";
import type { ErrorInterface } from "../types/error.type";
/**
* Generate Markdown
* =====================
*
* Each merge json and generate markdown
*
* @param {MergeDotfilesResponseInterface} json - merged JSON object from package.json and all-shieldsrc file
*
* @return {Promise<ErrorInterface>} { error } - description of error, catch error
*
*/
export declare const generate: ({ json }: MergeDotfilesResponseInterface) => Promise<ErrorInterface>;
declare const _default: {
generate: ({ json }: MergeDotfilesResponseInterface) => Promise<ErrorInterface>;
};
export default _default;