Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(style): format example variables with gofmt #224

Merged
merged 1 commit into from
May 8, 2024

Conversation

zimeg
Copy link
Contributor

@zimeg zimeg commented May 8, 2024

👋 Hello! These are cool forms and prompts! Small formatting change to a few variable types in this PR.

@zimeg zimeg requested a review from maaslalani as a code owner May 8, 2024 07:35
@maaslalani maaslalani merged commit 1395791 into charmbracelet:main May 8, 2024
@maaslalani
Copy link
Contributor

Thanks so much, really appreciate it! ❤️

@zimeg zimeg deleted the docs-style-format branch May 8, 2024 16:35
renovate bot referenced this pull request in jippi/dottie Jun 5, 2024
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [github.com/charmbracelet/huh](https://github.com/charmbracelet/huh)
| `v0.3.0` -> `v0.4.2` |
[![age](https://developer.mend.io/api/mc/badges/age/go/github.com%2fcharmbracelet%2fhuh/v0.4.2?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/go/github.com%2fcharmbracelet%2fhuh/v0.4.2?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/go/github.com%2fcharmbracelet%2fhuh/v0.3.0/v0.4.2?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/go/github.com%2fcharmbracelet%2fhuh/v0.3.0/v0.4.2?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
|
[github.com/charmbracelet/lipgloss](https://github.com/charmbracelet/lipgloss)
| `v0.10.0` -> `v0.11.0` |
[![age](https://developer.mend.io/api/mc/badges/age/go/github.com%2fcharmbracelet%2flipgloss/v0.11.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/go/github.com%2fcharmbracelet%2flipgloss/v0.11.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/go/github.com%2fcharmbracelet%2flipgloss/v0.10.0/v0.11.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/go/github.com%2fcharmbracelet%2flipgloss/v0.10.0/v0.11.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>charmbracelet/huh (github.com/charmbracelet/huh)</summary>

###
[`v0.4.2`](https://github.com/charmbracelet/huh/releases/tag/v0.4.2)

[Compare
Source](https://github.com/charmbracelet/huh/compare/v0.4.1...v0.4.2)

### Your favourite files 📁

Huh? `v0.4.0` (`v0.4.2`) introduces the File Picker to forms ✨

Prompt users to select a file in just a few lines of code, you know the
drill :)

```go
var file string

huh.NewFilePicker().
    Title("Select a file:").
    Description("This will be your profile image.").
    AllowedTypes([]string{".png", ".jpeg", ".webp", ".gif"}).
    Value(&file)
```

<img width="600"
src="https://vhs.charm.sh/vhs-5DCaCK6WfJGCUuWMjTXLrM.gif" alt="Made with
VHS">

***

#### Field Interface

##### Zoom

File pickers introduce a new `Zoom` method to the `Field` interface.

```go
type Field interface {

    // ...

    Zoom() bool

    // ...

}
```

`Zoom` tells the form whether this field should be the only visible
field.

Notice how the `FilePicker` field zooms in when selecting a file and
zooms out when the file is selected, showing only the selected file.

##### Skip

Notes introduce a new `Skip` method to the `Field` interface.

```go
type Field interface {

    // ...

    Skip() bool

    // ...

}
```

Skip indicates to the form whether or not to skip this field, i.e. don't
let the user interact with it. This is useful for notes to be purely
informational.

#### What else?

- feat: set `height` in `WithHeight` by
[@&#8203;ardnew](https://github.com/ardnew) in
[https://github.com/charmbracelet/huh/pull/122](https://github.com/charmbracelet/huh/pull/122)
- feat: use `EchoMode` for `Input` by
[@&#8203;caarlos0](https://github.com/caarlos0) in
[https://github.com/charmbracelet/huh/pull/131](https://github.com/charmbracelet/huh/pull/131)
- feat: zoom `FilePicker` by
[@&#8203;maaslalani](https://github.com/maaslalani) in
[https://github.com/charmbracelet/huh/pull/133](https://github.com/charmbracelet/huh/pull/133)
- feat: inline `Select` by
[@&#8203;maaslalani](https://github.com/maaslalani) in
[https://github.com/charmbracelet/huh/pull/136](https://github.com/charmbracelet/huh/pull/136)
- feat: <kbd>ctrl+u</kbd>, <kbd>ctrl+d</kbd>, <kbd>g</kbd>, and
<kbd>G</kbd> keybindings on `Select` by
[@&#8203;caarlos0](https://github.com/caarlos0) in
[https://github.com/charmbracelet/huh/pull/143](https://github.com/charmbracelet/huh/pull/143)
- feat: predefined `ValidationFunc`s by
[@&#8203;anirudhaCodes](https://github.com/anirudhaCodes) in
[https://github.com/charmbracelet/huh/pull/140](https://github.com/charmbracelet/huh/pull/140)
- feat: make `PrevField` and `NextField` public by
[@&#8203;KevM](https://github.com/KevM) in
[https://github.com/charmbracelet/huh/pull/175](https://github.com/charmbracelet/huh/pull/175)
- feat: accessible mode when `TERM=dumb` by
[@&#8203;maaslalani](https://github.com/maaslalani) in
[https://github.com/charmbracelet/huh/pull/188](https://github.com/charmbracelet/huh/pull/188)
- feat: `WithOutput` API by
[@&#8203;maaslalani](https://github.com/maaslalani) in
[https://github.com/charmbracelet/huh/pull/201](https://github.com/charmbracelet/huh/pull/201)
- feat: set note next button label by
[@&#8203;abtmr](https://github.com/abtmr) in
[https://github.com/charmbracelet/huh/pull/225](https://github.com/charmbracelet/huh/pull/225)

##### Bug Fixes

- fix: overlapping style issue in render function of `field_note` by
[@&#8203;anirudhaCodes](https://github.com/anirudhaCodes) in
[https://github.com/charmbracelet/huh/pull/112](https://github.com/charmbracelet/huh/pull/112)
- fix: `MultiSelect` limit in Accessible Mode by
[@&#8203;anirudhaCodes](https://github.com/anirudhaCodes) in
[https://github.com/charmbracelet/huh/pull/125](https://github.com/charmbracelet/huh/pull/125)
- fix: CharLimit of `Text` field in Accessible mode by
[@&#8203;anirudhaCodes](https://github.com/anirudhaCodes) in
[https://github.com/charmbracelet/huh/pull/126](https://github.com/charmbracelet/huh/pull/126)
- fix: set themes on fields by
[@&#8203;maaslalani](https://github.com/maaslalani) in
[https://github.com/charmbracelet/huh/pull/219](https://github.com/charmbracelet/huh/pull/219)
- fix: remove temporary file after opening external editor in `Text`
field by [@&#8203;auvred](https://github.com/auvred) in
[https://github.com/charmbracelet/huh/pull/154](https://github.com/charmbracelet/huh/pull/154)
- fix: spinner bubbles up `tea.Program` errors by
[@&#8203;clowder](https://github.com/clowder) in
[https://github.com/charmbracelet/huh/pull/237](https://github.com/charmbracelet/huh/pull/237)

#### New Contributors

A special thanks to everyone who made this release of Huh? possible! 🤗

- [@&#8203;theredditbandit](https://github.com/theredditbandit) made
their first contribution in
[https://github.com/charmbracelet/huh/pull/102](https://github.com/charmbracelet/huh/pull/102)
- [@&#8203;anirudhaCodes](https://github.com/anirudhaCodes) made their
first contribution in
[https://github.com/charmbracelet/huh/pull/112](https://github.com/charmbracelet/huh/pull/112)
- [@&#8203;rharshit82](https://github.com/rharshit82) made their first
contribution in
[https://github.com/charmbracelet/huh/pull/128](https://github.com/charmbracelet/huh/pull/128)
- [@&#8203;stefanlogue](https://github.com/stefanlogue) made their
first contribution in
[https://github.com/charmbracelet/huh/pull/99](https://github.com/charmbracelet/huh/pull/99)
- [@&#8203;auvred](https://github.com/auvred) made their first
contribution in
[https://github.com/charmbracelet/huh/pull/154](https://github.com/charmbracelet/huh/pull/154)
- [@&#8203;KevM](https://github.com/KevM) made their first
contribution in
[https://github.com/charmbracelet/huh/pull/175](https://github.com/charmbracelet/huh/pull/175)
- [@&#8203;zimeg](https://github.com/zimeg) made their first
contribution in
[https://github.com/charmbracelet/huh/pull/224](https://github.com/charmbracelet/huh/pull/224)
- [@&#8203;bradyjoslin](https://github.com/bradyjoslin) made their
first contribution in
[https://github.com/charmbracelet/huh/pull/241](https://github.com/charmbracelet/huh/pull/241)
- [@&#8203;joshi4](https://github.com/joshi4) made their first
contribution in
[https://github.com/charmbracelet/huh/pull/232](https://github.com/charmbracelet/huh/pull/232)
- [@&#8203;abtmr](https://github.com/abtmr) made their first
contribution in
[https://github.com/charmbracelet/huh/pull/225](https://github.com/charmbracelet/huh/pull/225)
- [@&#8203;clowder](https://github.com/clowder) made their first
contribution in
[https://github.com/charmbracelet/huh/pull/237](https://github.com/charmbracelet/huh/pull/237)

**Full Changelog**:
charmbracelet/huh@v0.3.0...v0.4.0

***

<a href="https://charm.sh/"><img alt="The Charm logo"
src="https://stuff.charm.sh/charm-badge.jpg" width="400"></a>

Thoughts? Questions? We love hearing from you. Feel free to reach out on
[Twitter](https://twitter.com/charmcli), [The
Fediverse](https://mastodon.technology/@&#8203;charm), or
[Slack](https://charm.sh/slack).

###
[`v0.4.1`](https://github.com/charmbracelet/huh/compare/v0.4.0...v0.4.1)

[Compare
Source](https://github.com/charmbracelet/huh/compare/v0.4.0...v0.4.1)

###
[`v0.4.0`](https://github.com/charmbracelet/huh/compare/v0.3.0...v0.4.0)

[Compare
Source](https://github.com/charmbracelet/huh/compare/v0.3.0...v0.4.0)

</details>

<details>
<summary>charmbracelet/lipgloss
(github.com/charmbracelet/lipgloss)</summary>

###
[`v0.11.0`](https://github.com/charmbracelet/lipgloss/releases/tag/v0.11.0)

[Compare
Source](https://github.com/charmbracelet/lipgloss/compare/v0.10.0...v0.11.0)

### Immutable Styles and Raw Speed, Baby

So! The big news in this release is:

-   `Style` methods will now *always* return new styles
-   `Style` and ANSI operations under the hood are faster

There are also a handful of great lil' bug fixes. Read on for more.

#### Immutable Styles

Every `Style` method now returns a completely new style with its own
underlying data structure no matter what. This means working with Styles
is a lot easier. No more need for `Copy()`!

```go
// Before
s := lipgloss.NewStyle().Bold(true)
newStyle := s.Copy()

// After
s := lipgloss.NewStyle().Bold(true)
newStyle := s // this is a true copy
```

Okay, but why are styles easier to work with now? Consider this:

```go
// Before
baseStyle := lipgloss.NewStyle().Background(lipgloss.Color("59"))
styleAtRuntime := baseStyle.Copy().Width(m.Width)

// After
baseStyle := lipgloss.NewStyle().Padding(1, 2)
styleAtRuntime := baseStyle.Width(m.Width)
```

It might seem small, but eliminating the risk of mutations in persistent
styles in an enormous usability improvement.

##### How to upgrade

There's nothing to do, however `Style.Copy()` is now deprecated and only
returns itself, so you can just remove `Style.Copy()` calls. If you need
to *just* copy a style without any changes to it you can simply `b :=
a`.

#### Faster ANSI

Sometimes watch companies brag about their "in-house" watch movement.
Well, now we're bragging about our in-house-amazing
[`x/ansi`](https://github.com/charmbracelet/x/tree/main/ansi) library
by our own [@&#8203;aymanbagabas](https://github.com/aymanbagabas).
It's a fine-tuned, low-level way to manage ANSI sequencing and, because
we're pretty nerdy, we’re *super* excited about it.

***

#### What's Changed

##### New!

- always return copies of styles by
[@&#8203;aymanbagabas](https://github.com/aymanbagabas) in
[https://github.com/charmbracelet/lipgloss/pull/276](https://github.com/charmbracelet/lipgloss/pull/276)

##### Changed

- switch to term/ansi for text manipulation by
[@&#8203;aymanbagabas](https://github.com/aymanbagabas) in
[https://github.com/charmbracelet/lipgloss/pull/268](https://github.com/charmbracelet/lipgloss/pull/268)
- replace stripansi with ansi.Strip in table by
[@&#8203;aymanbagabas](https://github.com/aymanbagabas) in
[https://github.com/charmbracelet/lipgloss/pull/271](https://github.com/charmbracelet/lipgloss/pull/271)
- test for different GOOS & GOARCH by
[@&#8203;aymanbagabas](https://github.com/aymanbagabas) in
[https://github.com/charmbracelet/lipgloss/pull/292](https://github.com/charmbracelet/lipgloss/pull/292)

##### Fixed

- fix combining both conditional and unconditional wrapping by
[@&#8203;aymanbagabas](https://github.com/aymanbagabas) in
[https://github.com/charmbracelet/lipgloss/pull/275](https://github.com/charmbracelet/lipgloss/pull/275)
- fix UnderlineSpaces and StrikethroughSpaces by
[@&#8203;Taz03](https://github.com/Taz03) in
[https://github.com/charmbracelet/lipgloss/pull/299](https://github.com/charmbracelet/lipgloss/pull/299)
- always render horizontal border edges when enabled by
[@&#8203;UnseenBook](https://github.com/UnseenBook) in
[https://github.com/charmbracelet/lipgloss/pull/211](https://github.com/charmbracelet/lipgloss/pull/211)
- fix possible nil panic by
[@&#8203;maaslalani](https://github.com/maaslalani) in
[https://github.com/charmbracelet/lipgloss/pull/245](https://github.com/charmbracelet/lipgloss/pull/245)
- fix transform operating on ANSI sequences by
[@&#8203;meowgorithm](https://github.com/meowgorithm) in
[https://github.com/charmbracelet/lipgloss/pull/274](https://github.com/charmbracelet/lipgloss/pull/274)
- change propkeys from int to int64 by
[@&#8203;hugoleodev](https://github.com/hugoleodev) in
[https://github.com/charmbracelet/lipgloss/pull/291](https://github.com/charmbracelet/lipgloss/pull/291)

#### New Contributors

- [@&#8203;benwaffle](https://github.com/benwaffle) made their first
contribution in
[https://github.com/charmbracelet/lipgloss/pull/247](https://github.com/charmbracelet/lipgloss/pull/247)
- [@&#8203;UnseenBook](https://github.com/UnseenBook) made their first
contribution in
[https://github.com/charmbracelet/lipgloss/pull/211](https://github.com/charmbracelet/lipgloss/pull/211)
- [@&#8203;hugoleodev](https://github.com/hugoleodev) made their first
contribution in
[https://github.com/charmbracelet/lipgloss/pull/291](https://github.com/charmbracelet/lipgloss/pull/291)
- [@&#8203;Taz03](https://github.com/Taz03) made their first
contribution in
[https://github.com/charmbracelet/lipgloss/pull/299](https://github.com/charmbracelet/lipgloss/pull/299)

**Full Changelog**:
charmbracelet/lipgloss@v0.10.0...v0.11.0

***

<a href="https://charm.sh/"><img alt="The Charm logo"
src="https://stuff.charm.sh/charm-badge.jpg" width="400"></a>

Thoughts? Questions? We love hearing from you. Feel free to reach out on
[Twitter](https://twitter.com/charmcli), [The
Fediverse](https://mastodon.technology/@&#8203;charm), or
[Discord](https://charm.sh/discord).

</details>

---

### Configuration

📅 **Schedule**: Branch creation - "* */8 * * *" (UTC), Automerge - At
any time (no schedule defined).

🚦 **Automerge**: Enabled.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

👻 **Immortal**: This PR will be recreated if closed unmerged. Get
[config help](https://github.com/renovatebot/renovate/discussions) if
that's undesired.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://developer.mend.io/github/jippi/dottie).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4zODguMSIsInVwZGF0ZWRJblZlciI6IjM3LjM4OC4xIiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6WyJkZXBlbmRlbmNpZXMiXX0=-->

---------

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: Christian Winther <jippignu@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants