feat(core): include 'description' for ruleset (#2000)

stoplightio · Dec 14, 2021 · aacae2c · aacae2c
1 parent 2fd923e
commit aacae2c
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 0 deletions.
diff --git a/packages/core/src/meta/ruleset.schema.json b/packages/core/src/meta/ruleset.schema.json
@@ -9,6 +9,7 @@
       "format": "url",
       "errorMessage": "must be a valid URL"
     },
+    "description": { "type": "string" },
     "rules": {
       "type": "object",
       "additionalProperties": {

diff --git a/packages/core/src/ruleset/__tests__/validation.test.ts b/packages/core/src/ruleset/__tests__/validation.test.ts
@@ -88,6 +88,21 @@ Error at #/rules/rule-with-invalid-enum/severity: the value has to be one of: 0,
     ).not.toThrow();
   });
 
+  it.each([false, 2, null])('given invalid %s description in a ruleset, throws', description => {
+    expect(assertValidRuleset.bind(null, { description, rules: {} })).toThrow(
+      new RulesetValidationError('Error at #/description: must be string'),
+    );
+  });
+
+  it('recognizes valid description in a ruleset', () => {
+    expect(
+      assertValidRuleset.bind(null, {
+        description: 'This is the ruleset description',
+        rules: {},
+      }),
+    ).not.toThrow();
+  });
+
   it.each(['error', 'warn', 'info', 'hint', 'off'])('recognizes human-readable %s severity', severity => {
     expect(
       assertValidRuleset.bind(null, {

diff --git a/packages/core/src/ruleset/types.ts b/packages/core/src/ruleset/types.ts
@@ -89,6 +89,7 @@ export type RulesetAliasesDefinition = Record<string, string | RulesetScopedAlia
 export type RulesetDefinition = Readonly<
   {
     documentationUrl?: string;
+    description?: string;
     formats?: Format<any>[];
     parserOptions?: Partial<ParserOptions>;
     overrides?: RulesetOverridesDefinition;