docs(core): add missing description field on custom conformance rule type

2024-10-06 16:39:52 -07:00 · 2024-10-06 16:39:52 -07:00 · cb41bcbc37
commit cb41bcbc37
parent fba6cc8f9b
1 changed files with 1 additions and 0 deletions
--- a/docs/shared/packages/powerpack-conformance/powerpack-conformance-plugin.md
+++ b/docs/shared/packages/powerpack-conformance/powerpack-conformance-plugin.md
@ -189,6 +189,7 @@ import { createConformanceRule } from '@nx/powerpack-conformance';

 const rule = createConformanceRule({
  name: 'local-conformance-rule-example',
+  description: 'The description of the rule',
  category: 'security', // `consistency`, `maintainability`, `reliability` or `security`
  reporter: 'project-reporter', // `project-reporter` or `project-files-reporter`
  implementation: async (context) => {