mise-projen 0.0.7 → 0.0.9
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/.jsii +2364 -898
- package/API.md +1006 -25
- package/lib/index.js +1 -1
- package/lib/miseConfig.d.ts +427 -3
- package/lib/miseConfig.js +257 -6
- package/lib/miseFile.js +1 -1
- package/package.json +1 -1
- package/schemas/mise.json +426 -11
package/lib/index.js
CHANGED
|
@@ -57,7 +57,7 @@ __exportStar(require("./types"), exports);
|
|
|
57
57
|
* project.with(new Mise({ config: { tools: { node: ['24'] } } }));
|
|
58
58
|
*/
|
|
59
59
|
class Mise {
|
|
60
|
-
static [JSII_RTTI_SYMBOL_1] = { fqn: "mise-projen.Mise", version: "0.0.
|
|
60
|
+
static [JSII_RTTI_SYMBOL_1] = { fqn: "mise-projen.Mise", version: "0.0.9" };
|
|
61
61
|
fileName;
|
|
62
62
|
config;
|
|
63
63
|
autoDiscover;
|
package/lib/miseConfig.d.ts
CHANGED
|
@@ -90,6 +90,12 @@ export interface MiseTomlSchema {
|
|
|
90
90
|
* @schema MiseTomlSchema#min_version
|
|
91
91
|
*/
|
|
92
92
|
readonly minVersion?: any;
|
|
93
|
+
/**
|
|
94
|
+
* [experimental] Sources for mise secrets: values resolved only when mise starts a task or `mise x` command that was granted them. Project config only.
|
|
95
|
+
*
|
|
96
|
+
* @schema MiseTomlSchema#secrets
|
|
97
|
+
*/
|
|
98
|
+
readonly secrets?: MiseTomlSchemaSecrets;
|
|
93
99
|
/**
|
|
94
100
|
* env or vars keys to redact from logs
|
|
95
101
|
*
|
|
@@ -130,6 +136,14 @@ export interface MiseTomlSchema {
|
|
|
130
136
|
readonly dotfiles?: {
|
|
131
137
|
[key: string]: any;
|
|
132
138
|
};
|
|
139
|
+
/**
|
|
140
|
+
* named directory trees of dotfiles, applied with `mise dotfiles apply` or `mise bootstrap` while [bootstrap] dotfile_groups selects them (or is unset)
|
|
141
|
+
*
|
|
142
|
+
* @schema MiseTomlSchema#dotfile_groups
|
|
143
|
+
*/
|
|
144
|
+
readonly dotfileGroups?: {
|
|
145
|
+
[key: string]: MiseTomlSchemaDotfileGroups;
|
|
146
|
+
};
|
|
133
147
|
/**
|
|
134
148
|
* machine-global bootstrapping (system packages, repos, macOS defaults, launchd agents, login shell)
|
|
135
149
|
*
|
|
@@ -296,6 +310,24 @@ export interface Monorepo {
|
|
|
296
310
|
* @internal
|
|
297
311
|
*/
|
|
298
312
|
export declare function toJson_Monorepo(obj: Monorepo | undefined): Record<string, any> | undefined;
|
|
313
|
+
/**
|
|
314
|
+
* [experimental] Sources for mise secrets: values resolved only when mise starts a task or `mise x` command that was granted them. Project config only.
|
|
315
|
+
*
|
|
316
|
+
* @schema MiseTomlSchemaSecrets
|
|
317
|
+
*/
|
|
318
|
+
export interface MiseTomlSchemaSecrets {
|
|
319
|
+
/**
|
|
320
|
+
* Use fnox (fnox.toml discovered from this config's directory). https://mise.jdx.dev/environments/secrets/fnox.html
|
|
321
|
+
*
|
|
322
|
+
* @schema MiseTomlSchemaSecrets#fnox
|
|
323
|
+
*/
|
|
324
|
+
readonly fnox?: MiseTomlSchemaSecretsFnox;
|
|
325
|
+
}
|
|
326
|
+
/**
|
|
327
|
+
* Converts an object of type 'MiseTomlSchemaSecrets' to JSON representation.
|
|
328
|
+
* @internal
|
|
329
|
+
*/
|
|
330
|
+
export declare function toJson_MiseTomlSchemaSecrets(obj: MiseTomlSchemaSecrets | undefined): Record<string, any> | undefined;
|
|
299
331
|
/**
|
|
300
332
|
* configure deps providers
|
|
301
333
|
*
|
|
@@ -536,13 +568,13 @@ export interface Settings {
|
|
|
536
568
|
*/
|
|
537
569
|
readonly autoInstallDisableTools?: string[];
|
|
538
570
|
/**
|
|
539
|
-
*
|
|
571
|
+
* [deprecated] Use `self_update.auto` instead.
|
|
540
572
|
*
|
|
541
573
|
* @schema settings#auto_update
|
|
542
574
|
*/
|
|
543
575
|
readonly autoUpdate?: boolean;
|
|
544
576
|
/**
|
|
545
|
-
*
|
|
577
|
+
* [deprecated] Use `self_update.check_duration` instead.
|
|
546
578
|
*
|
|
547
579
|
* @schema settings#auto_update_check_duration
|
|
548
580
|
*/
|
|
@@ -879,6 +911,12 @@ export interface Settings {
|
|
|
879
911
|
* @schema settings#install_before
|
|
880
912
|
*/
|
|
881
913
|
readonly installBefore?: string;
|
|
914
|
+
/**
|
|
915
|
+
* [experimental] Name installations by what they are (`identity`) instead of `installs/<tool>/<version>` (`legacy`).
|
|
916
|
+
*
|
|
917
|
+
* @schema settings#install_layout
|
|
918
|
+
*/
|
|
919
|
+
readonly installLayout?: SettingsInstallLayout;
|
|
882
920
|
/**
|
|
883
921
|
* @schema settings#java
|
|
884
922
|
*/
|
|
@@ -937,6 +975,12 @@ export interface Settings {
|
|
|
937
975
|
* @schema settings#lockfile
|
|
938
976
|
*/
|
|
939
977
|
readonly lockfile?: boolean;
|
|
978
|
+
/**
|
|
979
|
+
* Remove lockfile tools that are absent from the active configuration.
|
|
980
|
+
*
|
|
981
|
+
* @schema settings#lockfile_auto_prune
|
|
982
|
+
*/
|
|
983
|
+
readonly lockfileAutoPrune?: boolean;
|
|
940
984
|
/**
|
|
941
985
|
* Choose incremental merging or complete lockfile generation.
|
|
942
986
|
*
|
|
@@ -1100,6 +1144,10 @@ export interface Settings {
|
|
|
1100
1144
|
* @schema settings#provenance_api_failures_fatal
|
|
1101
1145
|
*/
|
|
1102
1146
|
readonly provenanceApiFailuresFatal?: boolean;
|
|
1147
|
+
/**
|
|
1148
|
+
* @schema settings#prune
|
|
1149
|
+
*/
|
|
1150
|
+
readonly prune?: SettingsPrune;
|
|
1103
1151
|
/**
|
|
1104
1152
|
* @schema settings#pypi
|
|
1105
1153
|
*/
|
|
@@ -1307,6 +1355,10 @@ export interface Settings {
|
|
|
1307
1355
|
* @schema settings#terminal_progress
|
|
1308
1356
|
*/
|
|
1309
1357
|
readonly terminalProgress?: boolean;
|
|
1358
|
+
/**
|
|
1359
|
+
* @schema settings#tool_update
|
|
1360
|
+
*/
|
|
1361
|
+
readonly toolUpdate?: SettingsToolUpdate;
|
|
1310
1362
|
/**
|
|
1311
1363
|
* Sets log level to trace
|
|
1312
1364
|
*
|
|
@@ -1403,6 +1455,10 @@ export interface Settings {
|
|
|
1403
1455
|
* @schema settings#windows_shim_mode
|
|
1404
1456
|
*/
|
|
1405
1457
|
readonly windowsShimMode?: string;
|
|
1458
|
+
/**
|
|
1459
|
+
* @schema settings#write_targets
|
|
1460
|
+
*/
|
|
1461
|
+
readonly writeTargets?: SettingsWriteTargets;
|
|
1406
1462
|
/**
|
|
1407
1463
|
* This will automatically answer yes or no to prompts. This is useful for scripting.
|
|
1408
1464
|
*
|
|
@@ -1419,6 +1475,66 @@ export interface Settings {
|
|
|
1419
1475
|
* @internal
|
|
1420
1476
|
*/
|
|
1421
1477
|
export declare function toJson_Settings(obj: Settings | undefined): Record<string, any> | undefined;
|
|
1478
|
+
/**
|
|
1479
|
+
* @schema MiseTomlSchemaDotfileGroups
|
|
1480
|
+
*/
|
|
1481
|
+
export interface MiseTomlSchemaDotfileGroups {
|
|
1482
|
+
/**
|
|
1483
|
+
* the directory tree the group deploys; a relative path resolves against dotfiles.root
|
|
1484
|
+
*
|
|
1485
|
+
* @schema MiseTomlSchemaDotfileGroups#root
|
|
1486
|
+
*/
|
|
1487
|
+
readonly root: string;
|
|
1488
|
+
/**
|
|
1489
|
+
* target directory, absolute or starting with ~/
|
|
1490
|
+
*
|
|
1491
|
+
* @schema MiseTomlSchemaDotfileGroups#target
|
|
1492
|
+
*/
|
|
1493
|
+
readonly target?: string;
|
|
1494
|
+
/**
|
|
1495
|
+
* how the tree is deployed
|
|
1496
|
+
*
|
|
1497
|
+
* @schema MiseTomlSchemaDotfileGroups#mode
|
|
1498
|
+
*/
|
|
1499
|
+
readonly mode?: MiseTomlSchemaDotfileGroupsMode;
|
|
1500
|
+
/**
|
|
1501
|
+
* glob patterns of source paths to skip, as for [dotfiles] exclude
|
|
1502
|
+
*
|
|
1503
|
+
* @schema MiseTomlSchemaDotfileGroups#exclude
|
|
1504
|
+
*/
|
|
1505
|
+
readonly exclude?: string[];
|
|
1506
|
+
/**
|
|
1507
|
+
* deploy each source path component named "dot-<name>" as ".<name>", like GNU Stow's --dotfiles
|
|
1508
|
+
*
|
|
1509
|
+
* @schema MiseTomlSchemaDotfileGroups#dot_prefix
|
|
1510
|
+
*/
|
|
1511
|
+
readonly dotPrefix?: boolean;
|
|
1512
|
+
/**
|
|
1513
|
+
* source manifest used to select managed files from the tree
|
|
1514
|
+
*
|
|
1515
|
+
* @schema MiseTomlSchemaDotfileGroups#manifest
|
|
1516
|
+
*/
|
|
1517
|
+
readonly manifest?: MiseTomlSchemaDotfileGroupsManifest;
|
|
1518
|
+
/**
|
|
1519
|
+
* link by a path relative to the link's directory; overrides the dotfiles.relative_symlinks setting (ignored on Windows)
|
|
1520
|
+
*
|
|
1521
|
+
* @schema MiseTomlSchemaDotfileGroups#relative
|
|
1522
|
+
*/
|
|
1523
|
+
readonly relative?: boolean;
|
|
1524
|
+
/**
|
|
1525
|
+
* whole-file entries for parts of the tree, keyed by target path inside the group's target and written like [dotfiles] entries; each is cut out of the walk. A missing source is found under the root at the entry's path inside the target, and a relative source starts at the root
|
|
1526
|
+
*
|
|
1527
|
+
* @schema MiseTomlSchemaDotfileGroups#entries
|
|
1528
|
+
*/
|
|
1529
|
+
readonly entries?: {
|
|
1530
|
+
[key: string]: any;
|
|
1531
|
+
};
|
|
1532
|
+
}
|
|
1533
|
+
/**
|
|
1534
|
+
* Converts an object of type 'MiseTomlSchemaDotfileGroups' to JSON representation.
|
|
1535
|
+
* @internal
|
|
1536
|
+
*/
|
|
1537
|
+
export declare function toJson_MiseTomlSchemaDotfileGroups(obj: MiseTomlSchemaDotfileGroups | undefined): Record<string, any> | undefined;
|
|
1422
1538
|
/**
|
|
1423
1539
|
* machine-global bootstrapping (system packages, repos, macOS defaults, launchd agents, login shell)
|
|
1424
1540
|
*
|
|
@@ -1441,6 +1557,12 @@ export interface MiseTomlSchemaBootstrap {
|
|
|
1441
1557
|
readonly directories?: {
|
|
1442
1558
|
[key: string]: MiseTomlSchemaBootstrapDirectories;
|
|
1443
1559
|
};
|
|
1560
|
+
/**
|
|
1561
|
+
* the dotfile groups this machine applies; when unset, every group applies. Entries without a group always apply, and a more local config's list replaces the others
|
|
1562
|
+
*
|
|
1563
|
+
* @schema MiseTomlSchemaBootstrap#dotfile_groups
|
|
1564
|
+
*/
|
|
1565
|
+
readonly dotfileGroups?: string[];
|
|
1444
1566
|
/**
|
|
1445
1567
|
* deprecated and will be removed in mise 2027.3.3; move each selected root into a conf.d folder instead (https://mise.jdx.dev/configuration.html#conf-d-folders)
|
|
1446
1568
|
*
|
|
@@ -1461,6 +1583,14 @@ export interface MiseTomlSchemaBootstrap {
|
|
|
1461
1583
|
readonly services?: {
|
|
1462
1584
|
[key: string]: MiseTomlSchemaBootstrapServices;
|
|
1463
1585
|
};
|
|
1586
|
+
/**
|
|
1587
|
+
* Docker Compose projects managed with `mise bootstrap compose`, keyed by project name. Text fields support Tera templates.
|
|
1588
|
+
*
|
|
1589
|
+
* @schema MiseTomlSchemaBootstrap#compose
|
|
1590
|
+
*/
|
|
1591
|
+
readonly compose?: {
|
|
1592
|
+
[key: string]: MiseTomlSchemaBootstrapCompose;
|
|
1593
|
+
};
|
|
1464
1594
|
/**
|
|
1465
1595
|
* package manager plugins to install with `mise bootstrap plugins apply`, keyed by manager name
|
|
1466
1596
|
*
|
|
@@ -1841,6 +1971,24 @@ export interface MonorepoProjects {
|
|
|
1841
1971
|
* @internal
|
|
1842
1972
|
*/
|
|
1843
1973
|
export declare function toJson_MonorepoProjects(obj: MonorepoProjects | undefined): Record<string, any> | undefined;
|
|
1974
|
+
/**
|
|
1975
|
+
* Use fnox (fnox.toml discovered from this config's directory). https://mise.jdx.dev/environments/secrets/fnox.html
|
|
1976
|
+
*
|
|
1977
|
+
* @schema MiseTomlSchemaSecretsFnox
|
|
1978
|
+
*/
|
|
1979
|
+
export interface MiseTomlSchemaSecretsFnox {
|
|
1980
|
+
/**
|
|
1981
|
+
* fnox profile (fnox -P); defaults to FNOX_PROFILE, then "default"
|
|
1982
|
+
*
|
|
1983
|
+
* @schema MiseTomlSchemaSecretsFnox#profile
|
|
1984
|
+
*/
|
|
1985
|
+
readonly profile?: string;
|
|
1986
|
+
}
|
|
1987
|
+
/**
|
|
1988
|
+
* Converts an object of type 'MiseTomlSchemaSecretsFnox' to JSON representation.
|
|
1989
|
+
* @internal
|
|
1990
|
+
*/
|
|
1991
|
+
export declare function toJson_MiseTomlSchemaSecretsFnox(obj: MiseTomlSchemaSecretsFnox | undefined): Record<string, any> | undefined;
|
|
1844
1992
|
/**
|
|
1845
1993
|
* Prepare provider configuration
|
|
1846
1994
|
*
|
|
@@ -2490,6 +2638,17 @@ export interface SettingsHookEnv {
|
|
|
2490
2638
|
* @internal
|
|
2491
2639
|
*/
|
|
2492
2640
|
export declare function toJson_SettingsHookEnv(obj: SettingsHookEnv | undefined): Record<string, any> | undefined;
|
|
2641
|
+
/**
|
|
2642
|
+
* [experimental] Name installations by what they are (`identity`) instead of `installs/<tool>/<version>` (`legacy`).
|
|
2643
|
+
*
|
|
2644
|
+
* @schema SettingsInstallLayout
|
|
2645
|
+
*/
|
|
2646
|
+
export declare enum SettingsInstallLayout {
|
|
2647
|
+
/** legacy */
|
|
2648
|
+
LEGACY = "legacy",
|
|
2649
|
+
/** identity */
|
|
2650
|
+
IDENTITY = "identity"
|
|
2651
|
+
}
|
|
2493
2652
|
/**
|
|
2494
2653
|
* @schema SettingsJava
|
|
2495
2654
|
*/
|
|
@@ -2798,6 +2957,22 @@ export interface SettingsPipx {
|
|
|
2798
2957
|
* @internal
|
|
2799
2958
|
*/
|
|
2800
2959
|
export declare function toJson_SettingsPipx(obj: SettingsPipx | undefined): Record<string, any> | undefined;
|
|
2960
|
+
/**
|
|
2961
|
+
* @schema SettingsPrune
|
|
2962
|
+
*/
|
|
2963
|
+
export interface SettingsPrune {
|
|
2964
|
+
/**
|
|
2965
|
+
* Tools that `mise prune` never removes, such as `node` or `aqua:BurntSushi/ripgrep`.
|
|
2966
|
+
*
|
|
2967
|
+
* @schema SettingsPrune#exclude
|
|
2968
|
+
*/
|
|
2969
|
+
readonly exclude?: string[];
|
|
2970
|
+
}
|
|
2971
|
+
/**
|
|
2972
|
+
* Converts an object of type 'SettingsPrune' to JSON representation.
|
|
2973
|
+
* @internal
|
|
2974
|
+
*/
|
|
2975
|
+
export declare function toJson_SettingsPrune(obj: SettingsPrune | undefined): Record<string, any> | undefined;
|
|
2801
2976
|
/**
|
|
2802
2977
|
* @schema SettingsPypi
|
|
2803
2978
|
*/
|
|
@@ -3082,6 +3257,18 @@ export interface SettingsSelfUpdate {
|
|
|
3082
3257
|
* @schema SettingsSelfUpdate#api_url
|
|
3083
3258
|
*/
|
|
3084
3259
|
readonly apiUrl?: string;
|
|
3260
|
+
/**
|
|
3261
|
+
* Automatically update mise before running eligible commands.
|
|
3262
|
+
*
|
|
3263
|
+
* @schema SettingsSelfUpdate#auto
|
|
3264
|
+
*/
|
|
3265
|
+
readonly auto?: boolean;
|
|
3266
|
+
/**
|
|
3267
|
+
* How often to check for a new mise release when `self_update.auto` is enabled.
|
|
3268
|
+
*
|
|
3269
|
+
* @schema SettingsSelfUpdate#check_duration
|
|
3270
|
+
*/
|
|
3271
|
+
readonly checkDuration?: string;
|
|
3085
3272
|
/**
|
|
3086
3273
|
* Minimum release age for mise itself; inherits minimum_release_age (24h by default).
|
|
3087
3274
|
*
|
|
@@ -3475,6 +3662,22 @@ export interface SettingsTask {
|
|
|
3475
3662
|
* @internal
|
|
3476
3663
|
*/
|
|
3477
3664
|
export declare function toJson_SettingsTask(obj: SettingsTask | undefined): Record<string, any> | undefined;
|
|
3665
|
+
/**
|
|
3666
|
+
* @schema SettingsToolUpdate
|
|
3667
|
+
*/
|
|
3668
|
+
export interface SettingsToolUpdate {
|
|
3669
|
+
/**
|
|
3670
|
+
* How often to check for updates to a global tool with `auto_update = true`.
|
|
3671
|
+
*
|
|
3672
|
+
* @schema SettingsToolUpdate#check_duration
|
|
3673
|
+
*/
|
|
3674
|
+
readonly checkDuration?: string;
|
|
3675
|
+
}
|
|
3676
|
+
/**
|
|
3677
|
+
* Converts an object of type 'SettingsToolUpdate' to JSON representation.
|
|
3678
|
+
* @internal
|
|
3679
|
+
*/
|
|
3680
|
+
export declare function toJson_SettingsToolUpdate(obj: SettingsToolUpdate | undefined): Record<string, any> | undefined;
|
|
3478
3681
|
/**
|
|
3479
3682
|
* @schema SettingsUpgrade
|
|
3480
3683
|
*/
|
|
@@ -3497,6 +3700,34 @@ export interface SettingsUpgrade {
|
|
|
3497
3700
|
* @internal
|
|
3498
3701
|
*/
|
|
3499
3702
|
export declare function toJson_SettingsUpgrade(obj: SettingsUpgrade | undefined): Record<string, any> | undefined;
|
|
3703
|
+
/**
|
|
3704
|
+
* @schema SettingsWriteTargets
|
|
3705
|
+
*/
|
|
3706
|
+
export interface SettingsWriteTargets {
|
|
3707
|
+
/**
|
|
3708
|
+
* Global config file to create new [dotfiles] entries in. Existing entries stay in the config file that already declares them.
|
|
3709
|
+
*
|
|
3710
|
+
* @schema SettingsWriteTargets#dotfiles
|
|
3711
|
+
*/
|
|
3712
|
+
readonly dotfiles?: string;
|
|
3713
|
+
/**
|
|
3714
|
+
* Global config file to create new [bootstrap.packages] entries in. Existing entries stay in the config file that already declares them.
|
|
3715
|
+
*
|
|
3716
|
+
* @schema SettingsWriteTargets#packages
|
|
3717
|
+
*/
|
|
3718
|
+
readonly packages?: string;
|
|
3719
|
+
/**
|
|
3720
|
+
* Global config file to create new [tools] entries in. Existing entries stay in the config file that already declares them.
|
|
3721
|
+
*
|
|
3722
|
+
* @schema SettingsWriteTargets#tools
|
|
3723
|
+
*/
|
|
3724
|
+
readonly tools?: string;
|
|
3725
|
+
}
|
|
3726
|
+
/**
|
|
3727
|
+
* Converts an object of type 'SettingsWriteTargets' to JSON representation.
|
|
3728
|
+
* @internal
|
|
3729
|
+
*/
|
|
3730
|
+
export declare function toJson_SettingsWriteTargets(obj: SettingsWriteTargets | undefined): Record<string, any> | undefined;
|
|
3500
3731
|
/**
|
|
3501
3732
|
* @schema SettingsZig
|
|
3502
3733
|
*/
|
|
@@ -3513,6 +3744,28 @@ export interface SettingsZig {
|
|
|
3513
3744
|
* @internal
|
|
3514
3745
|
*/
|
|
3515
3746
|
export declare function toJson_SettingsZig(obj: SettingsZig | undefined): Record<string, any> | undefined;
|
|
3747
|
+
/**
|
|
3748
|
+
* how the tree is deployed
|
|
3749
|
+
*
|
|
3750
|
+
* @schema MiseTomlSchemaDotfileGroupsMode
|
|
3751
|
+
*/
|
|
3752
|
+
export declare enum MiseTomlSchemaDotfileGroupsMode {
|
|
3753
|
+
/** symlink-each */
|
|
3754
|
+
SYMLINK_HYPHEN_EACH = "symlink-each",
|
|
3755
|
+
/** copy */
|
|
3756
|
+
COPY = "copy",
|
|
3757
|
+
/** symlink */
|
|
3758
|
+
SYMLINK = "symlink"
|
|
3759
|
+
}
|
|
3760
|
+
/**
|
|
3761
|
+
* source manifest used to select managed files from the tree
|
|
3762
|
+
*
|
|
3763
|
+
* @schema MiseTomlSchemaDotfileGroupsManifest
|
|
3764
|
+
*/
|
|
3765
|
+
export declare enum MiseTomlSchemaDotfileGroupsManifest {
|
|
3766
|
+
/** git */
|
|
3767
|
+
GIT = "git"
|
|
3768
|
+
}
|
|
3516
3769
|
/**
|
|
3517
3770
|
* @schema MiseTomlSchemaBootstrapFiles
|
|
3518
3771
|
*/
|
|
@@ -3738,6 +3991,122 @@ export interface MiseTomlSchemaBootstrapServices {
|
|
|
3738
3991
|
* @internal
|
|
3739
3992
|
*/
|
|
3740
3993
|
export declare function toJson_MiseTomlSchemaBootstrapServices(obj: MiseTomlSchemaBootstrapServices | undefined): Record<string, any> | undefined;
|
|
3994
|
+
/**
|
|
3995
|
+
* @schema MiseTomlSchemaBootstrapCompose
|
|
3996
|
+
*/
|
|
3997
|
+
export interface MiseTomlSchemaBootstrapCompose {
|
|
3998
|
+
/**
|
|
3999
|
+
* absolute directory containing the Compose project
|
|
4000
|
+
*
|
|
4001
|
+
* @schema MiseTomlSchemaBootstrapCompose#project_dir
|
|
4002
|
+
*/
|
|
4003
|
+
readonly projectDir: string;
|
|
4004
|
+
/**
|
|
4005
|
+
* Compose file paths relative to project_dir unless absolute
|
|
4006
|
+
*
|
|
4007
|
+
* @schema MiseTomlSchemaBootstrapCompose#files
|
|
4008
|
+
*/
|
|
4009
|
+
readonly files?: string[];
|
|
4010
|
+
/**
|
|
4011
|
+
* environment file paths relative to project_dir unless absolute
|
|
4012
|
+
*
|
|
4013
|
+
* @schema MiseTomlSchemaBootstrapCompose#env_files
|
|
4014
|
+
*/
|
|
4015
|
+
readonly envFiles?: string[];
|
|
4016
|
+
/**
|
|
4017
|
+
* optional Compose project name
|
|
4018
|
+
*
|
|
4019
|
+
* @schema MiseTomlSchemaBootstrapCompose#project_name
|
|
4020
|
+
*/
|
|
4021
|
+
readonly projectName?: string;
|
|
4022
|
+
/**
|
|
4023
|
+
* @schema MiseTomlSchemaBootstrapCompose#profiles
|
|
4024
|
+
*/
|
|
4025
|
+
readonly profiles?: string[];
|
|
4026
|
+
/**
|
|
4027
|
+
* @schema MiseTomlSchemaBootstrapCompose#services
|
|
4028
|
+
*/
|
|
4029
|
+
readonly services?: string[];
|
|
4030
|
+
/**
|
|
4031
|
+
* @schema MiseTomlSchemaBootstrapCompose#oneshot
|
|
4032
|
+
*/
|
|
4033
|
+
readonly oneshot?: string[];
|
|
4034
|
+
/**
|
|
4035
|
+
* @schema MiseTomlSchemaBootstrapCompose#state
|
|
4036
|
+
*/
|
|
4037
|
+
readonly state?: MiseTomlSchemaBootstrapComposeState;
|
|
4038
|
+
/**
|
|
4039
|
+
* @schema MiseTomlSchemaBootstrapCompose#pull
|
|
4040
|
+
*/
|
|
4041
|
+
readonly pull?: MiseTomlSchemaBootstrapComposePull;
|
|
4042
|
+
/**
|
|
4043
|
+
* @schema MiseTomlSchemaBootstrapCompose#build
|
|
4044
|
+
*/
|
|
4045
|
+
readonly buildValue?: MiseTomlSchemaBootstrapComposeBuild;
|
|
4046
|
+
/**
|
|
4047
|
+
* @schema MiseTomlSchemaBootstrapCompose#recreate
|
|
4048
|
+
*/
|
|
4049
|
+
readonly recreate?: MiseTomlSchemaBootstrapComposeRecreate;
|
|
4050
|
+
/**
|
|
4051
|
+
* @schema MiseTomlSchemaBootstrapCompose#wait
|
|
4052
|
+
*/
|
|
4053
|
+
readonly wait?: boolean;
|
|
4054
|
+
/**
|
|
4055
|
+
* wait timeout in seconds
|
|
4056
|
+
*
|
|
4057
|
+
* @schema MiseTomlSchemaBootstrapCompose#wait_timeout
|
|
4058
|
+
*/
|
|
4059
|
+
readonly waitTimeout?: number;
|
|
4060
|
+
/**
|
|
4061
|
+
* Compose shutdown timeout in seconds
|
|
4062
|
+
*
|
|
4063
|
+
* @schema MiseTomlSchemaBootstrapCompose#timeout
|
|
4064
|
+
*/
|
|
4065
|
+
readonly timeout?: number;
|
|
4066
|
+
/**
|
|
4067
|
+
* @schema MiseTomlSchemaBootstrapCompose#remove_orphans
|
|
4068
|
+
*/
|
|
4069
|
+
readonly removeOrphans?: boolean;
|
|
4070
|
+
/**
|
|
4071
|
+
* @schema MiseTomlSchemaBootstrapCompose#renew_anonymous_volumes
|
|
4072
|
+
*/
|
|
4073
|
+
readonly renewAnonymousVolumes?: boolean;
|
|
4074
|
+
/**
|
|
4075
|
+
* @schema MiseTomlSchemaBootstrapCompose#down_volumes
|
|
4076
|
+
*/
|
|
4077
|
+
readonly downVolumes?: boolean;
|
|
4078
|
+
/**
|
|
4079
|
+
* @schema MiseTomlSchemaBootstrapCompose#down_images
|
|
4080
|
+
*/
|
|
4081
|
+
readonly downImages?: MiseTomlSchemaBootstrapComposeDownImages;
|
|
4082
|
+
/**
|
|
4083
|
+
* @schema MiseTomlSchemaBootstrapCompose#sudo
|
|
4084
|
+
*/
|
|
4085
|
+
readonly sudo?: boolean;
|
|
4086
|
+
/**
|
|
4087
|
+
* standalone Compose command
|
|
4088
|
+
*
|
|
4089
|
+
* @schema MiseTomlSchemaBootstrapCompose#command
|
|
4090
|
+
*/
|
|
4091
|
+
readonly command?: string[];
|
|
4092
|
+
/**
|
|
4093
|
+
* container engine command
|
|
4094
|
+
*
|
|
4095
|
+
* @schema MiseTomlSchemaBootstrapCompose#engine_command
|
|
4096
|
+
*/
|
|
4097
|
+
readonly engineCommand?: string[];
|
|
4098
|
+
/**
|
|
4099
|
+
* bootstrap resource dependencies
|
|
4100
|
+
*
|
|
4101
|
+
* @schema MiseTomlSchemaBootstrapCompose#depends_on
|
|
4102
|
+
*/
|
|
4103
|
+
readonly dependsOn?: string[];
|
|
4104
|
+
}
|
|
4105
|
+
/**
|
|
4106
|
+
* Converts an object of type 'MiseTomlSchemaBootstrapCompose' to JSON representation.
|
|
4107
|
+
* @internal
|
|
4108
|
+
*/
|
|
4109
|
+
export declare function toJson_MiseTomlSchemaBootstrapCompose(obj: MiseTomlSchemaBootstrapCompose | undefined): Record<string, any> | undefined;
|
|
3741
4110
|
/**
|
|
3742
4111
|
* @schema MiseTomlSchemaBootstrapRepos
|
|
3743
4112
|
*/
|
|
@@ -4480,7 +4849,9 @@ export declare enum MiseTomlSchemaBootstrapServicesScope {
|
|
|
4480
4849
|
*/
|
|
4481
4850
|
export declare enum MiseTomlSchemaBootstrapServicesBuiltin {
|
|
4482
4851
|
/** history-watch */
|
|
4483
|
-
HISTORY_HYPHEN_WATCH = "history-watch"
|
|
4852
|
+
HISTORY_HYPHEN_WATCH = "history-watch",
|
|
4853
|
+
/** tool-update */
|
|
4854
|
+
TOOL_HYPHEN_UPDATE = "tool-update"
|
|
4484
4855
|
}
|
|
4485
4856
|
/**
|
|
4486
4857
|
* @schema MiseTomlSchemaBootstrapServicesRestart
|
|
@@ -4493,6 +4864,59 @@ export declare enum MiseTomlSchemaBootstrapServicesRestart {
|
|
|
4493
4864
|
/** never */
|
|
4494
4865
|
NEVER = "never"
|
|
4495
4866
|
}
|
|
4867
|
+
/**
|
|
4868
|
+
* @schema MiseTomlSchemaBootstrapComposeState
|
|
4869
|
+
*/
|
|
4870
|
+
export declare enum MiseTomlSchemaBootstrapComposeState {
|
|
4871
|
+
/** running */
|
|
4872
|
+
RUNNING = "running",
|
|
4873
|
+
/** stopped */
|
|
4874
|
+
STOPPED = "stopped",
|
|
4875
|
+
/** absent */
|
|
4876
|
+
ABSENT = "absent"
|
|
4877
|
+
}
|
|
4878
|
+
/**
|
|
4879
|
+
* @schema MiseTomlSchemaBootstrapComposePull
|
|
4880
|
+
*/
|
|
4881
|
+
export declare enum MiseTomlSchemaBootstrapComposePull {
|
|
4882
|
+
/** always */
|
|
4883
|
+
ALWAYS = "always",
|
|
4884
|
+
/** missing */
|
|
4885
|
+
MISSING = "missing",
|
|
4886
|
+
/** never */
|
|
4887
|
+
NEVER = "never"
|
|
4888
|
+
}
|
|
4889
|
+
/**
|
|
4890
|
+
* @schema MiseTomlSchemaBootstrapComposeBuild
|
|
4891
|
+
*/
|
|
4892
|
+
export declare enum MiseTomlSchemaBootstrapComposeBuild {
|
|
4893
|
+
/** auto */
|
|
4894
|
+
AUTO = "auto",
|
|
4895
|
+
/** always */
|
|
4896
|
+
ALWAYS = "always",
|
|
4897
|
+
/** never */
|
|
4898
|
+
NEVER = "never"
|
|
4899
|
+
}
|
|
4900
|
+
/**
|
|
4901
|
+
* @schema MiseTomlSchemaBootstrapComposeRecreate
|
|
4902
|
+
*/
|
|
4903
|
+
export declare enum MiseTomlSchemaBootstrapComposeRecreate {
|
|
4904
|
+
/** auto */
|
|
4905
|
+
AUTO = "auto",
|
|
4906
|
+
/** always */
|
|
4907
|
+
ALWAYS = "always",
|
|
4908
|
+
/** never */
|
|
4909
|
+
NEVER = "never"
|
|
4910
|
+
}
|
|
4911
|
+
/**
|
|
4912
|
+
* @schema MiseTomlSchemaBootstrapComposeDownImages
|
|
4913
|
+
*/
|
|
4914
|
+
export declare enum MiseTomlSchemaBootstrapComposeDownImages {
|
|
4915
|
+
/** local */
|
|
4916
|
+
LOCAL = "local",
|
|
4917
|
+
/** all */
|
|
4918
|
+
ALL = "all"
|
|
4919
|
+
}
|
|
4496
4920
|
/**
|
|
4497
4921
|
* curated Dock preferences that compile into macOS defaults
|
|
4498
4922
|
*
|