Use plural in package name and add matching library #199
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Every package should provide a library whose name matches that of the package. This allows tools, such as those used by Melpa, to extract metadata. At the same time every library named "*-theme.el" must itself implement a theme because `load-theme' unfortunately assumes that every file on `custom-theme-load-path' with such a name actually provides a theme. If it encounters files that to not provide a theme but are never-the-less named "*-theme.el", then it falsely offers those as themes, and trying to activate them will result in errors. Furthermore, since this package provides multiple themes, it makes sense to give it a name that suggests so. Unfortunately package.el does not (yet?) support informing the user about package renames or even automatically updating to the new name, so some users will not notice this rename for a while. Add a note at the beginning of the readme, in the hope that will help at least some users.
tarsius
added a commit
to emacsmirror/spacemacs-theme
that referenced
this pull request
Dec 9, 2022
[emacsmirror] This patch is being rebased on the Emacsmirror. This package should be named `spacemacs-themes' because it provides more than one theme. But upstream calls it `spacemacs-theme' and Melpa and Emacsmirror will continue to use that name as well, until it is fixed upstream. The file "spacemacs-theme.el" is added only so we can extract metadata from the (currently) expected place. A stub "spacemacs-common.el" file is only preserved until upstream merges the name change because "ewal" requires it. Once the pr is merged I will create a pr for "ewal" to address this. nashamri#199 Original commit message, submitted to upstream: Use plural in package name and add matching library Every package should provide a library whose name matches that of the package. This allows tools, such as those used by Melpa, to extract metadata. At the same time every library named "*-theme.el" must itself implement a theme because `load-theme' unfortunately assumes that every file on `custom-theme-load-path' with such a name actually provides a theme. If it encounters files that to not provide a theme but are never-the-less named "*-theme.el", then it falsely offers those as themes, and trying to activate them will result in errors. Furthermore, since this package provides multiple themes, it makes sense to give it a name that suggests so. Unfortunately package.el does not (yet?) support informing the user about package renames or even automatically updating to the new name, so some users will not notice this rename for a while. Add a note at the beginning of the readme, in the hope that will help at least some users.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This replaces #63. Also discussed at
melpa/melpa#821. Edit: Sorry linked wrong issue. I meant melpa/melpa#8219.Every package should provide a library whose name matches that of the
package. This allows tools, such as those used by Melpa, to extract
metadata.
At the same time every library named "...-theme.el" must itself
implement a theme because
load-themeunfortunately assumes thatevery file on
custom-theme-load-pathwith such a name actuallyprovides a theme. If it encounters files that to not provide a theme
but are never-the-less named "...-theme.el", then it falsely offers
those as themes, and trying to activate them will result in errors.
Furthermore, since this package provides multiple themes, it makes
sense to give it a name that suggests so.
Unfortunately package.el does not (yet?) support informing the user
about package renames or even automatically updating to the new name,
so some users will not notice this rename for a while. Add a note
at the beginning of the readme, in the hope that will help at least
some users.