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/API.md CHANGED
@@ -914,10 +914,12 @@ const miseTomlSchema: MiseTomlSchema = { ... }
914
914
  | <code><a href="#mise-projen.MiseTomlSchema.property.deps">deps</a></code> | <code><a href="#mise-projen.MiseTomlSchemaDeps">MiseTomlSchemaDeps</a></code> | configure deps providers. |
915
915
  | <code><a href="#mise-projen.MiseTomlSchema.property.doctor">doctor</a></code> | <code><a href="#mise-projen.Doctor">Doctor</a></code> | *No description.* |
916
916
  | <code><a href="#mise-projen.MiseTomlSchema.property.dotenv">dotenv</a></code> | <code>any</code> | dotenv file(s) to load. |
917
+ | <code><a href="#mise-projen.MiseTomlSchema.property.dotfileGroups">dotfileGroups</a></code> | <code>{[ key: string ]: <a href="#mise-projen.MiseTomlSchemaDotfileGroups">MiseTomlSchemaDotfileGroups</a>}</code> | named directory trees of dotfiles, applied with `mise dotfiles apply` or `mise bootstrap` while [bootstrap] dotfile_groups selects them (or is unset). |
917
918
  | <code><a href="#mise-projen.MiseTomlSchema.property.dotfiles">dotfiles</a></code> | <code>{[ key: string ]: any}</code> | dotfiles applied with `mise dotfiles apply` or `mise bootstrap`, keyed by target path or a logical name when every variant overrides the target; |
918
919
  | <code><a href="#mise-projen.MiseTomlSchema.property.env">env</a></code> | <code><a href="#mise-projen.Env">Env</a>[]</code> | environment variables to set. |
919
920
  | <code><a href="#mise-projen.MiseTomlSchema.property.envFile">envFile</a></code> | <code>any</code> | dotenv file(s) to load. |
920
921
  | <code><a href="#mise-projen.MiseTomlSchema.property.envPath">envPath</a></code> | <code>any</code> | PATH entries to add. |
922
+ | <code><a href="#mise-projen.MiseTomlSchema.property.experimentalMonorepoRoot">experimentalMonorepoRoot</a></code> | <code>boolean</code> | deprecated alias of monorepo_root. |
921
923
  | <code><a href="#mise-projen.MiseTomlSchema.property.history">history</a></code> | <code><a href="#mise-projen.MiseTomlSchemaHistory">MiseTomlSchemaHistory</a></code> | dotfiles history: what is never captured, reload commands, and the setup repository (https://mise.jdx.dev/history.html). |
922
924
  | <code><a href="#mise-projen.MiseTomlSchema.property.hooks">hooks</a></code> | <code><a href="#mise-projen.Hooks">Hooks</a></code> | hooks to run on events like cd, enter, leave. |
923
925
  | <code><a href="#mise-projen.MiseTomlSchema.property.include">include</a></code> | <code>any</code> | remote config files merged into this one, ranking just below it: git::<url>//<path>.toml?ref=<ref> or oci::<registry>/<repo>[:tag\|@sha256:<digest>] (the artifact holds a mise.toml). Paranoid mode requires a commit sha or digest; otherwise a branch or tag is refreshed after fetch_remote_versions_cache. |
@@ -1053,6 +1055,18 @@ Deprecated; use env._.file instead. This will be removed in mise 2027.4.0.
1053
1055
 
1054
1056
  ---
1055
1057
 
1058
+ ##### `dotfileGroups`<sup>Optional</sup> <a name="dotfileGroups" id="mise-projen.MiseTomlSchema.property.dotfileGroups"></a>
1059
+
1060
+ ```typescript
1061
+ public readonly dotfileGroups: {[ key: string ]: MiseTomlSchemaDotfileGroups};
1062
+ ```
1063
+
1064
+ - *Type:* {[ key: string ]: <a href="#mise-projen.MiseTomlSchemaDotfileGroups">MiseTomlSchemaDotfileGroups</a>}
1065
+
1066
+ named directory trees of dotfiles, applied with `mise dotfiles apply` or `mise bootstrap` while [bootstrap] dotfile_groups selects them (or is unset).
1067
+
1068
+ ---
1069
+
1056
1070
  ##### `dotfiles`<sup>Optional</sup> <a name="dotfiles" id="mise-projen.MiseTomlSchema.property.dotfiles"></a>
1057
1071
 
1058
1072
  ```typescript
@@ -1107,6 +1121,18 @@ Deprecated; use env._.path instead. This will be removed in mise 2027.4.0.
1107
1121
 
1108
1122
  ---
1109
1123
 
1124
+ ##### `experimentalMonorepoRoot`<sup>Optional</sup> <a name="experimentalMonorepoRoot" id="mise-projen.MiseTomlSchema.property.experimentalMonorepoRoot"></a>
1125
+
1126
+ ```typescript
1127
+ public readonly experimentalMonorepoRoot: boolean;
1128
+ ```
1129
+
1130
+ - *Type:* boolean
1131
+
1132
+ deprecated alias of monorepo_root.
1133
+
1134
+ ---
1135
+
1110
1136
  ##### `history`<sup>Optional</sup> <a name="history" id="mise-projen.MiseTomlSchema.property.history"></a>
1111
1137
 
1112
1138
  ```typescript
@@ -1364,8 +1390,10 @@ const miseTomlSchemaBootstrap: MiseTomlSchemaBootstrap = { ... }
1364
1390
  | **Name** | **Type** | **Description** |
1365
1391
  | --- | --- | --- |
1366
1392
  | <code><a href="#mise-projen.MiseTomlSchemaBootstrap.property.brew">brew</a></code> | <code><a href="#mise-projen.MiseTomlSchemaBootstrapBrew">MiseTomlSchemaBootstrapBrew</a></code> | Homebrew-specific bootstrap package config. |
1393
+ | <code><a href="#mise-projen.MiseTomlSchemaBootstrap.property.compose">compose</a></code> | <code>{[ key: string ]: <a href="#mise-projen.MiseTomlSchemaBootstrapCompose">MiseTomlSchemaBootstrapCompose</a>}</code> | Docker Compose projects managed with `mise bootstrap compose`, keyed by project name. |
1367
1394
  | <code><a href="#mise-projen.MiseTomlSchemaBootstrap.property.configRoots">configRoots</a></code> | <code>string[]</code> | 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). |
