@ptkdev/all-shields-cli/dist/functions/dotfiles.d.ts

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

import type { ReadDotfilesResponseInterface, MergeDotfilesResponseInterface } from "../types/dotfiles.type";
/**
 * readDotFiles
 * =====================
 *
 * Gets package.json and all-shields-cli rc dotfile
 *
 * @return {Promise<ReadDotfilesResponseInterface>} { pkg, rc } - (async) string of package.json and .all-shieldsrc dot file
 *
 */
export declare const readDotFiles: () => Promise<ReadDotfilesResponseInterface>;
/**
 * mergeDotFiles
 * =====================
 *
 * Merge all-shieldsrc liquid variables from package.json keys
 *
 * @param {ReadDotfilesResponseInterface} pkg - pkg string from package.json
 * @param {ReadDotfilesResponseInterface} rc - rc string from .all-shieldsrc
 *
 * @return {Promise<MergeDotfilesResponseInterface>} { json, error } - (async) merge string of package.json and .all-shieldsrc dot file
 *
 */
export declare const mergeDotFiles: ({ pkg, rc }: ReadDotfilesResponseInterface) => Promise<MergeDotfilesResponseInterface>;
declare const _default: {
    readDotFiles: () => Promise<ReadDotfilesResponseInterface>;
    mergeDotFiles: ({ pkg, rc }: ReadDotfilesResponseInterface) => Promise<MergeDotfilesResponseInterface>;
};
export default _default;