/*---------------------------------------------------------------------------------------------
 *  Copyright (c) Dolittle. All rights reserved.
 *  Licensed under the MIT License. See LICENSE in the project root for license information.
 *--------------------------------------------------------------------------------------------*/
export const toolingPackageKeywords = ['dolittle', 'tooling'];

/**
 * Whether or not the package object represents a dolittle tooling boilerplate package
 *
 * @export
 * @param {*} packageJson
 */
export function packageIsToolingPackage(packageJson: any) {
    return packageJson.keywords && toolingPackageKeywords.every(val => packageJson.keywords.includes(val));
}

export type ToolingPackage =  {

    /**
     * The name of the package
     *
     * @type {string}
     */
    name: string;

    /**
     * The version of the package
     *
     * @type {string}
     */
    version: string;

    /**
     * The description of the package
     *
     * @type {string}
     */
    description: string;

    /**
     * The keywords of the package
     *
     * @type {string[]}
     */
    keywords: string[];

    /**
     * The dolittle configuration
     *
     * @type {{tooling: string}}
     */
    dolittle: {tooling: string}
};

export type ToolingPackageDescriptor =  {

    /**
     * The name of the package
     *
     * @type {string}
     */
    name: string;

    /**
     * The description of the package
     *
     * @type {string}
     */
    description: string;
};