Skip to content

Add artist, album to item entry template in the web plugin #5753

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

Open
wants to merge 12 commits into
base: master
Choose a base branch
from

Conversation

matlads
Copy link
Contributor

@matlads matlads commented Apr 25, 2025

Description

Add the artist and album information to the item template in the web plugin.

When searching for an item, Instead of

Doo Woop (That Thing)

the interface now shows

Lauryn Hill - The Miseducation of Lauryn Hill - Doo Wop (That Thing)

which is arguably clearer, and matches the default output of beet ls in the cli.

To Do

  • Documentation.
  • Changelog.
  • Tests.

@matlads
Copy link
Contributor Author

matlads commented May 7, 2025

before:

before

after:

after

@matlads matlads force-pushed the feature/add-artist-to-item-entry-template branch from 2f5a49b to 977559c Compare May 8, 2025 18:40
@snejus snejus requested a review from Copilot May 11, 2025 00:51
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR enhances the web plugin by displaying additional metadata in the search results, showing the artist and album along with the title.

  • Updates the changelog with a new entry for the web plugin.
  • Modifies the item entry template in the web plugin to include artist and album information.

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
docs/changelog.rst Added a changelog entry for updated search result display.
beetsplug/web/templates/index.html Updated the item entry template to show "artist – album – title".

@matlads matlads force-pushed the feature/add-artist-to-item-entry-template branch from 977559c to ab7b7a2 Compare May 18, 2025 18:01
matlads and others added 2 commits July 6, 2025 12:14
handling cases where the artist or album data might be missing to avoid
rendering extraneous separators. Suggested by Copilot.
Copy link
Member

@snejus snejus left a comment

Choose a reason for hiding this comment

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

thanks!

@snejus
Copy link
Member

snejus commented Jul 6, 2025

@matlads Would you mind moving your changelog note to the Unreleased section?

@matlads
Copy link
Contributor Author

matlads commented Jul 7, 2025

@matlads Would you mind moving your changelog note to the Unreleased section?

Done.

I have a question about this, though. Why not leave the changelog entry where it was? When beets gets a new release, this section will have to be copied over to the 'New features' or whichever section is relevant. It sort of undoes this last commit.

I may have missed something in some discussion or documentation, so any pointers would be helpful.

Thanks.

@snejus
Copy link
Member

snejus commented Jul 7, 2025

@matlads Would you mind moving your changelog note to the Unreleased section?

Done.

I have a question about this, though. Why not leave the changelog entry where it was? When beets gets a new release, this section will have to be copied over to the 'New features' or whichever section is relevant. It sort of undoes this last commit.

I may have missed something in some discussion or documentation, so any pointers would be helpful.

Thanks.

You should indeed place it under the relevant subsection! (New features in this case). When I looked at this yesterday, it seemed like the note was under section 2.3.0 which had already been released?

matlads and others added 2 commits July 15, 2025 13:55
After some guidance from @snejus this is the proper place to place the
change log entries, not inside the New features section of _released_
versions.
@matlads
Copy link
Contributor Author

matlads commented Jul 15, 2025

@matlads Would you mind moving your changelog note to the Unreleased section?

Done.
I have a question about this, though. Why not leave the changelog entry where it was? When beets gets a new release, this section will have to be copied over to the 'New features' or whichever section is relevant. It sort of undoes this last commit.
I may have missed something in some discussion or documentation, so any pointers would be helpful.
Thanks.

You should indeed place it under the relevant subsection! (New features in this case). When I looked at this yesterday, it seemed like the note was under section 2.3.0 which had already been released?

All done. Thanks for the pointer.

matlads and others added 2 commits July 18, 2025 00:25
After some guidance from @snejus this is the proper place to place the
change log entries, not inside the New features section of _released_
versions.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants