20a7b35e50
Adds a doc comment to ModFile.Coords explaining the leading-@ trim and a note on ModPlugin.Scope clarifying that consumers should trim "@" before comparing. Locks in the contract with a test asserting both call shapes produce the same display string. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
61 lines
1.7 KiB
Go
61 lines
1.7 KiB
Go
package plugin
|
|
|
|
import (
|
|
"strings"
|
|
|
|
tomlpkg "github.com/BurntSushi/toml"
|
|
)
|
|
|
|
type ModFile struct {
|
|
Plugin ModPlugin `toml:"plugin"`
|
|
Compatibility *ModCompat `toml:"compatibility"`
|
|
Requires []ModRequirement `toml:"requires"`
|
|
}
|
|
|
|
type ModPlugin struct {
|
|
Name string `toml:"name"`
|
|
// Scope is the plugin owner namespace as it appears in plugin.mod. It may
|
|
// include the leading "@" (e.g. "@themes") or omit it (e.g. "themes") —
|
|
// both forms are accepted. Consumers comparing scopes should trim the "@"
|
|
// before comparing; use ModFile.Coords() for a normalised display string.
|
|
Scope string `toml:"scope"`
|
|
Version string `toml:"version"`
|
|
Kind string `toml:"kind,omitempty"`
|
|
Categories []string `toml:"categories,omitempty"`
|
|
}
|
|
|
|
type ModCompat struct {
|
|
BlockCore string `toml:"block_core"`
|
|
}
|
|
|
|
type ModRequirement struct {
|
|
Name string `toml:"name"`
|
|
Version string `toml:"version"`
|
|
}
|
|
|
|
func ParseModFull(b []byte) (*ModFile, error) {
|
|
var m ModFile
|
|
if err := tomlpkg.Unmarshal(b, &m); err != nil {
|
|
return nil, err
|
|
}
|
|
return &m, nil
|
|
}
|
|
|
|
// Coords returns the canonical display coordinate for the plugin in the form
|
|
// "@scope/name@version" (or "name@version" when no scope is set).
|
|
//
|
|
// The leading "@" on m.Plugin.Scope is intentionally trimmed before
|
|
// re-prefixing so that authors may write either "@themes" or "themes" in
|
|
// plugin.mod and get the same output. Callers that need the raw scope as
|
|
// written should read m.Plugin.Scope directly.
|
|
func (m *ModFile) Coords() string {
|
|
if m == nil {
|
|
return ""
|
|
}
|
|
scope := strings.TrimPrefix(m.Plugin.Scope, "@")
|
|
if scope == "" {
|
|
return m.Plugin.Name + "@" + m.Plugin.Version
|
|
}
|
|
return "@" + scope + "/" + m.Plugin.Name + "@" + m.Plugin.Version
|
|
}
|