1368
1395
  | <code><a href="#mise-projen.MiseTomlSchemaBootstrap.property.directories">directories</a></code> | <code>{[ key: string ]: <a href="#mise-projen.MiseTomlSchemaBootstrapDirectories">MiseTomlSchemaBootstrapDirectories</a>}</code> | Managed system directories keyed by absolute target path. |
1396
+ | <code><a href="#mise-projen.MiseTomlSchemaBootstrap.property.dotfileGroups">dotfileGroups</a></code> | <code>string[]</code> | the dotfile groups this machine applies; |
1369
1397
  | <code><a href="#mise-projen.MiseTomlSchemaBootstrap.property.files">files</a></code> | <code>{[ key: string ]: <a href="#mise-projen.MiseTomlSchemaBootstrapFiles">MiseTomlSchemaBootstrapFiles</a>}</code> | Managed system files keyed by absolute target path. |
1370
1398
  | <code><a href="#mise-projen.MiseTomlSchemaBootstrap.property.hooks">hooks</a></code> | <code><a href="#mise-projen.MiseTomlSchemaBootstrapHooks">MiseTomlSchemaBootstrapHooks</a></code> | commands to run before and after bootstrap phases. |
1371
1399
  | <code><a href="#mise-projen.MiseTomlSchemaBootstrap.property.linux">linux</a></code> | <code><a href="#mise-projen.MiseTomlSchemaBootstrapLinux">MiseTomlSchemaBootstrapLinux</a></code> | Linux-specific bootstrap config. |
@@ -1392,6 +1420,20 @@ Homebrew-specific bootstrap package config.
1392
1420
 
1393
1421
  ---
1394
1422
 
1423
+ ##### `compose`<sup>Optional</sup> <a name="compose" id="mise-projen.MiseTomlSchemaBootstrap.property.compose"></a>
1424
+
1425
+ ```typescript
1426
+ public readonly compose: {[ key: string ]: MiseTomlSchemaBootstrapCompose};
1427
+ ```
1428
+
1429
+ - *Type:* {[ key: string ]: <a href="#mise-projen.MiseTomlSchemaBootstrapCompose">MiseTomlSchemaBootstrapCompose</a>}
1430
+
1431
+ Docker Compose projects managed with `mise bootstrap compose`, keyed by project name.
1432
+
1433
+ Text fields support Tera templates.
1434
+
1435
+ ---
1436
+
1395
1437
  ##### `configRoots`<sup>Optional</sup> <a name="configRoots" id="mise-projen.MiseTomlSchemaBootstrap.property.configRoots"></a>
1396
1438
 
1397
1439
  ```typescript
@@ -1416,6 +1458,20 @@ Managed system directories keyed by absolute target path.
1416
1458
 
1417
1459
  ---
1418
1460
 
1461
+ ##### `dotfileGroups`<sup>Optional</sup> <a name="dotfileGroups" id="mise-projen.MiseTomlSchemaBootstrap.property.dotfileGroups"></a>
1462
+
1463
+ ```typescript
1464
+ public readonly dotfileGroups: string[];
1465
+ ```
1466
+
1467
+ - *Type:* string[]
1468
+
1469
+ the dotfile groups this machine applies;
1470
+
1471
+ when unset, every group applies. Entries without a group always apply, and a more local config's list replaces the others
1472
+
1473
+ ---
1474
+
1419
1475
  ##### `files`<sup>Optional</sup> <a name="files" id="mise-projen.MiseTomlSchemaBootstrap.property.files"></a>
1420
1476
 
1421
1477
  ```typescript
@@ -1593,6 +1649,283 @@ Homebrew tap names mapped to custom git URLs.
1593
1649
 
1594
1650
  ---
1595
1651
 
