add detail messages to config options

MeirionHughes · Jun 11, 2016 · 164690f · 164690f
1 parent afed9a7
commit 164690f
Show file tree

Hide file tree

Showing 4 changed files with 40 additions and 15 deletions.
diff --git a/source/aurelia-linter.ts b/source/aurelia-linter.ts
@@ -11,16 +11,7 @@ import {TemplateRule} from './template';
 import {RepeatForRule} from './repeatfor';
 import {ConflictingAttributesRule} from './conflictingattributes';
 
-export class Config {
-    obsoleteTags: Array<string> = ['content'];
-    obsoleteAttributes: Array<{ name: string, tag: string }> = [{name:"replaceable", tag:"template"}];
-    voids: Array<string> = ['area', 'base', 'br', 'col', 'embed', 'hr',
-        'img', 'input', 'keygen', 'link', 'meta',
-        'param', 'source', 'track', 'wbr'];
-    scopes: Array<string> = ['html', 'body', 'template', 'svg', 'math'];
-    containers: Array<string> = ['table', 'select'];
-    customRules: Rule[] = [];
-}
+import {Config} from './config';
 
 export class AureliaLinter {
     linter: Linter;

diff --git a/source/config.ts b/source/config.ts
@@ -0,0 +1,35 @@
+import {Rule} from 'template-lint';
+import {ConflictingAttributesRule} from './conflictingattributes';
+
+
+export class Config {
+    obsoleteTags: Array<{ tag: string, msg: string }> = [
+        {
+            tag: 'content',
+            msg: 'use slot instead'
+        }
+    ];
+
+    obsoleteAttributes: Array<{ name: string, tag: string, msg: string }> = [
+        {
+            name: "replaceable",
+            tag: "template",
+            msg: "'replaceable' on template has been superceded by the slot element"
+        }
+    ];
+
+    conflictingAttributes: Array<{ tags: string[], msg: string }> = [
+        {
+            tags: ["repeat.for", "if.bind", "with.bind"],
+            msg: "template controllers shouldn't be placed to the same element"
+        }
+    ];
+
+    voids: Array<string> = ['area', 'base', 'br', 'col', 'embed', 'hr',
+        'img', 'input', 'keygen', 'link', 'meta',
+        'param', 'source', 'track', 'wbr'];
+
+    scopes: Array<string> = ['html', 'body', 'template', 'svg', 'math'];
+    containers: Array<string> = ['table', 'select'];
+    customRules: Rule[] = [];
+}
diff --git a/source/conflictingattributes.ts b/source/conflictingattributes.ts
@@ -12,8 +12,7 @@ export class ConflictingAttributes {
  * Rule to ensure tags don't have attributes that shouldn't be used at the same time.
  */
 export class ConflictingAttributesRule extends Rule {
-  static TEMPLATE_CONTROLLER_ATTRIBUTES_ERRMSG_PREFIX = /*"template controllers shouldn't be placed to the same element, */ "conflicting attributes: ";
-  static TEMPLATE_CONTROLLER_ATTRIBUTES_ERRMSG_DESCRIPTION = "template controllers shouldn't be placed to the same element";
+  static ERRMSG_PREFIX = "conflicting attributes: ";
 
   constructor(public conflictingAttributesList?: ConflictingAttributes[]) {
     super();
@@ -26,7 +25,7 @@ export class ConflictingAttributesRule extends Rule {
 
   static createDefaultConflictingAttributes() {
     return [
-      new ConflictingAttributes(["repeat.for", "if.bind", "with.bind"], ConflictingAttributesRule.TEMPLATE_CONTROLLER_ATTRIBUTES_ERRMSG_PREFIX),
+      new ConflictingAttributes(["repeat.for", "if.bind", "with.bind"], ConflictingAttributesRule.ERRMSG_PREFIX),
     ];
   }
 

diff --git a/spec/conflictingattributes.spec.ts b/spec/conflictingattributes.spec.ts
@@ -30,7 +30,7 @@ describe("ConflictingAttributes Rule", () => {
       linter.lint(DEFAULT_RULES_VIOLATION_SAMPLE)
       .then((errors) => {
         const errMsg = getLoneError(errors).message;
-        expect(errMsg).toContain(ConflictingAttributesRule.TEMPLATE_CONTROLLER_ATTRIBUTES_ERRMSG_PREFIX);
+        expect(errMsg).toContain(ConflictingAttributesRule.ERRMSG_PREFIX);
         expect(errMsg).toContain("repeat.for");
         expect(errMsg).toContain("if.bind");
         done();
@@ -42,7 +42,7 @@ describe("ConflictingAttributes Rule", () => {
       linter.lint('<div repeat.for="user of users" with.bind="user"></div>')
       .then((errors) => {
         const errMsg = getLoneError(errors).message;
-        expect(errMsg).toContain(ConflictingAttributesRule.TEMPLATE_CONTROLLER_ATTRIBUTES_ERRMSG_PREFIX);
+        expect(errMsg).toContain(ConflictingAttributesRule.ERRMSG_PREFIX);
         expect(errMsg).toContain("repeat.for");
         expect(errMsg).toContain("with.bind");
         expect(errMsg).not.toContain("if.bind");