@pvm/pkgset
Interfaces
- ChangedFiles
- ChangedFilesOpts
- FromChangedFilesOpts
- PkgsetAllOpts
- PkgsetAsyncAllOpts
- PkgsetFromRefOpts
- PkgsetReleasedOpts
Type aliases
IncludeRootOption
ฦฌ IncludeRootOption: boolean | "auto"
Defined in
packages/pvm-pkgset/types/index.ts:2
PkgsetChangedOpts
ฦฌ PkgsetChangedOpts: ChangedFilesOpts & FromChangedFilesOpts & { ignoreDangerouslyOpts?: boolean }
Defined in
packages/pvm-pkgset/lib/strategies/affected.ts:20
PkgsetStaleOpts
ฦฌ PkgsetStaleOpts: Partial<Object>
Defined in
packages/pvm-pkgset/lib/strategies/stale.ts:12
PkgsetStdinOpts
ฦฌ PkgsetStdinOpts: Partial<Object>
Defined in
packages/pvm-pkgset/lib/strategies/stdin.ts:9
Variables
command
โข command: "pkgset"
Defined in
packages/pvm-pkgset/cli/pvm-pkgset.ts:10
description
โข description: "Shows the list of packages by the specified criterion (low-level version)"
Defined in
packages/pvm-pkgset/cli/pvm-pkgset.ts:11
Functions
builder
โธ Const builder(yargs): Argv<{ strategy: string } & { S: never[] } & { format: string }>
Parameters
| Name | Type |
|---|---|
yargs | Argv<Object> |
Returns
Argv<{ strategy: string } & { S: never[] } & { format: string }>
Defined in
packages/pvm-pkgset/cli/pvm-pkgset.ts:12
changedFiles
โธ changedFiles(opts?): ChangedFiles
Parameters
| Name | Type |
|---|---|
opts | ChangedFilesOpts |
Returns
Defined in
packages/pvm-pkgset/lib/changed-files.ts:39
default
โธ default(config, workspaces, changedFiles, includeRoot?): IterableIterator<string>
Parameters
| Name | Type | Default value |
|---|---|---|
config | Config | undefined |
workspaces | string[] | undefined |
changedFiles | string[] | undefined |
includeRoot | boolean | false |
Returns
IterableIterator<string>
Defined in
packages/pvm-pkgset/lib/filter-packages.ts:6
describeStrategy
โธ describeStrategy(strategyFn, display, description): void
Parameters
| Name | Type |
|---|---|
strategyFn | any |
display | any |
description | any |
Returns
void
Defined in
packages/pvm-pkgset/lib/utils/describe-strategy.ts:3
exclude
โธ exclude(sortedWorkspaces, fileList, ignorePatterns): string[]
Parameters
| Name | Type |
|---|---|
sortedWorkspaces | string[] |
fileList | string[] |
ignorePatterns | string[] |
Returns
string[]
Defined in
packages/pvm-pkgset/lib/smart-paths.ts:22
getStrategiesDescriptionList
โธ getStrategiesDescriptionList(): string[]
Returns
string[]
Defined in
packages/pvm-pkgset/lib/strategies/index.ts:22
handler
โธ Const handler(flags): Promise<void>
Parameters
| Name | Type |
|---|---|
flags | any |
Returns
Promise<void>
Defined in
packages/pvm-pkgset/cli/pvm-pkgset.ts:39
pkgset
โธ pkgset(strategy, opts?): AsyncIterable<Pkg>
Parameters
| Name | Type |
|---|---|
strategy | string |
opts | Record<string, any> |
Returns
AsyncIterable<Pkg>
Defined in
packages/pvm-pkgset/lib/pkgset.ts:5
pkgsetAll
โธ pkgsetAll(config, opts?): IterableIterator<Pkg>
Parameters
| Name | Type |
|---|---|
config | Config |
opts | PkgsetAllOpts |
Returns
IterableIterator<Pkg>
Defined in
packages/pvm-pkgset/lib/pkgset-all.ts:13
pkgsetFromChangedFiles
โธ pkgsetFromChangedFiles(config, changed, opts?): IterableIterator<Pkg>
Parameters
| Name | Type |
|---|---|
config | Config |
changed | ChangedFiles |
opts | FromChangedFilesOpts |
Returns
IterableIterator<Pkg>
Defined in
packages/pvm-pkgset/lib/from-changed-files.ts:14
pkgsetFromFlags
โธ pkgsetFromFlags(flags): AsyncIterableIterator<Pkg>
Parameters
| Name | Type |
|---|---|
flags | Object |
flags.strategy | string |
flags.strategyOption | string[] |
Returns
AsyncIterableIterator<Pkg>
Defined in
packages/pvm-pkgset/lib/pkgset.ts:14
pkgsetFromRef
โธ pkgsetFromRef(config, ref, opts?): IterableIterator<Pkg>
Parameters
| Name | Type |
|---|---|
config | Config |
ref | string |
opts | PkgsetFromRefOpts |
Returns
IterableIterator<Pkg>