move recommendations to description

vutran · Apr 8, 2019 · 0648ca5 · 0648ca5
1 parent 24a7e49
commit 0648ca5
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 12 deletions.
diff --git a/src/cli.ts b/src/cli.ts
@@ -19,6 +19,10 @@ async function main() {
     allFailures.forEach(failure => {
       const ruleName = chalk.bgRed.whiteBright(failure.ruleName + ':');
       console.error(ruleName, failure.message);
+      if (failure.description) {
+        console.error(`\n   ${failure.description}`);
+        console.error('');
+      }
     });
 
     console.log(`\nTotal errors: ${allFailures.length}`);

diff --git a/src/rules/prefer-local-style.ts b/src/rules/prefer-local-style.ts
@@ -146,14 +146,12 @@ export class Rule extends AbstractRule {
           node.fills,
           localStyles
         );
-        const recString = rec && `Recommended local style: ${rec.name}.`;
 
         this.addFailure({
           ruleName,
           node,
-          message:
-            `Prefer local styles for fill: ${node.name}.` +
-            (recString ? ` ${recString}` : ''),
+          message: `Prefer local styles for fill: ${node.name}.`,
+          description: rec && `Recommended local style: ${rec.name}.`,
         });
       }
 
@@ -163,14 +161,12 @@ export class Rule extends AbstractRule {
           node.strokes,
           localStyles
         );
-        const recString = rec && `Recommended local style: ${rec.name}.`;
 
         this.addFailure({
           ruleName,
           node,
-          message:
-            `Prefer local styles for stroke: ${node.name}.` +
-            (recString ? ` ${recString}` : ''),
+          message: `Prefer local styles for stroke: ${node.name}.`,
+          description: rec && `Recommended local style: ${rec.name}.`,
         });
       }
 
@@ -187,14 +183,12 @@ export class Rule extends AbstractRule {
           node.style,
           localStyles as any /* for typecheck */
         );
-        const recString = rec && `Recommended text style: ${rec.name}.`;
 
         this.addFailure({
           ruleName,
           node,
-          message:
-            `Prefer local styles for text: ${node.name}.` +
-            (recString ? ` ${recString}` : ''),
+          message: `Prefer local styles for text: ${node.name}.`,
+          description: rec && `Recommended text style: ${rec.name}`,
         });
       }
     }

diff --git a/typings/index.d.ts b/typings/index.d.ts
@@ -12,6 +12,8 @@ declare namespace DSLint {
     interface Failure {
       ruleName: string;
       message: string;
+      // Optional description used for recommendations, links, etc.
+      description?: string;
       // Optional since some rules can be applied at the global level
       node?: AnyType;
     }