Skip to content

Commit 55ee896

Browse files
authored
chore: document some interfaces (#52)
This would've helped me when getting started with this repo
1 parent 7f9a26e commit 55ee896

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

types.d.ts

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,41 +8,74 @@ export interface EnvironmentData {
88
}
99

1010
export interface RunOptions {
11+
/** Workspace package name to run. */
1112
workspace: string
13+
/** Repository root directory. */
1214
root: string
15+
/** Local path to the Svelte package. */
1316
sveltePath: string
17+
/** Installed Svelte major version. */
1418
svelteMajor: number
19+
/** Enable extra verification checks. */
1520
verify?: boolean
21+
/** Skip git clone/fetch steps. */
1622
skipGit?: boolean
23+
/** Release channel/version to test against. */
1724
release?: string
25+
/** Preferred package manager. */
1826
agent?: (typeof AGENTS)[number]
27+
/** Build task(s) to run; skipped when omitted. */
1928
build?: Task | Task[]
29+
/** Test task(s) to run; skipped when omitted. */
2030
test?: Task | Task[]
31+
/** Task(s) to run before installing dependencies. */
2132
beforeInstall?: Task | Task[]
33+
/** Task(s) to run before build. */
2234
beforeBuild?: Task | Task[]
35+
/** Task(s) to run before test. */
2336
beforeTest?: Task | Task[]
2437
}
2538

2639
type Task = string | { script: string; args?: string[] } | (() => Promise<any>)
2740

2841
export interface CommandOptions {
42+
/** Suites to include; runs all when omitted. */
2943
suites?: string[]
44+
/** Repository in owner/name format. */
3045
repo?: string
46+
/** Git branch to use. */
3147
branch?: string
48+
/** Git tag to use. */
3249
tag?: string
50+
/** Git commit SHA to use. */
3351
commit?: string
52+
/** Release channel/version override. */
3453
release?: string
54+
/** Enable verification checks. */
3555
verify?: boolean
56+
/** Skip git operations. */
3657
skipGit?: boolean
3758
}
3859

3960
export interface RepoOptions {
61+
/** Repository in owner/name format. */
4062
repo: string
63+
/** Target directory name for checkout. */
4164
dir?: string
65+
/** Git branch to checkout. */
4266
branch?: string
67+
/** Git tag to checkout. */
4368
tag?: string
69+
/** Git commit SHA to checkout. */
4470
commit?: string
71+
/** Perform a shallow clone. */
4572
shallow?: boolean
73+
/**
74+
* Key is the dependency, value is one of:
75+
* - `string`: override dependency source/version (local paths are supported).
76+
* - `true`: force-build and override this package from local builds.
77+
* - `false`: disable a previously set boolean flag.
78+
*/
4679
overrides?: Overrides
4780
}
4881

0 commit comments

Comments
 (0)