UNPKG

readmeasy

Version:

Creates README.md for node modules using any template engine as easy as possible.

27 lines 1.14 kB
"use strict"; Object.defineProperty(exports, "__esModule", { value: true }); /** @ignore */ const badges = require("badges"); // eslint-disable-line @typescript-eslint/no-var-requires /** @ignore */ const additionalShields = { conventionalcommits: "[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org)", commitizen: "[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)", }; /** @ignore */ function badgesConfig(packageJson) { return { homepage: packageJson.homepage, npmPackageName: packageJson.name, ...packageJson.identities, }; } /** @ignore */ function shields(packageJson) { const config = badgesConfig(packageJson); const requestedShields = packageJson.shields || []; return requestedShields .map((shield) => (typeof shield === "object" ? additionalShields[shield.name] : additionalShields[shield]) || badges.renderBadges([shield], config)) .join(" "); } exports.default = shields; //# sourceMappingURL=shields.js.map