readme-ranker/dist/index.js

A CLI tool to analyze and rank README files for projects, providing actionable suggestions for improvement.

#!/usr/bin/env node
"use strict";
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
    if (k2 === undefined) k2 = k;
    var desc = Object.getOwnPropertyDescriptor(m, k);
    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
      desc = { enumerable: true, get: function() { return m[k]; } };
    }
    Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
    if (k2 === undefined) k2 = k;
    o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
    Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
    o["default"] = v;
});
var __importStar = (this && this.__importStar) || (function () {
    var ownKeys = function(o) {
        ownKeys = Object.getOwnPropertyNames || function (o) {
            var ar = [];
            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
            return ar;
        };
        return ownKeys(o);
    };
    return function (mod) {
        if (mod && mod.__esModule) return mod;
        var result = {};
        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
        __setModuleDefault(result, mod);
        return result;
    };
})();
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
    return new (P || (P = Promise))(function (resolve, reject) {
        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
        step((generator = generator.apply(thisArg, _arguments || [])).next());
    });
};
var __importDefault = (this && this.__importDefault) || function (mod) {
    return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
const analyzer_1 = require("./analyzer");
const utils_1 = require("./utils");
const fs = __importStar(require("fs"));
const path = __importStar(require("path"));
const chalk_1 = __importDefault(require("chalk"));
const args = process.argv.slice(2);
const readmePath = args[0];
if (!readmePath) {
    console.error('Please provide the path to the README file.');
    process.exit(1);
}
const absolutePath = path.resolve(readmePath);
if (!fs.existsSync(absolutePath)) {
    console.error('The specified README file does not exist.');
    process.exit(1);
}
function main() {
    return __awaiter(this, void 0, void 0, function* () {
        const analyzer = new analyzer_1.ReadMeAnalyzer();
        try {
            const report = yield analyzer.analyze(absolutePath);
            (0, utils_1.logMessage)(chalk_1.default.bold.underline('\nREADME Analysis Report:\n'));
            (0, utils_1.logMessage)((0, utils_1.formatReport)(report));
            (0, utils_1.logMessage)('\n' + (0, utils_1.formatProgressBar)(report.totalScore, report.maxScore));
            if (report.suggestions.length > 0) {
                (0, utils_1.logMessage)(chalk_1.default.bold('\nSuggestions to improve your README:'));
                report.suggestions.forEach(s => (0, utils_1.logMessage)(chalk_1.default.yellow('- ' + s)));
            }
        }
        catch (error) {
            console.error(chalk_1.default.red('Error analyzing README:'), error);
            process.exit(1);
        }
    });
}
main();