@boardreadyops/plugin-sdk API

---

@boardreadyops/plugin-sdk API / Rule

Interface: Rule

Runtime rule implementation contributed by a plugin.

Properties

meta

meta: PluginRuleMetadata

Methods

run()

run(context): PluginFinding[] | Promise\<PluginFinding[]>

Inspect the project context and return findings for this rule.

Parameters

context

PluginRuleContext

Returns

PluginFinding[] | Promise\<PluginFinding[]>