[WIP] feat(peard): add segment #7096

NSPC911 · 2025-12-29T08:55:52Z

Prerequisites

I have read and understood the contributing guide.
The commit message follows the conventional commits guidelines.
Tests for the changes have been added (for bug fixes / features).
Docs have been added/updated (for bug fixes / features).

Description

Adds an integration with pear desktop as a segment.

Would like some help with this, because it renders the prompt once, then falls back to the default prompt

AI was used in the creation of this PR for scaffolding purposese, I wanted to rawdog my way through as part of my second interaction with GoLang. Code may be scuffed, I copy-pasted it from other segments like YTM

JanDeDobbeleer · 2025-12-29T08:55:59Z

Thanks for submitting a PR to the project!

In order to review and merge PRs most efficiently, we require that all PRs grant maintainer edit access before we review them. For information on how to do this, see the documentation.

Copilot

Pull request overview

This PR adds a new segment for integrating Pear Desktop music player into Oh My Posh. The implementation follows the pattern of existing music segments (YTM, Spotify), querying a local API endpoint to display currently playing track information. However, the implementation has several critical bugs that need to be addressed before merging.

Key Changes:

New Pear Desktop segment implementation with API integration
Documentation and schema configuration for the segment
Test coverage for various playback states and error conditions

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 7 comments.

Show a summary per file

File	Description
src/segments/peard.go	Core segment implementation that queries Pear Desktop's local API to fetch track information and status
src/segments/peard_test.go	Unit tests covering playing/paused states, error handling, and custom port configuration
src/config/segment_types.go	Registers the new PEARD segment type in the type system
website/docs/segments/music/peard.mdx	Documentation explaining setup, configuration options, and template properties
website/sidebars.js	Adds Pear Desktop segment to the music section of the documentation sidebar
themes/schema.json	JSON schema definition for segment validation and IDE autocomplete

Copilot · 2025-12-29T08:59:49Z

src/segments/peard.go

+		p.Icon = p.options.String(PausedIcon, "\uf04b ")
+		return nil
+	}
+
+	p.Status = playing
+	p.Icon = p.options.String(PlayingIcon, "\uf04c ")


The playing and paused icons are swapped. When paused, the code uses PlayingIcon (play symbol \uf04b), but should use PausedIcon (pause symbol). Similarly, when playing, it uses PausedIcon instead of PlayingIcon. The logic should be:

When paused: use PausedIcon (\uf04c)

When playing: use PlayingIcon (\uf04b)

Suggested change

p.Icon = p.options.String(PausedIcon, "\uf04b ")

return nil

}

p.Status = playing

p.Icon = p.options.String(PlayingIcon, "\uf04c ")

p.Icon = p.options.String(PausedIcon, "\uf04c ")

return nil

}

p.Status = playing

p.Icon = p.options.String(PlayingIcon, "\uf04b ")

Copilot · 2025-12-29T08:59:49Z

src/segments/peard.go

