nodekit-cli-lib/lib/nodekit-lib/nodekit/requirements.js

Command-line helpers for NodeKit command line interface

/**
    Licensed to OffGrid Networks (OGN) under one
    or more contributor license agreements.  See the NOTICE file
    distributed with this work for additional information
    regarding copyright ownership.  OGN licenses this file
    to you under the Apache License, Version 2.0 (the
    "License"); you may not use this file except in compliance
    with the License.  You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing,
    software distributed under the License is distributed on an
    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
    KIND, either express or implied.  See the License for the
    specific language governing permissions and limitations
    under the License.
*/

var nodekit_util = require('./util');
var Q            = require('q');
var NodeKitError = require('nodekit-cli-lib')['nodekit-common'].NodeKitError;
var knownPlatforms = require('../platforms/platforms');

/**
 * Runs requirements check against platforms specified in 'platfoms' argument
 *
 * @param  {String[]} platforms List of platforms for requirements check. If
 *   none, all platforms, added to project will be checked
 *
 * @return {Promise<Object>}    Promise fullfilled with map of platforms and
 *   requirements check results for each platform.
 */
module.exports = function check_reqs(platforms) {
    return Q().then(function() {
        var platforms = nodekit_util.preProcessOptions(platforms).platforms;

        return Q.allSettled(platforms.map(function (platform) {
            return knownPlatforms.getPlatformApi(platform).requirements();
        }))
        .then(function (settledChecks) {
            var res = {};
            settledChecks.reduce(function (result, settledCheck, idx) {
                var platformName = platforms[idx];
                result[platformName] = settledCheck.state === 'fulfilled' ?
                    settledCheck.value :
                    new NodeKitError(settledCheck.reason);
                return result;
            }, res);
            return res;
        });
    });
};