mise-projen 0.0.6 → 0.0.8
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 +1882 -846
- package/API.md +671 -0
- package/lib/index.js +1 -1
- package/lib/miseConfig.d.ts +279 -0
- package/lib/miseConfig.js +153 -6
- package/lib/miseFile.js +1 -1
- package/package.json +1 -1
- package/schemas/mise.json +2299 -53
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.8" };
|
|
61
61
|
fileName;
|
|
62
62
|
config;
|
|
63
63
|
autoDiscover;
|
package/lib/miseConfig.d.ts
CHANGED
|
@@ -72,6 +72,12 @@ export interface MiseTomlSchema {
|
|
|
72
72
|
* @schema MiseTomlSchema#monorepo_root
|
|
73
73
|
*/
|
|
74
74
|
readonly monorepoRoot?: boolean;
|
|
75
|
+
/**
|
|
76
|
+
* deprecated alias of monorepo_root
|
|
77
|
+
*
|
|
78
|
+
* @schema MiseTomlSchema#experimental_monorepo_root
|
|
79
|
+
*/
|
|
80
|
+
readonly experimentalMonorepoRoot?: boolean;
|
|
75
81
|
/**
|
|
76
82
|
* configuration for monorepo task discovery
|
|
77
83
|
*
|
|
@@ -124,6 +130,14 @@ export interface MiseTomlSchema {
|
|
|
124
130
|
readonly dotfiles?: {
|
|
125
131
|
[key: string]: any;
|
|
126
132
|
};
|
|
133
|
+
/**
|
|
134
|
+
* named directory trees of dotfiles, applied with `mise dotfiles apply` or `mise bootstrap` while [bootstrap] dotfile_groups selects them (or is unset)
|
|
135
|
+
*
|
|
136
|
+
* @schema MiseTomlSchema#dotfile_groups
|
|
137
|
+
*/
|
|
138
|
+
readonly dotfileGroups?: {
|
|
139
|
+
[key: string]: MiseTomlSchemaDotfileGroups;
|
|
140
|
+
};
|
|
127
141
|
/**
|
|
128
142
|
* machine-global bootstrapping (system packages, repos, macOS defaults, launchd agents, login shell)
|
|
129
143
|
*
|
|
@@ -1413,6 +1427,66 @@ export interface Settings {
|
|
|
1413
1427
|
* @internal
|
|
1414
1428
|
*/
|
|
1415
1429
|
export declare function toJson_Settings(obj: Settings | undefined): Record<string, any> | undefined;
|
|
1430
|
+
/**
|
|
1431
|
+
* @schema MiseTomlSchemaDotfileGroups
|
|
1432
|
+
*/
|
|
1433
|
+
export interface MiseTomlSchemaDotfileGroups {
|
|
1434
|
+
/**
|
|
1435
|
+
* the directory tree the group deploys; a relative path resolves against dotfiles.root
|
|
1436
|
+
*
|
|
1437
|
+
* @schema MiseTomlSchemaDotfileGroups#root
|
|
1438
|
+
*/
|
|
1439
|
+
readonly root: string;
|
|
1440
|
+
/**
|
|
1441
|
+
* target directory, absolute or starting with ~/
|
|
1442
|
+
*
|
|
1443
|
+
* @schema MiseTomlSchemaDotfileGroups#target
|
|
1444
|
+
*/
|
|
1445
|
+
readonly target?: string;
|
|
1446
|
+
/**
|
|
1447
|
+
* how the tree is deployed
|
|
1448
|
+
*
|
|
1449
|
+
* @schema MiseTomlSchemaDotfileGroups#mode
|
|
1450
|
+
*/
|
|
1451
|
+
readonly mode?: MiseTomlSchemaDotfileGroupsMode;
|
|
1452
|
+
/**
|
|
1453
|
+
* glob patterns of source paths to skip, as for [dotfiles] exclude
|
|
1454
|
+
*
|
|
1455
|
+
* @schema MiseTomlSchemaDotfileGroups#exclude
|
|
1456
|
+
*/
|
|
1457
|
+
readonly exclude?: string[];
|
|
1458
|
+
/**
|
|
1459
|
+
* deploy each source path component named "dot-<name>" as ".<name>", like GNU Stow's --dotfiles
|
|
1460
|
+
*
|
|
1461
|
+
* @schema MiseTomlSchemaDotfileGroups#dot_prefix
|
|
1462
|
+
*/
|
|
1463
|
+
readonly dotPrefix?: boolean;
|
|
1464
|
+
/**
|
|
1465
|
+
* source manifest used to select managed files from the tree
|
|
1466
|
+
*
|
|
1467
|
+
* @schema MiseTomlSchemaDotfileGroups#manifest
|
|
1468
|
+
*/
|
|
1469
|
+
readonly manifest?: MiseTomlSchemaDotfileGroupsManifest;
|
|
1470
|
+
/**
|
|
1471
|
+
* link by a path relative to the link's directory; overrides the dotfiles.relative_symlinks setting (ignored on Windows)
|
|
1472
|
+
*
|
|
1473
|
+
* @schema MiseTomlSchemaDotfileGroups#relative
|
|
1474
|
+
*/
|
|
1475
|
+
readonly relative?: boolean;
|
|
1476
|
+
/**
|
|
1477
|
+
* 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
|
|
1478
|
+
*
|
|
1479
|
+
* @schema MiseTomlSchemaDotfileGroups#entries
|
|
1480
|
+
*/
|
|
1481
|
+
readonly entries?: {
|
|
1482
|
+
[key: string]: any;
|
|
1483
|
+
};
|
|
1484
|
+
}
|
|
1485
|
+
/**
|
|
1486
|
+
* Converts an object of type 'MiseTomlSchemaDotfileGroups' to JSON representation.
|
|
1487
|
+
* @internal
|
|
1488
|
+
*/
|
|
1489
|
+
export declare function toJson_MiseTomlSchemaDotfileGroups(obj: MiseTomlSchemaDotfileGroups | undefined): Record<string, any> | undefined;
|
|
1416
1490
|
/**
|
|
1417
1491
|
* machine-global bootstrapping (system packages, repos, macOS defaults, launchd agents, login shell)
|
|
1418
1492
|
*
|
|
@@ -1435,6 +1509,12 @@ export interface MiseTomlSchemaBootstrap {
|
|
|
1435
1509
|
readonly directories?: {
|
|
1436
1510
|
[key: string]: MiseTomlSchemaBootstrapDirectories;
|
|
1437
1511
|
};
|
|
1512
|
+
/**
|
|
1513
|
+
* 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
|
|
1514
|
+
*
|
|
1515
|
+
* @schema MiseTomlSchemaBootstrap#dotfile_groups
|
|
1516
|
+
*/
|
|
1517
|
+
readonly dotfileGroups?: string[];
|
|
1438
1518
|
/**
|
|
1439
1519
|
* 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)
|
|
1440
1520
|
*
|
|
@@ -1455,6 +1535,14 @@ export interface MiseTomlSchemaBootstrap {
|
|
|
1455
1535
|
readonly services?: {
|
|
1456
1536
|
[key: string]: MiseTomlSchemaBootstrapServices;
|
|
1457
1537
|
};
|
|
1538
|
+
/**
|
|
1539
|
+
* Docker Compose projects managed with `mise bootstrap compose`, keyed by project name. Text fields support Tera templates.
|
|
1540
|
+
*
|
|
1541
|
+
* @schema MiseTomlSchemaBootstrap#compose
|
|
1542
|
+
*/
|
|
1543
|
+
readonly compose?: {
|
|
1544
|
+
[key: string]: MiseTomlSchemaBootstrapCompose;
|
|
1545
|
+
};
|
|
1458
1546
|
/**
|
|
1459
1547
|
* package manager plugins to install with `mise bootstrap plugins apply`, keyed by manager name
|
|
1460
1548
|
*
|
|
@@ -3507,6 +3595,28 @@ export interface SettingsZig {
|
|
|
3507
3595
|
* @internal
|
|
3508
3596
|
*/
|
|
3509
3597
|
export declare function toJson_SettingsZig(obj: SettingsZig | undefined): Record<string, any> | undefined;
|
|
3598
|
+
/**
|
|
3599
|
+
* how the tree is deployed
|
|
3600
|
+
*
|
|
3601
|
+
* @schema MiseTomlSchemaDotfileGroupsMode
|
|
3602
|
+
*/
|
|
3603
|
+
export declare enum MiseTomlSchemaDotfileGroupsMode {
|
|
3604
|
+
/** symlink-each */
|
|
3605
|
+
SYMLINK_HYPHEN_EACH = "symlink-each",
|
|
3606
|
+
/** copy */
|
|
3607
|
+
COPY = "copy",
|
|
3608
|
+
/** symlink */
|
|
3609
|
+
SYMLINK = "symlink"
|
|
3610
|
+
}
|
|
3611
|
+
/**
|
|
3612
|
+
* source manifest used to select managed files from the tree
|
|
3613
|
+
*
|
|
3614
|
+
* @schema MiseTomlSchemaDotfileGroupsManifest
|
|
3615
|
+
*/
|
|
3616
|
+
export declare enum MiseTomlSchemaDotfileGroupsManifest {
|
|
3617
|
+
/** git */
|
|
3618
|
+
GIT = "git"
|
|
3619
|
+
}
|
|
3510
3620
|
/**
|
|
3511
3621
|
* @schema MiseTomlSchemaBootstrapFiles
|
|
3512
3622
|
*/
|
|
@@ -3732,6 +3842,122 @@ export interface MiseTomlSchemaBootstrapServices {
|
|
|
3732
3842
|
* @internal
|
|
3733
3843
|
*/
|
|
3734
3844
|
export declare function toJson_MiseTomlSchemaBootstrapServices(obj: MiseTomlSchemaBootstrapServices | undefined): Record<string, any> | undefined;
|
|
3845
|
+
/**
|
|
3846
|
+
* @schema MiseTomlSchemaBootstrapCompose
|
|
3847
|
+
*/
|
|
3848
|
+
export interface MiseTomlSchemaBootstrapCompose {
|
|
3849
|
+
/**
|
|
3850
|
+
* absolute directory containing the Compose project
|
|
3851
|
+
*
|
|
3852
|
+
* @schema MiseTomlSchemaBootstrapCompose#project_dir
|
|
3853
|
+
*/
|
|
3854
|
+
readonly projectDir: string;
|
|
3855
|
+
/**
|
|
3856
|
+
* Compose file paths relative to project_dir unless absolute
|
|
3857
|
+
*
|
|
3858
|
+
* @schema MiseTomlSchemaBootstrapCompose#files
|
|
3859
|
+
*/
|
|
3860
|
+
readonly files?: string[];
|
|
3861
|
+
/**
|
|
3862
|
+
* environment file paths relative to project_dir unless absolute
|
|
3863
|
+
*
|
|
3864
|
+
* @schema MiseTomlSchemaBootstrapCompose#env_files
|
|
3865
|
+
*/
|
|
3866
|
+
readonly envFiles?: string[];
|
|
3867
|
+
/**
|
|
3868
|
+
* optional Compose project name
|
|
3869
|
+
*
|
|
3870
|
+
* @schema MiseTomlSchemaBootstrapCompose#project_name
|
|
3871
|
+
*/
|
|
3872
|
+
readonly projectName?: string;
|
|
3873
|
+
/**
|
|
3874
|
+
* @schema MiseTomlSchemaBootstrapCompose#profiles
|
|
3875
|
+
*/
|
|
3876
|
+
readonly profiles?: string[];
|
|
3877
|
+
/**
|
|
3878
|
+
* @schema MiseTomlSchemaBootstrapCompose#services
|
|
3879
|
+
*/
|
|
3880
|
+
readonly services?: string[];
|
|
3881
|
+
/**
|
|
3882
|
+
* @schema MiseTomlSchemaBootstrapCompose#oneshot
|
|
3883
|
+
*/
|
|
3884
|
+
readonly oneshot?: string[];
|
|
3885
|
+
/**
|
|
3886
|
+
* @schema MiseTomlSchemaBootstrapCompose#state
|
|
3887
|
+
*/
|
|
3888
|
+
readonly state?: MiseTomlSchemaBootstrapComposeState;
|
|
3889
|
+
/**
|
|
3890
|
+
* @schema MiseTomlSchemaBootstrapCompose#pull
|
|
3891
|
+
*/
|
|
3892
|
+
readonly pull?: MiseTomlSchemaBootstrapComposePull;
|
|
3893
|
+
/**
|
|
3894
|
+
* @schema MiseTomlSchemaBootstrapCompose#build
|
|
3895
|
+
*/
|
|
3896
|
+
readonly buildValue?: MiseTomlSchemaBootstrapComposeBuild;
|
|
3897
|
+
/**
|
|
3898
|
+
* @schema MiseTomlSchemaBootstrapCompose#recreate
|
|
3899
|
+
*/
|
|
3900
|
+
readonly recreate?: MiseTomlSchemaBootstrapComposeRecreate;
|
|
3901
|
+
/**
|
|
3902
|
+
* @schema MiseTomlSchemaBootstrapCompose#wait
|
|
3903
|
+
*/
|
|
3904
|
+
readonly wait?: boolean;
|
|
3905
|
+
/**
|
|
3906
|
+
* wait timeout in seconds
|
|
3907
|
+
*
|
|
3908
|
+
* @schema MiseTomlSchemaBootstrapCompose#wait_timeout
|
|
3909
|
+
*/
|
|
3910
|
+
readonly waitTimeout?: number;
|
|
3911
|
+
/**
|
|
3912
|
+
* Compose shutdown timeout in seconds
|
|
3913
|
+
*
|
|
3914
|
+
* @schema MiseTomlSchemaBootstrapCompose#timeout
|
|
3915
|
+
*/
|
|
3916
|
+
readonly timeout?: number;
|
|
3917
|
+
/**
|
|
3918
|
+
* @schema MiseTomlSchemaBootstrapCompose#remove_orphans
|
|
3919
|
+
*/
|
|
3920
|
+
readonly removeOrphans?: boolean;
|
|
3921
|
+
/**
|
|
3922
|
+
* @schema MiseTomlSchemaBootstrapCompose#renew_anonymous_volumes
|
|
3923
|
+
*/
|
|
3924
|
+
readonly renewAnonymousVolumes?: boolean;
|
|
3925
|
+
/**
|
|
3926
|
+
* @schema MiseTomlSchemaBootstrapCompose#down_volumes
|
|
3927
|
+
*/
|
|
3928
|
+
readonly downVolumes?: boolean;
|
|
3929
|
+
/**
|
|
3930
|
+
* @schema MiseTomlSchemaBootstrapCompose#down_images
|
|
3931
|
+
*/
|
|
3932
|
+
readonly downImages?: MiseTomlSchemaBootstrapComposeDownImages;
|
|
3933
|
+
/**
|
|
3934
|
+
* @schema MiseTomlSchemaBootstrapCompose#sudo
|
|
3935
|
+
*/
|
|
3936
|
+
readonly sudo?: boolean;
|
|
3937
|
+
/**
|
|
3938
|
+
* standalone Compose command
|
|
3939
|
+
*
|
|
3940
|
+
* @schema MiseTomlSchemaBootstrapCompose#command
|
|
3941
|
+
*/
|
|
3942
|
+
readonly command?: string[];
|
|
3943
|
+
/**
|
|
3944
|
+
* container engine command
|
|
3945
|
+
*
|
|
3946
|
+
* @schema MiseTomlSchemaBootstrapCompose#engine_command
|
|
3947
|
+
*/
|
|
3948
|
+
readonly engineCommand?: string[];
|
|
3949
|
+
/**
|
|
3950
|
+
* bootstrap resource dependencies
|
|
3951
|
+
*
|
|
3952
|
+
* @schema MiseTomlSchemaBootstrapCompose#depends_on
|
|
3953
|
+
*/
|
|
3954
|
+
readonly dependsOn?: string[];
|
|
3955
|
+
}
|
|
3956
|
+
/**
|
|
3957
|
+
* Converts an object of type 'MiseTomlSchemaBootstrapCompose' to JSON representation.
|
|
3958
|
+
* @internal
|
|
3959
|
+
*/
|
|
3960
|
+
export declare function toJson_MiseTomlSchemaBootstrapCompose(obj: MiseTomlSchemaBootstrapCompose | undefined): Record<string, any> | undefined;
|
|
3735
3961
|
/**
|
|
3736
3962
|
* @schema MiseTomlSchemaBootstrapRepos
|
|
3737
3963
|
*/
|
|
@@ -4487,6 +4713,59 @@ export declare enum MiseTomlSchemaBootstrapServicesRestart {
|
|
|
4487
4713
|
/** never */
|
|
4488
4714
|
NEVER = "never"
|
|
4489
4715
|
}
|
|
4716
|
+
/**
|
|
4717
|
+
* @schema MiseTomlSchemaBootstrapComposeState
|
|
4718
|
+
*/
|
|
4719
|
+
export declare enum MiseTomlSchemaBootstrapComposeState {
|
|
4720
|
+
/** running */
|
|
4721
|
+
RUNNING = "running",
|
|
4722
|
+
/** stopped */
|
|
4723
|
+
STOPPED = "stopped",
|
|
4724
|
+
/** absent */
|
|
4725
|
+
ABSENT = "absent"
|
|
4726
|
+
}
|
|
4727
|
+
/**
|
|
4728
|
+
* @schema MiseTomlSchemaBootstrapComposePull
|
|
4729
|
+
*/
|
|
4730
|
+
export declare enum MiseTomlSchemaBootstrapComposePull {
|
|
4731
|
+
/** always */
|
|
4732
|
+
ALWAYS = "always",
|
|
4733
|
+
/** missing */
|
|
4734
|
+
MISSING = "missing",
|
|
4735
|
+
/** never */
|
|
4736
|
+
NEVER = "never"
|
|
4737
|
+
}
|
|
4738
|
+
/**
|
|
4739
|
+
* @schema MiseTomlSchemaBootstrapComposeBuild
|
|
4740
|
+
*/
|
|
4741
|
+
export declare enum MiseTomlSchemaBootstrapComposeBuild {
|
|
4742
|
+
/** auto */
|
|
4743
|
+
AUTO = "auto",
|
|
4744
|
+
/** always */
|
|
4745
|
+
ALWAYS = "always",
|
|
4746
|
+
/** never */
|
|
4747
|
+
NEVER = "never"
|
|
4748
|
+
}
|
|
4749
|
+
/**
|
|
4750
|
+
* @schema MiseTomlSchemaBootstrapComposeRecreate
|
|
4751
|
+
*/
|
|
4752
|
+
export declare enum MiseTomlSchemaBootstrapComposeRecreate {
|
|
4753
|
+
/** auto */
|
|
4754
|
+
AUTO = "auto",
|
|
4755
|
+
/** always */
|
|
4756
|
+
ALWAYS = "always",
|
|
4757
|
+
/** never */
|
|
4758
|
+
NEVER = "never"
|
|
4759
|
+
}
|
|
4760
|
+
/**
|
|
4761
|
+
* @schema MiseTomlSchemaBootstrapComposeDownImages
|
|
4762
|
+
*/
|
|
4763
|
+
export declare enum MiseTomlSchemaBootstrapComposeDownImages {
|
|
4764
|
+
/** local */
|
|
4765
|
+
LOCAL = "local",
|
|
4766
|
+
/** all */
|
|
4767
|
+
ALL = "all"
|
|
4768
|
+
}
|
|
4490
4769
|
/**
|
|
4491
4770
|
* curated Dock preferences that compile into macOS defaults
|
|
4492
4771
|
*
|