mise-projen 0.0.8 → 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 +1321 -871
- package/API.md +327 -4
- package/lib/index.js +1 -1
- package/lib/miseConfig.d.ts +154 -3
- package/lib/miseConfig.js +111 -6
- package/lib/miseFile.js +1 -1
- package/package.json +1 -1
- package/schemas/mise.json +186 -8
package/API.md
CHANGED
|
@@ -929,6 +929,7 @@ const miseTomlSchema: MiseTomlSchema = { ... }
|
|
|
929
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`. |
|
|
930
930
|
| <code><a href="#mise-projen.MiseTomlSchema.property.plugins">plugins</a></code> | <code>{[ key: string ]: string}</code> | plugins to use. |
|
|
931
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. |
|
|
932
933
|
| <code><a href="#mise-projen.MiseTomlSchema.property.settings">settings</a></code> | <code><a href="#mise-projen.Settings">Settings</a></code> | mise settings. |
|
|
933
934
|
| <code><a href="#mise-projen.MiseTomlSchema.property.shellAlias">shellAlias</a></code> | <code>{[ key: string ]: string}</code> | shell aliases. |
|
|
934
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. |
|
|
@@ -1241,6 +1242,20 @@ env or vars keys to redact from logs.
|
|
|
1241
1242
|
|
|
1242
1243
|
---
|
|
1243
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
|
+
|
|
1244
1259
|
##### `settings`<sup>Optional</sup> <a name="settings" id="mise-projen.MiseTomlSchema.property.settings"></a>
|
|
1245
1260
|
|
|
1246
1261
|
```typescript
|
|
@@ -5510,6 +5525,74 @@ absolute non-root image path without `.` or `..` components.
|
|
|
5510
5525
|
|
|
5511
5526
|
---
|
|
5512
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
|
+
|
|
5513
5596
|
### Monorepo <a name="Monorepo" id="mise-projen.Monorepo"></a>
|
|
5514
5597
|
|
|
5515
5598
|
Configuration for monorepo task discovery.
|
|
@@ -5721,8 +5804,8 @@ const settings: Settings = { ... }
|
|
|
5721
5804
|
| <code><a href="#mise-projen.Settings.property.autoEnv">autoEnv</a></code> | <code>boolean</code> | Automatically enable platform config environments (unix, {os}, {os}-{arch}). |
|
|
5722
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. |
|
|
5723
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. |
|
|
5724
|
-
| <code><a href="#mise-projen.Settings.property.autoUpdate">autoUpdate</a></code> | <code>boolean</code> |
|
|
5725
|
-
| <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. |
|
|
5726
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. |
|
|
5727
5810
|
| <code><a href="#mise-projen.Settings.property.cargo">cargo</a></code> | <code><a href="#mise-projen.SettingsCargo">SettingsCargo</a></code> | *No description.* |
|
|
5728
5811
|
| <code><a href="#mise-projen.Settings.property.cd">cd</a></code> | <code>string</code> | Path to change to after launching mise. |
|
|
@@ -5782,6 +5865,7 @@ const settings: Settings = { ... }
|
|
|
5782
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. |
|
|
5783
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. |
|
|
5784
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`). |
|
|
5785
5869
|
| <code><a href="#mise-projen.Settings.property.java">java</a></code> | <code><a href="#mise-projen.SettingsJava">SettingsJava</a></code> | *No description.* |
|
|
5786
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. |
|
|
5787
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. |
|
|
@@ -5792,6 +5876,7 @@ const settings: Settings = { ... }
|
|
|
5792
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. |
|
|
5793
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. |
|
|
5794
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. |
|
|
5795
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. |
|
|
5796
5881
|
| <code><a href="#mise-projen.Settings.property.lockfilePlatforms">lockfilePlatforms</a></code> | <code>string[]</code> | Platforms to target in lockfile operations. |
|
|
5797
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. |
|
|
@@ -5821,6 +5906,7 @@ const settings: Settings = { ... }
|
|
|
5821
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. |
|
|
5822
5907
|
| <code><a href="#mise-projen.Settings.property.profile">profile</a></code> | <code>string</code> | Profile to use for mise.${MISE_PROFILE}.toml files. |
|
|
5823
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.* |
|
|
5824
5910
|
| <code><a href="#mise-projen.Settings.property.pypi">pypi</a></code> | <code><a href="#mise-projen.SettingsPypi">SettingsPypi</a></code> | *No description.* |
|
|
5825
5911
|
| <code><a href="#mise-projen.Settings.property.python">python</a></code> | <code><a href="#mise-projen.SettingsPython">SettingsPython</a></code> | *No description.* |
|
|
5826
5912
|
| <code><a href="#mise-projen.Settings.property.quiet">quiet</a></code> | <code>boolean</code> | Suppress all output except errors. |
|
|
@@ -5860,6 +5946,7 @@ const settings: Settings = { ... }
|
|
|
5860
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`. |
|
|
5861
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. |
|
|
5862
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.* |
|
|
5863
5950
|
| <code><a href="#mise-projen.Settings.property.trace">trace</a></code> | <code>boolean</code> | Sets log level to trace. |
|
|
5864
5951
|
| <code><a href="#mise-projen.Settings.property.truncate">truncate</a></code> | <code>boolean</code> | Truncate long terminal output to fit the available width. |
|
|
5865
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. |
|
|
@@ -5876,6 +5963,7 @@ const settings: Settings = { ... }
|
|
|
5876
5963
|
| <code><a href="#mise-projen.Settings.property.windowsExecutableExtensions">windowsExecutableExtensions</a></code> | <code>string[]</code> | List of executable extensions for Windows. |
|
|
5877
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. |
|
|
5878
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.* |
|
|
5879
5967
|
| <code><a href="#mise-projen.Settings.property.yes">yes</a></code> | <code>boolean</code> | This will automatically answer yes or no to prompts. |
|
|
5880
5968
|
| <code><a href="#mise-projen.Settings.property.zig">zig</a></code> | <code><a href="#mise-projen.SettingsZig">SettingsZig</a></code> | *No description.* |
|
|
5881
5969
|
|
|
@@ -6029,7 +6117,7 @@ public readonly autoUpdate: boolean;
|
|
|
6029
6117
|
|
|
6030
6118
|
- *Type:* boolean
|
|
6031
6119
|
|
|
6032
|
-
|
|
6120
|
+
[deprecated] Use `self_update.auto` instead.
|
|
6033
6121
|
|
|
6034
6122
|
---
|
|
6035
6123
|
|
|
@@ -6041,7 +6129,7 @@ public readonly autoUpdateCheckDuration: string;
|
|
|
6041
6129
|
|
|
6042
6130
|
- *Type:* string
|
|
6043
6131
|
|
|
6044
|
-
|
|
6132
|
+
[deprecated] Use `self_update.check_duration` instead.
|
|
6045
6133
|
|
|
6046
6134
|
---
|
|
6047
6135
|
|
|
@@ -6743,6 +6831,18 @@ Minimum release age / supply chain protection — only install versions released
|
|
|
6743
6831
|
|
|
6744
6832
|
---
|
|
6745
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
|
+
|
|
6746
6846
|
##### `java`<sup>Optional</sup> <a name="java" id="mise-projen.Settings.property.java"></a>
|
|
6747
6847
|
|
|
6748
6848
|
```typescript
|
|
@@ -6863,6 +6963,18 @@ Create and read lockfiles for tool versions.
|
|
|
6863
6963
|
|
|
6864
6964
|
---
|
|
6865
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
|
+
|
|
6866
6978
|
##### `lockfileMode`<sup>Optional</sup> <a name="lockfileMode" id="mise-projen.Settings.property.lockfileMode"></a>
|
|
6867
6979
|
|
|
6868
6980
|
```typescript
|
|
@@ -7202,6 +7314,16 @@ Fail when provenance API checks cannot be completed.
|
|
|
7202
7314
|
|
|
7203
7315
|
---
|
|
7204
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
|
+
|
|
7205
7327
|
##### `pypi`<sup>Optional</sup> <a name="pypi" id="mise-projen.Settings.property.pypi"></a>
|
|
7206
7328
|
|
|
7207
7329
|
```typescript
|
|
@@ -7651,6 +7773,16 @@ Enable terminal progress indicators (OSC 9;4) for compatible terminals.
|
|
|
7651
7773
|
|
|
7652
7774
|
---
|
|
7653
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
|
+
|
|
7654
7786
|
##### `trace`<sup>Optional</sup> <a name="trace" id="mise-projen.Settings.property.trace"></a>
|
|
7655
7787
|
|
|
7656
7788
|
```typescript
|
|
@@ -7857,6 +7989,16 @@ Options: `exe`, `file`, `hardlink`, `symlink`.
|
|
|
7857
7989
|
|
|
7858
7990
|
---
|
|
7859
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
|
+
|
|
7860
8002
|
##### `yes`<sup>Optional</sup> <a name="yes" id="mise-projen.Settings.property.yes"></a>
|
|
7861
8003
|
|
|
7862
8004
|
```typescript
|
|
@@ -9602,6 +9744,36 @@ Use uvx instead of pipx if uv is installed and on PATH.
|
|
|
9602
9744
|
|
|
9603
9745
|
---
|
|
9604
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
|
+
|
|
9605
9777
|
### SettingsPypi <a name="SettingsPypi" id="mise-projen.SettingsPypi"></a>
|
|
9606
9778
|
|
|
9607
9779
|
#### Initializer <a name="Initializer" id="mise-projen.SettingsPypi.Initializer"></a>
|
|
@@ -10199,6 +10371,8 @@ const settingsSelfUpdate: SettingsSelfUpdate = { ... }
|
|
|
10199
10371
|
| **Name** | **Type** | **Description** |
|
|
10200
10372
|
| --- | --- | --- |
|
|
10201
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. |
|
|
10202
10376
|
| <code><a href="#mise-projen.SettingsSelfUpdate.property.minimumReleaseAge">minimumReleaseAge</a></code> | <code>string</code> | Minimum release age for mise itself; |
|
|
10203
10377
|
| <code><a href="#mise-projen.SettingsSelfUpdate.property.repository">repository</a></code> | <code>string</code> | GitHub repository used by `mise self-update`. |
|
|
10204
10378
|
|
|
@@ -10216,6 +10390,30 @@ GitHub API base URL used by `mise self-update`.
|
|
|
10216
10390
|
|
|
10217
10391
|
---
|
|
10218
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
|
+
|
|
10219
10417
|
##### `minimumReleaseAge`<sup>Optional</sup> <a name="minimumReleaseAge" id="mise-projen.SettingsSelfUpdate.property.minimumReleaseAge"></a>
|
|
10220
10418
|
|
|
10221
10419
|
```typescript
|
|
@@ -11130,6 +11328,36 @@ public readonly statsReport: string;
|
|
|
11130
11328
|
|
|
11131
11329
|
---
|
|
11132
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
|
+
|
|
11133
11361
|
### SettingsUpgrade <a name="SettingsUpgrade" id="mise-projen.SettingsUpgrade"></a>
|
|
11134
11362
|
|
|
11135
11363
|
#### Initializer <a name="Initializer" id="mise-projen.SettingsUpgrade.Initializer"></a>
|
|
@@ -11173,6 +11401,66 @@ Grace period before versions replaced by `mise upgrade` are automatically pruned
|
|
|
11173
11401
|
|
|
11174
11402
|
---
|
|
11175
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
|
+
|
|
11176
11464
|
### SettingsZig <a name="SettingsZig" id="mise-projen.SettingsZig"></a>
|
|
11177
11465
|
|
|
11178
11466
|
#### Initializer <a name="Initializer" id="mise-projen.SettingsZig.Initializer"></a>
|
|
@@ -12633,6 +12921,7 @@ A mise-provided user service.
|
|
|
12633
12921
|
| **Name** | **Description** |
|
|
12634
12922
|
| --- | --- |
|
|
12635
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. |
|
|
12636
12925
|
|
|
12637
12926
|
---
|
|
12638
12927
|
|
|
@@ -12643,6 +12932,13 @@ history-watch.
|
|
|
12643
12932
|
---
|
|
12644
12933
|
|
|
12645
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
|
+
|
|
12646
12942
|
### MiseTomlSchemaBootstrapServicesOnChange <a name="MiseTomlSchemaBootstrapServicesOnChange" id="mise-projen.MiseTomlSchemaBootstrapServicesOnChange"></a>
|
|
12647
12943
|
|
|
12648
12944
|
System scope only.
|
|
@@ -12964,6 +13260,33 @@ manual.
|
|
|
12964
13260
|
---
|
|
12965
13261
|
|
|
12966
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
|
+
|
|
12967
13290
|
### SettingsLibc <a name="SettingsLibc" id="mise-projen.SettingsLibc"></a>
|
|
12968
13291
|
|
|
12969
13292
|
Libc implementation to use for precompiled Linux binaries.
|
package/lib/index.js
CHANGED
|
@@ -57,7 +57,7 @@ __exportStar(require("./types"), exports);
|
|
|
57
57
|
* project.with(new Mise({ config: { tools: { node: ['24'] } } }));
|
|
58
58
|
*/
|
|
59
59
|
class Mise {
|
|
60
|
-
static [JSII_RTTI_SYMBOL_1] = { fqn: "mise-projen.Mise", version: "0.0.
|
|
60
|
+
static [JSII_RTTI_SYMBOL_1] = { fqn: "mise-projen.Mise", version: "0.0.9" };
|
|
61
61
|
fileName;
|
|
62
62
|
config;
|
|
63
63
|
autoDiscover;
|