Changing section titles, how to edit "Sponsor Me!" in the Sponsors plugin?

[Lissy93]

Is there a way to change the default title of a plugin section?

Specifically, in the Sponsor plugin, I would really like the title to be something like "Thank you" instead of "Sponsor Me".

---

I'd be happy to try and submit a PR, if this is something that might be useful to others? I'm not sure if this is just a case of replacing the hard-coded value with something like plugins.sponsors.title || "Sponsor me!", and adding it the action.yml file and the docs. Or is there's more to it than that?

---

I also wanted to say a big thank you to @lowlighter - This project is super awesome, and everything is beautifully documented 🙌
I've had a lot of fun playing around with it, and it's clear how much time you've put towards building it. So I've sent you a couple of quid so you can get yourself a few drinks, as a small thank you.

[lowlighter]

Hi 👋 !

Thanks a lot for your kind words and support, I really appreciate it and am happy you like this project 😄 !

I think indeed a plugin_sponsors_title would make a lot of sense in this context.
The website screenshot plugin actually have a similar feature where you can change the section title:

metrics/source/plugins/community/screenshot/metadata.yml

Lines 26 to 30 in 1713f5e

	plugin_screenshot_title:
	description: |
	Title caption
	type: string
	default: Screenshot

---

I'd be happy to see such a feature, so PRs are welcome 😄

To make this project easier to maintain, action.yml and docs are mostly auto-generated, so they shouldn't be edited directly.

You'll need instead to define the plugin_sponsors_title option within the metadata.yml (which serves as specification, documentation and input validation) of the sponsors plugin.

When imports.metadata.plugins.sponsors.inputs() is called, it'll give you a compliant title value to what was specified in the metadata.yml that you can extract, similarly to the other inputs:

metrics/source/plugins/sponsors/index.mjs

Line 10 in 1713f5e

let {size, sections, past} = await imports.metadata.plugins.sponsors.inputs({data, account, q})

Then just send it back at the end to expose it in templating:

metrics/source/plugins/sponsors/index.mjs

Line 84 in 1713f5e

return {sections, about, list, count, goal, size, past}

And you'll be able to patch the template by using <%= plugins.sponsors.title %> instead like you suggested:

metrics/source/templates/classic/partials/sponsors.ejs

Line 5 in 1713f5e

Sponsor me!

It's not necessary to add a test case, since they only check that code is able to run, they aren't capable of checking the content of the resulting SVG atm

---

Hope this helps 👍 !

[Lissy93]

Awesome, thank you for the detailed explanation. I've submitted a PR in #1128 :)