Function addTutorialConf

lib/jsdoc/tutorial/resolver.js:48–75

* Helper function that adds tutorial configuration to the `conf` variable. This helps when multiple * tutorial configurations are specified in one object, or when a tutorial's children are specified * as tutorial configurations as opposed to an array of tutorial names. * * Recurses as necessary

(name, meta)

 * child tutorials.
 */
function addTutorialConf(name, meta) {
    let names;

    if (isTutorialJSON(meta)) {
        // if the children are themselves tutorial defintions as opposed to an
        // array of strings, add each child.
        if (hasOwnProp.call(meta, 'children') && !Array.isArray(meta.children)) {
            names = Object.keys(meta.children);
            for (let childName of names) {
                addTutorialConf(childName, meta.children[childName]);
            }
            // replace with an array of names.
            meta.children = names;
        }
        // check if the tutorial has already been defined...
        if (hasOwnProp.call(conf, name)) {
            logger.warn(`Metadata for the tutorial ${name} is defined more than once. Only the first definition will be used.`);
        } else {
            conf[name] = meta;
        }
    } else {
        // keys are tutorial names, values are `Tutorial` instances
        names = Object.keys(meta);
        for (let tutorialName of names) {
            addTutorialConf(tutorialName, meta[tutorialName]);
        }
    }
}

/**
 * Add a tutorial.