@adobe/xdpm/commands/package.js

Adobe XD CLI Plugin Manager Utility

/*
 * Copyright 2018 Adobe Inc.
 *
 * Licensed 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.
 */

const cli = require("cli");
const shell = require("shelljs");
const path = require("path");
const fs = require("fs");
const localXdPath = require("../lib/localXdPath");
const getPluginMetadata = require("../lib/getPluginMetadata");
const validate = require("../lib/validate");

const yazl = require("yazl");
const ignoreWalk = require("ignore-walk");
const filterAlwaysIgnoredFile = require("../lib/filterAlwaysIgnoredFile");


/**
 * Packages one or more plugins
 */
function package(opts, args) {

    if (args.length === 0) {
        args.push("."); // assume we want to package the plugin in the cwd
    }

    const results = args.map(pluginToPackage => {
        const sourcePath = path.resolve(pluginToPackage);
        const result = {
            path: sourcePath
        };

        const metadata = getPluginMetadata(sourcePath);
        if (!metadata) {
            return Object.assign({}, result, {
                "error": "Can't package a plugin that doesn't have a valid manifest.json"
            });
        }

        const errors = validate(metadata, {root: sourcePath});
        if (errors.length > 0) {
            return Object.assign({}, result, {
                "error": "Can't package a plugin that has validation errors in the manifest.json:\n" + errors.join("\n")
            });
        }

        const id = metadata.id;
        if (!id) {
            return Object.assign({}, result, {
                "error": "Can't package a plugin without a plugin ID in the manifest"
            });
        }

        result.targetZip = path.join(sourcePath, '..', path.basename(sourcePath) + ".xdx");

        const zipfile = new yazl.ZipFile();

        zipfile.outputStream.pipe(fs.createWriteStream(result.targetZip)).on("close", function() {
        });

        const files = ignoreWalk.sync({
            path: sourcePath,
            ignoreFiles: [".gitignore", ".xdignore", ".npmignore"],
            includeEmpty: false,
        }).filter(filterAlwaysIgnoredFile);

        files.forEach(file => {
            zipfile.addFile(path.join(sourcePath, file), file);
        });


        zipfile.end();

        result.ok = `"${metadata.name}"@${metadata.version} [${metadata.id}] packaged successfully at ${result.targetZip}`;
        return result;
    });

    if (opts.json) {
        cli.output(JSON.stringify(results));
        return results;
    }

    results.forEach(result => {
        if (result.ok) {
            cli.ok(result.ok);
        } else {
            cli.error(result.error);
        }
    });

    return results;
}

module.exports = package;