poppins-pr-checklist
Mary Poppins plugin for responding to new PRs with a checklist of PR guidelines in a Github comment.
Install
npm install poppins-pr-checklist
Configure
To use this plugin, you need to load it in your config file with couldYouPlease
:
// config.jsmodule { poppinsconfig = /*...*/ ; poppins; // pr checklist poppinspluginsprChecklistgreeting = 'Hello'; poppinspluginsprChecklistchecks = message: 'Foo' { return false; } ; poppinspluginsprChecklistclosing = 'Farewell';};
By default, Mary Poppins will only respond with a greeting and closing. You have to configure her checks to get a list.
poppins.plugins.prChecklist.greeting
String to start the response with.
Defaults to "Greetings."
.
poppins.plugins.prChecklist.closing
String to start the response with.
Defaults to "Farewell."
.
poppins.plugins.prChecklist.checks
Array of {check}
objects.
Defaults to an empty array.
A {check}
object has two properties:
message
: the string that corresponds to the text of the checkbox item.condition
: a function that returns a representing whether or not the checkbox should be checked. It can also return a promise. The function receives one argument,data
, which is a JSON object representing the PR in question. See the Github API for a description of the object.
Here's an example check:
var myCheck = message: 'The PR has an odd number.' { return data; };
Checklist Plugins
Because checks are just objects in the poppins.plugins.prChecklist.checks
array, you can make a plugin that add new checks by appending to that array.
// in a new module called `poppins-my-check`module { poppinspluginsprChecklistchecks;};
Then you can load this module like you would any other:
// config.js:module { poppins; poppins;};
It's plugins all the way down!
See poppins-check-cla and poppins-check-commit for an example.
License
MIT