Add translator notes to Gettext strings and update makepot task

[unfulvio-godaddy]

Adds some translators notes requested on #617 via Slack -- Closes #617

About this item:

There are several multi-lines strings. Please provide string in a single line, linguists can adjust the order. Such as
#: rest-api/Controllers/Settings.php:342
msgid ""
"Optional object that defines how the user will interact with and update the "
"setting."
-> "Optional object that defines how the user will interact with and update the setting."

This seems to be the output from our potfile builder, not the source, which truncates lines at 80 chars. I could not find an option in https://github.com/cedaro/grunt-wp-i18n/blob/develop/docs/makepot.md to change this.

We should probably switch to https://developer.wordpress.org/cli/commands/i18n/make-pot/ (something that is recommended also on the Grunt project above) as this other tool does not seem to exhibit the problem. I made a quick test from CLI and runs fine. We could do so with this PR and later update Sake to do the same in plugins. This would require the user to have installed WP CLI (or later have scripts that install the dependency to correctly handle the command).

But I could probably reach the translations team and tell to ignore the line breaks. Nope: they want it without line breaks: #618 (comment)

I have updated the makepot command to switch to WP CLI. I wanted to run a local instance of WP CLI loaded via Composer as dev dependency. However, it turns out that since we bundle Codeception one such dependency already exists and I think it ends up running an older version that doesn't include the i18n command. So I'm a bit stuck there and opted to use a global WP CLI instance - this means if the person running the script doesn't have WP CLI installed, it will fail.

QA

• The cases prompted by Add gettext context for strings #617 are addressed
• Try to run grunt update_translations: the potfile should be generated via WP CLI without line/breaks

No code change, no tests or changelog needed

[unfulvio-godaddy]

edit: it appears that the GoLF team prefers not having multi-line strings to translate - I can imagine this could become troublesome in their system, especially if those lines change - perhaps we should try to implement the new potfile generator in the same context as this PR -- see https://godaddy.slack.com/archives/C07TDQWJ1/p1695707752498609?thread_ts=1695360403.201719&cid=C07TDQWJ1

[itambek-godaddy]

Looking good, although I would tweak the comments here and there.

[itambek-godaddy]

Either 'Authorization' or 'Charge' (untranslated)

Is there a reason why these are untranslated? Perhaps something that was simply initially missed?

[unfulvio-godaddy]

I am not sure unfortunately, and I don't know if there's any legal requirement to keep them as such

[itambek-godaddy]

We should probably switch to https://developer.wordpress.org/cli/commands/i18n/make-pot/ (something that is recommended also on the Grunt project above) as this other tool does not seem to exhibit the problem. I made a quick test from CLI and runs fine. We could do so with this PR and later update Sake to do the same in plugins. This would require the user to have installed WP CLI (or later have scripts that install the dependency to correctly handle the command).

@unfulvio-godaddy with GoLF integration in place, this should already be done for us with GitHub Actions. It looks like the actions to update and send files to translations have not yet been set up in this repo, though. I'm going to try going through the rest of the setup steps today, to hopefully finish the integration.

However, since this is an open-source project, I think your suggestion to switch from grunt-wp-i18n to wp-cli i18n makes sense (also, for sake to use the cli tool).

[itambek-godaddy]

LGTM