Skip to content

SubmoduleOperations

Defined in: src/core/repo.ts:3034

Submodule operations

Wraps: git submodule subcommands

Methods

absorbGitDirs()

absorbGitDirs(opts?): Promise<void>

Defined in: src/core/repo.ts:3103

Absorb git directories of submodules into the superproject

Wraps: git submodule absorbgitdirs

Parameters

opts?

ExecOpts

Returns

Promise<void>


add()

add(url, path, opts?): Promise<void>

Defined in: src/core/repo.ts:3061

Add a submodule

Wraps: git submodule add <url> <path>

Parameters

url

string

path

string

opts?

SubmoduleAddOpts & ExecOpts

Returns

Promise<void>


deinit()

deinit(path, opts?): Promise<void>

Defined in: src/core/repo.ts:3068

Deinitialize a submodule

Wraps: git submodule deinit <path>

Parameters

path

string

opts?

SubmoduleDeinitOpts & ExecOpts

Returns

Promise<void>


foreach()

foreach(command, opts?): Promise<string>

Defined in: src/core/repo.ts:3089

Run a command in each submodule

Wraps: git submodule foreach <command>

Parameters

command

string

opts?

SubmoduleForeachOpts & ExecOpts

Returns

Promise<string>


init()

init(paths?, opts?): Promise<void>

Defined in: src/core/repo.ts:3047

Initialize submodules

Wraps: git submodule init

Parameters

paths?

string[]

opts?

ExecOpts

Returns

Promise<void>


list()

list(opts?): Promise<SubmoduleInfo[]>

Defined in: src/core/repo.ts:3040

List submodules

Wraps: git submodule status

Parameters

opts?

ExecOpts

Returns

Promise<SubmoduleInfo[]>


setBranch()

setBranch(path, branch, opts?): Promise<void>

Defined in: src/core/repo.ts:3110

Set the branch for a submodule

Wraps: git submodule set-branch --branch <branch> -- <path>

Parameters

path

string

branch

string

opts?

SubmoduleSetBranchOpts & ExecOpts

Returns

Promise<void>


setUrl()

setUrl(path, url, opts?): Promise<void>

Defined in: src/core/repo.ts:3117

Set the URL for a submodule

Wraps: git submodule set-url -- <path> <url>

Parameters

path

string

url

string

opts?

ExecOpts

Returns

Promise<void>


status()

status(paths?, opts?): Promise<string>

Defined in: src/core/repo.ts:3075

Get submodule status

Wraps: git submodule status

Parameters

paths?

string[]

opts?

SubmoduleStatusOpts & ExecOpts

Returns

Promise<string>


summary()

summary(opts?): Promise<string>

Defined in: src/core/repo.ts:3082

Get submodule summary

Wraps: git submodule summary

Parameters

opts?

SubmoduleSummaryOpts & ExecOpts

Returns

Promise<string>


sync()

sync(paths?, opts?): Promise<void>

Defined in: src/core/repo.ts:3096

Sync submodule URL configuration

Wraps: git submodule sync

Parameters

paths?

string[]

opts?

SubmoduleSyncOpts & ExecOpts

Returns

Promise<void>


update()

update(opts?): Promise<void>

Defined in: src/core/repo.ts:3054

Update submodules

Wraps: git submodule update

Parameters

opts?

SubmoduleOpts & ExecOpts

Returns

Promise<void>