1652
+ ### MiseTomlSchemaBootstrapCompose <a name="MiseTomlSchemaBootstrapCompose" id="mise-projen.MiseTomlSchemaBootstrapCompose"></a>
1653
+
1654
+ #### Initializer <a name="Initializer" id="mise-projen.MiseTomlSchemaBootstrapCompose.Initializer"></a>
1655
+
1656
+ ```typescript
1657
+ import { MiseTomlSchemaBootstrapCompose } from 'mise-projen'
1658
+
1659
+ const miseTomlSchemaBootstrapCompose: MiseTomlSchemaBootstrapCompose = { ... }
1660
+ ```
1661
+
1662
+ #### Properties <a name="Properties" id="Properties"></a>
1663
+
1664
+ | **Name** | **Type** | **Description** |
1665
+ | --- | --- | --- |
1666
+ | <code><a href="#mise-projen.MiseTomlSchemaBootstrapCompose.property.projectDir">projectDir</a></code> | <code>string</code> | absolute directory containing the Compose project. |
1667
+ | <code><a href="#mise-projen.MiseTomlSchemaBootstrapCompose.property.buildValue">buildValue</a></code> | <code><a href="#mise-projen.MiseTomlSchemaBootstrapComposeBuild">MiseTomlSchemaBootstrapComposeBuild</a></code> | *No description.* |
1668
+ | <code><a href="#mise-projen.MiseTomlSchemaBootstrapCompose.property.command">command</a></code> | <code>string[]</code> | standalone Compose command. |
1669
+ | <code><a href="#mise-projen.MiseTomlSchemaBootstrapCompose.property.dependsOn">dependsOn</a></code> | <code>string[]</code> | bootstrap resource dependencies. |
1670
+ | <code><a href="#mise-projen.MiseTomlSchemaBootstrapCompose.property.downImages">downImages</a></code> | <code><a href="#mise-projen.MiseTomlSchemaBootstrapComposeDownImages">MiseTomlSchemaBootstrapComposeDownImages</a></code> | *No description.* |
1671
+ | <code><a href="#mise-projen.MiseTomlSchemaBootstrapCompose.property.downVolumes">downVolumes</a></code> | <code>boolean</code> | *No description.* |
1672
+ | <code><a href="#mise-projen.MiseTomlSchemaBootstrapCompose.property.engineCommand">engineCommand</a></code> | <code>string[]</code> | container engine command. |
1673
+ | <code><a href="#mise-projen.MiseTomlSchemaBootstrapCompose.property.envFiles">envFiles</a></code> | <code>string[]</code> | environment file paths relative to project_dir unless absolute. |
1674
+ | <code><a href="#mise-projen.MiseTomlSchemaBootstrapCompose.property.files">files</a></code> | <code>string[]</code> | Compose file paths relative to project_dir unless absolute. |
1675
+ | <code><a href="#mise-projen.MiseTomlSchemaBootstrapCompose.property.oneshot">oneshot</a></code> | <code>string[]</code> | *No description.* |
1676
+ | <code><a href="#mise-projen.MiseTomlSchemaBootstrapCompose.property.profiles">profiles</a></code> | <code>string[]</code> | *No description.* |
1677
+ | <code><a href="#mise-projen.MiseTomlSchemaBootstrapCompose.property.projectName">projectName</a></code> | <code>string</code> | optional Compose project name. |
1678
+ | <code><a href="#mise-projen.MiseTomlSchemaBootstrapCompose.property.pull">pull</a></code> | <code><a href="#mise-projen.MiseTomlSchemaBootstrapComposePull">MiseTomlSchemaBootstrapComposePull</a></code> | *No description.* |
1679
+ | <code><a href="#mise-projen.MiseTomlSchemaBootstrapCompose.property.recreate">recreate</a></code> | <code><a href="#mise-projen.MiseTomlSchemaBootstrapComposeRecreate">MiseTomlSchemaBootstrapComposeRecreate</a></code> | *No description.* |
1680
+ | <code><a href="#mise-projen.MiseTomlSchemaBootstrapCompose.property.removeOrphans">removeOrphans</a></code> | <code>boolean</code> | *No description.* |
1681
+ | <code><a href="#mise-projen.MiseTomlSchemaBootstrapCompose.property.renewAnonymousVolumes">renewAnonymousVolumes</a></code> | <code>boolean</code> | *No description.* |
1682
+ | <code><a href="#mise-projen.MiseTomlSchemaBootstrapCompose.property.services">services</a></code> | <code>string[]</code> | *No description.* |
1683
+ | <code><a href="#mise-projen.MiseTomlSchemaBootstrapCompose.property.state">state</a></code> | <code><a href="#mise-projen.MiseTomlSchemaBootstrapComposeState">MiseTomlSchemaBootstrapComposeState</a></code> | *No description.* |
1684
+ | <code><a href="#mise-projen.MiseTomlSchemaBootstrapCompose.property.sudo">sudo</a></code> | <code>boolean</code> | *No description.* |
1685
+ | <code><a href="#mise-projen.MiseTomlSchemaBootstrapCompose.property.timeout">timeout</a></code> | <code>number</code> | Compose shutdown timeout in seconds. |
1686
+ | <code><a href="#mise-projen.MiseTomlSchemaBootstrapCompose.property.wait">wait</a></code> | <code>boolean</code> | *No description.* |
1687
+ | <code><a href="#mise-projen.MiseTomlSchemaBootstrapCompose.property.waitTimeout">waitTimeout</a></code> | <code>number</code> | wait timeout in seconds. |
1688
+
1689
+ ---
1690
+
1691
+ ##### `projectDir`<sup>Required</sup> <a name="projectDir" id="mise-projen.MiseTomlSchemaBootstrapCompose.property.projectDir"></a>
1692
+
1693
+ ```typescript
1694
+ public readonly projectDir: string;
1695
+ ```
1696
+
1697
+ - *Type:* string
1698
+
1699
+ absolute directory containing the Compose project.
1700
+
1701
+ ---
1702
+
1703
+ ##### `buildValue`<sup>Optional</sup> <a name="buildValue" id="mise-projen.MiseTomlSchemaBootstrapCompose.property.buildValue"></a>
1704
+
1705
+ ```typescript
1706
+ public readonly buildValue: MiseTomlSchemaBootstrapComposeBuild;
1707
+ ```
1708
+
1709
+ - *Type:* <a href="#mise-projen.MiseTomlSchemaBootstrapComposeBuild">MiseTomlSchemaBootstrapComposeBuild</a>
1710
+
1711
+ ---
1712
+
1713
+ ##### `command`<sup>Optional</sup> <a name="command" id="mise-projen.MiseTomlSchemaBootstrapCompose.property.command"></a>
1714
+
1715
+ ```typescript
1716
+ public readonly command: string[];
1717
+ ```
1718
+
1719
+ - *Type:* string[]
1720
+
1721
+ standalone Compose command.
1722
+
1723
+ ---
1724
+
1725
+ ##### `dependsOn`<sup>Optional</sup> <a name="dependsOn" id="mise-projen.MiseTomlSchemaBootstrapCompose.property.dependsOn"></a>
1726
+
1727
+ ```typescript
1728
+ public readonly dependsOn: string[];
1729
+ ```
1730
+
1731
+ - *Type:* string[]
1732
+
1733
+ bootstrap resource dependencies.
1734
+
1735
+ ---
1736
+
1737
+ ##### `downImages`<sup>Optional</sup> <a name="downImages" id="mise-projen.MiseTomlSchemaBootstrapCompose.property.downImages"></a>
1738
+
1739
+ ```typescript
1740
+ public readonly downImages: MiseTomlSchemaBootstrapComposeDownImages;
1741
+ ```
1742
+
1743
+ - *Type:* <a href="#mise-projen.MiseTomlSchemaBootstrapComposeDownImages">MiseTomlSchemaBootstrapComposeDownImages</a>
1744
+
1745
+ ---
1746
+
1747
+ ##### `downVolumes`<sup>Optional</sup> <a name="downVolumes" id="mise-projen.MiseTomlSchemaBootstrapCompose.property.downVolumes"></a>
1748
+
1749
+ ```typescript
1750
+ public readonly downVolumes: boolean;
1751
+ ```
1752
+
1753
+ - *Type:* boolean
1754
+
1755
+ ---
1756
+
1757
+ ##### `engineCommand`<sup>Optional</sup> <a name="engineCommand" id="mise-projen.MiseTomlSchemaBootstrapCompose.property.engineCommand"></a>
1758
+
1759
+ ```typescript
1760
+ public readonly engineCommand: string[];
1761
+ ```
1762
+
1763
+ - *Type:* string[]
1764
+
1765
+ container engine command.
1766
+
1767
+ ---
1768
+
1769
+ ##### `envFiles`<sup>Optional</sup> <a name="envFiles" id="mise-projen.MiseTomlSchemaBootstrapCompose.property.envFiles"></a>
1770
+
1771
+ ```typescript
1772
+ public readonly envFiles: string[];
1773
+ ```
1774
+
1775
+ - *Type:* string[]
1776
+
1777
+ environment file paths relative to project_dir unless absolute.
1778
+
1779
+ ---
1780
+
1781
+ ##### `files`<sup>Optional</sup> <a name="files" id="mise-projen.MiseTomlSchemaBootstrapCompose.property.files"></a>
1782
+
1783
+ ```typescript
1784
+ public readonly files: string[];
1785
+ ```
1786
+
1787
+ - *Type:* string[]
1788
+
1789
+ Compose file paths relative to project_dir unless absolute.
1790
+
1791
+ ---
1792
+
1793
+ ##### `oneshot`<sup>Optional</sup> <a name="oneshot" id="mise-projen.MiseTomlSchemaBootstrapCompose.property.oneshot"></a>
1794
+
1795
+ ```typescript
1796
+ public readonly oneshot: string[];
1797
+ ```
1798
+
1799
+ - *Type:* string[]
1800
+
1801
+ ---
1802
+
1803
+ ##### `profiles`<sup>Optional</sup> <a name="profiles" id="mise-projen.MiseTomlSchemaBootstrapCompose.property.profiles"></a>
1804
+
1805
+ ```typescript
1806
+ public readonly profiles: string[];
1807
+ ```
1808
+
1809
+ - *Type:* string[]
1810
+
1811
+ ---
1812
+
1813
+ ##### `projectName`<sup>Optional</sup> <a name="projectName" id="mise-projen.MiseTomlSchemaBootstrapCompose.property.projectName"></a>
1814
+
1815
+ ```typescript
1816
+ public readonly projectName: string;
1817
+ ```
1818
+
1819
+ - *Type:* string
1820
+
1821
+ optional Compose project name.
1822
+
1823
+ ---
1824
+
1825
+ ##### `pull`<sup>Optional</sup> <a name="pull" id="mise-projen.MiseTomlSchemaBootstrapCompose.property.pull"></a>
1826
+
1827
+ ```typescript
1828
+ public readonly pull: MiseTomlSchemaBootstrapComposePull;
1829
+ ```
1830
+
1831
+ - *Type:* <a href="#mise-projen.MiseTomlSchemaBootstrapComposePull">MiseTomlSchemaBootstrapComposePull</a>
1832
+
1833
+ ---
1834
+
1835
+ ##### `recreate`<sup>Optional</sup> <a name="recreate" id="mise-projen.MiseTomlSchemaBootstrapCompose.property.recreate"></a>
1836
+
1837
+ ```typescript
1838
+ public readonly recreate: MiseTomlSchemaBootstrapComposeRecreate;
1839
+ ```
1840
+
1841
+ - *Type:* <a href="#mise-projen.MiseTomlSchemaBootstrapComposeRecreate">MiseTomlSchemaBootstrapComposeRecreate</a>
1842
+
1843
+ ---
1844
+
1845
+ ##### `removeOrphans`<sup>Optional</sup> <a name="removeOrphans" id="mise-projen.MiseTomlSchemaBootstrapCompose.property.removeOrphans"></a>
1846
+
1847
+ ```typescript
1848
+ public readonly removeOrphans: boolean;
1849
+ ```
1850
+
1851
+ - *Type:* boolean
1852
+
1853
+ ---
1854
+
1855
+ ##### `renewAnonymousVolumes`<sup>Optional</sup> <a name="renewAnonymousVolumes" id="mise-projen.MiseTomlSchemaBootstrapCompose.property.renewAnonymousVolumes"></a>
1856
+
1857
+ ```typescript
1858
+ public readonly renewAnonymousVolumes: boolean;
1859
+ ```
1860
+
1861
+ - *Type:* boolean
1862
+
1863
+ ---
1864
+
1865
+ ##### `services`<sup>Optional</sup> <a name="services" id="mise-projen.MiseTomlSchemaBootstrapCompose.property.services"></a>
1866
+
1867
+ ```typescript
1868
+ public readonly services: string[];
1869
+ ```
1870
+
1871
+ - *Type:* string[]
1872
+
1873
+ ---
1874
+
1875
+ ##### `state`<sup>Optional</sup> <a name="state" id="mise-projen.MiseTomlSchemaBootstrapCompose.property.state"></a>
1876
+
1877
+ ```typescript
1878
+ public readonly state: MiseTomlSchemaBootstrapComposeState;
1879
+ ```
1880
+
1881
+ - *Type:* <a href="#mise-projen.MiseTomlSchemaBootstrapComposeState">MiseTomlSchemaBootstrapComposeState</a>
1882
+
1883
+ ---
1884
+
1885
+ ##### `sudo`<sup>Optional</sup> <a name="sudo" id="mise-projen.MiseTomlSchemaBootstrapCompose.property.sudo"></a>
1886
+
1887
+ ```typescript
1888
+ public readonly sudo: boolean;
1889
+ ```
1890
+
1891
+ - *Type:* boolean
1892
+
1893
+ ---
1894
+
1895
+ ##### `timeout`<sup>Optional</sup> <a name="timeout" id="mise-projen.MiseTomlSchemaBootstrapCompose.property.timeout"></a>
1896
+
1897
+ ```typescript
1898
+ public readonly timeout: number;
1899
+ ```
1900
+
1901
+ - *Type:* number
1902
+
1903
+ Compose shutdown timeout in seconds.
1904
+
1905
+ ---
1906
+
1907
+ ##### `wait`<sup>Optional</sup> <a name="wait" id="mise-projen.MiseTomlSchemaBootstrapCompose.property.wait"></a>
1908
+
1909
+ ```typescript
1910
+ public readonly wait: boolean;
1911
+ ```
1912
+
1913
+ - *Type:* boolean
1914
+
1915
+ ---
1916
+
1917
+ ##### `waitTimeout`<sup>Optional</sup> <a name="waitTimeout" id="mise-projen.MiseTomlSchemaBootstrapCompose.property.waitTimeout"></a>
1918
+
1919
+ ```typescript
1920
+ public readonly waitTimeout: number;
1921
+ ```
1922
+
1923
+ - *Type:* number
1924
+
1925
+ wait timeout in seconds.
1926
+
1927
+ ---
1928
+
1596
1929
  ### MiseTomlSchemaBootstrapDirectories <a name="MiseTomlSchemaBootstrapDirectories" id="mise-projen.MiseTomlSchemaBootstrapDirectories"></a>
