Merge pull request #78 from ember-template-lint/add-fixer

Fix templates with Prettier

Author: dcyriller

lib/rules/prettier.js

@@ -11,7 +11,7 @@ const { INSERT, DELETE, REPLACE } = generateDifferences;
 
 let prettier;
 
-const Rule = require("ember-template-lint").Rule;
+const { Rule, recast } = require("ember-template-lint");
 
 function isFile(loc) {
   return loc.start && loc.start.line === 1 && loc.start.column === 0;
@@ -99,6 +99,11 @@ module.exports = class Prettier extends Rule {
           }
 
           if (source !== prettierSource) {
+            if (this.mode === "fix") {
+              node.body = recast.parse(prettierSource).body;
+              return;
+            }
+
             const differences = generateDifferences(source, prettierSource);
 
             differences.forEach(difference => {
@@ -126,7 +131,7 @@ module.exports = class Prettier extends Rule {
                   break;
               }
 
-              this.log({ message, line, column, source });
+              this.log({ message, line, column, source, isFixable: true });
             });
           }
         }

package.json

@@ -28,11 +28,11 @@
   "license": "Apache-2.0",
   "private": false,
   "peerDependencies": {
-    "ember-template-lint": "^2.1.0",
+    "ember-template-lint": "^2.10.0",
     "prettier": "^1.18.2"
   },
   "devDependencies": {
-    "ember-template-lint": "^2.1.0",
+    "ember-template-lint": "^2.10.0",
     "eslint": "^7.1.0",
     "eslint-config-prettier": "^6.0.0",
     "eslint-plugin-node": "^11.0.0",

test/unit/rules/lint-prettier-test.js

@@ -29,23 +29,47 @@ test
     {
       config: true,
       template: "{{#my-component}}{{/my-component}}\n",
+      fixedTemplate: "{{#my-component}}{{/my-component}}",
       result: {
         moduleId: "layout",
         message: "Delete `⏎`",
         line: 1,
         column: 34,
-        source: "{{#my-component}}{{/my-component}}\n"
+        source: "{{#my-component}}{{/my-component}}\n",
+        isFixable: true
+      }
+    },
+    {
+      config: true,
+      template: `<div data-foo
+ data-bar="lol"
+      some-other-thing={{haha-morethaneightychars}}>
+</div>`,
+      fixedTemplate: `<div data-foo data-bar="lol" some-other-thing={{haha-morethaneightychars}}>
+</div>`,
+      result: {
+        moduleId: "layout",
+        message: 'Replace `⏎·data-bar="lol"⏎·····` with ` data-bar="lol"`',
+        line: 1,
+        column: 13,
+        source: `<div data-foo
+ data-bar="lol"
+      some-other-thing={{haha-morethaneightychars}}>
+</div>`,
+        isFixable: true
       }
     },
     {
       config: true,
       template: "test\n",
+      fixedTemplate: "test",
       result: {
         moduleId: "layout",
         message: "Delete `⏎`",
         line: 1,
         column: 4,
-        source: "test\n"
+        source: "test\n",
+        isFixable: true
       }
     },
     {
@@ -54,28 +78,36 @@ test
 
 test
 
+{{/my-component}}`,
+      fixedTemplate: `{{#my-component}}
+  test
 {{/my-component}}`,
       result: {
         moduleId: "layout",
         message: "Replace `⏎test⏎` with `  test`",
         line: 1,
         column: 18,
-        source: "{{#my-component}}\n\ntest\n\n{{/my-component}}"
+        source: "{{#my-component}}\n\ntest\n\n{{/my-component}}",
+        isFixable: true
       }
     },
     {
       config: true,
       template: `{{#my-component class="class1 class2"}}
   test
 
+{{/my-component}}`,
+      fixedTemplate: `{{#my-component class="class1 class2"}}
+  test
 {{/my-component}}`,
       result: {
         moduleId: "layout",
         message: "Delete `⏎`",
         line: 2,
         column: 7,
         source:
-          '{{#my-component class="class1 class2"}}\n  test\n\n{{/my-component}}'
+          '{{#my-component class="class1 class2"}}\n  test\n\n{{/my-component}}',
+        isFixable: true
       }
     }
   ]