Skip to content

Commit

Permalink
start docs of new plugin features
Browse files Browse the repository at this point in the history
  • Loading branch information
GantMan committed Feb 4, 2018
1 parent b88a28d commit 3aa0ed7
Showing 1 changed file with 38 additions and 0 deletions.
38 changes: 38 additions & 0 deletions docs/advancedPlugin.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
```json
"CustomRequirement": [
{
rule: "custom",
plugin: "My Plugin Name",
name: "checkThing",
otherStuff: "I like nachos"
}
]
```

plugin
```js
const addOptionalRules = require('./helpers/addOptionalRules')

module.exports = (context) => {
// Register this plugin
context.addPlugin({
name: 'My Plugin Name',
description: 'I do amazing things',
customChecks: {
checkThing: async (rule, context) => {
const successObject = {
pass: true,
message: 'Custom check succeeded!'
}
const failureObject = {
pass: false,
message: 'Custom check failed!'
}

// Randomly succeed or fail
return !!Math.floor(Math.random() * 2) ? successObject : failureObject
}
}
})
}
```

0 comments on commit 3aa0ed7

Please sign in to comment.