1597
1930
 
1598
1931
  #### Initializer <a name="Initializer" id="mise-projen.MiseTomlSchemaBootstrapDirectories.Initializer"></a>
@@ -4664,6 +4997,133 @@ public readonly yarn: DepsProvider;
4664
4997
 
4665
4998
  ---
4666
4999
 
5000
+ ### MiseTomlSchemaDotfileGroups <a name="MiseTomlSchemaDotfileGroups" id="mise-projen.MiseTomlSchemaDotfileGroups"></a>
5001
+
5002
+ #### Initializer <a name="Initializer" id="mise-projen.MiseTomlSchemaDotfileGroups.Initializer"></a>
5003
+
5004
+ ```typescript
5005
+ import { MiseTomlSchemaDotfileGroups } from 'mise-projen'
5006
+
5007
+ const miseTomlSchemaDotfileGroups: MiseTomlSchemaDotfileGroups = { ... }
5008
+ ```
5009
+
5010
+ #### Properties <a name="Properties" id="Properties"></a>
5011
+
5012
+ | **Name** | **Type** | **Description** |
5013
+ | --- | --- | --- |
5014
+ | <code><a href="#mise-projen.MiseTomlSchemaDotfileGroups.property.root">root</a></code> | <code>string</code> | the directory tree the group deploys; |
5015
+ | <code><a href="#mise-projen.MiseTomlSchemaDotfileGroups.property.dotPrefix">dotPrefix</a></code> | <code>boolean</code> | deploy each source path component named "dot-<name>" as ".<name>", like GNU Stow's --dotfiles. |
5016
+ | <code><a href="#mise-projen.MiseTomlSchemaDotfileGroups.property.entries">entries</a></code> | <code>{[ key: string ]: any}</code> | whole-file entries for parts of the tree, keyed by target path inside the group's target and written like [dotfiles] entries; |
5017
+ | <code><a href="#mise-projen.MiseTomlSchemaDotfileGroups.property.exclude">exclude</a></code> | <code>string[]</code> | glob patterns of source paths to skip, as for [dotfiles] exclude. |
5018
+ | <code><a href="#mise-projen.MiseTomlSchemaDotfileGroups.property.manifest">manifest</a></code> | <code><a href="#mise-projen.MiseTomlSchemaDotfileGroupsManifest">MiseTomlSchemaDotfileGroupsManifest</a></code> | source manifest used to select managed files from the tree. |
5019
+ | <code><a href="#mise-projen.MiseTomlSchemaDotfileGroups.property.mode">mode</a></code> | <code><a href="#mise-projen.MiseTomlSchemaDotfileGroupsMode">MiseTomlSchemaDotfileGroupsMode</a></code> | how the tree is deployed. |
5020
+ | <code><a href="#mise-projen.MiseTomlSchemaDotfileGroups.property.relative">relative</a></code> | <code>boolean</code> | link by a path relative to the link's directory; |
5021
+ | <code><a href="#mise-projen.MiseTomlSchemaDotfileGroups.property.target">target</a></code> | <code>string</code> | target directory, absolute or starting with ~/. |
5022
+
5023
+ ---
5024
+
5025
+ ##### `root`<sup>Required</sup> <a name="root" id="mise-projen.MiseTomlSchemaDotfileGroups.property.root"></a>
5026
+
5027
+ ```typescript
5028
+ public readonly root: string;
5029
+ ```
5030
+
5031
+ - *Type:* string
5032
+
5033
+ the directory tree the group deploys;
5034
+
5035
+ a relative path resolves against dotfiles.root
5036
+
5037
+ ---
5038
+
5039
+ ##### `dotPrefix`<sup>Optional</sup> <a name="dotPrefix" id="mise-projen.MiseTomlSchemaDotfileGroups.property.dotPrefix"></a>
5040
+
5041
+ ```typescript
5042
+ public readonly dotPrefix: boolean;
5043
+ ```
5044
+
5045
+ - *Type:* boolean
5046
+
5047
+ deploy each source path component named "dot-<name>" as ".<name>", like GNU Stow's --dotfiles.
5048
+
5049
+ ---
5050
+
5051
+ ##### `entries`<sup>Optional</sup> <a name="entries" id="mise-projen.MiseTomlSchemaDotfileGroups.property.entries"></a>
5052
+
5053
+ ```typescript
5054
+ public readonly entries: {[ key: string ]: any};
5055
+ ```
5056
+
5057
+ - *Type:* {[ key: string ]: any}
5058
+
5059
+ whole-file entries for parts of the tree, keyed by target path inside the group's target and written like [dotfiles] entries;
5060
+
5061
+ 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
5062
+
5063
+ ---
5064
+
5065
+ ##### `exclude`<sup>Optional</sup> <a name="exclude" id="mise-projen.MiseTomlSchemaDotfileGroups.property.exclude"></a>
5066
+
5067
+ ```typescript
5068
+ public readonly exclude: string[];
5069
+ ```
5070
+
5071
+ - *Type:* string[]
5072
+
5073
+ glob patterns of source paths to skip, as for [dotfiles] exclude.
5074
+
5075
+ ---
5076
+
5077
+ ##### `manifest`<sup>Optional</sup> <a name="manifest" id="mise-projen.MiseTomlSchemaDotfileGroups.property.manifest"></a>
5078
+
5079
+ ```typescript
5080
+ public readonly manifest: MiseTomlSchemaDotfileGroupsManifest;
5081
+ ```
5082
+
5083
+ - *Type:* <a href="#mise-projen.MiseTomlSchemaDotfileGroupsManifest">MiseTomlSchemaDotfileGroupsManifest</a>
5084
+
5085
+ source manifest used to select managed files from the tree.
5086
+
5087
+ ---
5088
+
5089
+ ##### `mode`<sup>Optional</sup> <a name="mode" id="mise-projen.MiseTomlSchemaDotfileGroups.property.mode"></a>
5090
+
5091
+ ```typescript
5092
+ public readonly mode: MiseTomlSchemaDotfileGroupsMode;
5093
+ ```
5094
+
5095
+ - *Type:* <a href="#mise-projen.MiseTomlSchemaDotfileGroupsMode">MiseTomlSchemaDotfileGroupsMode</a>
5096
+
5097
+ how the tree is deployed.
5098
+
5099
+ ---
5100
+
5101
+ ##### `relative`<sup>Optional</sup> <a name="relative" id="mise-projen.MiseTomlSchemaDotfileGroups.property.relative"></a>
5102
+
5103
+ ```typescript
5104
+ public readonly relative: boolean;
5105
+ ```
5106
+
5107
+ - *Type:* boolean
5108
+
5109
+ link by a path relative to the link's directory;
5110
+
5111
+ overrides the dotfiles.relative_symlinks setting (ignored on Windows)
5112
+
5113
+ ---
5114
+
5115
+ ##### `target`<sup>Optional</sup> <a name="target" id="mise-projen.MiseTomlSchemaDotfileGroups.property.target"></a>
5116
+
5117
+ ```typescript
5118
+ public readonly target: string;
5119
+ ```
5120
+
5121
+ - *Type:* string
5122
+
5123
+ target directory, absolute or starting with ~/.
5124
+
5125
+ ---
5126
+
4667
5127
  ### MiseTomlSchemaHistory <a name="MiseTomlSchemaHistory" id="mise-projen.MiseTomlSchemaHistory"></a>
