workspace-tools 0.21.0 → 0.23.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.json +54 -1
- package/CHANGELOG.md +30 -2
- package/lib/dependencies/index.d.ts +12 -0
- package/lib/dependencies/index.js +14 -0
- package/lib/{dependencies.d.ts → dependencies/transitiveDeps.d.ts} +1 -7
- package/lib/{dependencies.js → dependencies/transitiveDeps.js} +3 -12
- package/lib/{createDependencyMap.d.ts → graph/createDependencyMap.d.ts} +3 -5
- package/lib/{createDependencyMap.js → graph/createDependencyMap.js} +3 -2
- package/lib/graph/createPackageGraph.d.ts +10 -0
- package/lib/graph/createPackageGraph.js +122 -0
- package/lib/graph/getPackageDependencies.d.ts +6 -0
- package/lib/graph/getPackageDependencies.js +20 -0
- package/lib/graph/index.d.ts +3 -0
- package/lib/graph/index.js +16 -0
- package/lib/index.d.ts +2 -2
- package/lib/index.js +2 -2
- package/lib/lockfile/index.js +2 -2
- package/package.json +5 -3
- package/.github/workflows/pr.yml +0 -29
- package/.github/workflows/release.yml +0 -36
- package/.prettierrc +0 -6
- package/CODE_OF_CONDUCT.md +0 -9
- package/SECURITY.md +0 -41
- package/beachball.config.js +0 -12
- package/docs/.nojekyll +0 -1
- package/docs/assets/highlight.css +0 -22
- package/docs/assets/icons.css +0 -1043
- package/docs/assets/icons.png +0 -0
- package/docs/assets/icons@2x.png +0 -0
- package/docs/assets/main.js +0 -52
- package/docs/assets/search.js +0 -1
- package/docs/assets/style.css +0 -1414
- package/docs/assets/widgets.png +0 -0
- package/docs/assets/widgets@2x.png +0 -0
- package/docs/index.html +0 -42
- package/docs/interfaces/NpmLockFile.html +0 -1
- package/docs/interfaces/NpmSymlinkInfo.html +0 -1
- package/docs/interfaces/NpmWorkspacesInfo.html +0 -1
- package/docs/interfaces/PackageInfo.html +0 -1
- package/docs/interfaces/PackageInfos.html +0 -1
- package/docs/interfaces/PnpmLockFile.html +0 -1
- package/docs/modules.html +0 -70
- package/jest.config.js +0 -11
- package/lib/__tests__/dependencies.test.d.ts +0 -1
- package/lib/__tests__/dependencies.test.js +0 -141
- package/lib/__tests__/getChangedPackages.test.d.ts +0 -1
- package/lib/__tests__/getChangedPackages.test.js +0 -142
- package/lib/__tests__/getDefaultRemote.test.d.ts +0 -1
- package/lib/__tests__/getDefaultRemote.test.js +0 -26
- package/lib/__tests__/getInitDefaultBranch.test.d.ts +0 -1
- package/lib/__tests__/getInitDefaultBranch.test.js +0 -26
- package/lib/__tests__/getPackagesByFiles.test.d.ts +0 -1
- package/lib/__tests__/getPackagesByFiles.test.js +0 -54
- package/lib/__tests__/getScopedPackages.test.d.ts +0 -1
- package/lib/__tests__/getScopedPackages.test.js +0 -74
- package/lib/__tests__/getWorkspaceRoot.test.d.ts +0 -1
- package/lib/__tests__/getWorkspaceRoot.test.js +0 -40
- package/lib/__tests__/getWorkspaces.test.d.ts +0 -1
- package/lib/__tests__/getWorkspaces.test.js +0 -122
- package/lib/__tests__/graph.test.d.ts +0 -1
- package/lib/__tests__/graph.test.js +0 -117
- package/lib/__tests__/lockfile.test.d.ts +0 -1
- package/lib/__tests__/lockfile.test.js +0 -42
- package/lib/__tests__/queryLockFile.test.d.ts +0 -1
- package/lib/__tests__/queryLockFile.test.js +0 -43
- package/lib/graph.d.ts +0 -8
- package/lib/graph.js +0 -61
package/docs/modules.html
DELETED
|
@@ -1,70 +0,0 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>workspace-tools</title><meta name="description" content="Documentation for workspace-tools"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script async src="assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">workspace-tools</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><h1>workspace-tools </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Interfaces</h3><ul class="tsd-index-list"><li class="tsd-kind-interface"><a href="interfaces/NpmLockFile.html" class="tsd-kind-icon">Npm<wbr/>Lock<wbr/>File</a></li><li class="tsd-kind-interface"><a href="interfaces/NpmSymlinkInfo.html" class="tsd-kind-icon">Npm<wbr/>Symlink<wbr/>Info</a></li><li class="tsd-kind-interface"><a href="interfaces/NpmWorkspacesInfo.html" class="tsd-kind-icon">Npm<wbr/>Workspaces<wbr/>Info</a></li><li class="tsd-kind-interface"><a href="interfaces/PackageInfo.html" class="tsd-kind-icon">Package<wbr/>Info</a></li><li class="tsd-kind-interface"><a href="interfaces/PackageInfos.html" class="tsd-kind-icon">Package<wbr/>Infos</a></li><li class="tsd-kind-interface"><a href="interfaces/PnpmLockFile.html" class="tsd-kind-icon">Pnpm<wbr/>Lock<wbr/>File</a></li></ul></section><section class="tsd-index-section "><h3>Type aliases</h3><ul class="tsd-index-list"><li class="tsd-kind-type-alias"><a href="modules.html#Dependencies" class="tsd-kind-icon">Dependencies</a></li><li class="tsd-kind-type-alias"><a href="modules.html#LockDependency" class="tsd-kind-icon">Lock<wbr/>Dependency</a></li><li class="tsd-kind-type-alias"><a href="modules.html#ParsedLock" class="tsd-kind-icon">Parsed<wbr/>Lock</a></li><li class="tsd-kind-type-alias"><a href="modules.html#WorkspaceInfo" class="tsd-kind-icon">Workspace<wbr/>Info</a></li></ul></section><section class="tsd-index-section "><h3>Functions</h3><ul class="tsd-index-list"><li class="tsd-kind-function"><a href="modules.html#_resetCache" class="tsd-kind-icon">_reset<wbr/>Cache</a></li><li class="tsd-kind-function"><a href="modules.html#_resetGraphCache" class="tsd-kind-icon">_reset<wbr/>Graph<wbr/>Cache</a></li><li class="tsd-kind-function"><a href="modules.html#addGitObserver" class="tsd-kind-icon">add<wbr/>Git<wbr/>Observer</a></li><li class="tsd-kind-function"><a href="modules.html#commit" class="tsd-kind-icon">commit</a></li><li class="tsd-kind-function"><a href="modules.html#fetchRemote" class="tsd-kind-icon">fetch<wbr/>Remote</a></li><li class="tsd-kind-function"><a href="modules.html#fetchRemoteBranch" class="tsd-kind-icon">fetch<wbr/>Remote<wbr/>Branch</a></li><li class="tsd-kind-function"><a href="modules.html#findGitRoot" class="tsd-kind-icon">find<wbr/>Git<wbr/>Root</a></li><li class="tsd-kind-function"><a href="modules.html#findPackageRoot" class="tsd-kind-icon">find<wbr/>Package<wbr/>Root</a></li><li class="tsd-kind-function"><a href="modules.html#findWorkspacePath" class="tsd-kind-icon">find<wbr/>Workspace<wbr/>Path</a></li><li class="tsd-kind-function"><a href="modules.html#getAllPackageJsonFiles" class="tsd-kind-icon">get<wbr/>All<wbr/>Package<wbr/>Json<wbr/>Files</a></li><li class="tsd-kind-function"><a href="modules.html#getBranchChanges" class="tsd-kind-icon">get<wbr/>Branch<wbr/>Changes</a></li><li class="tsd-kind-function"><a href="modules.html#getBranchName" class="tsd-kind-icon">get<wbr/>Branch<wbr/>Name</a></li><li class="tsd-kind-function"><a href="modules.html#getChangePath" class="tsd-kind-icon">get<wbr/>Change<wbr/>Path</a></li><li class="tsd-kind-function"><a href="modules.html#getChangedPackages" class="tsd-kind-icon">get<wbr/>Changed<wbr/>Packages</a></li><li class="tsd-kind-function"><a href="modules.html#getChangedPackagesBetweenRefs" class="tsd-kind-icon">get<wbr/>Changed<wbr/>Packages<wbr/>Between<wbr/>Refs</a></li><li class="tsd-kind-function"><a href="modules.html#getChanges" class="tsd-kind-icon">get<wbr/>Changes</a></li><li class="tsd-kind-function"><a href="modules.html#getChangesBetweenRefs" class="tsd-kind-icon">get<wbr/>Changes<wbr/>Between<wbr/>Refs</a></li><li class="tsd-kind-function"><a href="modules.html#getCurrentHash" class="tsd-kind-icon">get<wbr/>Current<wbr/>Hash</a></li><li class="tsd-kind-function"><a href="modules.html#getDefaultBranch" class="tsd-kind-icon">get<wbr/>Default<wbr/>Branch</a></li><li class="tsd-kind-function"><a href="modules.html#getDefaultRemote" class="tsd-kind-icon">get<wbr/>Default<wbr/>Remote</a></li><li class="tsd-kind-function"><a href="modules.html#getDefaultRemoteBranch" class="tsd-kind-icon">get<wbr/>Default<wbr/>Remote<wbr/>Branch</a></li><li class="tsd-kind-function"><a href="modules.html#getDependentMap" class="tsd-kind-icon">get<wbr/>Dependent<wbr/>Map</a></li><li class="tsd-kind-function"><a href="modules.html#getFileAddedHash" class="tsd-kind-icon">get<wbr/>File<wbr/>Added<wbr/>Hash</a></li><li class="tsd-kind-function"><a href="modules.html#getFullBranchRef" class="tsd-kind-icon">get<wbr/>Full<wbr/>Branch<wbr/>Ref</a></li><li class="tsd-kind-function"><a href="modules.html#getInternalDeps" class="tsd-kind-icon">get<wbr/>Internal<wbr/>Deps</a></li><li class="tsd-kind-function"><a href="modules.html#getPackageGraph" class="tsd-kind-icon">get<wbr/>Package<wbr/>Graph</a></li><li class="tsd-kind-function"><a href="modules.html#getPackageInfos" class="tsd-kind-icon">get<wbr/>Package<wbr/>Infos</a></li><li class="tsd-kind-function"><a href="modules.html#getPackagesByFiles" class="tsd-kind-icon">get<wbr/>Packages<wbr/>By<wbr/>Files</a></li><li class="tsd-kind-function"><a href="modules.html#getParentBranch" class="tsd-kind-icon">get<wbr/>Parent<wbr/>Branch</a></li><li class="tsd-kind-function"><a href="modules.html#getPnpmWorkspaceRoot" class="tsd-kind-icon">get<wbr/>Pnpm<wbr/>Workspace<wbr/>Root</a></li><li class="tsd-kind-function"><a href="modules.html#getPnpmWorkspaces" class="tsd-kind-icon">get<wbr/>Pnpm<wbr/>Workspaces</a></li><li class="tsd-kind-function"><a href="modules.html#getRecentCommitMessages" class="tsd-kind-icon">get<wbr/>Recent<wbr/>Commit<wbr/>Messages</a></li><li class="tsd-kind-function"><a href="modules.html#getRemoteBranch" class="tsd-kind-icon">get<wbr/>Remote<wbr/>Branch</a></li><li class="tsd-kind-function"><a href="modules.html#getRushWorkspaceRoot" class="tsd-kind-icon">get<wbr/>Rush<wbr/>Workspace<wbr/>Root</a></li><li class="tsd-kind-function"><a href="modules.html#getRushWorkspaces" class="tsd-kind-icon">get<wbr/>Rush<wbr/>Workspaces</a></li><li class="tsd-kind-function"><a href="modules.html#getScopedPackages" class="tsd-kind-icon">get<wbr/>Scoped<wbr/>Packages</a></li><li class="tsd-kind-function"><a href="modules.html#getShortBranchName" class="tsd-kind-icon">get<wbr/>Short<wbr/>Branch<wbr/>Name</a></li><li class="tsd-kind-function"><a href="modules.html#getStagedChanges" class="tsd-kind-icon">get<wbr/>Staged<wbr/>Changes</a></li><li class="tsd-kind-function"><a href="modules.html#getTransitiveConsumers" class="tsd-kind-icon">get<wbr/>Transitive<wbr/>Consumers</a></li><li class="tsd-kind-function"><a href="modules.html#getTransitiveDependencies" class="tsd-kind-icon">get<wbr/>Transitive<wbr/>Dependencies</a></li><li class="tsd-kind-function"><a href="modules.html#getTransitiveDependents" class="tsd-kind-icon">get<wbr/>Transitive<wbr/>Dependents</a></li><li class="tsd-kind-function"><a href="modules.html#getTransitiveProviders" class="tsd-kind-icon">get<wbr/>Transitive<wbr/>Providers</a></li><li class="tsd-kind-function"><a href="modules.html#getUnstagedChanges" class="tsd-kind-icon">get<wbr/>Unstaged<wbr/>Changes</a></li><li class="tsd-kind-function"><a href="modules.html#getUntrackedChanges" class="tsd-kind-icon">get<wbr/>Untracked<wbr/>Changes</a></li><li class="tsd-kind-function"><a href="modules.html#getUserEmail" class="tsd-kind-icon">get<wbr/>User<wbr/>Email</a></li><li class="tsd-kind-function"><a href="modules.html#getWorkspaceRoot" class="tsd-kind-icon">get<wbr/>Workspace<wbr/>Root</a></li><li class="tsd-kind-function"><a href="modules.html#getWorkspaces" class="tsd-kind-icon">get<wbr/>Workspaces</a></li><li class="tsd-kind-function"><a href="modules.html#getYarnWorkspaceRoot" class="tsd-kind-icon">get<wbr/>Yarn<wbr/>Workspace<wbr/>Root</a></li><li class="tsd-kind-function"><a href="modules.html#getYarnWorkspaces" class="tsd-kind-icon">get<wbr/>Yarn<wbr/>Workspaces</a></li><li class="tsd-kind-function"><a href="modules.html#git" class="tsd-kind-icon">git</a></li><li class="tsd-kind-function"><a href="modules.html#gitFailFast" class="tsd-kind-icon">git<wbr/>Fail<wbr/>Fast</a></li><li class="tsd-kind-function"><a href="modules.html#init" class="tsd-kind-icon">init</a></li><li class="tsd-kind-function"><a href="modules.html#isChildOf" class="tsd-kind-icon">is<wbr/>Child<wbr/>Of</a></li><li class="tsd-kind-function"><a href="modules.html#listAllTrackedFiles" class="tsd-kind-icon">list<wbr/>All<wbr/>Tracked<wbr/>Files</a></li><li class="tsd-kind-function"><a href="modules.html#listOfWorkspacePackageNames" class="tsd-kind-icon">list<wbr/>Of<wbr/>Workspace<wbr/>Package<wbr/>Names</a></li><li class="tsd-kind-function"><a href="modules.html#nameAtVersion" class="tsd-kind-icon">name<wbr/>At<wbr/>Version</a></li><li class="tsd-kind-function"><a href="modules.html#parseLockFile" class="tsd-kind-icon">parse<wbr/>Lock<wbr/>File</a></li><li class="tsd-kind-function"><a href="modules.html#parseRemoteBranch" class="tsd-kind-icon">parse<wbr/>Remote<wbr/>Branch</a></li><li class="tsd-kind-function"><a href="modules.html#queryLockFile" class="tsd-kind-icon">query<wbr/>Lock<wbr/>File</a></li><li class="tsd-kind-function"><a href="modules.html#revertLocalChanges" class="tsd-kind-icon">revert<wbr/>Local<wbr/>Changes</a></li><li class="tsd-kind-function"><a href="modules.html#searchUp" class="tsd-kind-icon">search<wbr/>Up</a></li><li class="tsd-kind-function"><a href="modules.html#stage" class="tsd-kind-icon">stage</a></li><li class="tsd-kind-function"><a href="modules.html#stageAndCommit" class="tsd-kind-icon">stage<wbr/>And<wbr/>Commit</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Type aliases</h2><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="Dependencies" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Dependencies<a href="#Dependencies" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Dependencies<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-signature-symbol">[ </span><span class="tsd-signature-type">key</span><span class="tsd-signature-symbol"> in </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/workspace-tools/blob/d895921/src/lockfile/types.ts#L1">lockfile/types.ts:1</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="LockDependency" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Lock<wbr/>Dependency<a href="#LockDependency" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Lock<wbr/>Dependency<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>dependencies<span class="tsd-signature-symbol">?: </span><a href="modules.html#Dependencies" class="tsd-signature-type" data-tsd-kind="Type alias">Dependencies</a><span class="tsd-signature-symbol">; </span>version<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/workspace-tools/blob/d895921/src/lockfile/types.ts#L3">lockfile/types.ts:3</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> dependencies<span class="tsd-signature-symbol">?: </span><a href="modules.html#Dependencies" class="tsd-signature-type" data-tsd-kind="Type alias">Dependencies</a></h5></li><li class="tsd-parameter"><h5>version<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="ParsedLock" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Parsed<wbr/>Lock<a href="#ParsedLock" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Parsed<wbr/>Lock<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>object<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{</span> <span class="tsd-signature-symbol">[ </span><span class="tsd-signature-type">key</span><span class="tsd-signature-symbol"> in </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">: </span><a href="modules.html#LockDependency" class="tsd-signature-type" data-tsd-kind="Type alias">LockDependency</a> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"success"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"merge"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"conflict"</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/workspace-tools/blob/d895921/src/lockfile/types.ts#L8">lockfile/types.ts:8</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>object<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{</span> <span class="tsd-signature-symbol">[ </span><span class="tsd-signature-type">key</span><span class="tsd-signature-symbol"> in </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">: </span><a href="modules.html#LockDependency" class="tsd-signature-type" data-tsd-kind="Type alias">LockDependency</a> <span class="tsd-signature-symbol">}</span></h5></li><li class="tsd-parameter"><h5>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"success"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"merge"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"conflict"</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="WorkspaceInfo" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Workspace<wbr/>Info<a href="#WorkspaceInfo" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Workspace<wbr/>Info<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>packageJson<span class="tsd-signature-symbol">: </span><a href="interfaces/PackageInfo.html" class="tsd-signature-type" data-tsd-kind="Interface">PackageInfo</a><span class="tsd-signature-symbol">; </span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/workspace-tools/blob/d895921/src/types/WorkspaceInfo.ts#L3">types/WorkspaceInfo.ts:3</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group "><h2>Functions</h2><section class="tsd-panel tsd-member tsd-kind-function"><a id="_resetCache" class="tsd-anchor"></a><h3 class="tsd-anchor-link">_reset<wbr/>Cache<a href="#_resetCache" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">_reset<wbr/>Cache<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/workspace-tools/blob/d895921/src/workspaces/workspaces.ts#L24">workspaces/workspaces.ts:24</a></li></ul></aside><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="_resetGraphCache" class="tsd-anchor"></a><h3 class="tsd-anchor-link">_reset<wbr/>Graph<wbr/>Cache<a href="#_resetGraphCache" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">_reset<wbr/>Graph<wbr/>Cache<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/workspace-tools/blob/d895921/src/graph.ts#L28">graph.ts:28</a></li></ul></aside><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>internal</dt><dd><p>resets the graph cache for internal testing purpose only</p>
|
|
2
|
-
</dd></dl></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="addGitObserver" class="tsd-anchor"></a><h3 class="tsd-anchor-link">add<wbr/>Git<wbr/>Observer<a href="#addGitObserver" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">add<wbr/>Git<wbr/>Observer<span class="tsd-signature-symbol">(</span>observer<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">GitObserver</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/workspace-tools/blob/d895921/src/git.ts#L36">git.ts:36</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
3
|
-
<p>Adds an observer for the git operations, e.g. for testing</p>
|
|
4
|
-
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>observer: <span class="tsd-signature-type">GitObserver</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
5
|
-
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="commit" class="tsd-anchor"></a><h3 class="tsd-anchor-link">commit<a href="#commit" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">commit<span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, cwd<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/workspace-tools/blob/d895921/src/git.ts#L307">git.ts:307</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>message: <span class="tsd-signature-type">string</span></h5></li><li><h5>cwd: <span class="tsd-signature-type">string</span></h5></li><li><h5>options: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="fetchRemote" class="tsd-anchor"></a><h3 class="tsd-anchor-link">fetch<wbr/>Remote<a href="#fetchRemote" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">fetch<wbr/>Remote<span class="tsd-signature-symbol">(</span>remote<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, cwd<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/workspace-tools/blob/d895921/src/git.ts#L120">git.ts:120</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>remote: <span class="tsd-signature-type">string</span></h5></li><li><h5>cwd: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="fetchRemoteBranch" class="tsd-anchor"></a><h3 class="tsd-anchor-link">fetch<wbr/>Remote<wbr/>Branch<a href="#fetchRemoteBranch" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">fetch<wbr/>Remote<wbr/>Branch<span class="tsd-signature-symbol">(</span>remote<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, remoteBranch<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, cwd<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/workspace-tools/blob/d895921/src/git.ts#L128">git.ts:128</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>remote: <span class="tsd-signature-type">string</span></h5></li><li><h5>remoteBranch: <span class="tsd-signature-type">string</span></h5></li><li><h5>cwd: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="findGitRoot" class="tsd-anchor"></a><h3 class="tsd-anchor-link">find<wbr/>Git<wbr/>Root<a href="#findGitRoot" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">find<wbr/>Git<wbr/>Root<span class="tsd-signature-symbol">(</span>cwd<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/workspace-tools/blob/d895921/src/paths.ts#L30">paths.ts:30</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>cwd: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="findPackageRoot" class="tsd-anchor"></a><h3 class="tsd-anchor-link">find<wbr/>Package<wbr/>Root<a href="#findPackageRoot" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">find<wbr/>Package<wbr/>Root<span class="tsd-signature-symbol">(</span>cwd<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/workspace-tools/blob/d895921/src/paths.ts#L34">paths.ts:34</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>cwd: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="findWorkspacePath" class="tsd-anchor"></a><h3 class="tsd-anchor-link">find<wbr/>Workspace<wbr/>Path<a href="#findWorkspacePath" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">find<wbr/>Workspace<wbr/>Path<span class="tsd-signature-symbol">(</span>workspaces<span class="tsd-signature-symbol">: </span><a href="modules.html#WorkspaceInfo" class="tsd-signature-type" data-tsd-kind="Type alias">WorkspaceInfo</a>, packageName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/workspace-tools/blob/d895921/src/workspaces/findWorkspacePath.ts#L3">workspaces/findWorkspacePath.ts:3</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>workspaces: <a href="modules.html#WorkspaceInfo" class="tsd-signature-type" data-tsd-kind="Type alias">WorkspaceInfo</a></h5></li><li><h5>packageName: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="getAllPackageJsonFiles" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>All<wbr/>Package<wbr/>Json<wbr/>Files<a href="#getAllPackageJsonFiles" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">get<wbr/>All<wbr/>Package<wbr/>Json<wbr/>Files<span class="tsd-signature-symbol">(</span>cwd<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/workspace-tools/blob/d895921/src/workspaces/workspaces.ts#L9">workspaces/workspaces.ts:9</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
6
|
-
<p>Get paths to every package.json in the workspace, given a cwd</p>
|
|
7
|
-
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>cwd: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
8
|
-
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="getBranchChanges" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Branch<wbr/>Changes<a href="#getBranchChanges" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">get<wbr/>Branch<wbr/>Changes<span class="tsd-signature-symbol">(</span>branch<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, cwd<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/workspace-tools/blob/d895921/src/git.ts#L161">git.ts:161</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
9
|
-
<p>Gets all the changes between the branch and the merge-base</p>
|
|
10
|
-
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>branch: <span class="tsd-signature-type">string</span></h5></li><li><h5>cwd: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
11
|
-
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="getBranchName" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Branch<wbr/>Name<a href="#getBranchName" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">get<wbr/>Branch<wbr/>Name<span class="tsd-signature-symbol">(</span>cwd<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/workspace-tools/blob/d895921/src/git.ts#L216">git.ts:216</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>cwd: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="getChangePath" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Change<wbr/>Path<a href="#getChangePath" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">get<wbr/>Change<wbr/>Path<span class="tsd-signature-symbol">(</span>cwd<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/workspace-tools/blob/d895921/src/paths.ts#L38">paths.ts:38</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>cwd: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="getChangedPackages" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Changed<wbr/>Packages<a href="#getChangedPackages" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">get<wbr/>Changed<wbr/>Packages<span class="tsd-signature-symbol">(</span>cwd<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, target<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span>, ignoreGlobs<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/workspace-tools/blob/d895921/src/workspaces/getChangedPackages.ts#L63">workspaces/getChangedPackages.ts:63</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
12
|
-
<p>Finds all packages that had been changed in the repo under cwd</p>
|
|
13
|
-
</div><div><p>executes a "git diff $Target..." to get changes given a merge-base</p>
|
|
14
|
-
<p>further explanation with the three dots:</p>
|
|
15
|
-
<blockquote>
|
|
16
|
-
<p>git diff [--options] <commit>...<commit> [--] [<path>...]</p>
|
|
17
|
-
<p> This form is to view the changes on the branch containing and up to
|
|
18
|
-
the second <commit>, starting at a common ancestor of both
|
|
19
|
-
<commit>. "git diff A...B" is equivalent to "git diff
|
|
20
|
-
$(git-merge-base A B) B". You can omit any one of <commit>, which
|
|
21
|
-
has the same effect as using HEAD instead.</p>
|
|
22
|
-
</blockquote>
|
|
23
|
-
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>cwd: <span class="tsd-signature-type">string</span></h5></li><li><h5>target: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5></li><li><h5>ignoreGlobs: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><div><p>string[] of package names that have changed</p>
|
|
24
|
-
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="getChangedPackagesBetweenRefs" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Changed<wbr/>Packages<wbr/>Between<wbr/>Refs<a href="#getChangedPackagesBetweenRefs" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">get<wbr/>Changed<wbr/>Packages<wbr/>Between<wbr/>Refs<span class="tsd-signature-symbol">(</span>cwd<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, fromRef<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, toRef<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, ignoreGlobs<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/workspace-tools/blob/d895921/src/workspaces/getChangedPackages.ts#L28">workspaces/getChangedPackages.ts:28</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
25
|
-
<p>Finds all packages that had been changed between two refs in the repo under cwd</p>
|
|
26
|
-
</div><div><p>executes a "git diff $fromRef...$toRef" to get changes given a merge-base</p>
|
|
27
|
-
<p>further explanation with the three dots:</p>
|
|
28
|
-
<blockquote>
|
|
29
|
-
<p>git diff [--options] <commit>...<commit> [--] [<path>...]</p>
|
|
30
|
-
<p> This form is to view the changes on the branch containing and up to
|
|
31
|
-
the second <commit>, starting at a common ancestor of both
|
|
32
|
-
<commit>. "git diff A...B" is equivalent to "git diff
|
|
33
|
-
$(git-merge-base A B) B". You can omit any one of <commit>, which
|
|
34
|
-
has the same effect as using HEAD instead.</p>
|
|
35
|
-
</blockquote>
|
|
36
|
-
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>cwd: <span class="tsd-signature-type">string</span></h5></li><li><h5>fromRef: <span class="tsd-signature-type">string</span></h5></li><li><h5>toRef: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ""</span></h5></li><li><h5>ignoreGlobs: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><div><p>string[] of package names that have changed</p>
|
|
37
|
-
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="getChanges" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Changes<a href="#getChanges" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">get<wbr/>Changes<span class="tsd-signature-symbol">(</span>branch<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, cwd<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/workspace-tools/blob/d895921/src/git.ts#L148">git.ts:148</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>branch: <span class="tsd-signature-type">string</span></h5></li><li><h5>cwd: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="getChangesBetweenRefs" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Changes<wbr/>Between<wbr/>Refs<a href="#getChangesBetweenRefs" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">get<wbr/>Changes<wbr/>Between<wbr/>Refs<span class="tsd-signature-symbol">(</span>fromRef<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, toRef<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, pattern<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, cwd<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/workspace-tools/blob/d895921/src/git.ts#L165">git.ts:165</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>fromRef: <span class="tsd-signature-type">string</span></h5></li><li><h5>toRef: <span class="tsd-signature-type">string</span></h5></li><li><h5>options: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5></li><li><h5>pattern: <span class="tsd-signature-type">string</span></h5></li><li><h5>cwd: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="getCurrentHash" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Current<wbr/>Hash<a href="#getCurrentHash" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">get<wbr/>Current<wbr/>Hash<span class="tsd-signature-symbol">(</span>cwd<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/workspace-tools/blob/d895921/src/git.ts#L250">git.ts:250</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>cwd: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="getDefaultBranch" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Default<wbr/>Branch<a href="#getDefaultBranch" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">get<wbr/>Default<wbr/>Branch<span class="tsd-signature-symbol">(</span>cwd<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/workspace-tools/blob/d895921/src/git.ts#L434">git.ts:434</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>cwd: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="getDefaultRemote" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Default<wbr/>Remote<a href="#getDefaultRemote" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">get<wbr/>Default<wbr/>Remote<span class="tsd-signature-symbol">(</span>cwd<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/workspace-tools/blob/d895921/src/git.ts#L445">git.ts:445</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>cwd: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="getDefaultRemoteBranch" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Default<wbr/>Remote<wbr/>Branch<a href="#getDefaultRemoteBranch" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">get<wbr/>Default<wbr/>Remote<wbr/>Branch<span class="tsd-signature-symbol">(</span>branch<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span>, cwd<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/workspace-tools/blob/d895921/src/git.ts#L408">git.ts:408</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>branch: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5></li><li><h5>cwd: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="getDependentMap" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Dependent<wbr/>Map<a href="#getDependentMap" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">get<wbr/>Dependent<wbr/>Map<span class="tsd-signature-symbol">(</span>packages<span class="tsd-signature-symbol">: </span><a href="interfaces/PackageInfos.html" class="tsd-signature-type" data-tsd-kind="Interface">PackageInfos</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Set</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/workspace-tools/blob/d895921/src/dependencies.ts#L48">dependencies.ts:48</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>packages: <a href="interfaces/PackageInfos.html" class="tsd-signature-type" data-tsd-kind="Interface">PackageInfos</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Set</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="getFileAddedHash" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>File<wbr/>Added<wbr/>Hash<a href="#getFileAddedHash" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">get<wbr/>File<wbr/>Added<wbr/>Hash<span class="tsd-signature-symbol">(</span>filename<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, cwd<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/workspace-tools/blob/d895921/src/git.ts#L267">git.ts:267</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
38
|
-
<p>Get the commit hash in which the file was first added.</p>
|
|
39
|
-
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>filename: <span class="tsd-signature-type">string</span></h5></li><li><h5>cwd: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="getFullBranchRef" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Full<wbr/>Branch<wbr/>Ref<a href="#getFullBranchRef" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">get<wbr/>Full<wbr/>Branch<wbr/>Ref<span class="tsd-signature-symbol">(</span>branch<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, cwd<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/workspace-tools/blob/d895921/src/git.ts#L230">git.ts:230</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>branch: <span class="tsd-signature-type">string</span></h5></li><li><h5>cwd: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="getInternalDeps" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Internal<wbr/>Deps<a href="#getInternalDeps" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">get<wbr/>Internal<wbr/>Deps<span class="tsd-signature-symbol">(</span>info<span class="tsd-signature-symbol">: </span><a href="interfaces/PackageInfo.html" class="tsd-signature-type" data-tsd-kind="Interface">PackageInfo</a>, packages<span class="tsd-signature-symbol">: </span><a href="interfaces/PackageInfos.html" class="tsd-signature-type" data-tsd-kind="Interface">PackageInfos</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/workspace-tools/blob/d895921/src/dependencies.ts#L132">dependencies.ts:132</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>info: <a href="interfaces/PackageInfo.html" class="tsd-signature-type" data-tsd-kind="Interface">PackageInfo</a></h5></li><li><h5>packages: <a href="interfaces/PackageInfos.html" class="tsd-signature-type" data-tsd-kind="Interface">PackageInfos</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="getPackageGraph" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Package<wbr/>Graph<a href="#getPackageGraph" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">get<wbr/>Package<wbr/>Graph<span class="tsd-signature-symbol">(</span>packages<span class="tsd-signature-symbol">: </span><a href="interfaces/PackageInfos.html" class="tsd-signature-type" data-tsd-kind="Interface">PackageInfos</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[]</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/workspace-tools/blob/d895921/src/graph.ts#L6">graph.ts:6</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>packages: <a href="interfaces/PackageInfos.html" class="tsd-signature-type" data-tsd-kind="Interface">PackageInfos</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[]</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="getPackageInfos" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Package<wbr/>Infos<a href="#getPackageInfos" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">get<wbr/>Package<wbr/>Infos<span class="tsd-signature-symbol">(</span>cwd<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="interfaces/PackageInfos.html" class="tsd-signature-type" data-tsd-kind="Interface">PackageInfos</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/workspace-tools/blob/d895921/src/getPackageInfos.ts#L6">getPackageInfos.ts:6</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>cwd: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="interfaces/PackageInfos.html" class="tsd-signature-type" data-tsd-kind="Interface">PackageInfos</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="getPackagesByFiles" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Packages<wbr/>By<wbr/>Files<a href="#getPackagesByFiles" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">get<wbr/>Packages<wbr/>By<wbr/>Files<span class="tsd-signature-symbol">(</span>workspaceRoot<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, files<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, ignoreGlobs<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, returnAllPackagesOnNoMatch<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/workspace-tools/blob/d895921/src/workspaces/getPackagesByFiles.ts#L14">workspaces/getPackagesByFiles.ts:14</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
40
|
-
<p>Given a list of files, finds all packages names that contain those files</p>
|
|
41
|
-
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>workspaceRoot: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
42
|
-
<p>The root of the workspace</p>
|
|
43
|
-
</div></div></li><li><h5>files: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
44
|
-
<p>files to search for</p>
|
|
45
|
-
</div></div></li><li><h5>ignoreGlobs: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
46
|
-
<p>glob patterns to ignore</p>
|
|
47
|
-
</div></div></li><li><h5>returnAllPackagesOnNoMatch: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
48
|
-
<p>if true, will return all packages if no matches are found</p>
|
|
49
|
-
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><div><p>package names that have changed</p>
|
|
50
|
-
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="getParentBranch" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Parent<wbr/>Branch<a href="#getParentBranch" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">get<wbr/>Parent<wbr/>Branch<span class="tsd-signature-symbol">(</span>cwd<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/workspace-tools/blob/d895921/src/git.ts#L344">git.ts:344</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>cwd: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="getPnpmWorkspaceRoot" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Pnpm<wbr/>Workspace<wbr/>Root<a href="#getPnpmWorkspaceRoot" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">get<wbr/>Pnpm<wbr/>Workspace<wbr/>Root<span class="tsd-signature-symbol">(</span>cwd<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/workspace-tools/blob/d895921/src/workspaces/implementations/pnpm.ts#L13">workspaces/implementations/pnpm.ts:13</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>cwd: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="getPnpmWorkspaces" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Pnpm<wbr/>Workspaces<a href="#getPnpmWorkspaces" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">get<wbr/>Pnpm<wbr/>Workspaces<span class="tsd-signature-symbol">(</span>cwd<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="modules.html#WorkspaceInfo" class="tsd-signature-type" data-tsd-kind="Type alias">WorkspaceInfo</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/workspace-tools/blob/d895921/src/workspaces/implementations/pnpm.ts#L23">workspaces/implementations/pnpm.ts:23</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>cwd: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="modules.html#WorkspaceInfo" class="tsd-signature-type" data-tsd-kind="Type alias">WorkspaceInfo</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="getRecentCommitMessages" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Recent<wbr/>Commit<wbr/>Messages<a href="#getRecentCommitMessages" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">get<wbr/>Recent<wbr/>Commit<wbr/>Messages<span class="tsd-signature-symbol">(</span>branch<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, cwd<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/workspace-tools/blob/d895921/src/git.ts#L185">git.ts:185</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>branch: <span class="tsd-signature-type">string</span></h5></li><li><h5>cwd: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="getRemoteBranch" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Remote<wbr/>Branch<a href="#getRemoteBranch" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">get<wbr/>Remote<wbr/>Branch<span class="tsd-signature-symbol">(</span>branch<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, cwd<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/workspace-tools/blob/d895921/src/git.ts#L375">git.ts:375</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>branch: <span class="tsd-signature-type">string</span></h5></li><li><h5>cwd: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="getRushWorkspaceRoot" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Rush<wbr/>Workspace<wbr/>Root<a href="#getRushWorkspaceRoot" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">get<wbr/>Rush<wbr/>Workspace<wbr/>Root<span class="tsd-signature-symbol">(</span>cwd<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/workspace-tools/blob/d895921/src/workspaces/implementations/rush.ts#L9">workspaces/implementations/rush.ts:9</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>cwd: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="getRushWorkspaces" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Rush<wbr/>Workspaces<a href="#getRushWorkspaces" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">get<wbr/>Rush<wbr/>Workspaces<span class="tsd-signature-symbol">(</span>cwd<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="modules.html#WorkspaceInfo" class="tsd-signature-type" data-tsd-kind="Type alias">WorkspaceInfo</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/workspace-tools/blob/d895921/src/workspaces/implementations/rush.ts#L19">workspaces/implementations/rush.ts:19</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>cwd: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="modules.html#WorkspaceInfo" class="tsd-signature-type" data-tsd-kind="Type alias">WorkspaceInfo</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="getScopedPackages" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Scoped<wbr/>Packages<a href="#getScopedPackages" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">get<wbr/>Scoped<wbr/>Packages<span class="tsd-signature-symbol">(</span>search<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, packages<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/workspace-tools/blob/d895921/src/scope.ts#L9">scope.ts:9</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
51
|
-
<p>Searches all package names based on "scoping" (i.e. "scope" in the sense of inclusion)
|
|
52
|
-
NOTE: scoping is different than package scopes (@scope/package)</p>
|
|
53
|
-
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>search: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5></li><li><h5>packages: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{}</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
54
|
-
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="getShortBranchName" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Short<wbr/>Branch<wbr/>Name<a href="#getShortBranchName" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">get<wbr/>Short<wbr/>Branch<wbr/>Name<span class="tsd-signature-symbol">(</span>fullBranchRef<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, cwd<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/workspace-tools/blob/d895921/src/git.ts#L239">git.ts:239</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>fullBranchRef: <span class="tsd-signature-type">string</span></h5></li><li><h5>cwd: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="getStagedChanges" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Staged<wbr/>Changes<a href="#getStagedChanges" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">get<wbr/>Staged<wbr/>Changes<span class="tsd-signature-symbol">(</span>cwd<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/workspace-tools/blob/d895921/src/git.ts#L177">git.ts:177</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>cwd: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="getTransitiveConsumers" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Transitive<wbr/>Consumers<a href="#getTransitiveConsumers" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">get<wbr/>Transitive<wbr/>Consumers<span class="tsd-signature-symbol">(</span>targets<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, packages<span class="tsd-signature-symbol">: </span><a href="interfaces/PackageInfos.html" class="tsd-signature-type" data-tsd-kind="Interface">PackageInfos</a>, scope<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/workspace-tools/blob/d895921/src/dependencies.ts#L70">dependencies.ts:70</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
55
|
-
<p>for a package graph of a->b->c (where b depends on a), transitive consumers of a are b & c and their consumers (or what are the consequences of a)</p>
|
|
56
|
-
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>targets: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5></li><li><h5>packages: <a href="interfaces/PackageInfos.html" class="tsd-signature-type" data-tsd-kind="Interface">PackageInfos</a></h5></li><li><h5>scope: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
57
|
-
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="getTransitiveDependencies" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Transitive<wbr/>Dependencies<a href="#getTransitiveDependencies" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">get<wbr/>Transitive<wbr/>Dependencies<span class="tsd-signature-symbol">(</span>targets<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, packages<span class="tsd-signature-symbol">: </span><a href="interfaces/PackageInfos.html" class="tsd-signature-type" data-tsd-kind="Interface">PackageInfos</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/workspace-tools/blob/d895921/src/dependencies.ts#L127">dependencies.ts:127</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>targets: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5></li><li><h5>packages: <a href="interfaces/PackageInfos.html" class="tsd-signature-type" data-tsd-kind="Interface">PackageInfos</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="getTransitiveDependents" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Transitive<wbr/>Dependents<a href="#getTransitiveDependents" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">get<wbr/>Transitive<wbr/>Dependents<span class="tsd-signature-symbol">(</span>targets<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, packages<span class="tsd-signature-symbol">: </span><a href="interfaces/PackageInfos.html" class="tsd-signature-type" data-tsd-kind="Interface">PackageInfos</a>, scope<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/workspace-tools/blob/d895921/src/dependencies.ts#L130">dependencies.ts:130</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>targets: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5></li><li><h5>packages: <a href="interfaces/PackageInfos.html" class="tsd-signature-type" data-tsd-kind="Interface">PackageInfos</a></h5></li><li><h5>scope: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="getTransitiveProviders" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Transitive<wbr/>Providers<a href="#getTransitiveProviders" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">get<wbr/>Transitive<wbr/>Providers<span class="tsd-signature-symbol">(</span>targets<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, packages<span class="tsd-signature-symbol">: </span><a href="interfaces/PackageInfos.html" class="tsd-signature-type" data-tsd-kind="Interface">PackageInfos</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/workspace-tools/blob/d895921/src/dependencies.ts#L101">dependencies.ts:101</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
58
|
-
<p>for a package graph of a->b->c (where b depends on a), transitive providers of c are a & b and their providers (or what is needed to satisfy c)</p>
|
|
59
|
-
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>targets: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5></li><li><h5>packages: <a href="interfaces/PackageInfos.html" class="tsd-signature-type" data-tsd-kind="Interface">PackageInfos</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
60
|
-
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="getUnstagedChanges" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Unstaged<wbr/>Changes<a href="#getUnstagedChanges" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">get<wbr/>Unstaged<wbr/>Changes<span class="tsd-signature-symbol">(</span>cwd<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/workspace-tools/blob/d895921/src/git.ts#L140">git.ts:140</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
61
|
-
<p>Gets all the changes that have not been staged yet</p>
|
|
62
|
-
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>cwd: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
63
|
-
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="getUntrackedChanges" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Untracked<wbr/>Changes<a href="#getUntrackedChanges" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">get<wbr/>Untracked<wbr/>Changes<span class="tsd-signature-symbol">(</span>cwd<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/workspace-tools/blob/d895921/src/git.ts#L87">git.ts:87</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>cwd: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="getUserEmail" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>User<wbr/>Email<a href="#getUserEmail" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">get<wbr/>User<wbr/>Email<span class="tsd-signature-symbol">(</span>cwd<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/workspace-tools/blob/d895921/src/git.ts#L202">git.ts:202</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>cwd: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="getWorkspaceRoot" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Workspace<wbr/>Root<a href="#getWorkspaceRoot" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">get<wbr/>Workspace<wbr/>Root<span class="tsd-signature-symbol">(</span>cwd<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/workspace-tools/blob/d895921/src/workspaces/getWorkspaceRoot.ts#L7">workspaces/getWorkspaceRoot.ts:7</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>cwd: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="getWorkspaces" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Workspaces<a href="#getWorkspaces" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">get<wbr/>Workspaces<span class="tsd-signature-symbol">(</span>cwd<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="modules.html#WorkspaceInfo" class="tsd-signature-type" data-tsd-kind="Type alias">WorkspaceInfo</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/workspace-tools/blob/d895921/src/workspaces/getWorkspaces.ts#L8">workspaces/getWorkspaces.ts:8</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>cwd: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="modules.html#WorkspaceInfo" class="tsd-signature-type" data-tsd-kind="Type alias">WorkspaceInfo</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="getYarnWorkspaceRoot" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Yarn<wbr/>Workspace<wbr/>Root<a href="#getYarnWorkspaceRoot" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">get<wbr/>Yarn<wbr/>Workspace<wbr/>Root<span class="tsd-signature-symbol">(</span>cwd<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/workspace-tools/blob/d895921/src/workspaces/implementations/yarn.ts#L4">workspaces/implementations/yarn.ts:4</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>cwd: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="getYarnWorkspaces" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Yarn<wbr/>Workspaces<a href="#getYarnWorkspaces" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">get<wbr/>Yarn<wbr/>Workspaces<span class="tsd-signature-symbol">(</span>cwd<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="modules.html#WorkspaceInfo" class="tsd-signature-type" data-tsd-kind="Type alias">WorkspaceInfo</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/workspace-tools/blob/d895921/src/workspaces/implementations/yarn.ts#L14">workspaces/implementations/yarn.ts:14</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>cwd: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="modules.html#WorkspaceInfo" class="tsd-signature-type" data-tsd-kind="Type alias">WorkspaceInfo</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="git" class="tsd-anchor"></a><h3 class="tsd-anchor-link">git<a href="#git" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">git<span class="tsd-signature-symbol">(</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>cwd<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>maxBuffer<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ProcessOutput</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/workspace-tools/blob/d895921/src/git.ts#L43">git.ts:43</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
64
|
-
<p>Runs git command - use this for read only commands</p>
|
|
65
|
-
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>args: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-symbol">{ </span>cwd<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>maxBuffer<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></h5><ul class="tsd-parameters"><li class="tsd-parameter"><h5>cwd<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> max<wbr/>Buffer<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ProcessOutput</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="gitFailFast" class="tsd-anchor"></a><h3 class="tsd-anchor-link">git<wbr/>Fail<wbr/>Fast<a href="#gitFailFast" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">git<wbr/>Fail<wbr/>Fast<span class="tsd-signature-symbol">(</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>cwd<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>maxBuffer<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/workspace-tools/blob/d895921/src/git.ts#L76">git.ts:76</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
66
|
-
<p>Runs git command - use this for commands that makes changes to the file system</p>
|
|
67
|
-
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>args: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-symbol">{ </span>cwd<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>maxBuffer<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></h5><ul class="tsd-parameters"><li class="tsd-parameter"><h5>cwd<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> max<wbr/>Buffer<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="init" class="tsd-anchor"></a><h3 class="tsd-anchor-link">init<a href="#init" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">init<span class="tsd-signature-symbol">(</span>cwd<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, email<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, username<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/workspace-tools/blob/d895921/src/git.ts#L277">git.ts:277</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>cwd: <span class="tsd-signature-type">string</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> email: <span class="tsd-signature-type">string</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> username: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="isChildOf" class="tsd-anchor"></a><h3 class="tsd-anchor-link">is<wbr/>Child<wbr/>Of<a href="#isChildOf" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">is<wbr/>Child<wbr/>Of<span class="tsd-signature-symbol">(</span>child<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, parent<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/workspace-tools/blob/d895921/src/paths.ts#L48">paths.ts:48</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>child: <span class="tsd-signature-type">string</span></h5></li><li><h5>parent: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="listAllTrackedFiles" class="tsd-anchor"></a><h3 class="tsd-anchor-link">list<wbr/>All<wbr/>Tracked<wbr/>Files<a href="#listAllTrackedFiles" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">list<wbr/>All<wbr/>Tracked<wbr/>Files<span class="tsd-signature-symbol">(</span>patterns<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, cwd<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/workspace-tools/blob/d895921/src/git.ts#L486">git.ts:486</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>patterns: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5></li><li><h5>cwd: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="listOfWorkspacePackageNames" class="tsd-anchor"></a><h3 class="tsd-anchor-link">list<wbr/>Of<wbr/>Workspace<wbr/>Package<wbr/>Names<a href="#listOfWorkspacePackageNames" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">list<wbr/>Of<wbr/>Workspace<wbr/>Package<wbr/>Names<span class="tsd-signature-symbol">(</span>workspaces<span class="tsd-signature-symbol">: </span><a href="modules.html#WorkspaceInfo" class="tsd-signature-type" data-tsd-kind="Type alias">WorkspaceInfo</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/workspace-tools/blob/d895921/src/workspaces/listOfWorkspacePackageNames.ts#L3">workspaces/listOfWorkspacePackageNames.ts:3</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>workspaces: <a href="modules.html#WorkspaceInfo" class="tsd-signature-type" data-tsd-kind="Type alias">WorkspaceInfo</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="nameAtVersion" class="tsd-anchor"></a><h3 class="tsd-anchor-link">name<wbr/>At<wbr/>Version<a href="#nameAtVersion" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">name<wbr/>At<wbr/>Version<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, version<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/workspace-tools/blob/d895921/src/lockfile/nameAtVersion.ts#L1">lockfile/nameAtVersion.ts:1</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>name: <span class="tsd-signature-type">string</span></h5></li><li><h5>version: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="parseLockFile" class="tsd-anchor"></a><h3 class="tsd-anchor-link">parse<wbr/>Lock<wbr/>File<a href="#parseLockFile" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">parse<wbr/>Lock<wbr/>File<span class="tsd-signature-symbol">(</span>packageRoot<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="modules.html#ParsedLock" class="tsd-signature-type" data-tsd-kind="Type alias">ParsedLock</a><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/workspace-tools/blob/d895921/src/lockfile/index.ts#L11">lockfile/index.ts:11</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>packageRoot: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="modules.html#ParsedLock" class="tsd-signature-type" data-tsd-kind="Type alias">ParsedLock</a><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="parseRemoteBranch" class="tsd-anchor"></a><h3 class="tsd-anchor-link">parse<wbr/>Remote<wbr/>Branch<a href="#parseRemoteBranch" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">parse<wbr/>Remote<wbr/>Branch<span class="tsd-signature-symbol">(</span>branch<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>remote<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>remoteBranch<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/workspace-tools/blob/d895921/src/git.ts#L385">git.ts:385</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>branch: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>remote<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>remoteBranch<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>remote<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5>remote<wbr/>Branch<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="queryLockFile" class="tsd-anchor"></a><h3 class="tsd-anchor-link">query<wbr/>Lock<wbr/>File<a href="#queryLockFile" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">query<wbr/>Lock<wbr/>File<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, versionRange<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, lock<span class="tsd-signature-symbol">: </span><a href="modules.html#ParsedLock" class="tsd-signature-type" data-tsd-kind="Type alias">ParsedLock</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="modules.html#LockDependency" class="tsd-signature-type" data-tsd-kind="Type alias">LockDependency</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/workspace-tools/blob/d895921/src/lockfile/queryLockFile.ts#L4">lockfile/queryLockFile.ts:4</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>name: <span class="tsd-signature-type">string</span></h5></li><li><h5>versionRange: <span class="tsd-signature-type">string</span></h5></li><li><h5>lock: <a href="modules.html#ParsedLock" class="tsd-signature-type" data-tsd-kind="Type alias">ParsedLock</a></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="modules.html#LockDependency" class="tsd-signature-type" data-tsd-kind="Type alias">LockDependency</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="revertLocalChanges" class="tsd-anchor"></a><h3 class="tsd-anchor-link">revert<wbr/>Local<wbr/>Changes<a href="#revertLocalChanges" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">revert<wbr/>Local<wbr/>Changes<span class="tsd-signature-symbol">(</span>cwd<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/workspace-tools/blob/d895921/src/git.ts#L324">git.ts:324</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>cwd: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="searchUp" class="tsd-anchor"></a><h3 class="tsd-anchor-link">search<wbr/>Up<a href="#searchUp" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">search<wbr/>Up<span class="tsd-signature-symbol">(</span>pathName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, cwd<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/workspace-tools/blob/d895921/src/paths.ts#L9">paths.ts:9</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
68
|
-
<p>Starting from <code>cwd</code>, searches up the directory hierarchy for <code>pathName</code></p>
|
|
69
|
-
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>pathName: <span class="tsd-signature-type">string</span></h5></li><li><h5>cwd: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
70
|
-
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="stage" class="tsd-anchor"></a><h3 class="tsd-anchor-link">stage<a href="#stage" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">stage<span class="tsd-signature-symbol">(</span>patterns<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, cwd<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/workspace-tools/blob/d895921/src/git.ts#L297">git.ts:297</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>patterns: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5></li><li><h5>cwd: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="stageAndCommit" class="tsd-anchor"></a><h3 class="tsd-anchor-link">stage<wbr/>And<wbr/>Commit<a href="#stageAndCommit" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">stage<wbr/>And<wbr/>Commit<span class="tsd-signature-symbol">(</span>patterns<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, cwd<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, commitOptions<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/workspace-tools/blob/d895921/src/git.ts#L319">git.ts:319</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>patterns: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5></li><li><h5>message: <span class="tsd-signature-type">string</span></h5></li><li><h5>cwd: <span class="tsd-signature-type">string</span></h5></li><li><h5>commitOptions: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class="current"><a href="modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-interface"><a href="interfaces/NpmLockFile.html" class="tsd-kind-icon">Npm<wbr/>Lock<wbr/>File</a></li><li class="tsd-kind-interface"><a href="interfaces/NpmSymlinkInfo.html" class="tsd-kind-icon">Npm<wbr/>Symlink<wbr/>Info</a></li><li class="tsd-kind-interface"><a href="interfaces/NpmWorkspacesInfo.html" class="tsd-kind-icon">Npm<wbr/>Workspaces<wbr/>Info</a></li><li class="tsd-kind-interface"><a href="interfaces/PackageInfo.html" class="tsd-kind-icon">Package<wbr/>Info</a></li><li class="tsd-kind-interface"><a href="interfaces/PackageInfos.html" class="tsd-kind-icon">Package<wbr/>Infos</a></li><li class="tsd-kind-interface"><a href="interfaces/PnpmLockFile.html" class="tsd-kind-icon">Pnpm<wbr/>Lock<wbr/>File</a></li><li class="tsd-kind-type-alias"><a href="modules.html#Dependencies" class="tsd-kind-icon">Dependencies</a></li><li class="tsd-kind-type-alias"><a href="modules.html#LockDependency" class="tsd-kind-icon">Lock<wbr/>Dependency</a></li><li class="tsd-kind-type-alias"><a href="modules.html#ParsedLock" class="tsd-kind-icon">Parsed<wbr/>Lock</a></li><li class="tsd-kind-type-alias"><a href="modules.html#WorkspaceInfo" class="tsd-kind-icon">Workspace<wbr/>Info</a></li><li class="tsd-kind-function"><a href="modules.html#_resetCache" class="tsd-kind-icon">_reset<wbr/>Cache</a></li><li class="tsd-kind-function"><a href="modules.html#_resetGraphCache" class="tsd-kind-icon">_reset<wbr/>Graph<wbr/>Cache</a></li><li class="tsd-kind-function"><a href="modules.html#addGitObserver" class="tsd-kind-icon">add<wbr/>Git<wbr/>Observer</a></li><li class="tsd-kind-function"><a href="modules.html#commit" class="tsd-kind-icon">commit</a></li><li class="tsd-kind-function"><a href="modules.html#fetchRemote" class="tsd-kind-icon">fetch<wbr/>Remote</a></li><li class="tsd-kind-function"><a href="modules.html#fetchRemoteBranch" class="tsd-kind-icon">fetch<wbr/>Remote<wbr/>Branch</a></li><li class="tsd-kind-function"><a href="modules.html#findGitRoot" class="tsd-kind-icon">find<wbr/>Git<wbr/>Root</a></li><li class="tsd-kind-function"><a href="modules.html#findPackageRoot" class="tsd-kind-icon">find<wbr/>Package<wbr/>Root</a></li><li class="tsd-kind-function"><a href="modules.html#findWorkspacePath" class="tsd-kind-icon">find<wbr/>Workspace<wbr/>Path</a></li><li class="tsd-kind-function"><a href="modules.html#getAllPackageJsonFiles" class="tsd-kind-icon">get<wbr/>All<wbr/>Package<wbr/>Json<wbr/>Files</a></li><li class="tsd-kind-function"><a href="modules.html#getBranchChanges" class="tsd-kind-icon">get<wbr/>Branch<wbr/>Changes</a></li><li class="tsd-kind-function"><a href="modules.html#getBranchName" class="tsd-kind-icon">get<wbr/>Branch<wbr/>Name</a></li><li class="tsd-kind-function"><a href="modules.html#getChangePath" class="tsd-kind-icon">get<wbr/>Change<wbr/>Path</a></li><li class="tsd-kind-function"><a href="modules.html#getChangedPackages" class="tsd-kind-icon">get<wbr/>Changed<wbr/>Packages</a></li><li class="tsd-kind-function"><a href="modules.html#getChangedPackagesBetweenRefs" class="tsd-kind-icon">get<wbr/>Changed<wbr/>Packages<wbr/>Between<wbr/>Refs</a></li><li class="tsd-kind-function"><a href="modules.html#getChanges" class="tsd-kind-icon">get<wbr/>Changes</a></li><li class="tsd-kind-function"><a href="modules.html#getChangesBetweenRefs" class="tsd-kind-icon">get<wbr/>Changes<wbr/>Between<wbr/>Refs</a></li><li class="tsd-kind-function"><a href="modules.html#getCurrentHash" class="tsd-kind-icon">get<wbr/>Current<wbr/>Hash</a></li><li class="tsd-kind-function"><a href="modules.html#getDefaultBranch" class="tsd-kind-icon">get<wbr/>Default<wbr/>Branch</a></li><li class="tsd-kind-function"><a href="modules.html#getDefaultRemote" class="tsd-kind-icon">get<wbr/>Default<wbr/>Remote</a></li><li class="tsd-kind-function"><a href="modules.html#getDefaultRemoteBranch" class="tsd-kind-icon">get<wbr/>Default<wbr/>Remote<wbr/>Branch</a></li><li class="tsd-kind-function"><a href="modules.html#getDependentMap" class="tsd-kind-icon">get<wbr/>Dependent<wbr/>Map</a></li><li class="tsd-kind-function"><a href="modules.html#getFileAddedHash" class="tsd-kind-icon">get<wbr/>File<wbr/>Added<wbr/>Hash</a></li><li class="tsd-kind-function"><a href="modules.html#getFullBranchRef" class="tsd-kind-icon">get<wbr/>Full<wbr/>Branch<wbr/>Ref</a></li><li class="tsd-kind-function"><a href="modules.html#getInternalDeps" class="tsd-kind-icon">get<wbr/>Internal<wbr/>Deps</a></li><li class="tsd-kind-function"><a href="modules.html#getPackageGraph" class="tsd-kind-icon">get<wbr/>Package<wbr/>Graph</a></li><li class="tsd-kind-function"><a href="modules.html#getPackageInfos" class="tsd-kind-icon">get<wbr/>Package<wbr/>Infos</a></li><li class="tsd-kind-function"><a href="modules.html#getPackagesByFiles" class="tsd-kind-icon">get<wbr/>Packages<wbr/>By<wbr/>Files</a></li><li class="tsd-kind-function"><a href="modules.html#getParentBranch" class="tsd-kind-icon">get<wbr/>Parent<wbr/>Branch</a></li><li class="tsd-kind-function"><a href="modules.html#getPnpmWorkspaceRoot" class="tsd-kind-icon">get<wbr/>Pnpm<wbr/>Workspace<wbr/>Root</a></li><li class="tsd-kind-function"><a href="modules.html#getPnpmWorkspaces" class="tsd-kind-icon">get<wbr/>Pnpm<wbr/>Workspaces</a></li><li class="tsd-kind-function"><a href="modules.html#getRecentCommitMessages" class="tsd-kind-icon">get<wbr/>Recent<wbr/>Commit<wbr/>Messages</a></li><li class="tsd-kind-function"><a href="modules.html#getRemoteBranch" class="tsd-kind-icon">get<wbr/>Remote<wbr/>Branch</a></li><li class="tsd-kind-function"><a href="modules.html#getRushWorkspaceRoot" class="tsd-kind-icon">get<wbr/>Rush<wbr/>Workspace<wbr/>Root</a></li><li class="tsd-kind-function"><a href="modules.html#getRushWorkspaces" class="tsd-kind-icon">get<wbr/>Rush<wbr/>Workspaces</a></li><li class="tsd-kind-function"><a href="modules.html#getScopedPackages" class="tsd-kind-icon">get<wbr/>Scoped<wbr/>Packages</a></li><li class="tsd-kind-function"><a href="modules.html#getShortBranchName" class="tsd-kind-icon">get<wbr/>Short<wbr/>Branch<wbr/>Name</a></li><li class="tsd-kind-function"><a href="modules.html#getStagedChanges" class="tsd-kind-icon">get<wbr/>Staged<wbr/>Changes</a></li><li class="tsd-kind-function"><a href="modules.html#getTransitiveConsumers" class="tsd-kind-icon">get<wbr/>Transitive<wbr/>Consumers</a></li><li class="tsd-kind-function"><a href="modules.html#getTransitiveDependencies" class="tsd-kind-icon">get<wbr/>Transitive<wbr/>Dependencies</a></li><li class="tsd-kind-function"><a href="modules.html#getTransitiveDependents" class="tsd-kind-icon">get<wbr/>Transitive<wbr/>Dependents</a></li><li class="tsd-kind-function"><a href="modules.html#getTransitiveProviders" class="tsd-kind-icon">get<wbr/>Transitive<wbr/>Providers</a></li><li class="tsd-kind-function"><a href="modules.html#getUnstagedChanges" class="tsd-kind-icon">get<wbr/>Unstaged<wbr/>Changes</a></li><li class="tsd-kind-function"><a href="modules.html#getUntrackedChanges" class="tsd-kind-icon">get<wbr/>Untracked<wbr/>Changes</a></li><li class="tsd-kind-function"><a href="modules.html#getUserEmail" class="tsd-kind-icon">get<wbr/>User<wbr/>Email</a></li><li class="tsd-kind-function"><a href="modules.html#getWorkspaceRoot" class="tsd-kind-icon">get<wbr/>Workspace<wbr/>Root</a></li><li class="tsd-kind-function"><a href="modules.html#getWorkspaces" class="tsd-kind-icon">get<wbr/>Workspaces</a></li><li class="tsd-kind-function"><a href="modules.html#getYarnWorkspaceRoot" class="tsd-kind-icon">get<wbr/>Yarn<wbr/>Workspace<wbr/>Root</a></li><li class="tsd-kind-function"><a href="modules.html#getYarnWorkspaces" class="tsd-kind-icon">get<wbr/>Yarn<wbr/>Workspaces</a></li><li class="tsd-kind-function"><a href="modules.html#git" class="tsd-kind-icon">git</a></li><li class="tsd-kind-function"><a href="modules.html#gitFailFast" class="tsd-kind-icon">git<wbr/>Fail<wbr/>Fast</a></li><li class="tsd-kind-function"><a href="modules.html#init" class="tsd-kind-icon">init</a></li><li class="tsd-kind-function"><a href="modules.html#isChildOf" class="tsd-kind-icon">is<wbr/>Child<wbr/>Of</a></li><li class="tsd-kind-function"><a href="modules.html#listAllTrackedFiles" class="tsd-kind-icon">list<wbr/>All<wbr/>Tracked<wbr/>Files</a></li><li class="tsd-kind-function"><a href="modules.html#listOfWorkspacePackageNames" class="tsd-kind-icon">list<wbr/>Of<wbr/>Workspace<wbr/>Package<wbr/>Names</a></li><li class="tsd-kind-function"><a href="modules.html#nameAtVersion" class="tsd-kind-icon">name<wbr/>At<wbr/>Version</a></li><li class="tsd-kind-function"><a href="modules.html#parseLockFile" class="tsd-kind-icon">parse<wbr/>Lock<wbr/>File</a></li><li class="tsd-kind-function"><a href="modules.html#parseRemoteBranch" class="tsd-kind-icon">parse<wbr/>Remote<wbr/>Branch</a></li><li class="tsd-kind-function"><a href="modules.html#queryLockFile" class="tsd-kind-icon">query<wbr/>Lock<wbr/>File</a></li><li class="tsd-kind-function"><a href="modules.html#revertLocalChanges" class="tsd-kind-icon">revert<wbr/>Local<wbr/>Changes</a></li><li class="tsd-kind-function"><a href="modules.html#searchUp" class="tsd-kind-icon">search<wbr/>Up</a></li><li class="tsd-kind-function"><a href="modules.html#stage" class="tsd-kind-icon">stage</a></li><li class="tsd-kind-function"><a href="modules.html#stageAndCommit" class="tsd-kind-icon">stage<wbr/>And<wbr/>Commit</a></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="assets/main.js"></script></body></html>
|