+
+const (
+	// Port is the port to connect to Pear Desktop API
+	Port options.Option = "port"


The constants PlayingIcon and PausedIcon are used but never defined in this file. These need to be added to the const block. You can reference how other music segments like Spotify define these constants.

Suggested change

Port options.Option = "port"

Port options.Option = "port"

PlayingIcon options.Option = "playing_icon"

PausedIcon options.Option = "paused_icon"

Copilot · 2025-12-29T08:59:49Z

src/segments/peard.go

+
+const (
+	// Port is the port to connect to Pear Desktop API
+	Port options.Option = "port"


The constants 'playing' and 'paused' are used but never defined. These need to be added to the const block, similar to how they're defined in the Spotify segment.

Suggested change

Port options.Option = "port"

Port options.Option = "port"

paused = "paused"

playing = "playing"

src/segments/peard_test.go

website/docs/segments/music/peard.mdx

themes/schema.json

Copilot · 2025-12-29T08:59:50Z

website/docs/segments/music/peard.mdx

+You need to enable the API Server plugin in the Pear Desktop settings.
+To do this, open the app, go to `Plugins > API Server [Beta]` and enable it.
+
+You must also disable authorization in `Plugins > API Server [Beta] > Authorization Strategy` for the segment to work.


The instruction to disable authorization in the Pear Desktop API Server [Beta] (Authorization Strategy) effectively turns off access control for that API, which can expose playback controls and metadata to any process (or potentially any host) that can reach the API port. An attacker on the same machine or network could abuse this to query or control the player without the user’s consent if the API is not strictly bound to localhost or otherwise isolated. Instead of fully disabling authorization, the segment should support a secure auth mechanism (or clearly document a restricted, localhost-only configuration) so that the API remains protected.

Suggested change

You must also disable authorization in `Plugins > API Server [Beta] > Authorization Strategy` for the segment to work.

Ensure the API Server is configured securely (for example, keep an authorization strategy enabled and/or bind the API to `localhost` only) and that your segment is configured to use the same port.

NSPC911 · 2025-12-29T09:01:23Z

I spammed the hell out of the Stop Review button, and Copilot refused...

JanDeDobbeleer · 2025-12-29T09:03:12Z

Thanks for submitting a PR to the project!

In order to review and merge PRs most efficiently, we require that all PRs grant maintainer edit access before we review them. For information on how to do this, see the documentation.

NSPC911 · 2025-12-29T09:17:01Z

In order to review and merge PRs most efficiently, we require that all PRs grant maintainer edit access before we review them. For information on how to do this, see the documentation.

well, it's not there, so I don't know what to do

JanDeDobbeleer · 2025-12-29T19:59:31Z

@NSPC911 to solve the issue you have, make sure to add the segment struct to the gob registry as well.

Copilot

Pull request overview

Copilot reviewed 6 out of 6 changed files in this pull request and generated 7 comments.

src/segments/peard.go

website/docs/segments/music/peard.mdx

themes/schema.json

Copilot · 2025-12-30T01:43:00Z

website/docs/segments/music/peard.mdx

+| `.TrackUrl`       | `string` | YouTube Music URL for the track                                                                           |
+| `.ArtistUrl`      | `string` | YouTube Music URL for the artist                                                                          |
+| `.MediaType`      | `string` | Media type (`AUDIO`, `ORIGINAL_MUSIC_VIDEO`, `USER_GENERATED_CONTENT`, `PODCAST_EPISODE`, `OTHER_VIDEO`)  |


The documentation incorrectly states that TrackUrl, ArtistUrl, and MediaType properties return "YouTube Music" URLs and types. These properties should describe Pear Desktop-specific values, not YouTube Music values. Update the descriptions to accurately reflect what Pear Desktop returns for these fields.

Suggested change

| `.TrackUrl` | `string` | YouTube Music URL for the track |

| `.ArtistUrl` | `string` | YouTube Music URL for the artist |

| `.MediaType` | `string` | Media type (`AUDIO`, `ORIGINAL_MUSIC_VIDEO`, `USER_GENERATED_CONTENT`, `PODCAST_EPISODE`, `OTHER_VIDEO`) |

| `.TrackUrl` | `string` | URL for the current track as reported by Pear Desktop (for example, a web URL or app deep link; may be empty) |

| `.ArtistUrl` | `string` | URL for the current artist as reported by Pear Desktop (for example, a web URL or app deep link; may be empty) |

| `.MediaType` | `string` | Media type value returned by Pear Desktop for the current item (for example, `AUDIO`, `VIDEO`, or other app-specific types) |

src/config/segment_types.go

src/segments/peard.go

NSPC911 · 2025-12-30T02:00:47Z

I want to know, so Pear Desktop does support API Authentication, and doing something like curl -X POST https://127.0.0.1/auth/oh-my-posh gives you a json of {"accessToken":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"} but I'm not sure how to implement it, aside from well just copy pasting code

The cache as well, I don't think Pear Desktop has any sort of limits, so spamming is possible, but should Caching be implemented?

_{also oh my god copilot, I turned him off already, he still wants to review it}

Copilot

Pull request overview

Copilot reviewed 6 out of 6 changed files in this pull request and generated 3 comments.

Copilot · 2025-12-30T02:01:16Z

src/segments/peard.go

+	Base
+
+	Status         string
+	Artist         string
+	Track          string
+	TrackUrl       string
+	ArtistUrl      string
+	MediaType      string
+	IsPaused       bool
+	SongDuration   int
+	ElapsedSeconds int
+	Icon           string


The PearDesktop struct duplicates fields that already exist in the MusicPlayer struct (Status, Artist, Track, Icon). Following the pattern used by Spotify and YTM segments, this struct should embed MusicPlayer instead of duplicating its fields. This would eliminate redundancy and ensure consistency with other music player segments.

Suggested change

Base

Status string

Artist string

Track string

TrackUrl string

ArtistUrl string

MediaType string

IsPaused bool

SongDuration int

ElapsedSeconds int

Icon string

MusicPlayer

TrackUrl string

ArtistUrl string

MediaType string

IsPaused bool

SongDuration int

ElapsedSeconds int

Copilot · 2025-12-30T02:01:16Z

src/segments/peard.go

+	IsPaused       bool   `json:"isPaused"`
+	SongDuration   int    `json:"songDuration"`
+	ElapsedSeconds int    `json:"elapsedSeconds"`
+	Url            string `json:"url"`


The Url field name violates Go naming conventions. According to Go style guides, initialisms should be all uppercase or all lowercase. This should be renamed to URL to follow idiomatic Go naming, matching the pattern used in ArtistUrl which should also be ArtistURL.

Copilot · 2025-12-30T02:01:16Z

src/segments/peard.go

+	TrackUrl       string
+	ArtistUrl      string
+	MediaType      string


The TrackUrl and ArtistUrl field names in the struct violate Go naming conventions. According to Go style guides, initialisms like URL should be all uppercase or all lowercase. These should be renamed to TrackURL and ArtistURL to follow idiomatic Go naming.

Copilot AI review requested due to automatic review settings December 29, 2025 08:55

Copilot started reviewing on behalf of NSPC911 December 29, 2025 08:56 View session

NSPC911 marked this pull request as ready for review December 29, 2025 08:58

Copilot AI reviewed Dec 29, 2025

View reviewed changes

NSPC911 force-pushed the peard branch from 0a4455b to 0d15613 Compare December 29, 2025 09:18

NSPC911 force-pushed the peard branch from 0d15613 to 5906fba Compare December 30, 2025 01:37

Copilot AI review requested due to automatic review settings December 30, 2025 01:37

Copilot started reviewing on behalf of NSPC911 December 30, 2025 01:38 View session

Copilot AI reviewed Dec 30, 2025

View reviewed changes

NSPC911 force-pushed the peard branch from 5906fba to c27ab1c Compare December 30, 2025 01:54

feat(peard): add segment

4ed86de

Copilot AI review requested due to automatic review settings December 30, 2025 01:57

NSPC911 force-pushed the peard branch from c27ab1c to 4ed86de Compare December 30, 2025 01:57

Copilot started reviewing on behalf of NSPC911 December 30, 2025 01:58 View session

Copilot AI reviewed Dec 30, 2025

View reviewed changes

	You must also disable authorization in `Plugins > API Server [Beta] > Authorization Strategy` for the segment to work.
	Ensure the API Server is configured securely (for example, keep an authorization strategy enabled and/or bind the API to `localhost` only) and that your segment is configured to use the same port.

Uh oh!

[WIP] feat(peard): add segment #7096

Are you sure you want to change the base?

[WIP] feat(peard): add segment #7096

Conversation

NSPC911 commented Dec 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Prerequisites

Description

Uh oh!

JanDeDobbeleer commented Dec 29, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Dec 29, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 29, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 29, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI Dec 29, 2025

Choose a reason for hiding this comment

Uh oh!

NSPC911 commented Dec 29, 2025

Uh oh!

JanDeDobbeleer commented Dec 29, 2025

Uh oh!

NSPC911 commented Dec 29, 2025

Uh oh!

JanDeDobbeleer commented Dec 29, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI Dec 30, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

NSPC911 commented Dec 30, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Dec 30, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 30, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 30, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

NSPC911 commented Dec 29, 2025 •

edited

Loading