Allow passing custom headers and comments for POT file about i18n-command

[greatislander]

@swissspidy That would be useful as well, yes.

[greatislander]

I like the JSON --headers idea. Much more flexible than adding a bunch of parameters. I'd be happy to work on a PR for that. And I'd lean towards the --comments parameter (again, over specificity that could be unnecessarily limiting).

[swissspidy]

Tools like grunt-wp-i18n also allow specifying a custom copyright comment notice. Would that be needed too in your case?

[swissspidy]

Related: wp-cli/wp-cli#4616, wp-cli/entity-command#133

We could add a --headers argument that allows passing an associative array in JSON format to add custom headers.

Example:

wp i18n make-pot --headers='{"Report-Msgid-Bugs-To":"https://github.com/wp-cli/i18n-command/issues"}'

This could also be useful to add other headers if one really wants to (see #48 and #49).

For the copyright notice I'd add a new --copyright argument (since it's a comment and not a header) or perhaps a new --comments argument that takes a comma separated list of comments to add (overriding the existing copyright notice if used). This would make things much more flexible.

---

I just noticed that the original makepot.php script has a description field for projects, e.g. Translation of the WordPress theme {name} {version} by {author}. However, that appears to be unused.

We might want to add this as a default comment to the POT file though as it can be useful when opening a POT file without context.

[swissspidy]

@greatislander I'd say go for it! :-) Happy to help when you encounter any problems.

[greatislander]

Thanks, will let you know if I encounter any issues.