md-generator
Version:
NPM Package which bootstraps Development by creating all required .md files to meet community standards.
89 lines (88 loc) • 3.96 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
var tslib_1 = require("tslib");
var boxen_1 = tslib_1.__importDefault(require("boxen"));
var pad_1 = tslib_1.__importDefault(require("pad"));
var chalk_1 = tslib_1.__importDefault(require("chalk"));
var ora_1 = tslib_1.__importDefault(require("ora"));
var red = chalk_1.default.red, gray = chalk_1.default.gray, green = chalk_1.default.green, cyan = chalk_1.default.cyan;
exports.red = red;
exports.gray = gray;
exports.green = green;
exports.cyan = cyan;
var whiteUnderline = chalk_1.default.underline.rgb(174, 174, 174);
exports.whiteUnderline = whiteUnderline;
var dimWhite = chalk_1.default.rgb(174, 174, 174);
exports.dimWhite = dimWhite;
var log = function (data1, data2, data3) {
if (data2 === void 0) { data2 = ''; }
if (data3 === void 0) { data3 = ''; }
process.stdout.write("\n" + data1);
process.stdout.write("" + data2);
process.stdout.write("" + data3);
};
exports.log = log;
var BOX_CONFIG = {
padding: 1,
margin: { top: 2, bottom: 2 },
borderColor: 'cyan',
align: 'center',
borderStyle: 'double',
};
var useBox = function (text) {
log(boxen_1.default(text, BOX_CONFIG));
};
exports.useBox = useBox;
var showEndMessage = function () {
return useBox('File(s) Created Successfully\nThank you for using md-generator');
};
exports.showEndMessage = showEndMessage;
var customHelp = function () {
log('\nCommand-Options :');
log('Usage: md-generator [commands] [command-options]\n');
log(pad_1.default('-A, --all', 26), 'Operate on all required/optional .md files');
log(pad_1.default('-F, --file', 26), 'Operate on specific .md files');
log(pad_1.default('-E, --empty', 26), 'make added files empty');
log(pad_1.default('-R --required', 26), 'Operate on required files');
log(pad_1.default('-O --optional', 26), 'Operate on optional files\n');
};
exports.customHelp = customHelp;
var wrongCommandAlert = function (command) {
return log("Command \"" + command + "\" Does not Exist,\nPlease use --help to get the available commands\n");
};
exports.wrongCommandAlert = wrongCommandAlert;
var noCommandAlert = function () {
log('Error: No Command Supplied. Please use --help to view the available Commands and Options\n');
};
exports.noCommandAlert = noCommandAlert;
var spinner = function (text) { return ora_1.default(text).start(); };
exports.spinner = spinner;
var castElementsToFormatedString = function (filesArray) {
var files = '';
filesArray.forEach(function (file) { return (files += cyan(pad_1.default('-', 2)) + " " + dimWhite("" + file) + "\n"); });
return files;
};
exports.castElementsToFormatedString = castElementsToFormatedString;
var checkCommunityStandardMet = function (authorGithubUsername, projectName) {
if (authorGithubUsername && projectName) {
log("You can check community standards met via https://github.com/" + authorGithubUsername + "/" + projectName + "/community \n");
}
else {
log('You can check community standards met via https://github.com/"<GithubUsername>"/"<projectName>"/community \n');
}
};
exports.checkCommunityStandardMet = checkCommunityStandardMet;
var fileNotDetectedAlert = function () {
log('Error: File names not detected, please supply file names i.e --file "README.md CONTRIBUTING.md" \n');
};
exports.fileNotDetectedAlert = fileNotDetectedAlert;
var unrecognizedFileAlert = function (inValidFileNamesArray) {
log("The following file name(s) is/are not recognized as one of the required/optional .md files\n" + castElementsToFormatedString(inValidFileNamesArray));
};
exports.unrecognizedFileAlert = unrecognizedFileAlert;
var useHelpAlert = function (_a) {
var errorText = _a.errorText, override = _a.override;
var genericText = override ? '\n' : ' please use --help to check all supported md Files\n';
log(errorText + " " + genericText);
};
exports.useHelpAlert = useHelpAlert;