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/API.md
CHANGED
|
@@ -914,6 +914,7 @@ 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. |
|
|
@@ -928,6 +929,7 @@ const miseTomlSchema: MiseTomlSchema = { ... }
|
|
|
928
929
|
| <code><a href="#mise-projen.MiseTomlSchema.property.oci">oci</a></code> | <code><a href="#mise-projen.MiseTomlSchemaOci">MiseTomlSchemaOci</a></code> | configuration for `mise oci build`. |
|
|
929
930
|
| <code><a href="#mise-projen.MiseTomlSchema.property.plugins">plugins</a></code> | <code>{[ key: string ]: string}</code> | plugins to use. |
|
|
930
931
|
| <code><a href="#mise-projen.MiseTomlSchema.property.redactions">redactions</a></code> | <code>string[]</code> | env or vars keys to redact from logs. |
|
|
932
|
+
| <code><a href="#mise-projen.MiseTomlSchema.property.secrets">secrets</a></code> | <code><a href="#mise-projen.MiseTomlSchemaSecrets">MiseTomlSchemaSecrets</a></code> | [experimental] Sources for mise secrets: values resolved only when mise starts a task or `mise x` command that was granted them. |
|
|
931
933
|
| <code><a href="#mise-projen.MiseTomlSchema.property.settings">settings</a></code> | <code><a href="#mise-projen.Settings">Settings</a></code> | mise settings. |
|
|
932
934
|
| <code><a href="#mise-projen.MiseTomlSchema.property.shellAlias">shellAlias</a></code> | <code>{[ key: string ]: string}</code> | shell aliases. |
|
|
933
935
|
| <code><a href="#mise-projen.MiseTomlSchema.property.taskConfig">taskConfig</a></code> | <code><a href="#mise-projen.TaskConfig">TaskConfig</a></code> | configuration for task execution and management. |
|
|
@@ -1054,6 +1056,18 @@ Deprecated; use env._.file instead. This will be removed in mise 2027.4.0.
|
|
|
1054
1056
|
|
|
1055
1057
|
---
|
|
1056
1058
|
|
|
1059
|
+
##### `dotfileGroups`<sup>Optional</sup> <a name="dotfileGroups" id="mise-projen.MiseTomlSchema.property.dotfileGroups"></a>
|
|
1060
|
+
|
|
1061
|
+
```typescript
|
|
1062
|
+
public readonly dotfileGroups: {[ key: string ]: MiseTomlSchemaDotfileGroups};
|
|
1063
|
+
```
|
|
1064
|
+
|
|
1065
|
+
- *Type:* {[ key: string ]: <a href="#mise-projen.MiseTomlSchemaDotfileGroups">MiseTomlSchemaDotfileGroups</a>}
|
|
1066
|
+
|
|
1067
|
+
named directory trees of dotfiles, applied with `mise dotfiles apply` or `mise bootstrap` while [bootstrap] dotfile_groups selects them (or is unset).
|
|
1068
|
+
|
|
1069
|
+
---
|
|
1070
|
+
|
|
1057
1071
|
##### `dotfiles`<sup>Optional</sup> <a name="dotfiles" id="mise-projen.MiseTomlSchema.property.dotfiles"></a>
|
|
1058
1072
|
|
|
1059
1073
|
```typescript
|
|
@@ -1228,6 +1242,20 @@ env or vars keys to redact from logs.
|
|
|
1228
1242
|
|
|
1229
1243
|
---
|
|
1230
1244
|
|
|
1245
|
+
##### `secrets`<sup>Optional</sup> <a name="secrets" id="mise-projen.MiseTomlSchema.property.secrets"></a>
|
|
1246
|
+
|
|
1247
|
+
```typescript
|
|
1248
|
+
public readonly secrets: MiseTomlSchemaSecrets;
|
|
1249
|
+
```
|
|
1250
|
+
|
|
1251
|
+
- *Type:* <a href="#mise-projen.MiseTomlSchemaSecrets">MiseTomlSchemaSecrets</a>
|
|
1252
|
+
|
|
1253
|
+
[experimental] Sources for mise secrets: values resolved only when mise starts a task or `mise x` command that was granted them.
|
|
1254
|
+
|
|
1255
|
+
Project config only.
|
|
1256
|
+
|
|
1257
|
+
---
|
|
1258
|
+
|
|
1231
1259
|
##### `settings`<sup>Optional</sup> <a name="settings" id="mise-projen.MiseTomlSchema.property.settings"></a>
|
|
1232
1260
|
|
|
1233
1261
|
```typescript
|
|
@@ -1377,8 +1405,10 @@ const miseTomlSchemaBootstrap: MiseTomlSchemaBootstrap = { ... }
|
|
|
1377
1405
|
| **Name** | **Type** | **Description** |
|
|
1378
1406
|
| --- | --- | --- |
|
|
1379
1407
|
| <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. |
|
|
1408
|
+
| <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. |
|
|
1380
1409
|
| <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). |
|
|
1381
1410
|
| <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. |
|
|
1411
|
+
| <code><a href="#mise-projen.MiseTomlSchemaBootstrap.property.dotfileGroups">dotfileGroups</a></code> | <code>string[]</code> | the dotfile groups this machine applies; |
|
|
1382
1412
|
| <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. |
|
|
1383
1413
|
| <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. |
|
|
1384
1414
|
| <code><a href="#mise-projen.MiseTomlSchemaBootstrap.property.linux">linux</a></code> | <code><a href="#mise-projen.MiseTomlSchemaBootstrapLinux">MiseTomlSchemaBootstrapLinux</a></code> | Linux-specific bootstrap config. |
|
|
@@ -1405,6 +1435,20 @@ Homebrew-specific bootstrap package config.
|
|
|
1405
1435
|
|
|
1406
1436
|
---
|
|
1407
1437
|
|
|
1438
|
+
##### `compose`<sup>Optional</sup> <a name="compose" id="mise-projen.MiseTomlSchemaBootstrap.property.compose"></a>
|
|
1439
|
+
|
|
1440
|
+
```typescript
|
|
1441
|
+
public readonly compose: {[ key: string ]: MiseTomlSchemaBootstrapCompose};
|
|
1442
|
+
```
|
|
1443
|
+
|
|
1444
|
+
- *Type:* {[ key: string ]: <a href="#mise-projen.MiseTomlSchemaBootstrapCompose">MiseTomlSchemaBootstrapCompose</a>}
|
|
1445
|
+
|
|
1446
|
+
Docker Compose projects managed with `mise bootstrap compose`, keyed by project name.
|
|
1447
|
+
|
|
1448
|
+
Text fields support Tera templates.
|
|
1449
|
+
|
|
1450
|
+
---
|
|
1451
|
+
|
|
1408
1452
|
##### `configRoots`<sup>Optional</sup> <a name="configRoots" id="mise-projen.MiseTomlSchemaBootstrap.property.configRoots"></a>
|
|
1409
1453
|
|
|
1410
1454
|
```typescript
|
|
@@ -1429,6 +1473,20 @@ Managed system directories keyed by absolute target path.
|
|
|
1429
1473
|
|
|
1430
1474
|
---
|
|
1431
1475
|
|
|
1476
|
+
##### `dotfileGroups`<sup>Optional</sup> <a name="dotfileGroups" id="mise-projen.MiseTomlSchemaBootstrap.property.dotfileGroups"></a>
|
|
1477
|
+
|
|
1478
|
+
```typescript
|
|
1479
|
+
public readonly dotfileGroups: string[];
|
|
1480
|
+
```
|
|
1481
|
+
|
|
1482
|
+
- *Type:* string[]
|
|
1483
|
+
|
|
1484
|
+
the dotfile groups this machine applies;
|
|
1485
|
+
|
|
1486
|
+
when unset, every group applies. Entries without a group always apply, and a more local config's list replaces the others
|
|
1487
|
+
|
|
1488
|
+
---
|
|
1489
|
+
|
|
1432
1490
|
##### `files`<sup>Optional</sup> <a name="files" id="mise-projen.MiseTomlSchemaBootstrap.property.files"></a>
|
|
1433
1491
|
|
|
1434
1492
|
```typescript
|
|
@@ -1606,6 +1664,283 @@ Homebrew tap names mapped to custom git URLs.
|
|
|
1606
1664
|
|
|
1607
1665
|
---
|
|
1608
1666
|
|
|
1667
|
+
### MiseTomlSchemaBootstrapCompose <a name="MiseTomlSchemaBootstrapCompose" id="mise-projen.MiseTomlSchemaBootstrapCompose"></a>
|
|
1668
|
+
|
|
1669
|
+
#### Initializer <a name="Initializer" id="mise-projen.MiseTomlSchemaBootstrapCompose.Initializer"></a>
|
|
1670
|
+
|
|
1671
|
+
```typescript
|
|
1672
|
+
import { MiseTomlSchemaBootstrapCompose } from 'mise-projen'
|
|
1673
|
+
|
|
1674
|
+
const miseTomlSchemaBootstrapCompose: MiseTomlSchemaBootstrapCompose = { ... }
|
|
1675
|
+
```
|
|
1676
|
+
|
|
1677
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
1678
|
+
|
|
1679
|
+
| **Name** | **Type** | **Description** |
|
|
1680
|
+
| --- | --- | --- |
|
|
1681
|
+
| <code><a href="#mise-projen.MiseTomlSchemaBootstrapCompose.property.projectDir">projectDir</a></code> | <code>string</code> | absolute directory containing the Compose project. |
|
|
1682
|
+
| <code><a href="#mise-projen.MiseTomlSchemaBootstrapCompose.property.buildValue">buildValue</a></code> | <code><a href="#mise-projen.MiseTomlSchemaBootstrapComposeBuild">MiseTomlSchemaBootstrapComposeBuild</a></code> | *No description.* |
|
|
1683
|
+
| <code><a href="#mise-projen.MiseTomlSchemaBootstrapCompose.property.command">command</a></code> | <code>string[]</code> | standalone Compose command. |
|
|
1684
|
+
| <code><a href="#mise-projen.MiseTomlSchemaBootstrapCompose.property.dependsOn">dependsOn</a></code> | <code>string[]</code> | bootstrap resource dependencies. |
|
|
1685
|
+
| <code><a href="#mise-projen.MiseTomlSchemaBootstrapCompose.property.downImages">downImages</a></code> | <code><a href="#mise-projen.MiseTomlSchemaBootstrapComposeDownImages">MiseTomlSchemaBootstrapComposeDownImages</a></code> | *No description.* |
|
|
1686
|
+
| <code><a href="#mise-projen.MiseTomlSchemaBootstrapCompose.property.downVolumes">downVolumes</a></code> | <code>boolean</code> | *No description.* |
|
|
1687
|
+
| <code><a href="#mise-projen.MiseTomlSchemaBootstrapCompose.property.engineCommand">engineCommand</a></code> | <code>string[]</code> | container engine command. |
|
|
1688
|
+
| <code><a href="#mise-projen.MiseTomlSchemaBootstrapCompose.property.envFiles">envFiles</a></code> | <code>string[]</code> | environment file paths relative to project_dir unless absolute. |
|
|
1689
|
+
| <code><a href="#mise-projen.MiseTomlSchemaBootstrapCompose.property.files">files</a></code> | <code>string[]</code> | Compose file paths relative to project_dir unless absolute. |
|
|
1690
|
+
| <code><a href="#mise-projen.MiseTomlSchemaBootstrapCompose.property.oneshot">oneshot</a></code> | <code>string[]</code> | *No description.* |
|
|
1691
|
+
| <code><a href="#mise-projen.MiseTomlSchemaBootstrapCompose.property.profiles">profiles</a></code> | <code>string[]</code> | *No description.* |
|
|
1692
|
+
| <code><a href="#mise-projen.MiseTomlSchemaBootstrapCompose.property.projectName">projectName</a></code> | <code>string</code> | optional Compose project name. |
|
|
1693
|
+
| <code><a href="#mise-projen.MiseTomlSchemaBootstrapCompose.property.pull">pull</a></code> | <code><a href="#mise-projen.MiseTomlSchemaBootstrapComposePull">MiseTomlSchemaBootstrapComposePull</a></code> | *No description.* |
|
|
1694
|
+
| <code><a href="#mise-projen.MiseTomlSchemaBootstrapCompose.property.recreate">recreate</a></code> | <code><a href="#mise-projen.MiseTomlSchemaBootstrapComposeRecreate">MiseTomlSchemaBootstrapComposeRecreate</a></code> | *No description.* |
|
|
1695
|
+
| <code><a href="#mise-projen.MiseTomlSchemaBootstrapCompose.property.removeOrphans">removeOrphans</a></code> | <code>boolean</code> | *No description.* |
|
|
1696
|
+
| <code><a href="#mise-projen.MiseTomlSchemaBootstrapCompose.property.renewAnonymousVolumes">renewAnonymousVolumes</a></code> | <code>boolean</code> | *No description.* |
|
|
1697
|
+
| <code><a href="#mise-projen.MiseTomlSchemaBootstrapCompose.property.services">services</a></code> | <code>string[]</code> | *No description.* |
|
|
1698
|
+
| <code><a href="#mise-projen.MiseTomlSchemaBootstrapCompose.property.state">state</a></code> | <code><a href="#mise-projen.MiseTomlSchemaBootstrapComposeState">MiseTomlSchemaBootstrapComposeState</a></code> | *No description.* |
|
|
1699
|
+
| <code><a href="#mise-projen.MiseTomlSchemaBootstrapCompose.property.sudo">sudo</a></code> | <code>boolean</code> | *No description.* |
|
|
1700
|
+
| <code><a href="#mise-projen.MiseTomlSchemaBootstrapCompose.property.timeout">timeout</a></code> | <code>number</code> | Compose shutdown timeout in seconds. |
|
|
1701
|
+
| <code><a href="#mise-projen.MiseTomlSchemaBootstrapCompose.property.wait">wait</a></code> | <code>boolean</code> | *No description.* |
|
|
1702
|
+
| <code><a href="#mise-projen.MiseTomlSchemaBootstrapCompose.property.waitTimeout">waitTimeout</a></code> | <code>number</code> | wait timeout in seconds. |
|
|
1703
|
+
|
|
1704
|
+
---
|
|
1705
|
+
|
|
1706
|
+
##### `projectDir`<sup>Required</sup> <a name="projectDir" id="mise-projen.MiseTomlSchemaBootstrapCompose.property.projectDir"></a>
|
|
1707
|
+
|
|
1708
|
+
```typescript
|
|
1709
|
+
public readonly projectDir: string;
|
|
1710
|
+
```
|
|
1711
|
+
|
|
1712
|
+
- *Type:* string
|
|
1713
|
+
|
|
1714
|
+
absolute directory containing the Compose project.
|
|
1715
|
+
|
|
1716
|
+
---
|
|
1717
|
+
|
|
1718
|
+
##### `buildValue`<sup>Optional</sup> <a name="buildValue" id="mise-projen.MiseTomlSchemaBootstrapCompose.property.buildValue"></a>
|
|
1719
|
+
|
|
1720
|
+
```typescript
|
|
1721
|
+
public readonly buildValue: MiseTomlSchemaBootstrapComposeBuild;
|
|
1722
|
+
```
|
|
1723
|
+
|
|
1724
|
+
- *Type:* <a href="#mise-projen.MiseTomlSchemaBootstrapComposeBuild">MiseTomlSchemaBootstrapComposeBuild</a>
|
|
1725
|
+
|
|
1726
|
+
---
|
|
1727
|
+
|
|
1728
|
+
##### `command`<sup>Optional</sup> <a name="command" id="mise-projen.MiseTomlSchemaBootstrapCompose.property.command"></a>
|
|
1729
|
+
|
|
1730
|
+
```typescript
|
|
1731
|
+
public readonly command: string[];
|
|
1732
|
+
```
|
|
1733
|
+
|
|
1734
|
+
- *Type:* string[]
|
|
1735
|
+
|
|
1736
|
+
standalone Compose command.
|
|
1737
|
+
|
|
1738
|
+
---
|
|
1739
|
+
|
|
1740
|
+
##### `dependsOn`<sup>Optional</sup> <a name="dependsOn" id="mise-projen.MiseTomlSchemaBootstrapCompose.property.dependsOn"></a>
|
|
1741
|
+
|
|
1742
|
+
```typescript
|
|
1743
|
+
public readonly dependsOn: string[];
|
|
1744
|
+
```
|
|
1745
|
+
|
|
1746
|
+
- *Type:* string[]
|
|
1747
|
+
|
|
1748
|
+
bootstrap resource dependencies.
|
|
1749
|
+
|
|
1750
|
+
---
|
|
1751
|
+
|
|
1752
|
+
##### `downImages`<sup>Optional</sup> <a name="downImages" id="mise-projen.MiseTomlSchemaBootstrapCompose.property.downImages"></a>
|
|
1753
|
+
|
|
1754
|
+
```typescript
|
|
1755
|
+
public readonly downImages: MiseTomlSchemaBootstrapComposeDownImages;
|
|
1756
|
+
```
|
|
1757
|
+
|
|
1758
|
+
- *Type:* <a href="#mise-projen.MiseTomlSchemaBootstrapComposeDownImages">MiseTomlSchemaBootstrapComposeDownImages</a>
|
|
1759
|
+
|
|
1760
|
+
---
|
|
1761
|
+
|
|
1762
|
+
##### `downVolumes`<sup>Optional</sup> <a name="downVolumes" id="mise-projen.MiseTomlSchemaBootstrapCompose.property.downVolumes"></a>
|
|
1763
|
+
|
|
1764
|
+
```typescript
|
|
1765
|
+
public readonly downVolumes: boolean;
|
|
1766
|
+
```
|
|
1767
|
+
|
|
1768
|
+
- *Type:* boolean
|
|
1769
|
+
|
|
1770
|
+
---
|
|
1771
|
+
|
|
1772
|
+
##### `engineCommand`<sup>Optional</sup> <a name="engineCommand" id="mise-projen.MiseTomlSchemaBootstrapCompose.property.engineCommand"></a>
|
|
1773
|
+
|
|
1774
|
+
```typescript
|
|
1775
|
+
public readonly engineCommand: string[];
|
|
1776
|
+
```
|
|
1777
|
+
|
|
1778
|
+
- *Type:* string[]
|
|
1779
|
+
|
|
1780
|
+
container engine command.
|
|
1781
|
+
|
|
1782
|
+
---
|
|
1783
|
+
|
|
1784
|
+
##### `envFiles`<sup>Optional</sup> <a name="envFiles" id="mise-projen.MiseTomlSchemaBootstrapCompose.property.envFiles"></a>
|
|
1785
|
+
|
|
1786
|
+
```typescript
|
|
1787
|
+
public readonly envFiles: string[];
|
|
1788
|
+
```
|
|
1789
|
+
|
|
1790
|
+
- *Type:* string[]
|
|
1791
|
+
|
|
1792
|
+
environment file paths relative to project_dir unless absolute.
|
|
1793
|
+
|
|
1794
|
+
---
|
|
1795
|
+
|
|
1796
|
+
##### `files`<sup>Optional</sup> <a name="files" id="mise-projen.MiseTomlSchemaBootstrapCompose.property.files"></a>
|
|
1797
|
+
|
|
1798
|
+
```typescript
|
|
1799
|
+
public readonly files: string[];
|
|
1800
|
+
```
|
|
1801
|
+
|
|
1802
|
+
- *Type:* string[]
|
|
1803
|
+
|
|
1804
|
+
Compose file paths relative to project_dir unless absolute.
|
|
1805
|
+
|
|
1806
|
+
---
|
|
1807
|
+
|
|
1808
|
+
##### `oneshot`<sup>Optional</sup> <a name="oneshot" id="mise-projen.MiseTomlSchemaBootstrapCompose.property.oneshot"></a>
|
|
1809
|
+
|
|
1810
|
+
```typescript
|
|
1811
|
+
public readonly oneshot: string[];
|
|
1812
|
+
```
|
|
1813
|
+
|
|
1814
|
+
- *Type:* string[]
|
|
1815
|
+
|
|
1816
|
+
---
|
|
1817
|
+
|
|
1818
|
+
##### `profiles`<sup>Optional</sup> <a name="profiles" id="mise-projen.MiseTomlSchemaBootstrapCompose.property.profiles"></a>
|
|
1819
|
+
|
|
1820
|
+
```typescript
|
|
1821
|
+
public readonly profiles: string[];
|
|
1822
|
+
```
|
|
1823
|
+
|
|
1824
|
+
- *Type:* string[]
|
|
1825
|
+
|
|
1826
|
+
---
|
|
1827
|
+
|
|
1828
|
+
##### `projectName`<sup>Optional</sup> <a name="projectName" id="mise-projen.MiseTomlSchemaBootstrapCompose.property.projectName"></a>
|
|
1829
|
+
|
|
1830
|
+
```typescript
|
|
1831
|
+
public readonly projectName: string;
|
|
1832
|
+
```
|
|
1833
|
+
|
|
1834
|
+
- *Type:* string
|
|
1835
|
+
|
|
1836
|
+
optional Compose project name.
|
|
1837
|
+
|
|
1838
|
+
---
|
|
1839
|
+
|
|
1840
|
+
##### `pull`<sup>Optional</sup> <a name="pull" id="mise-projen.MiseTomlSchemaBootstrapCompose.property.pull"></a>
|
|
1841
|
+
|
|
1842
|
+
```typescript
|
|
1843
|
+
public readonly pull: MiseTomlSchemaBootstrapComposePull;
|
|
1844
|
+
```
|
|
1845
|
+
|
|
1846
|
+
- *Type:* <a href="#mise-projen.MiseTomlSchemaBootstrapComposePull">MiseTomlSchemaBootstrapComposePull</a>
|
|
1847
|
+
|
|
1848
|
+
---
|
|
1849
|
+
|
|
1850
|
+
##### `recreate`<sup>Optional</sup> <a name="recreate" id="mise-projen.MiseTomlSchemaBootstrapCompose.property.recreate"></a>
|
|
1851
|
+
|
|
1852
|
+
```typescript
|
|
1853
|
+
public readonly recreate: MiseTomlSchemaBootstrapComposeRecreate;
|
|
1854
|
+
```
|
|
1855
|
+
|
|
1856
|
+
- *Type:* <a href="#mise-projen.MiseTomlSchemaBootstrapComposeRecreate">MiseTomlSchemaBootstrapComposeRecreate</a>
|
|
1857
|
+
|
|
1858
|
+
---
|
|
1859
|
+
|
|
1860
|
+
##### `removeOrphans`<sup>Optional</sup> <a name="removeOrphans" id="mise-projen.MiseTomlSchemaBootstrapCompose.property.removeOrphans"></a>
|
|
1861
|
+
|
|
1862
|
+
```typescript
|
|
1863
|
+
public readonly removeOrphans: boolean;
|
|
1864
|
+
```
|
|
1865
|
+
|
|
1866
|
+
- *Type:* boolean
|
|
1867
|
+
|
|
1868
|
+
---
|
|
1869
|
+
|
|
1870
|
+
##### `renewAnonymousVolumes`<sup>Optional</sup> <a name="renewAnonymousVolumes" id="mise-projen.MiseTomlSchemaBootstrapCompose.property.renewAnonymousVolumes"></a>
|
|
1871
|
+
|
|
1872
|
+
```typescript
|
|
1873
|
+
public readonly renewAnonymousVolumes: boolean;
|
|
1874
|
+
```
|
|
1875
|
+
|
|
1876
|
+
- *Type:* boolean
|
|
1877
|
+
|
|
1878
|
+
---
|
|
1879
|
+
|
|
1880
|
+
##### `services`<sup>Optional</sup> <a name="services" id="mise-projen.MiseTomlSchemaBootstrapCompose.property.services"></a>
|
|
1881
|
+
|
|
1882
|
+
```typescript
|
|
1883
|
+
public readonly services: string[];
|
|
1884
|
+
```
|
|
1885
|
+
|
|
1886
|
+
- *Type:* string[]
|
|
1887
|
+
|
|
1888
|
+
---
|
|
1889
|
+
|
|
1890
|
+
##### `state`<sup>Optional</sup> <a name="state" id="mise-projen.MiseTomlSchemaBootstrapCompose.property.state"></a>
|
|
1891
|
+
|
|
1892
|
+
```typescript
|
|
1893
|
+
public readonly state: MiseTomlSchemaBootstrapComposeState;
|
|
1894
|
+
```
|
|
1895
|
+
|
|
1896
|
+
- *Type:* <a href="#mise-projen.MiseTomlSchemaBootstrapComposeState">MiseTomlSchemaBootstrapComposeState</a>
|
|
1897
|
+
|
|
1898
|
+
---
|
|
1899
|
+
|
|
1900
|
+
##### `sudo`<sup>Optional</sup> <a name="sudo" id="mise-projen.MiseTomlSchemaBootstrapCompose.property.sudo"></a>
|
|
1901
|
+
|
|
1902
|
+
```typescript
|
|
1903
|
+
public readonly sudo: boolean;
|
|
1904
|
+
```
|
|
1905
|
+
|
|
1906
|
+
- *Type:* boolean
|
|
1907
|
+
|
|
1908
|
+
---
|
|
1909
|
+
|
|
1910
|
+
##### `timeout`<sup>Optional</sup> <a name="timeout" id="mise-projen.MiseTomlSchemaBootstrapCompose.property.timeout"></a>
|
|
1911
|
+
|
|
1912
|
+
```typescript
|
|
1913
|
+
public readonly timeout: number;
|
|
1914
|
+
```
|
|
1915
|
+
|
|
1916
|
+
- *Type:* number
|
|
1917
|
+
|
|
1918
|
+
Compose shutdown timeout in seconds.
|
|
1919
|
+
|
|
1920
|
+
---
|
|
1921
|
+
|
|
1922
|
+
##### `wait`<sup>Optional</sup> <a name="wait" id="mise-projen.MiseTomlSchemaBootstrapCompose.property.wait"></a>
|
|
1923
|
+
|
|
1924
|
+
```typescript
|
|
1925
|
+
public readonly wait: boolean;
|
|
1926
|
+
```
|
|
1927
|
+
|
|
1928
|
+
- *Type:* boolean
|
|
1929
|
+
|
|
1930
|
+
---
|
|
1931
|
+
|
|
1932
|
+
##### `waitTimeout`<sup>Optional</sup> <a name="waitTimeout" id="mise-projen.MiseTomlSchemaBootstrapCompose.property.waitTimeout"></a>
|
|
1933
|
+
|
|
1934
|
+
```typescript
|
|
1935
|
+
public readonly waitTimeout: number;
|
|
1936
|
+
```
|
|
1937
|
+
|
|
1938
|
+
- *Type:* number
|
|
1939
|
+
|
|
1940
|
+
wait timeout in seconds.
|
|
1941
|
+
|
|
1942
|
+
---
|
|
1943
|
+
|
|
1609
1944
|
### MiseTomlSchemaBootstrapDirectories <a name="MiseTomlSchemaBootstrapDirectories" id="mise-projen.MiseTomlSchemaBootstrapDirectories"></a>
|
|
1610
1945
|
|
|
1611
1946
|
#### Initializer <a name="Initializer" id="mise-projen.MiseTomlSchemaBootstrapDirectories.Initializer"></a>
|
|
@@ -4677,55 +5012,182 @@ public readonly yarn: DepsProvider;
|
|
|
4677
5012
|
|
|
4678
5013
|
---
|
|
4679
5014
|
|
|
4680
|
-
###
|
|
4681
|
-
|
|
4682
|
-
dotfiles history: what is never captured, reload commands, and the setup repository (https://mise.jdx.dev/history.html).
|
|
5015
|
+
### MiseTomlSchemaDotfileGroups <a name="MiseTomlSchemaDotfileGroups" id="mise-projen.MiseTomlSchemaDotfileGroups"></a>
|
|
4683
5016
|
|
|
4684
|
-
#### Initializer <a name="Initializer" id="mise-projen.
|
|
5017
|
+
#### Initializer <a name="Initializer" id="mise-projen.MiseTomlSchemaDotfileGroups.Initializer"></a>
|
|
4685
5018
|
|
|
4686
5019
|
```typescript
|
|
4687
|
-
import {
|
|
5020
|
+
import { MiseTomlSchemaDotfileGroups } from 'mise-projen'
|
|
4688
5021
|
|
|
4689
|
-
const
|
|
5022
|
+
const miseTomlSchemaDotfileGroups: MiseTomlSchemaDotfileGroups = { ... }
|
|
4690
5023
|
```
|
|
4691
5024
|
|
|
4692
5025
|
#### Properties <a name="Properties" id="Properties"></a>
|
|
4693
5026
|
|
|
4694
5027
|
| **Name** | **Type** | **Description** |
|
|
4695
5028
|
| --- | --- | --- |
|
|
4696
|
-
| <code><a href="#mise-projen.
|
|
4697
|
-
| <code><a href="#mise-projen.
|
|
4698
|
-
| <code><a href="#mise-projen.
|
|
4699
|
-
| <code><a href="#mise-projen.
|
|
4700
|
-
| <code><a href="#mise-projen.
|
|
5029
|
+
| <code><a href="#mise-projen.MiseTomlSchemaDotfileGroups.property.root">root</a></code> | <code>string</code> | the directory tree the group deploys; |
|
|
5030
|
+
| <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. |
|
|
5031
|
+
| <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; |
|
|
5032
|
+
| <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. |
|
|
5033
|
+
| <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. |
|
|
5034
|
+
| <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. |
|
|
5035
|
+
| <code><a href="#mise-projen.MiseTomlSchemaDotfileGroups.property.relative">relative</a></code> | <code>boolean</code> | link by a path relative to the link's directory; |
|
|
5036
|
+
| <code><a href="#mise-projen.MiseTomlSchemaDotfileGroups.property.target">target</a></code> | <code>string</code> | target directory, absolute or starting with ~/. |
|
|
4701
5037
|
|
|
4702
5038
|
---
|
|
4703
5039
|
|
|
4704
|
-
##### `
|
|
5040
|
+
##### `root`<sup>Required</sup> <a name="root" id="mise-projen.MiseTomlSchemaDotfileGroups.property.root"></a>
|
|
4705
5041
|
|
|
4706
5042
|
```typescript
|
|
4707
|
-
public readonly
|
|
5043
|
+
public readonly root: string;
|
|
4708
5044
|
```
|
|
4709
5045
|
|
|
4710
|
-
- *Type:*
|
|
5046
|
+
- *Type:* string
|
|
5047
|
+
|
|
5048
|
+
the directory tree the group deploys;
|
|
5049
|
+
|
|
5050
|
+
a relative path resolves against dotfiles.root
|
|
4711
5051
|
|
|
4712
5052
|
---
|
|
4713
5053
|
|
|
4714
|
-
##### `
|
|
5054
|
+
##### `dotPrefix`<sup>Optional</sup> <a name="dotPrefix" id="mise-projen.MiseTomlSchemaDotfileGroups.property.dotPrefix"></a>
|
|
4715
5055
|
|
|
4716
5056
|
```typescript
|
|
4717
|
-
public readonly
|
|
5057
|
+
public readonly dotPrefix: boolean;
|
|
4718
5058
|
```
|
|
4719
5059
|
|
|
4720
|
-
- *Type:*
|
|
4721
|
-
|
|
4722
|
-
globs never captured by dotfiles history;
|
|
5060
|
+
- *Type:* boolean
|
|
4723
5061
|
|
|
4724
|
-
|
|
5062
|
+
deploy each source path component named "dot-<name>" as ".<name>", like GNU Stow's --dotfiles.
|
|
4725
5063
|
|
|
4726
5064
|
---
|
|
4727
5065
|
|
|
4728
|
-
##### `
|
|
5066
|
+
##### `entries`<sup>Optional</sup> <a name="entries" id="mise-projen.MiseTomlSchemaDotfileGroups.property.entries"></a>
|
|
5067
|
+
|
|
5068
|
+
```typescript
|
|
5069
|
+
public readonly entries: {[ key: string ]: any};
|
|
5070
|
+
```
|
|
5071
|
+
|
|
5072
|
+
- *Type:* {[ key: string ]: any}
|
|
5073
|
+
|
|
5074
|
+
whole-file entries for parts of the tree, keyed by target path inside the group's target and written like [dotfiles] entries;
|
|
5075
|
+
|
|
5076
|
+
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
|
|
5077
|
+
|
|
5078
|
+
---
|
|
5079
|
+
|
|
5080
|
+
##### `exclude`<sup>Optional</sup> <a name="exclude" id="mise-projen.MiseTomlSchemaDotfileGroups.property.exclude"></a>
|
|
5081
|
+
|
|
5082
|
+
```typescript
|
|
5083
|
+
public readonly exclude: string[];
|
|
5084
|
+
```
|
|
5085
|
+
|
|
5086
|
+
- *Type:* string[]
|
|
5087
|
+
|
|
5088
|
+
glob patterns of source paths to skip, as for [dotfiles] exclude.
|
|
5089
|
+
|
|
5090
|
+
---
|
|
5091
|
+
|
|
5092
|
+
##### `manifest`<sup>Optional</sup> <a name="manifest" id="mise-projen.MiseTomlSchemaDotfileGroups.property.manifest"></a>
|
|
5093
|
+
|
|
5094
|
+
```typescript
|
|
5095
|
+
public readonly manifest: MiseTomlSchemaDotfileGroupsManifest;
|
|
5096
|
+
```
|
|
5097
|
+
|
|
5098
|
+
- *Type:* <a href="#mise-projen.MiseTomlSchemaDotfileGroupsManifest">MiseTomlSchemaDotfileGroupsManifest</a>
|
|
5099
|
+
|
|
5100
|
+
source manifest used to select managed files from the tree.
|
|
5101
|
+
|
|
5102
|
+
---
|
|
5103
|
+
|
|
5104
|
+
##### `mode`<sup>Optional</sup> <a name="mode" id="mise-projen.MiseTomlSchemaDotfileGroups.property.mode"></a>
|
|
5105
|
+
|
|
5106
|
+
```typescript
|
|
5107
|
+
public readonly mode: MiseTomlSchemaDotfileGroupsMode;
|
|
5108
|
+
```
|
|
5109
|
+
|
|
5110
|
+
- *Type:* <a href="#mise-projen.MiseTomlSchemaDotfileGroupsMode">MiseTomlSchemaDotfileGroupsMode</a>
|
|
5111
|
+
|
|
5112
|
+
how the tree is deployed.
|
|
5113
|
+
|
|
5114
|
+
---
|
|
5115
|
+
|
|
5116
|
+
##### `relative`<sup>Optional</sup> <a name="relative" id="mise-projen.MiseTomlSchemaDotfileGroups.property.relative"></a>
|
|
5117
|
+
|
|
5118
|
+
```typescript
|
|
5119
|
+
public readonly relative: boolean;
|
|
5120
|
+
```
|
|
5121
|
+
|
|
5122
|
+
- *Type:* boolean
|
|
5123
|
+
|
|
5124
|
+
link by a path relative to the link's directory;
|
|
5125
|
+
|
|
5126
|
+
overrides the dotfiles.relative_symlinks setting (ignored on Windows)
|
|
5127
|
+
|
|
5128
|
+
---
|
|
5129
|
+
|
|
5130
|
+
##### `target`<sup>Optional</sup> <a name="target" id="mise-projen.MiseTomlSchemaDotfileGroups.property.target"></a>
|
|
5131
|
+
|
|
5132
|
+
```typescript
|
|
5133
|
+
public readonly target: string;
|
|
5134
|
+
```
|
|
5135
|
+
|
|
5136
|
+
- *Type:* string
|
|
5137
|
+
|
|
5138
|
+
target directory, absolute or starting with ~/.
|
|
5139
|
+
|
|
5140
|
+
---
|
|
5141
|
+
|
|
5142
|
+
### MiseTomlSchemaHistory <a name="MiseTomlSchemaHistory" id="mise-projen.MiseTomlSchemaHistory"></a>
|
|
5143
|
+
|
|
5144
|
+
dotfiles history: what is never captured, reload commands, and the setup repository (https://mise.jdx.dev/history.html).
|
|
5145
|
+
|
|
5146
|
+
#### Initializer <a name="Initializer" id="mise-projen.MiseTomlSchemaHistory.Initializer"></a>
|
|
5147
|
+
|
|
5148
|
+
```typescript
|
|
5149
|
+
import { MiseTomlSchemaHistory } from 'mise-projen'
|
|
5150
|
+
|
|
5151
|
+
const miseTomlSchemaHistory: MiseTomlSchemaHistory = { ... }
|
|
5152
|
+
```
|
|
5153
|
+
|
|
5154
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
5155
|
+
|
|
5156
|
+
| **Name** | **Type** | **Description** |
|
|
5157
|
+
| --- | --- | --- |
|
|
5158
|
+
| <code><a href="#mise-projen.MiseTomlSchemaHistory.property.encryption">encryption</a></code> | <code><a href="#mise-projen.MiseTomlSchemaHistoryEncryption">MiseTomlSchemaHistoryEncryption</a></code> | *No description.* |
|
|
5159
|
+
| <code><a href="#mise-projen.MiseTomlSchemaHistory.property.exclude">exclude</a></code> | <code>string[]</code> | globs never captured by dotfiles history; |
|
|
5160
|
+
| <code><a href="#mise-projen.MiseTomlSchemaHistory.property.gitEmail">gitEmail</a></code> | <code>string</code> | email used for history commit authors and committers; |
|
|
5161
|
+
| <code><a href="#mise-projen.MiseTomlSchemaHistory.property.origin">origin</a></code> | <code><a href="#mise-projen.MiseTomlSchemaHistoryOrigin">MiseTomlSchemaHistoryOrigin</a></code> | the setup repository this machine publishes to and fetches from; |
|
|
5162
|
+
| <code><a href="#mise-projen.MiseTomlSchemaHistory.property.reload">reload</a></code> | <code>{[ key: string ]: string}</code> | commands run once after a rollback or undo writes a path matching the glob (trusted global or system config only). |
|
|
5163
|
+
|
|
5164
|
+
---
|
|
5165
|
+
|
|
5166
|
+
##### `encryption`<sup>Optional</sup> <a name="encryption" id="mise-projen.MiseTomlSchemaHistory.property.encryption"></a>
|
|
5167
|
+
|
|
5168
|
+
```typescript
|
|
5169
|
+
public readonly encryption: MiseTomlSchemaHistoryEncryption;
|
|
5170
|
+
```
|
|
5171
|
+
|
|
5172
|
+
- *Type:* <a href="#mise-projen.MiseTomlSchemaHistoryEncryption">MiseTomlSchemaHistoryEncryption</a>
|
|
5173
|
+
|
|
5174
|
+
---
|
|
5175
|
+
|
|
5176
|
+
##### `exclude`<sup>Optional</sup> <a name="exclude" id="mise-projen.MiseTomlSchemaHistory.property.exclude"></a>
|
|
5177
|
+
|
|
5178
|
+
```typescript
|
|
5179
|
+
public readonly exclude: string[];
|
|
5180
|
+
```
|
|
5181
|
+
|
|
5182
|
+
- *Type:* string[]
|
|
5183
|
+
|
|
5184
|
+
globs never captured by dotfiles history;
|
|
5185
|
+
|
|
5186
|
+
a `!glob` entry re-includes a path an earlier glob excluded
|
|
5187
|
+
|
|
5188
|
+
---
|
|
5189
|
+
|
|
5190
|
+
##### `gitEmail`<sup>Optional</sup> <a name="gitEmail" id="mise-projen.MiseTomlSchemaHistory.property.gitEmail"></a>
|
|
4729
5191
|
|
|
4730
5192
|
```typescript
|
|
4731
5193
|
public readonly gitEmail: string;
|
|
@@ -5063,6 +5525,74 @@ absolute non-root image path without `.` or `..` components.
|
|
|
5063
5525
|
|
|
5064
5526
|
---
|
|
5065
5527
|
|
|
5528
|
+
### MiseTomlSchemaSecrets <a name="MiseTomlSchemaSecrets" id="mise-projen.MiseTomlSchemaSecrets"></a>
|
|
5529
|
+
|
|
5530
|
+
[experimental] Sources for mise secrets: values resolved only when mise starts a task or `mise x` command that was granted them.
|
|
5531
|
+
|
|
5532
|
+
Project config only.
|
|
5533
|
+
|
|
5534
|
+
#### Initializer <a name="Initializer" id="mise-projen.MiseTomlSchemaSecrets.Initializer"></a>
|
|
5535
|
+
|
|
5536
|
+
```typescript
|
|
5537
|
+
import { MiseTomlSchemaSecrets } from 'mise-projen'
|
|
5538
|
+
|
|
5539
|
+
const miseTomlSchemaSecrets: MiseTomlSchemaSecrets = { ... }
|
|
5540
|
+
```
|
|
5541
|
+
|
|
5542
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
5543
|
+
|
|
5544
|
+
| **Name** | **Type** | **Description** |
|
|
5545
|
+
| --- | --- | --- |
|
|
5546
|
+
| <code><a href="#mise-projen.MiseTomlSchemaSecrets.property.fnox">fnox</a></code> | <code><a href="#mise-projen.MiseTomlSchemaSecretsFnox">MiseTomlSchemaSecretsFnox</a></code> | Use fnox (fnox.toml discovered from this config's directory). https://mise.jdx.dev/environments/secrets/fnox.html. |
|
|
5547
|
+
|
|
5548
|
+
---
|
|
5549
|
+
|
|
5550
|
+
##### `fnox`<sup>Optional</sup> <a name="fnox" id="mise-projen.MiseTomlSchemaSecrets.property.fnox"></a>
|
|
5551
|
+
|
|
5552
|
+
```typescript
|
|
5553
|
+
public readonly fnox: MiseTomlSchemaSecretsFnox;
|
|
5554
|
+
```
|
|
5555
|
+
|
|
5556
|
+
- *Type:* <a href="#mise-projen.MiseTomlSchemaSecretsFnox">MiseTomlSchemaSecretsFnox</a>
|
|
5557
|
+
|
|
5558
|
+
Use fnox (fnox.toml discovered from this config's directory). https://mise.jdx.dev/environments/secrets/fnox.html.
|
|
5559
|
+
|
|
5560
|
+
---
|
|
5561
|
+
|
|
5562
|
+
### MiseTomlSchemaSecretsFnox <a name="MiseTomlSchemaSecretsFnox" id="mise-projen.MiseTomlSchemaSecretsFnox"></a>
|
|
5563
|
+
|
|
5564
|
+
Use fnox (fnox.toml discovered from this config's directory). https://mise.jdx.dev/environments/secrets/fnox.html.
|
|
5565
|
+
|
|
5566
|
+
#### Initializer <a name="Initializer" id="mise-projen.MiseTomlSchemaSecretsFnox.Initializer"></a>
|
|
5567
|
+
|
|
5568
|
+
```typescript
|
|
5569
|
+
import { MiseTomlSchemaSecretsFnox } from 'mise-projen'
|
|
5570
|
+
|
|
5571
|
+
const miseTomlSchemaSecretsFnox: MiseTomlSchemaSecretsFnox = { ... }
|
|
5572
|
+
```
|
|
5573
|
+
|
|
5574
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
5575
|
+
|
|
5576
|
+
| **Name** | **Type** | **Description** |
|
|
5577
|
+
| --- | --- | --- |
|
|
5578
|
+
| <code><a href="#mise-projen.MiseTomlSchemaSecretsFnox.property.profile">profile</a></code> | <code>string</code> | fnox profile (fnox -P); |
|
|
5579
|
+
|
|
5580
|
+
---
|
|
5581
|
+
|
|
5582
|
+
##### `profile`<sup>Optional</sup> <a name="profile" id="mise-projen.MiseTomlSchemaSecretsFnox.property.profile"></a>
|
|
5583
|
+
|
|
5584
|
+
```typescript
|
|
5585
|
+
public readonly profile: string;
|
|
5586
|
+
```
|
|
5587
|
+
|
|
5588
|
+
- *Type:* string
|
|
5589
|
+
|
|
5590
|
+
fnox profile (fnox -P);
|
|
5591
|
+
|
|
5592
|
+
defaults to FNOX_PROFILE, then "default"
|
|
5593
|
+
|
|
5594
|
+
---
|
|
5595
|
+
|
|
5066
5596
|
### Monorepo <a name="Monorepo" id="mise-projen.Monorepo"></a>
|
|
5067
5597
|
|
|
5068
5598
|
Configuration for monorepo task discovery.
|
|
@@ -5274,8 +5804,8 @@ const settings: Settings = { ... }
|
|
|
5274
5804
|
| <code><a href="#mise-projen.Settings.property.autoEnv">autoEnv</a></code> | <code>boolean</code> | Automatically enable platform config environments (unix, {os}, {os}-{arch}). |
|
|
5275
5805
|
| <code><a href="#mise-projen.Settings.property.autoInstall">autoInstall</a></code> | <code>boolean</code> | Automatically install missing tools when running `mise x`, `mise run`, or as part of the 'not found' handler. |
|
|
5276
5806
|
| <code><a href="#mise-projen.Settings.property.autoInstallDisableTools">autoInstallDisableTools</a></code> | <code>string[]</code> | List of tools to skip automatically installing when running `mise x`, `mise run`, or as part of the 'not found' handler. |
|
|
5277
|
-
| <code><a href="#mise-projen.Settings.property.autoUpdate">autoUpdate</a></code> | <code>boolean</code> |
|
|
5278
|
-
| <code><a href="#mise-projen.Settings.property.autoUpdateCheckDuration">autoUpdateCheckDuration</a></code> | <code>string</code> |
|
|
5807
|
+
| <code><a href="#mise-projen.Settings.property.autoUpdate">autoUpdate</a></code> | <code>boolean</code> | [deprecated] Use `self_update.auto` instead. |
|
|
5808
|
+
| <code><a href="#mise-projen.Settings.property.autoUpdateCheckDuration">autoUpdateCheckDuration</a></code> | <code>string</code> | [deprecated] Use `self_update.check_duration` instead. |
|
|
5279
5809
|
| <code><a href="#mise-projen.Settings.property.cachePruneAge">cachePruneAge</a></code> | <code>string</code> | Delete files in cache that have not been accessed in this duration. |
|
|
5280
5810
|
| <code><a href="#mise-projen.Settings.property.cargo">cargo</a></code> | <code><a href="#mise-projen.SettingsCargo">SettingsCargo</a></code> | *No description.* |
|
|
5281
5811
|
| <code><a href="#mise-projen.Settings.property.cd">cd</a></code> | <code>string</code> | Path to change to after launching mise. |
|
|
@@ -5335,6 +5865,7 @@ const settings: Settings = { ... }
|
|
|
5335
5865
|
| <code><a href="#mise-projen.Settings.property.idiomaticVersionFileIgnoreMinimumVersions">idiomaticVersionFileIgnoreMinimumVersions</a></code> | <code>boolean</code> | Ignore idiomatic version file fields that only declare a minimum compatible version. |
|
|
5336
5866
|
| <code><a href="#mise-projen.Settings.property.ignoredConfigPaths">ignoredConfigPaths</a></code> | <code>string[]</code> | This is a list of config paths that mise will ignore. |
|
|
5337
5867
|
| <code><a href="#mise-projen.Settings.property.installBefore">installBefore</a></code> | <code>string</code> | Minimum release age / supply chain protection — only install versions released before this date. |
|
|
5868
|
+
| <code><a href="#mise-projen.Settings.property.installLayout">installLayout</a></code> | <code><a href="#mise-projen.SettingsInstallLayout">SettingsInstallLayout</a></code> | [experimental] Name installations by what they are (`identity`) instead of `installs/<tool>/<version>` (`legacy`). |
|
|
5338
5869
|
| <code><a href="#mise-projen.Settings.property.java">java</a></code> | <code><a href="#mise-projen.SettingsJava">SettingsJava</a></code> | *No description.* |
|
|
5339
5870
|
| <code><a href="#mise-projen.Settings.property.jobs">jobs</a></code> | <code>number</code> | How many jobs to run concurrently such as tool installs. |
|
|
5340
5871
|
| <code><a href="#mise-projen.Settings.property.legacyVersionFile">legacyVersionFile</a></code> | <code>boolean</code> | Set to false to disable the idiomatic version files such as .node-version, .ruby-version, etc. |
|
|
@@ -5345,6 +5876,7 @@ const settings: Settings = { ... }
|
|
|
5345
5876
|
| <code><a href="#mise-projen.Settings.property.lockedScopes">lockedScopes</a></code> | <code><a href="#mise-projen.SettingsLockedScopes">SettingsLockedScopes</a>[]</code> | Config scopes where invocation-wide locked mode is enforced. |
|
|
5346
5877
|
| <code><a href="#mise-projen.Settings.property.lockedVerifyProvenance">lockedVerifyProvenance</a></code> | <code>boolean</code> | Re-verify provenance at install time even when the lockfile already has provenance. |
|
|
5347
5878
|
| <code><a href="#mise-projen.Settings.property.lockfile">lockfile</a></code> | <code>boolean</code> | Create and read lockfiles for tool versions. |
|
|
5879
|
+
| <code><a href="#mise-projen.Settings.property.lockfileAutoPrune">lockfileAutoPrune</a></code> | <code>boolean</code> | Remove lockfile tools that are absent from the active configuration. |
|
|
5348
5880
|
| <code><a href="#mise-projen.Settings.property.lockfileMode">lockfileMode</a></code> | <code><a href="#mise-projen.SettingsLockfileMode">SettingsLockfileMode</a></code> | Choose incremental merging or complete lockfile generation. |
|
|
5349
5881
|
| <code><a href="#mise-projen.Settings.property.lockfilePlatforms">lockfilePlatforms</a></code> | <code>string[]</code> | Platforms to target in lockfile operations. |
|
|
5350
5882
|
| <code><a href="#mise-projen.Settings.property.logLevel">logLevel</a></code> | <code><a href="#mise-projen.SettingsLogLevel">SettingsLogLevel</a></code> | Show more/less output. |
|
|
@@ -5374,6 +5906,7 @@ const settings: Settings = { ... }
|
|
|
5374
5906
|
| <code><a href="#mise-projen.Settings.property.prereleases">prereleases</a></code> | <code>boolean</code> | Include pre-release versions in `ls-remote`, `latest` resolution, and fuzzy matching for all tools. |
|
|
5375
5907
|
| <code><a href="#mise-projen.Settings.property.profile">profile</a></code> | <code>string</code> | Profile to use for mise.${MISE_PROFILE}.toml files. |
|
|
5376
5908
|
| <code><a href="#mise-projen.Settings.property.provenanceApiFailuresFatal">provenanceApiFailuresFatal</a></code> | <code>boolean</code> | Fail when provenance API checks cannot be completed. |
|
|
5909
|
+
| <code><a href="#mise-projen.Settings.property.prune">prune</a></code> | <code><a href="#mise-projen.SettingsPrune">SettingsPrune</a></code> | *No description.* |
|
|
5377
5910
|
| <code><a href="#mise-projen.Settings.property.pypi">pypi</a></code> | <code><a href="#mise-projen.SettingsPypi">SettingsPypi</a></code> | *No description.* |
|
|
5378
5911
|
| <code><a href="#mise-projen.Settings.property.python">python</a></code> | <code><a href="#mise-projen.SettingsPython">SettingsPython</a></code> | *No description.* |
|
|
5379
5912
|
| <code><a href="#mise-projen.Settings.property.quiet">quiet</a></code> | <code>boolean</code> | Suppress all output except errors. |
|
|
@@ -5413,6 +5946,7 @@ const settings: Settings = { ... }
|
|
|
5413
5946
|
| <code><a href="#mise-projen.Settings.property.taskTimings">taskTimings</a></code> | <code>boolean</code> | Show completion message with elapsed time for each task on `mise run`. |
|
|
5414
5947
|
| <code><a href="#mise-projen.Settings.property.teraV1">teraV1</a></code> | <code>boolean</code> | Use Tera v1 instead of Tera v2 for template rendering. |
|
|
5415
5948
|
| <code><a href="#mise-projen.Settings.property.terminalProgress">terminalProgress</a></code> | <code>boolean</code> | Enable terminal progress indicators (OSC 9;4) for compatible terminals. |
|
|
5949
|
+
| <code><a href="#mise-projen.Settings.property.toolUpdate">toolUpdate</a></code> | <code><a href="#mise-projen.SettingsToolUpdate">SettingsToolUpdate</a></code> | *No description.* |
|
|
5416
5950
|
| <code><a href="#mise-projen.Settings.property.trace">trace</a></code> | <code>boolean</code> | Sets log level to trace. |
|
|
5417
5951
|
| <code><a href="#mise-projen.Settings.property.truncate">truncate</a></code> | <code>boolean</code> | Truncate long terminal output to fit the available width. |
|
|
5418
5952
|
| <code><a href="#mise-projen.Settings.property.trustedConfigPaths">trustedConfigPaths</a></code> | <code>string[]</code> | This is a list of config paths that mise will automatically mark as trusted. |
|
|
@@ -5429,6 +5963,7 @@ const settings: Settings = { ... }
|
|
|
5429
5963
|
| <code><a href="#mise-projen.Settings.property.windowsExecutableExtensions">windowsExecutableExtensions</a></code> | <code>string[]</code> | List of executable extensions for Windows. |
|
|
5430
5964
|
| <code><a href="#mise-projen.Settings.property.windowsPowershellNoProfile">windowsPowershellNoProfile</a></code> | <code>boolean</code> | Pass `-NoProfile` to PowerShell (`pwsh`/`powershell`) shells that mise spawns for tasks and inline commands, so startup profiles are skipped. |
|
|
5431
5965
|
| <code><a href="#mise-projen.Settings.property.windowsShimMode">windowsShimMode</a></code> | <code>string</code> | Shim file mode for Windows. |
|
|
5966
|
+
| <code><a href="#mise-projen.Settings.property.writeTargets">writeTargets</a></code> | <code><a href="#mise-projen.SettingsWriteTargets">SettingsWriteTargets</a></code> | *No description.* |
|
|
5432
5967
|
| <code><a href="#mise-projen.Settings.property.yes">yes</a></code> | <code>boolean</code> | This will automatically answer yes or no to prompts. |
|
|
5433
5968
|
| <code><a href="#mise-projen.Settings.property.zig">zig</a></code> | <code><a href="#mise-projen.SettingsZig">SettingsZig</a></code> | *No description.* |
|
|
5434
5969
|
|
|
@@ -5582,7 +6117,7 @@ public readonly autoUpdate: boolean;
|
|
|
5582
6117
|
|
|
5583
6118
|
- *Type:* boolean
|
|
5584
6119
|
|
|
5585
|
-
|
|
6120
|
+
[deprecated] Use `self_update.auto` instead.
|
|
5586
6121
|
|
|
5587
6122
|
---
|
|
5588
6123
|
|
|
@@ -5594,7 +6129,7 @@ public readonly autoUpdateCheckDuration: string;
|
|
|
5594
6129
|
|
|
5595
6130
|
- *Type:* string
|
|
5596
6131
|
|
|
5597
|
-
|
|
6132
|
+
[deprecated] Use `self_update.check_duration` instead.
|
|
5598
6133
|
|
|
5599
6134
|
---
|
|
5600
6135
|
|
|
@@ -6296,6 +6831,18 @@ Minimum release age / supply chain protection — only install versions released
|
|
|
6296
6831
|
|
|
6297
6832
|
---
|
|
6298
6833
|
|
|
6834
|
+
##### `installLayout`<sup>Optional</sup> <a name="installLayout" id="mise-projen.Settings.property.installLayout"></a>
|
|
6835
|
+
|
|
6836
|
+
```typescript
|
|
6837
|
+
public readonly installLayout: SettingsInstallLayout;
|
|
6838
|
+
```
|
|
6839
|
+
|
|
6840
|
+
- *Type:* <a href="#mise-projen.SettingsInstallLayout">SettingsInstallLayout</a>
|
|
6841
|
+
|
|
6842
|
+
[experimental] Name installations by what they are (`identity`) instead of `installs/<tool>/<version>` (`legacy`).
|
|
6843
|
+
|
|
6844
|
+
---
|
|
6845
|
+
|
|
6299
6846
|
##### `java`<sup>Optional</sup> <a name="java" id="mise-projen.Settings.property.java"></a>
|
|
6300
6847
|
|
|
6301
6848
|
```typescript
|
|
@@ -6416,6 +6963,18 @@ Create and read lockfiles for tool versions.
|
|
|
6416
6963
|
|
|
6417
6964
|
---
|
|
6418
6965
|
|
|
6966
|
+
##### `lockfileAutoPrune`<sup>Optional</sup> <a name="lockfileAutoPrune" id="mise-projen.Settings.property.lockfileAutoPrune"></a>
|
|
6967
|
+
|
|
6968
|
+
```typescript
|
|
6969
|
+
public readonly lockfileAutoPrune: boolean;
|
|
6970
|
+
```
|
|
6971
|
+
|
|
6972
|
+
- *Type:* boolean
|
|
6973
|
+
|
|
6974
|
+
Remove lockfile tools that are absent from the active configuration.
|
|
6975
|
+
|
|
6976
|
+
---
|
|
6977
|
+
|
|
6419
6978
|
##### `lockfileMode`<sup>Optional</sup> <a name="lockfileMode" id="mise-projen.Settings.property.lockfileMode"></a>
|
|
6420
6979
|
|
|
6421
6980
|
```typescript
|
|
@@ -6755,6 +7314,16 @@ Fail when provenance API checks cannot be completed.
|
|
|
6755
7314
|
|
|
6756
7315
|
---
|
|
6757
7316
|
|
|
7317
|
+
##### `prune`<sup>Optional</sup> <a name="prune" id="mise-projen.Settings.property.prune"></a>
|
|
7318
|
+
|
|
7319
|
+
```typescript
|
|
7320
|
+
public readonly prune: SettingsPrune;
|
|
7321
|
+
```
|
|
7322
|
+
|
|
7323
|
+
- *Type:* <a href="#mise-projen.SettingsPrune">SettingsPrune</a>
|
|
7324
|
+
|
|
7325
|
+
---
|
|
7326
|
+
|
|
6758
7327
|
##### `pypi`<sup>Optional</sup> <a name="pypi" id="mise-projen.Settings.property.pypi"></a>
|
|
6759
7328
|
|
|
6760
7329
|
```typescript
|
|
@@ -7204,6 +7773,16 @@ Enable terminal progress indicators (OSC 9;4) for compatible terminals.
|
|
|
7204
7773
|
|
|
7205
7774
|
---
|
|
7206
7775
|
|
|
7776
|
+
##### `toolUpdate`<sup>Optional</sup> <a name="toolUpdate" id="mise-projen.Settings.property.toolUpdate"></a>
|
|
7777
|
+
|
|
7778
|
+
```typescript
|
|
7779
|
+
public readonly toolUpdate: SettingsToolUpdate;
|
|
7780
|
+
```
|
|
7781
|
+
|
|
7782
|
+
- *Type:* <a href="#mise-projen.SettingsToolUpdate">SettingsToolUpdate</a>
|
|
7783
|
+
|
|
7784
|
+
---
|
|
7785
|
+
|
|
7207
7786
|
##### `trace`<sup>Optional</sup> <a name="trace" id="mise-projen.Settings.property.trace"></a>
|
|
7208
7787
|
|
|
7209
7788
|
```typescript
|
|
@@ -7410,6 +7989,16 @@ Options: `exe`, `file`, `hardlink`, `symlink`.
|
|
|
7410
7989
|
|
|
7411
7990
|
---
|
|
7412
7991
|
|
|
7992
|
+
##### `writeTargets`<sup>Optional</sup> <a name="writeTargets" id="mise-projen.Settings.property.writeTargets"></a>
|
|
7993
|
+
|
|
7994
|
+
```typescript
|
|
7995
|
+
public readonly writeTargets: SettingsWriteTargets;
|
|
7996
|
+
```
|
|
7997
|
+
|
|
7998
|
+
- *Type:* <a href="#mise-projen.SettingsWriteTargets">SettingsWriteTargets</a>
|
|
7999
|
+
|
|
8000
|
+
---
|
|
8001
|
+
|
|
7413
8002
|
##### `yes`<sup>Optional</sup> <a name="yes" id="mise-projen.Settings.property.yes"></a>
|
|
7414
8003
|
|
|
7415
8004
|
```typescript
|
|
@@ -9155,6 +9744,36 @@ Use uvx instead of pipx if uv is installed and on PATH.
|
|
|
9155
9744
|
|
|
9156
9745
|
---
|
|
9157
9746
|
|
|
9747
|
+
### SettingsPrune <a name="SettingsPrune" id="mise-projen.SettingsPrune"></a>
|
|
9748
|
+
|
|
9749
|
+
#### Initializer <a name="Initializer" id="mise-projen.SettingsPrune.Initializer"></a>
|
|
9750
|
+
|
|
9751
|
+
```typescript
|
|
9752
|
+
import { SettingsPrune } from 'mise-projen'
|
|
9753
|
+
|
|
9754
|
+
const settingsPrune: SettingsPrune = { ... }
|
|
9755
|
+
```
|
|
9756
|
+
|
|
9757
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
9758
|
+
|
|
9759
|
+
| **Name** | **Type** | **Description** |
|
|
9760
|
+
| --- | --- | --- |
|
|
9761
|
+
| <code><a href="#mise-projen.SettingsPrune.property.exclude">exclude</a></code> | <code>string[]</code> | Tools that `mise prune` never removes, such as `node` or `aqua:BurntSushi/ripgrep`. |
|
|
9762
|
+
|
|
9763
|
+
---
|
|
9764
|
+
|
|
9765
|
+
##### `exclude`<sup>Optional</sup> <a name="exclude" id="mise-projen.SettingsPrune.property.exclude"></a>
|
|
9766
|
+
|
|
9767
|
+
```typescript
|
|
9768
|
+
public readonly exclude: string[];
|
|
9769
|
+
```
|
|
9770
|
+
|
|
9771
|
+
- *Type:* string[]
|
|
9772
|
+
|
|
9773
|
+
Tools that `mise prune` never removes, such as `node` or `aqua:BurntSushi/ripgrep`.
|
|
9774
|
+
|
|
9775
|
+
---
|
|
9776
|
+
|
|
9158
9777
|
### SettingsPypi <a name="SettingsPypi" id="mise-projen.SettingsPypi"></a>
|
|
9159
9778
|
|
|
9160
9779
|
#### Initializer <a name="Initializer" id="mise-projen.SettingsPypi.Initializer"></a>
|
|
@@ -9752,6 +10371,8 @@ const settingsSelfUpdate: SettingsSelfUpdate = { ... }
|
|
|
9752
10371
|
| **Name** | **Type** | **Description** |
|
|
9753
10372
|
| --- | --- | --- |
|
|
9754
10373
|
| <code><a href="#mise-projen.SettingsSelfUpdate.property.apiUrl">apiUrl</a></code> | <code>string</code> | GitHub API base URL used by `mise self-update`. |
|
|
10374
|
+
| <code><a href="#mise-projen.SettingsSelfUpdate.property.auto">auto</a></code> | <code>boolean</code> | Automatically update mise before running eligible commands. |
|
|
10375
|
+
| <code><a href="#mise-projen.SettingsSelfUpdate.property.checkDuration">checkDuration</a></code> | <code>string</code> | How often to check for a new mise release when `self_update.auto` is enabled. |
|
|
9755
10376
|
| <code><a href="#mise-projen.SettingsSelfUpdate.property.minimumReleaseAge">minimumReleaseAge</a></code> | <code>string</code> | Minimum release age for mise itself; |
|
|
9756
10377
|
| <code><a href="#mise-projen.SettingsSelfUpdate.property.repository">repository</a></code> | <code>string</code> | GitHub repository used by `mise self-update`. |
|
|
9757
10378
|
|
|
@@ -9769,6 +10390,30 @@ GitHub API base URL used by `mise self-update`.
|
|
|
9769
10390
|
|
|
9770
10391
|
---
|
|
9771
10392
|
|
|
10393
|
+
##### `auto`<sup>Optional</sup> <a name="auto" id="mise-projen.SettingsSelfUpdate.property.auto"></a>
|
|
10394
|
+
|
|
10395
|
+
```typescript
|
|
10396
|
+
public readonly auto: boolean;
|
|
10397
|
+
```
|
|
10398
|
+
|
|
10399
|
+
- *Type:* boolean
|
|
10400
|
+
|
|
10401
|
+
Automatically update mise before running eligible commands.
|
|
10402
|
+
|
|
10403
|
+
---
|
|
10404
|
+
|
|
10405
|
+
##### `checkDuration`<sup>Optional</sup> <a name="checkDuration" id="mise-projen.SettingsSelfUpdate.property.checkDuration"></a>
|
|
10406
|
+
|
|
10407
|
+
```typescript
|
|
10408
|
+
public readonly checkDuration: string;
|
|
10409
|
+
```
|
|
10410
|
+
|
|
10411
|
+
- *Type:* string
|
|
10412
|
+
|
|
10413
|
+
How often to check for a new mise release when `self_update.auto` is enabled.
|
|
10414
|
+
|
|
10415
|
+
---
|
|
10416
|
+
|
|
9772
10417
|
##### `minimumReleaseAge`<sup>Optional</sup> <a name="minimumReleaseAge" id="mise-projen.SettingsSelfUpdate.property.minimumReleaseAge"></a>
|
|
9773
10418
|
|
|
9774
10419
|
```typescript
|
|
@@ -10683,6 +11328,36 @@ public readonly statsReport: string;
|
|
|
10683
11328
|
|
|
10684
11329
|
---
|
|
10685
11330
|
|
|
11331
|
+
### SettingsToolUpdate <a name="SettingsToolUpdate" id="mise-projen.SettingsToolUpdate"></a>
|
|
11332
|
+
|
|
11333
|
+
#### Initializer <a name="Initializer" id="mise-projen.SettingsToolUpdate.Initializer"></a>
|
|
11334
|
+
|
|
11335
|
+
```typescript
|
|
11336
|
+
import { SettingsToolUpdate } from 'mise-projen'
|
|
11337
|
+
|
|
11338
|
+
const settingsToolUpdate: SettingsToolUpdate = { ... }
|
|
11339
|
+
```
|
|
11340
|
+
|
|
11341
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
11342
|
+
|
|
11343
|
+
| **Name** | **Type** | **Description** |
|
|
11344
|
+
| --- | --- | --- |
|
|
11345
|
+
| <code><a href="#mise-projen.SettingsToolUpdate.property.checkDuration">checkDuration</a></code> | <code>string</code> | How often to check for updates to a global tool with `auto_update = true`. |
|
|
11346
|
+
|
|
11347
|
+
---
|
|
11348
|
+
|
|
11349
|
+
##### `checkDuration`<sup>Optional</sup> <a name="checkDuration" id="mise-projen.SettingsToolUpdate.property.checkDuration"></a>
|
|
11350
|
+
|
|
11351
|
+
```typescript
|
|
11352
|
+
public readonly checkDuration: string;
|
|
11353
|
+
```
|
|
11354
|
+
|
|
11355
|
+
- *Type:* string
|
|
11356
|
+
|
|
11357
|
+
How often to check for updates to a global tool with `auto_update = true`.
|
|
11358
|
+
|
|
11359
|
+
---
|
|
11360
|
+
|
|
10686
11361
|
### SettingsUpgrade <a name="SettingsUpgrade" id="mise-projen.SettingsUpgrade"></a>
|
|
10687
11362
|
|
|
10688
11363
|
#### Initializer <a name="Initializer" id="mise-projen.SettingsUpgrade.Initializer"></a>
|
|
@@ -10726,6 +11401,66 @@ Grace period before versions replaced by `mise upgrade` are automatically pruned
|
|
|
10726
11401
|
|
|
10727
11402
|
---
|
|
10728
11403
|
|
|
11404
|
+
### SettingsWriteTargets <a name="SettingsWriteTargets" id="mise-projen.SettingsWriteTargets"></a>
|
|
11405
|
+
|
|
11406
|
+
#### Initializer <a name="Initializer" id="mise-projen.SettingsWriteTargets.Initializer"></a>
|
|
11407
|
+
|
|
11408
|
+
```typescript
|
|
11409
|
+
import { SettingsWriteTargets } from 'mise-projen'
|
|
11410
|
+
|
|
11411
|
+
const settingsWriteTargets: SettingsWriteTargets = { ... }
|
|
11412
|
+
```
|
|
11413
|
+
|
|
11414
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
11415
|
+
|
|
11416
|
+
| **Name** | **Type** | **Description** |
|
|
11417
|
+
| --- | --- | --- |
|
|
11418
|
+
| <code><a href="#mise-projen.SettingsWriteTargets.property.dotfiles">dotfiles</a></code> | <code>string</code> | Global config file to create new [dotfiles] entries in. |
|
|
11419
|
+
| <code><a href="#mise-projen.SettingsWriteTargets.property.packages">packages</a></code> | <code>string</code> | Global config file to create new [bootstrap.packages] entries in. Existing entries stay in the config file that already declares them. |
|
|
11420
|
+
| <code><a href="#mise-projen.SettingsWriteTargets.property.tools">tools</a></code> | <code>string</code> | Global config file to create new [tools] entries in. |
|
|
11421
|
+
|
|
11422
|
+
---
|
|
11423
|
+
|
|
11424
|
+
##### `dotfiles`<sup>Optional</sup> <a name="dotfiles" id="mise-projen.SettingsWriteTargets.property.dotfiles"></a>
|
|
11425
|
+
|
|
11426
|
+
```typescript
|
|
11427
|
+
public readonly dotfiles: string;
|
|
11428
|
+
```
|
|
11429
|
+
|
|
11430
|
+
- *Type:* string
|
|
11431
|
+
|
|
11432
|
+
Global config file to create new [dotfiles] entries in.
|
|
11433
|
+
|
|
11434
|
+
Existing entries stay in the config file that already declares them.
|
|
11435
|
+
|
|
11436
|
+
---
|
|
11437
|
+
|
|
11438
|
+
##### `packages`<sup>Optional</sup> <a name="packages" id="mise-projen.SettingsWriteTargets.property.packages"></a>
|
|
11439
|
+
|
|
11440
|
+
```typescript
|
|
11441
|
+
public readonly packages: string;
|
|
11442
|
+
```
|
|
11443
|
+
|
|
11444
|
+
- *Type:* string
|
|
11445
|
+
|
|
11446
|
+
Global config file to create new [bootstrap.packages] entries in. Existing entries stay in the config file that already declares them.
|
|
11447
|
+
|
|
11448
|
+
---
|
|
11449
|
+
|
|
11450
|
+
##### `tools`<sup>Optional</sup> <a name="tools" id="mise-projen.SettingsWriteTargets.property.tools"></a>
|
|
11451
|
+
|
|
11452
|
+
```typescript
|
|
11453
|
+
public readonly tools: string;
|
|
11454
|
+
```
|
|
11455
|
+
|
|
11456
|
+
- *Type:* string
|
|
11457
|
+
|
|
11458
|
+
Global config file to create new [tools] entries in.
|
|
11459
|
+
|
|
11460
|
+
Existing entries stay in the config file that already declares them.
|
|
11461
|
+
|
|
11462
|
+
---
|
|
11463
|
+
|
|
10729
11464
|
### SettingsZig <a name="SettingsZig" id="mise-projen.SettingsZig"></a>
|
|
10730
11465
|
|
|
10731
11466
|
#### Initializer <a name="Initializer" id="mise-projen.SettingsZig.Initializer"></a>
|
|
@@ -11467,6 +12202,163 @@ post-packages.
|
|
|
11467
12202
|
---
|
|
11468
12203
|
|
|
11469
12204
|
|
|
12205
|
+
### MiseTomlSchemaBootstrapComposeBuild <a name="MiseTomlSchemaBootstrapComposeBuild" id="mise-projen.MiseTomlSchemaBootstrapComposeBuild"></a>
|
|
12206
|
+
|
|
12207
|
+
#### Members <a name="Members" id="Members"></a>
|
|
12208
|
+
|
|
12209
|
+
| **Name** | **Description** |
|
|
12210
|
+
| --- | --- |
|
|
12211
|
+
| <code><a href="#mise-projen.MiseTomlSchemaBootstrapComposeBuild.AUTO">AUTO</a></code> | auto. |
|
|
12212
|
+
| <code><a href="#mise-projen.MiseTomlSchemaBootstrapComposeBuild.ALWAYS">ALWAYS</a></code> | always. |
|
|
12213
|
+
| <code><a href="#mise-projen.MiseTomlSchemaBootstrapComposeBuild.NEVER">NEVER</a></code> | never. |
|
|
12214
|
+
|
|
12215
|
+
---
|
|
12216
|
+
|
|
12217
|
+
##### `AUTO` <a name="AUTO" id="mise-projen.MiseTomlSchemaBootstrapComposeBuild.AUTO"></a>
|
|
12218
|
+
|
|
12219
|
+
auto.
|
|
12220
|
+
|
|
12221
|
+
---
|
|
12222
|
+
|
|
12223
|
+
|
|
12224
|
+
##### `ALWAYS` <a name="ALWAYS" id="mise-projen.MiseTomlSchemaBootstrapComposeBuild.ALWAYS"></a>
|
|
12225
|
+
|
|
12226
|
+
always.
|
|
12227
|
+
|
|
12228
|
+
---
|
|
12229
|
+
|
|
12230
|
+
|
|
12231
|
+
##### `NEVER` <a name="NEVER" id="mise-projen.MiseTomlSchemaBootstrapComposeBuild.NEVER"></a>
|
|
12232
|
+
|
|
12233
|
+
never.
|
|
12234
|
+
|
|
12235
|
+
---
|
|
12236
|
+
|
|
12237
|
+
|
|
12238
|
+
### MiseTomlSchemaBootstrapComposeDownImages <a name="MiseTomlSchemaBootstrapComposeDownImages" id="mise-projen.MiseTomlSchemaBootstrapComposeDownImages"></a>
|
|
12239
|
+
|
|
12240
|
+
#### Members <a name="Members" id="Members"></a>
|
|
12241
|
+
|
|
12242
|
+
| **Name** | **Description** |
|
|
12243
|
+
| --- | --- |
|
|
12244
|
+
| <code><a href="#mise-projen.MiseTomlSchemaBootstrapComposeDownImages.LOCAL">LOCAL</a></code> | local. |
|
|
12245
|
+
| <code><a href="#mise-projen.MiseTomlSchemaBootstrapComposeDownImages.ALL">ALL</a></code> | all. |
|
|
12246
|
+
|
|
12247
|
+
---
|
|
12248
|
+
|
|
12249
|
+
##### `LOCAL` <a name="LOCAL" id="mise-projen.MiseTomlSchemaBootstrapComposeDownImages.LOCAL"></a>
|
|
12250
|
+
|
|
12251
|
+
local.
|
|
12252
|
+
|
|
12253
|
+
---
|
|
12254
|
+
|
|
12255
|
+
|
|
12256
|
+
##### `ALL` <a name="ALL" id="mise-projen.MiseTomlSchemaBootstrapComposeDownImages.ALL"></a>
|
|
12257
|
+
|
|
12258
|
+
all.
|
|
12259
|
+
|
|
12260
|
+
---
|
|
12261
|
+
|
|
12262
|
+
|
|
12263
|
+
### MiseTomlSchemaBootstrapComposePull <a name="MiseTomlSchemaBootstrapComposePull" id="mise-projen.MiseTomlSchemaBootstrapComposePull"></a>
|
|
12264
|
+
|
|
12265
|
+
#### Members <a name="Members" id="Members"></a>
|
|
12266
|
+
|
|
12267
|
+
| **Name** | **Description** |
|
|
12268
|
+
| --- | --- |
|
|
12269
|
+
| <code><a href="#mise-projen.MiseTomlSchemaBootstrapComposePull.ALWAYS">ALWAYS</a></code> | always. |
|
|
12270
|
+
| <code><a href="#mise-projen.MiseTomlSchemaBootstrapComposePull.MISSING">MISSING</a></code> | missing. |
|
|
12271
|
+
| <code><a href="#mise-projen.MiseTomlSchemaBootstrapComposePull.NEVER">NEVER</a></code> | never. |
|
|
12272
|
+
|
|
12273
|
+
---
|
|
12274
|
+
|
|
12275
|
+
##### `ALWAYS` <a name="ALWAYS" id="mise-projen.MiseTomlSchemaBootstrapComposePull.ALWAYS"></a>
|
|
12276
|
+
|
|
12277
|
+
always.
|
|
12278
|
+
|
|
12279
|
+
---
|
|
12280
|
+
|
|
12281
|
+
|
|
12282
|
+
##### `MISSING` <a name="MISSING" id="mise-projen.MiseTomlSchemaBootstrapComposePull.MISSING"></a>
|
|
12283
|
+
|
|
12284
|
+
missing.
|
|
12285
|
+
|
|
12286
|
+
---
|
|
12287
|
+
|
|
12288
|
+
|
|
12289
|
+
##### `NEVER` <a name="NEVER" id="mise-projen.MiseTomlSchemaBootstrapComposePull.NEVER"></a>
|
|
12290
|
+
|
|
12291
|
+
never.
|
|
12292
|
+
|
|
12293
|
+
---
|
|
12294
|
+
|
|
12295
|
+
|
|
12296
|
+
### MiseTomlSchemaBootstrapComposeRecreate <a name="MiseTomlSchemaBootstrapComposeRecreate" id="mise-projen.MiseTomlSchemaBootstrapComposeRecreate"></a>
|
|
12297
|
+
|
|
12298
|
+
#### Members <a name="Members" id="Members"></a>
|
|
12299
|
+
|
|
12300
|
+
| **Name** | **Description** |
|
|
12301
|
+
| --- | --- |
|
|
12302
|
+
| <code><a href="#mise-projen.MiseTomlSchemaBootstrapComposeRecreate.AUTO">AUTO</a></code> | auto. |
|
|
12303
|
+
| <code><a href="#mise-projen.MiseTomlSchemaBootstrapComposeRecreate.ALWAYS">ALWAYS</a></code> | always. |
|
|
12304
|
+
| <code><a href="#mise-projen.MiseTomlSchemaBootstrapComposeRecreate.NEVER">NEVER</a></code> | never. |
|
|
12305
|
+
|
|
12306
|
+
---
|
|
12307
|
+
|
|
12308
|
+
##### `AUTO` <a name="AUTO" id="mise-projen.MiseTomlSchemaBootstrapComposeRecreate.AUTO"></a>
|
|
12309
|
+
|
|
12310
|
+
auto.
|
|
12311
|
+
|
|
12312
|
+
---
|
|
12313
|
+
|
|
12314
|
+
|
|
12315
|
+
##### `ALWAYS` <a name="ALWAYS" id="mise-projen.MiseTomlSchemaBootstrapComposeRecreate.ALWAYS"></a>
|
|
12316
|
+
|
|
12317
|
+
always.
|
|
12318
|
+
|
|
12319
|
+
---
|
|
12320
|
+
|
|
12321
|
+
|
|
12322
|
+
##### `NEVER` <a name="NEVER" id="mise-projen.MiseTomlSchemaBootstrapComposeRecreate.NEVER"></a>
|
|
12323
|
+
|
|
12324
|
+
never.
|
|
12325
|
+
|
|
12326
|
+
---
|
|
12327
|
+
|
|
12328
|
+
|
|
12329
|
+
### MiseTomlSchemaBootstrapComposeState <a name="MiseTomlSchemaBootstrapComposeState" id="mise-projen.MiseTomlSchemaBootstrapComposeState"></a>
|
|
12330
|
+
|
|
12331
|
+
#### Members <a name="Members" id="Members"></a>
|
|
12332
|
+
|
|
12333
|
+
| **Name** | **Description** |
|
|
12334
|
+
| --- | --- |
|
|
12335
|
+
| <code><a href="#mise-projen.MiseTomlSchemaBootstrapComposeState.RUNNING">RUNNING</a></code> | running. |
|
|
12336
|
+
| <code><a href="#mise-projen.MiseTomlSchemaBootstrapComposeState.STOPPED">STOPPED</a></code> | stopped. |
|
|
12337
|
+
| <code><a href="#mise-projen.MiseTomlSchemaBootstrapComposeState.ABSENT">ABSENT</a></code> | absent. |
|
|
12338
|
+
|
|
12339
|
+
---
|
|
12340
|
+
|
|
12341
|
+
##### `RUNNING` <a name="RUNNING" id="mise-projen.MiseTomlSchemaBootstrapComposeState.RUNNING"></a>
|
|
12342
|
+
|
|
12343
|
+
running.
|
|
12344
|
+
|
|
12345
|
+
---
|
|
12346
|
+
|
|
12347
|
+
|
|
12348
|
+
##### `STOPPED` <a name="STOPPED" id="mise-projen.MiseTomlSchemaBootstrapComposeState.STOPPED"></a>
|
|
12349
|
+
|
|
12350
|
+
stopped.
|
|
12351
|
+
|
|
12352
|
+
---
|
|
12353
|
+
|
|
12354
|
+
|
|
12355
|
+
##### `ABSENT` <a name="ABSENT" id="mise-projen.MiseTomlSchemaBootstrapComposeState.ABSENT"></a>
|
|
12356
|
+
|
|
12357
|
+
absent.
|
|
12358
|
+
|
|
12359
|
+
---
|
|
12360
|
+
|
|
12361
|
+
|
|
11470
12362
|
### MiseTomlSchemaBootstrapDirectoriesState <a name="MiseTomlSchemaBootstrapDirectoriesState" id="mise-projen.MiseTomlSchemaBootstrapDirectoriesState"></a>
|
|
11471
12363
|
|
|
11472
12364
|
#### Members <a name="Members" id="Members"></a>
|
|
@@ -12029,6 +12921,7 @@ A mise-provided user service.
|
|
|
12029
12921
|
| **Name** | **Description** |
|
|
12030
12922
|
| --- | --- |
|
|
12031
12923
|
| <code><a href="#mise-projen.MiseTomlSchemaBootstrapServicesBuiltin.HISTORY_HYPHEN_WATCH">HISTORY_HYPHEN_WATCH</a></code> | history-watch. |
|
|
12924
|
+
| <code><a href="#mise-projen.MiseTomlSchemaBootstrapServicesBuiltin.TOOL_HYPHEN_UPDATE">TOOL_HYPHEN_UPDATE</a></code> | tool-update. |
|
|
12032
12925
|
|
|
12033
12926
|
---
|
|
12034
12927
|
|
|
@@ -12039,6 +12932,13 @@ history-watch.
|
|
|
12039
12932
|
---
|
|
12040
12933
|
|
|
12041
12934
|
|
|
12935
|
+
##### `TOOL_HYPHEN_UPDATE` <a name="TOOL_HYPHEN_UPDATE" id="mise-projen.MiseTomlSchemaBootstrapServicesBuiltin.TOOL_HYPHEN_UPDATE"></a>
|
|
12936
|
+
|
|
12937
|
+
tool-update.
|
|
12938
|
+
|
|
12939
|
+
---
|
|
12940
|
+
|
|
12941
|
+
|
|
12042
12942
|
### MiseTomlSchemaBootstrapServicesOnChange <a name="MiseTomlSchemaBootstrapServicesOnChange" id="mise-projen.MiseTomlSchemaBootstrapServicesOnChange"></a>
|
|
12043
12943
|
|
|
12044
12944
|
System scope only.
|
|
@@ -12210,6 +13110,60 @@ nats.
|
|
|
12210
13110
|
---
|
|
12211
13111
|
|
|
12212
13112
|
|
|
13113
|
+
### MiseTomlSchemaDotfileGroupsManifest <a name="MiseTomlSchemaDotfileGroupsManifest" id="mise-projen.MiseTomlSchemaDotfileGroupsManifest"></a>
|
|
13114
|
+
|
|
13115
|
+
source manifest used to select managed files from the tree.
|
|
13116
|
+
|
|
13117
|
+
#### Members <a name="Members" id="Members"></a>
|
|
13118
|
+
|
|
13119
|
+
| **Name** | **Description** |
|
|
13120
|
+
| --- | --- |
|
|
13121
|
+
| <code><a href="#mise-projen.MiseTomlSchemaDotfileGroupsManifest.GIT">GIT</a></code> | git. |
|
|
13122
|
+
|
|
13123
|
+
---
|
|
13124
|
+
|
|
13125
|
+
##### `GIT` <a name="GIT" id="mise-projen.MiseTomlSchemaDotfileGroupsManifest.GIT"></a>
|
|
13126
|
+
|
|
13127
|
+
git.
|
|
13128
|
+
|
|
13129
|
+
---
|
|
13130
|
+
|
|
13131
|
+
|
|
13132
|
+
### MiseTomlSchemaDotfileGroupsMode <a name="MiseTomlSchemaDotfileGroupsMode" id="mise-projen.MiseTomlSchemaDotfileGroupsMode"></a>
|
|
13133
|
+
|
|
13134
|
+
how the tree is deployed.
|
|
13135
|
+
|
|
13136
|
+
#### Members <a name="Members" id="Members"></a>
|
|
13137
|
+
|
|
13138
|
+
| **Name** | **Description** |
|
|
13139
|
+
| --- | --- |
|
|
13140
|
+
| <code><a href="#mise-projen.MiseTomlSchemaDotfileGroupsMode.SYMLINK_HYPHEN_EACH">SYMLINK_HYPHEN_EACH</a></code> | symlink-each. |
|
|
13141
|
+
| <code><a href="#mise-projen.MiseTomlSchemaDotfileGroupsMode.COPY">COPY</a></code> | copy. |
|
|
13142
|
+
| <code><a href="#mise-projen.MiseTomlSchemaDotfileGroupsMode.SYMLINK">SYMLINK</a></code> | symlink. |
|
|
13143
|
+
|
|
13144
|
+
---
|
|
13145
|
+
|
|
13146
|
+
##### `SYMLINK_HYPHEN_EACH` <a name="SYMLINK_HYPHEN_EACH" id="mise-projen.MiseTomlSchemaDotfileGroupsMode.SYMLINK_HYPHEN_EACH"></a>
|
|
13147
|
+
|
|
13148
|
+
symlink-each.
|
|
13149
|
+
|
|
13150
|
+
---
|
|
13151
|
+
|
|
13152
|
+
|
|
13153
|
+
##### `COPY` <a name="COPY" id="mise-projen.MiseTomlSchemaDotfileGroupsMode.COPY"></a>
|
|
13154
|
+
|
|
13155
|
+
copy.
|
|
13156
|
+
|
|
13157
|
+
---
|
|
13158
|
+
|
|
13159
|
+
|
|
13160
|
+
##### `SYMLINK` <a name="SYMLINK" id="mise-projen.MiseTomlSchemaDotfileGroupsMode.SYMLINK"></a>
|
|
13161
|
+
|
|
13162
|
+
symlink.
|
|
13163
|
+
|
|
13164
|
+
---
|
|
13165
|
+
|
|
13166
|
+
|
|
12213
13167
|
### SettingsColorTheme <a name="SettingsColorTheme" id="mise-projen.SettingsColorTheme"></a>
|
|
12214
13168
|
|
|
12215
13169
|
Theme for interactive prompts (auto/default, charm, base16, catppuccin, dracula).
|
|
@@ -12306,6 +13260,33 @@ manual.
|
|
|
12306
13260
|
---
|
|
12307
13261
|
|
|
12308
13262
|
|
|
13263
|
+
### SettingsInstallLayout <a name="SettingsInstallLayout" id="mise-projen.SettingsInstallLayout"></a>
|
|
13264
|
+
|
|
13265
|
+
[experimental] Name installations by what they are (`identity`) instead of `installs/<tool>/<version>` (`legacy`).
|
|
13266
|
+
|
|
13267
|
+
#### Members <a name="Members" id="Members"></a>
|
|
13268
|
+
|
|
13269
|
+
| **Name** | **Description** |
|
|
13270
|
+
| --- | --- |
|
|
13271
|
+
| <code><a href="#mise-projen.SettingsInstallLayout.LEGACY">LEGACY</a></code> | legacy. |
|
|
13272
|
+
| <code><a href="#mise-projen.SettingsInstallLayout.IDENTITY">IDENTITY</a></code> | identity. |
|
|
13273
|
+
|
|
13274
|
+
---
|
|
13275
|
+
|
|
13276
|
+
##### `LEGACY` <a name="LEGACY" id="mise-projen.SettingsInstallLayout.LEGACY"></a>
|
|
13277
|
+
|
|
13278
|
+
legacy.
|
|
13279
|
+
|
|
13280
|
+
---
|
|
13281
|
+
|
|
13282
|
+
|
|
13283
|
+
##### `IDENTITY` <a name="IDENTITY" id="mise-projen.SettingsInstallLayout.IDENTITY"></a>
|
|
13284
|
+
|
|
13285
|
+
identity.
|
|
13286
|
+
|
|
13287
|
+
---
|
|
13288
|
+
|
|
13289
|
+
|
|
12309
13290
|
### SettingsLibc <a name="SettingsLibc" id="mise-projen.SettingsLibc"></a>
|
|
12310
13291
|
|
|
12311
13292
|
Libc implementation to use for precompiled Linux binaries.
|