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.

Sign up for GitHub

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

Jump to bottom

feat: lipgloss renderer #140

Merged
merged 16 commits into from Feb 9, 2023
Merged

feat: lipgloss renderer #140

merged 16 commits into from Feb 9, 2023

Conversation

aymanbagabas
Copy link
Member

  • bump termenv & reflow
  • use custom renderers
  • update readme
  • add examples

@aymanbagabas aymanbagabas added the enhancement New feature or request label Oct 5, 2022
muesli
muesli reviewed Oct 6, 2022
View reviewed changes
color.go Show resolved Hide resolved
muesli
muesli reviewed Oct 6, 2022
View reviewed changes
renderer.go Outdated Show resolved Hide resolved
@muesli
Copy link
Member

muesli commented Oct 6, 2022

examples/layout/go.mod has an incorrect relative path in the replace directive. Maybe we should just keep a single go.mod directly in examples and not introduce separate definitions per example. Keeping them update is painful enough as it is (see #142 and many other commits).

@aymanbagabas aymanbagabas force-pushed the renderer branch 3 times, most recently from ba1ce87 to 0da4b11 Compare October 6, 2022 17:07
caarlos0 and others added 15 commits February 6, 2023 13:06
@caarlos0 @aymanbagabas
fix: reduce dependencies
87489ac 
Signed-off-by: Carlos A Becker <caarlos0@users.noreply.github.com>
@aymanbagabas
feat: instantiate lipgloss renderers
ea7aa74 
* Use lipgloss instances instead of a singleton global instance
* Deprecate (s Style).Render & (s Style).String
* Deprecate the Stringer interface
* Update README and godocs
* Update example
@aymanbagabas
feat(renderer): use style renderer
44e0f41 
lipgloss.Style now takes a renderer instance to be used to detect styles
and colors based on its termenv.Output and terminal
@aymanbagabas
docs: update readme
39228ae 
* add new color types
* more examples
* custom renderer example
@aymanbagabas
chore: add ssh example
da6fc84
@aymanbagabas
fix(whitespace): use position renderer
7876f7f
@aymanbagabas
fix(whitespace): style color profile
f154d7e
@aymanbagabas
chore: use unified examples go.mod
4fdd6f0
@aymanbagabas
feat(renderer): add WithTermenvOutput option
0f2c9e1
@aymanbagabas
feat: conform to the Go color interface
4b1d4b7 
implement RGBA with the default output
@aymanbagabas
fix: renderer nil check
a8579ce
@aymanbagabas
docs: update readme example
99ae588
@aymanbagabas
feat(opts): use style options
c073b37
@aymanbagabas
chore(tests): add more style tests
2aa5b78
@aymanbagabas
docs: update readme
580ad68
@aymanbagabas aymanbagabas force-pushed the renderer branch 2 times, most recently from a4a40ba to fe255dc Compare February 6, 2023 18:08
@aymanbagabas
chore(examples): update ssh example
0f413ed 
chore(examples): go mod tidy
@nervo nervo mentioned this pull request Feb 8, 2023
Merged
@muesli
Copy link
Member

muesli commented Feb 8, 2023

We should probably unify the example/ and examples/ folder.

muesli
muesli approved these changes Feb 9, 2023
View reviewed changes
Copy link
Member

@muesli muesli left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, LGTM. We could squash a few commits, but we could also just ignore it and go ahead merge this one now.

@aymanbagabas aymanbagabas merged commit 776c15f into master Feb 9, 2023
@aymanbagabas aymanbagabas deleted the renderer branch February 9, 2023 17:00
renovate bot added a commit to sheldonhull/az-pr that referenced this pull request Apr 3, 2023
@renovate
chore(deps): update ⬆️ golang module github.com/charmbracelet/lipglos…
fd3f20c 
…s to v0.7.1 (#7)

[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
|
[github.com/charmbracelet/lipgloss](https://togithub.com/charmbracelet/lipgloss)
| require | minor | `v0.6.0` -> `v0.7.1` |

---

### Release Notes

<details>
<summary>charmbracelet/lipgloss</summary>

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

[Compare
Source](https://togithub.com/charmbracelet/lipgloss/compare/v0.7.0...v0.7.1)

This bugfix release fixes a problem introduced in v0.7.0 where
applications could freeze or hang on start-up.

#### What's Changed

- fix(renderer): use termenv default renderer by
[@&#8203;aymanbagabas](https://togithub.com/aymanbagabas) in
[charmbracelet/lipgloss#179
- chore: bump termenv to v0.15.1 by
[@&#8203;muesli](https://togithub.com/muesli) in
[charmbracelet/lipgloss#180

**Full Changelog**:
charmbracelet/lipgloss@v0.7.0...v0.7.1

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

[Compare
Source](https://togithub.com/charmbracelet/lipgloss/compare/v0.6.0...v0.7.0)

### Custom Renderers

We're pleased to introduce custom renders for Lip Gloss! Custom
renderers allow you to render to a specific outputs, which is
particularly important when you want to detect the color profile and
dark background status for multiple different outputs at runtime, such
as in a server-client situation.

Here's what it looks like:

```go
func myLittleHandler(sess ssh.Session) {
    // Create a renderer for the client.
    renderer := lipgloss.NewRenderer(sess)

    // Create a new style on the renderer.
    style := renderer.NewStyle().Background(lipgloss.AdaptiveColor{Light: "63", Dark: "228"})

    // Render. The color profile and dark background state will be correctly detected.
    io.WriteString(sess, style.Render("Heyyyyyyy"))
}
```

For a full example on using a custom renderer over SSH with
[Wish](https://togithub.com/charmbracelet/wish) see the [SSH
example](https://togithub.com/charmbracelet/lipgloss/blob/master/examples/ssh).

#### New API Stuff

-   `type Renderer struct`
-   `NewRenderer(io.Writer)`
-   `DefaultRenderer()`
-   `SetDefaultRenderer(*lipgloss.Renderer)`
-   `style.Renderer(*lipgloss.Renderer) Style`

#### What's Changed

##### New

- lipgloss renderer by
[@&#8203;aymanbagabas](https://togithub.com/aymanbagabas) in
[charmbracelet/lipgloss#140
and
[charmbracelet/lipgloss#174
- add BlockBorder, OuterHalfBlockBorder, and InnerHalfBlockBorder border
styles by [@&#8203;VictorBersy](https://togithub.com/VictorBersy) in
[charmbracelet/lipgloss#120

##### Fixed

- RGBA implementations for non-hex color values by
[@&#8203;muesli](https://togithub.com/muesli) in
[charmbracelet/lipgloss#126
- unify get border size function names by
[@&#8203;nerg4l](https://togithub.com/nerg4l) in
[charmbracelet/lipgloss#148
- reduce dependencies by
[@&#8203;caarlos0](https://togithub.com/caarlos0) in
[charmbracelet/lipgloss#146
- don't concurrently change output profiles by
[@&#8203;muesli](https://togithub.com/muesli) in
[charmbracelet/lipgloss#172

#### New Contributors

- [@&#8203;dependabot](https://togithub.com/dependabot) made their first
contribution in
[charmbracelet/lipgloss#133
- [@&#8203;winder](https://togithub.com/winder) made their first
contribution in
[charmbracelet/lipgloss#147
- [@&#8203;VictorBersy](https://togithub.com/VictorBersy) made their
first contribution in
[charmbracelet/lipgloss#120
- [@&#8203;nervo](https://togithub.com/nervo) made their first
contribution in
[charmbracelet/lipgloss#156
- [@&#8203;caarlos0](https://togithub.com/caarlos0) made their first
contribution in
[charmbracelet/lipgloss#146
- [@&#8203;Isti115](https://togithub.com/Isti115) made their first
contribution in
[charmbracelet/lipgloss#170
- [@&#8203;nerg4l](https://togithub.com/nerg4l) made their first
contribution in
[charmbracelet/lipgloss#148

**Full Changelog**:
charmbracelet/lipgloss@v0.6.0...v0.7.0

</details>

---

### Configuration

📅 **Schedule**: Branch creation - "before 3am on Monday" (UTC),
Automerge - At any time (no schedule defined).

🚦 **Automerge**: Enabled.

♻ **Rebasing**: Whenever PR is behind base branch, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- 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://app.renovatebot.com/dashboard#github/sheldonhull/az-pr).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNS4yMi4xIiwidXBkYXRlZEluVmVyIjoiMzUuMjIuMSJ9-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@muesli muesli muesli approved these changes

@meowgorithm meowgorithm Awaiting requested review from meowgorithm meowgorithm is a code owner

Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@aymanbagabas @muesli @caarlos0