Skip to content

Commit

Permalink
feat(segments): add bun.lock file support for bun v1.2+
Browse files Browse the repository at this point in the history
  • Loading branch information
@wiyco @JanDeDobbeleer
wiyco authored and JanDeDobbeleer committed Feb 27, 2025
1 parent 17910fa commit 8178872
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 12 deletions.
2 changes: 1 addition & 1 deletion src/segments/bun.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ func (b *Bun) Template() string {
}

func (b *Bun) Enabled() bool {
b.extensions = []string{"bun.lockb"}
b.extensions = []string{"bun.lockb", "bun.lock"}
b.commands = []*cmd{
{
executable: "bun",
Expand Down
3 changes: 2 additions & 1 deletion themes/schema.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -900,7 +900,8 @@
"title": "Extensions",
"description": "The extensions to look for when determining if a folder is a Bun workspace",
"default": [
"bun.lockb"
"bun.lockb",
"bun.lock"
],
"items": {
"type": "string"
Expand Down
20 changes: 10 additions & 10 deletions website/docs/segments/cli/bun.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,16 +23,16 @@ import Config from "@site/src/components/Config.js";

## Properties

| Name | Type | Default | Description |
| ---------------------- | :--------: | :---------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not |
| `fetch_version` | `boolean` | `true` | fetch the active version or not; useful if all you need is an icon indicating `bun` |
| `cache_duration` | `string` | `24h` | the duration for which the version will be cached. The duration is a string in the format `1h2m3s` and is parsed using the [time.ParseDuration] function from the Go standard library. To disable the cache, use `none` |
| `missing_command_text` | `string` | | text to display when the command is missing |
| `display_mode` | `string` | `context` | <ul><li>`always`: the segment is always displayed</li><li>`files`: the segment is only displayed when file `extensions` listed are present</li><li>`context`: displays the segment when the environment or files is active</li></ul> |
| `version_url_template` | `string` | | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `extensions` | `[]string` | `bun.lockb` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | | allows to override the list of folder names to validate |
| Name | Type | Default | Description |
| ---------------------- | :--------: | :-------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not |
| `fetch_version` | `boolean` | `true` | fetch the active version or not; useful if all you need is an icon indicating `bun` |
| `cache_duration` | `string` | `24h` | the duration for which the version will be cached. The duration is a string in the format `1h2m3s` and is parsed using the [time.ParseDuration] function from the Go standard library. To disable the cache, use `none` |
| `missing_command_text` | `string` | | text to display when the command is missing |
| `display_mode` | `string` | `context` | <ul><li>`always`: the segment is always displayed</li><li>`files`: the segment is only displayed when file `extensions` listed are present</li><li>`context`: displays the segment when the environment or files is active</li></ul> |
| `version_url_template` | `string` | | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `extensions` | `[]string` | `bun.lockb, bun.lock` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | | allows to override the list of folder names to validate |

## Template ([info][templates])

Expand Down

0 comments on commit 8178872

Please sign in to comment.