node-sloc/lib/index.js

A small tool for counting SLOC.

"use strict";
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
    if (k2 === undefined) k2 = k;
    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
}) : (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 (mod) {
    if (mod && mod.__esModule) return mod;
    var result = {};
    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
    __setModuleDefault(result, mod);
    return result;
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.sloc = void 0;
const sloc = __importStar(require("./sloc"));
const file_extensions_1 = require("./file-extensions");
const allowedExtensions = file_extensions_1.extensions.map((x) => x.lang);
/**
 * @typedef  {Object}      Options
 * @property {string}      path               The path to walk or file to read.
 * @property {Array}       [extensions]       Additional file extensions to look for.
 * @property {Array}       [ignorePaths]      A list of directories to ignore.
 * @property {boolean}     [ignoreDefault]    Ignores the default file extensions.
 * @property {function}    [logger]           Outputs extra information to this function if specified.
 */
/**
 * Reads a specified file/directory and counts the SLOC.
 * If a directory is supplied the function will walk the directory recursively and count the SLOC.
 * @param  {Options}  options     The options. See object options.
 * @param  {Function} [callback]  The callback function, if node-style callbacks are preferred over promises.
 * @return {Promise}              If no callback is supplied, it returns a promise which will resolve to an object with
 *                                properties `sloc` and `paths` (or null if no path matched).
 */
const nodeSloc = (options, callback) => {
    // Check if options object is valid
    if (typeof options !== 'object' || !options) {
        return Promise.reject(new Error('Parameter `options` must be an object.'));
    }
    if (typeof options.path !== 'string') {
        return Promise.reject(new Error('`options.path` must be a string.'));
    }
    // if ignoreDefault is true, extensions must be supplied as well
    if (options.ignoreDefault && !options.extensions) {
        return Promise.reject(new Error('`options.extensions` must be supplied when ignoreDefault is set to true'));
    }
    let extensions = allowedExtensions;
    const ignorePaths = options.ignorePaths || [];
    if (options.extensions) {
        // Don't use the default extensions if ignoreDefault is true
        const ext = options.ignoreDefault ? [] : allowedExtensions;
        extensions = [...ext, ...options.extensions];
    }
    const opts = {
        path: options.path,
        logger: options.logger,
        extensions,
        ignorePaths,
    };
    // If no callback is provided, use promises
    if (!callback) {
        return sloc.walkAndCount(opts);
    }
    // Else use node-style callback
    if (typeof callback !== 'function') {
        throw new Error('type mismatch: callback must be a function');
    }
    sloc
        .walkAndCount(opts)
        .then((res) => callback(null, res))
        .catch((err) => callback(err, null));
};
exports.sloc = nodeSloc;
exports.default = nodeSloc;
// CommonJS support
module.exports = exports = nodeSloc;