Files
nih-plug-template/tools/branding-sites.tsv
T
mikkeli 1dc836dca5 chore: point the placeholder homepage at the org wiki
The Cargo homepage feeds Plugin::URL, which hosts can show to users, so
the placeholder should be somewhere reachable rather than a github.com URL
that never existed.

This retires YOUR-USERNAME and YOUR-PLUGIN-NAME as canonical values, which
is the self-arming STALE mechanism working as designed: both were skipped
while they were part of HOMEPAGE and became live checks the moment they
were not. Both pass, since the whole URL was replaced.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01WHt4DykxXaQnyaJfyS8KCn
2026-09-04 16:14:32 +09:00

46 lines
2.6 KiB
Plaintext

# branding-sites.tsv - every place a canonical name has to appear, and in what form.
#
# Generated and refreshed by tools/brand-plugin.sh; read by tools/check-branding.sh,
# which asserts each pattern is present in its file. Tab-separated, four columns:
#
# kind req = a missing file is a failure; opt = a missing file is a skip
# owner the brand-plugin.sh rule that manages this row, or "custom" for rows
# you added by hand. Custom rows are preserved across regeneration;
# owned rows are overwritten, so do not hand-edit those.
# file repo-relative path
# pattern literal text that must appear in that file, already resolved
#
# Adding a site for something the template does not ship is a one-line edit here
# with owner "custom" - no shell to change, and it survives the next rename.
#
#kind owner file pattern
req pkg.cargo Cargo.toml name = "plugin_name"
req pkg.bundler bundler.toml [plugin_name]
opt pkg.lock Cargo.lock name = "plugin_name"
opt pkg.ci .github/workflows/ci.yaml cargo xtask bundle plugin_name
opt pkg.readme README.md cargo xtask bundle plugin_name
req display.bundler bundler.toml name = "Plugin Name"
opt display.notice NOTICE Plugin Name
req name.plugin src/lib.rs const NAME: &'static str = "Plugin Name"
req vendor.plugin src/lib.rs const VENDOR: &'static str = "Your Name"
req email.plugin src/lib.rs const EMAIL: &'static str = "your@email.com"
req authors.cargo Cargo.toml authors = ["Your Name <your@email.com>"]
req homepage.cargo Cargo.toml homepage = "https://wiki.novoyuuparosk.org"
req url.plugin src/lib.rs const URL: &'static str = env!("CARGO_PKG_HOMEPAGE")
req description.cargo Cargo.toml description = "A minimal NIH-plug audio plugin"
req description.clap src/lib.rs Some("Your plugin description")
req clapid.plugin src/lib.rs const CLAP_ID: &'static str = "com.your-domain.plugin-name"
req vst3id.plugin src/lib.rs const VST3_CLASS_ID: [u8; 16] = *b"Unique16CharId!!"
req struct.def src/lib.rs struct PluginName {
req struct.plugin src/lib.rs impl Plugin for PluginName {
req struct.clap src/lib.rs impl ClapPlugin for PluginName {
req struct.vst3 src/lib.rs impl Vst3Plugin for PluginName {
req struct.exportclap src/lib.rs nih_export_clap!(PluginName);
req struct.exportvst3 src/lib.rs nih_export_vst3!(PluginName);
req params.def src/lib.rs struct PluginNameParams {
req params.default src/lib.rs impl Default for PluginNameParams {
req params.field src/lib.rs params: Arc<PluginNameParams>,
opt deploy.pkg deploy.ps1 $Package = "plugin_name"
opt deploy.vst3 deploy.ps1 $vst3Name = "Plugin Name.vst3"
opt deploy.clap deploy.ps1 $clapName = "Plugin Name.clap"