Feedback / Improvements / Change requests

[kabaros]

Some improvements to do:

• Rename plugins-registry repo to plugin-gallery
• Add code headers per PKP usual approach - e.g. https://github.com/pkp/pkp-lib/blob/master/js/controllers/TabHandler.js for an example.
• Document that some of the commands need to be run from within a git checkout of the plugin gallery XML repository in the help command
• Escape command line arguments properly https://stackoverflow.com/questions/1779858/how-do-i-escape-a-string-for-a-shell-command-in-node/50424976#50424976
• Use https://www.npmjs.com/package/diff rather than relying on an external diff tool to keep platform independence
• Use temp folder for temporary files, as using the current folder might create issues
• Set github token globally
• Tests and documentation

---

For setting gh_token globally, the way it would work, is that we set some file at home directory (.pkpconfig or similar) and add the token to it. Similar to what tools like git or aws cli do, and read that file when using the tool. (make sure this works on windows) For setting Github token, you just need to prefix the command with GITHUB_TOKEN=my_personal_token i.e. GITHUB_TOKEN=my_personal_token pkp-plugin bump

[kabaros]

For escaping the command lines, I moved to this library which handles escaping and makes dealing with the command line easier execa.

For the diff, I thought relying on git should be similar between platforms. It's a prerequisite for that command and would feel if it git doesn't exist, or not being ran on git repo. The command line gives feedback to that effect: https://github.com/kabaros/pkp-plugin-cli/blob/master/src/validate-new-release/index.js#L25

@asmecher Let me know if you disagree, or think more should be done regarding these two points

[kabaros]

For using temp files, I did it like this:

pkp-plugin-cli/src/release/buildRelease.js

Line 35 in 6ce0a90

const { stdout: tempFileName } = await execa('mktemp', `${fileName}XXXXXXXX`)

ps: I just realised there is one instance where I am still writing to the wrong place, so I will update it too now (fixed now)

[asmecher]

For the diff, I thought relying on git should be similar between platforms...

Ah, I can't find the comment I made before, but I probably misread a git diff command as a straight-up diff command. Agreed that we can rely on git being present.