4668
5128
 
4669
5129
  dotfiles history: what is never captured, reload commands, and the setup repository (https://mise.jdx.dev/history.html).
@@ -11454,6 +11914,163 @@ post-packages.
11454
11914
  ---
11455
11915
 
11456
11916
 
11917
+ ### MiseTomlSchemaBootstrapComposeBuild <a name="MiseTomlSchemaBootstrapComposeBuild" id="mise-projen.MiseTomlSchemaBootstrapComposeBuild"></a>
11918
+
11919
+ #### Members <a name="Members" id="Members"></a>
11920
+
11921
+ | **Name** | **Description** |
11922
+ | --- | --- |
11923
+ | <code><a href="#mise-projen.MiseTomlSchemaBootstrapComposeBuild.AUTO">AUTO</a></code> | auto. |
11924
+ | <code><a href="#mise-projen.MiseTomlSchemaBootstrapComposeBuild.ALWAYS">ALWAYS</a></code> | always. |
11925
+ | <code><a href="#mise-projen.MiseTomlSchemaBootstrapComposeBuild.NEVER">NEVER</a></code> | never. |
11926
+
11927
+ ---
11928
+
11929
+ ##### `AUTO` <a name="AUTO" id="mise-projen.MiseTomlSchemaBootstrapComposeBuild.AUTO"></a>
11930
+
11931
+ auto.
11932
+
11933
+ ---
11934
+
11935
+
11936
+ ##### `ALWAYS` <a name="ALWAYS" id="mise-projen.MiseTomlSchemaBootstrapComposeBuild.ALWAYS"></a>
11937
+
11938
+ always.
11939
+
11940
+ ---
11941
+
11942
+
11943
+ ##### `NEVER` <a name="NEVER" id="mise-projen.MiseTomlSchemaBootstrapComposeBuild.NEVER"></a>
11944
+
11945
+ never.
11946
+
11947
+ ---
11948
+
11949
+
11950
+ ### MiseTomlSchemaBootstrapComposeDownImages <a name="MiseTomlSchemaBootstrapComposeDownImages" id="mise-projen.MiseTomlSchemaBootstrapComposeDownImages"></a>
11951
+
11952
+ #### Members <a name="Members" id="Members"></a>
11953
+
11954
+ | **Name** | **Description** |
11955
+ | --- | --- |
11956
+ | <code><a href="#mise-projen.MiseTomlSchemaBootstrapComposeDownImages.LOCAL">LOCAL</a></code> | local. |
11957
+ | <code><a href="#mise-projen.MiseTomlSchemaBootstrapComposeDownImages.ALL">ALL</a></code> | all. |
11958
+
11959
+ ---
11960
+
11961
+ ##### `LOCAL` <a name="LOCAL" id="mise-projen.MiseTomlSchemaBootstrapComposeDownImages.LOCAL"></a>
11962
+
11963
+ local.
11964
+
11965
+ ---
11966
+
11967
+
11968
+ ##### `ALL` <a name="ALL" id="mise-projen.MiseTomlSchemaBootstrapComposeDownImages.ALL"></a>
11969
+
11970
+ all.
11971
+
11972
+ ---
11973
+
11974
+
11975
+ ### MiseTomlSchemaBootstrapComposePull <a name="MiseTomlSchemaBootstrapComposePull" id="mise-projen.MiseTomlSchemaBootstrapComposePull"></a>
11976
+
11977
+ #### Members <a name="Members" id="Members"></a>
11978
+
11979
+ | **Name** | **Description** |
11980
+ | --- | --- |
11981
+ | <code><a href="#mise-projen.MiseTomlSchemaBootstrapComposePull.ALWAYS">ALWAYS</a></code> | always. |
11982
+ | <code><a href="#mise-projen.MiseTomlSchemaBootstrapComposePull.MISSING">MISSING</a></code> | missing. |
11983
+ | <code><a href="#mise-projen.MiseTomlSchemaBootstrapComposePull.NEVER">NEVER</a></code> | never. |
11984
+
11985
+ ---
11986
+
11987
+ ##### `ALWAYS` <a name="ALWAYS" id="mise-projen.MiseTomlSchemaBootstrapComposePull.ALWAYS"></a>
11988
+
11989
+ always.
11990
+
11991
+ ---
11992
+
11993
+
11994
+ ##### `MISSING` <a name="MISSING" id="mise-projen.MiseTomlSchemaBootstrapComposePull.MISSING"></a>
11995
+
11996
+ missing.
11997
+
11998
+ ---
11999
+
12000
+
12001
+ ##### `NEVER` <a name="NEVER" id="mise-projen.MiseTomlSchemaBootstrapComposePull.NEVER"></a>
12002
+
12003
+ never.
12004
+
12005
+ ---
12006
+
12007
+
12008
+ ### MiseTomlSchemaBootstrapComposeRecreate <a name="MiseTomlSchemaBootstrapComposeRecreate" id="mise-projen.MiseTomlSchemaBootstrapComposeRecreate"></a>
12009
+
12010
+ #### Members <a name="Members" id="Members"></a>
12011
+
12012
+ | **Name** | **Description** |
12013
+ | --- | --- |
12014
+ | <code><a href="#mise-projen.MiseTomlSchemaBootstrapComposeRecreate.AUTO">AUTO</a></code> | auto. |
12015
+ | <code><a href="#mise-projen.MiseTomlSchemaBootstrapComposeRecreate.ALWAYS">ALWAYS</a></code> | always. |
12016
+ | <code><a href="#mise-projen.MiseTomlSchemaBootstrapComposeRecreate.NEVER">NEVER</a></code> | never. |
12017
+
12018
+ ---
12019
+
12020
+ ##### `AUTO` <a name="AUTO" id="mise-projen.MiseTomlSchemaBootstrapComposeRecreate.AUTO"></a>
12021
+
12022
+ auto.
12023
+
12024
+ ---
12025
+
12026
+
12027
+ ##### `ALWAYS` <a name="ALWAYS" id="mise-projen.MiseTomlSchemaBootstrapComposeRecreate.ALWAYS"></a>
12028
+
12029
+ always.
12030
+
12031
+ ---
12032
+
12033
+
12034
+ ##### `NEVER` <a name="NEVER" id="mise-projen.MiseTomlSchemaBootstrapComposeRecreate.NEVER"></a>
12035
+
12036
+ never.
12037
+
12038
+ ---
12039
+
12040
+
12041
+ ### MiseTomlSchemaBootstrapComposeState <a name="MiseTomlSchemaBootstrapComposeState" id="mise-projen.MiseTomlSchemaBootstrapComposeState"></a>
12042
+
12043
+ #### Members <a name="Members" id="Members"></a>
12044
+
12045
+ | **Name** | **Description** |
12046
+ | --- | --- |
12047
+ | <code><a href="#mise-projen.MiseTomlSchemaBootstrapComposeState.RUNNING">RUNNING</a></code> | running. |
12048
+ | <code><a href="#mise-projen.MiseTomlSchemaBootstrapComposeState.STOPPED">STOPPED</a></code> | stopped. |
12049
+ | <code><a href="#mise-projen.MiseTomlSchemaBootstrapComposeState.ABSENT">ABSENT</a></code> | absent. |
12050
+
12051
+ ---
12052
+
12053
+ ##### `RUNNING` <a name="RUNNING" id="mise-projen.MiseTomlSchemaBootstrapComposeState.RUNNING"></a>
12054
+
12055
+ running.
12056
+
12057
+ ---
12058
+
12059
+
12060
+ ##### `STOPPED` <a name="STOPPED" id="mise-projen.MiseTomlSchemaBootstrapComposeState.STOPPED"></a>
12061
+
12062
+ stopped.
12063
+
12064
+ ---
12065
+
12066
+
12067
+ ##### `ABSENT` <a name="ABSENT" id="mise-projen.MiseTomlSchemaBootstrapComposeState.ABSENT"></a>
12068
+
12069
+ absent.
12070
+
12071
+ ---
12072
+
12073
+
11457
12074
  ### MiseTomlSchemaBootstrapDirectoriesState <a name="MiseTomlSchemaBootstrapDirectoriesState" id="mise-projen.MiseTomlSchemaBootstrapDirectoriesState"></a>
11458
12075
 
11459
12076
  #### Members <a name="Members" id="Members"></a>
@@ -12197,6 +12814,60 @@ nats.
12197
12814
  ---
12198
12815
 
12199
12816
 
12817
+ ### MiseTomlSchemaDotfileGroupsManifest <a name="MiseTomlSchemaDotfileGroupsManifest" id="mise-projen.MiseTomlSchemaDotfileGroupsManifest"></a>
12818
+
12819
+ source manifest used to select managed files from the tree.
12820
+
12821
+ #### Members <a name="Members" id="Members"></a>
12822
+
12823
+ | **Name** | **Description** |
12824
+ | --- | --- |
12825
+ | <code><a href="#mise-projen.MiseTomlSchemaDotfileGroupsManifest.GIT">GIT</a></code> | git. |
12826
+
12827
+ ---
12828
+
12829
+ ##### `GIT` <a name="GIT" id="mise-projen.MiseTomlSchemaDotfileGroupsManifest.GIT"></a>
12830
+
12831
+ git.
12832
+
12833
+ ---
12834
+
12835
+
12836
+ ### MiseTomlSchemaDotfileGroupsMode <a name="MiseTomlSchemaDotfileGroupsMode" id="mise-projen.MiseTomlSchemaDotfileGroupsMode"></a>
12837
+
12838
+ how the tree is deployed.
12839
+
12840
+ #### Members <a name="Members" id="Members"></a>
12841
+
12842
+ | **Name** | **Description** |
12843
+ | --- | --- |
12844
+ | <code><a href="#mise-projen.MiseTomlSchemaDotfileGroupsMode.SYMLINK_HYPHEN_EACH">SYMLINK_HYPHEN_EACH</a></code> | symlink-each. |
12845
+ | <code><a href="#mise-projen.MiseTomlSchemaDotfileGroupsMode.COPY">COPY</a></code> | copy. |
12846
+ | <code><a href="#mise-projen.MiseTomlSchemaDotfileGroupsMode.SYMLINK">SYMLINK</a></code> | symlink. |
12847
+
12848
+ ---
12849
+
12850
+ ##### `SYMLINK_HYPHEN_EACH` <a name="SYMLINK_HYPHEN_EACH" id="mise-projen.MiseTomlSchemaDotfileGroupsMode.SYMLINK_HYPHEN_EACH"></a>
12851
+
12852
+ symlink-each.
12853
+
12854
+ ---
12855
+
12856
+
12857
+ ##### `COPY` <a name="COPY" id="mise-projen.MiseTomlSchemaDotfileGroupsMode.COPY"></a>
12858
+
12859
+ copy.
12860
+
12861
+ ---
12862
+
12863
+
12864
+ ##### `SYMLINK` <a name="SYMLINK" id="mise-projen.MiseTomlSchemaDotfileGroupsMode.SYMLINK"></a>
12865
+
12866
+ symlink.
12867
+
12868
+ ---
12869
+
12870
+
12200
12871
  ### SettingsColorTheme <a name="SettingsColorTheme" id="mise-projen.SettingsColorTheme"></a>
12201
12872
 
12202
12873
  Theme for interactive prompts (auto/default, charm, base16, catppuccin, dracula).