com.github.sdorra.buildfrontend.PackageManager Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of buildfrontend-maven-plugin Show documentation

Installs and run node, npm or yarn as part of your maven build

There is a newer version: 2.5.0

Show newest version

package com.github.sdorra.buildfrontend;

/**
 * Interface for a node package manager (yarn or npm).
 */
public interface PackageManager {

    /**
     * Install everything which is defined in the package.json file of the package manager.
     */
    void install();

    /**
     * Runs a script which is defined in the package.json.
     *
     * @param script name of the script
     */
    void run(String script);

    /**
     * Symlink a package folder during development.
     */
    void link();

    /**
     * Link another package to the current package.
     *
     * @param pkg of package to link
     */
    void link(String pkg);

    /**
     * Publishes the package to an npm registry.
     *
     * @param version version of the package
     */
    void publish(String version);
}