git-command-helper/dist/submodule.d.ts

github command helper for nodejs

import Bluebird from "bluebird";
import { SpawnOptions } from "child_process";
import git from "./git";
export declare class submodule {
    /** current working directory */
    cwd: string;
    /** .gitmodules exist */
    hasConfig: boolean;
    /** git-command-helper class */
    github: Record<string, git>;
    constructor(cwd: string);
    private spawnOpt;
    /**
     * add submodule
     */
    add(opt: {
        remote: string;
        branch?: string;
        dest: string;
    }): Promise<void>;
    /**
     * remove submodule
     * @param submodulePath path to submodule
     */
    remove(submodulePath: string): Promise<void>;
    /**
     * check has submodule
     * @returns
     */
    hasSubmodule(): boolean;
    /**
     * git submodule update
     * @param args custom arguments
     * @param optionSpawn
     * @returns
     */
    update(args?: string[], optionSpawn?: SpawnOptions): Bluebird<string>;
    /**
     * Update all submodule with cd method
     * @param reset do git reset --hard origin/branch ?
     */
    safeUpdate(reset?: boolean): Bluebird<unknown>;
    /**
     * git submodule status
     * @param optionSpawn
     * @returns
     */
    status(optionSpawn?: SpawnOptions): Bluebird<string>;
    /**
     * git add all each submodule
     * @param pathOrArg ex: `-A`
     * @returns
     */
    addAll(pathOrArg: string): Bluebird<string>;
    commitAll(msg: string): Bluebird<string>;
    /**
     * get submodule informations
     * @returns
     */
    get(): import("./utils/extract-submodule").Submodule[];
}
export default submodule;
export { submodule as gitSubmodule };