eslint-plugin-ember-template-lint 0.7.0 → 0.9.0

package/LICENSE.md

@@ -1,6 +1,6 @@
 ISC License (ISC)
 
-Copyright 2017, Patrick Pircher
+Copyright 2023, Patrick Pircher
 
 Permission to use, copy, modify, and/or distribute this software for any
 purpose with or without fee is hereby granted, provided that the above

package/README.md

@@ -1,6 +1,15 @@
 # eslint-plugin-hbs-template
 
-Provide linting for hbs templates files
+Provide linting (via [ember-template-lint](https://github.com/ember-template-lint/ember-template-lint)) for hbs templates files, template string literals and gts,gjs 
+* no extra config file needed
+
+* no need to run extra tool for linting
+
+* no need to run extra tool to fix lint issues
+
+* no need to implement & maintain editor support for ember-template-lint
+
+* it also has the advantage that it can know the scope for some template-lint rules, like no-implicit-this, and remove those messages
 
 ## Installation
 
@@ -20,7 +29,7 @@ $ npm install eslint-plugin-ember-template-lint --save-dev
 
 ## Usage
 
-Add `hbs` to the plugins section of your `.eslintrc` configuration file. You can omit the `eslint-plugin-` prefix:
+Add `ember-template-lint` to the plugins section of your `.eslintrc` configuration file. You can omit the `eslint-plugin-` prefix:
 
 ### 2. Modify your `.eslintrc.js`
 

package/lib/parser/hbs-parser.js

@@ -28,6 +28,7 @@ module.exports = {
     const comments = [];
     const types = new Set(['Program']);
     const ast = {};
+    ast.body = [];
     ast.tokens = [ast];
     ast.range = [0, code.length];
     const lines = code.split('\n');

package/lib/rules/hbs-worker.js

@@ -1,5 +1,6 @@
 const { runAsWorker } = require('synckit');
 const { generateDifferences } = require('prettier-linter-helpers');
+const Document = require('../utils/document');
 
 async function _applyFixes(options, results, columnOffset) {
   const { transform } = await import('ember-template-recast');
@@ -16,6 +17,18 @@ async function _applyFixes(options, results, columnOffset) {
   let ruleNames = new Set(fixableIssues.map((r) => r.rule));
   const spaces = ' '.repeat(columnOffset);
 
+  let template = currentSource;
+  if (columnOffset) {
+    template = spaces + template.split('\n').join('\n' + spaces);
+  }
+  const origDoc = new Document(template);
+  fixableIssues.forEach((r) => {
+    r.range = [
+      origDoc.positionToOffset({line: r.line - 1, character: r.column}),
+      origDoc.positionToOffset({line: r.endLine - 1, character: r.endColumn}),
+    ];
+  });
+
   for (let ruleName of ruleNames) {
     let templateInfos = [{
       template: currentSource,
@@ -23,6 +36,12 @@ async function _applyFixes(options, results, columnOffset) {
       isStrictMode: false
     }];
 
+    const diffContained = (d, range) => d.range[0] >= range[0] && d.range[1] <= range[1];
+    const diffIntersect = (d, range) =>
+      (d.range[1] >= range[0] && d.range[1] <= range[1])
+      ||
+      (d.range[0] >= range[0] && d.range[0] <= range[1]);
+
     for (let templateInfo of templateInfos) {
 
       let rule = this._buildRule(ruleName, {
@@ -38,16 +57,17 @@ async function _applyFixes(options, results, columnOffset) {
       let { code } = transform(templateInfo.template, () => visitor);
 
       if (code !== templateInfo.template) {
-        let template = templateInfo.template;
-        if (columnOffset) {
-          template = spaces + template.split('\n').join('\n' + spaces);
-        }
+
         if (columnOffset) {
           code = spaces + code.split('\n').join('\n' + spaces);
         }
         const diffs = generateDifferences(template, code);
-        fixableIssues.filter(r => r.rule === ruleName).forEach((r, i) => {
-          r.fix = diffs[i];
+        diffs.forEach((d) => {
+          d.range = [d.offset, d.offset + (d.deleteText?.length || 0)];
+        });
+        fixableIssues.filter(r => r.rule === ruleName).forEach((r) => {
+          const range = r.range;
+          r.fix = diffs.filter(d => diffContained(d, range) || diffIntersect(d, range));
         });
       }
     }

package/lib/rules/lint.js

@@ -26,22 +26,23 @@ function runTemplateLint(node, context) {
     const lintMessages = response.messages;
     lintMessages.forEach((m) => {
       if (m.fix) {
-        const d = m.fix;
-        m.fix.range = [d.offset, d.offset + (d.deleteText?.length || 0)];
-        m.range = m.fix.range;
-        const start = originalDocument.offsetToPosition(m.fix.range[0]);
-        const end = originalDocument.offsetToPosition(m.fix.range[1]);
-        m.fix.range = [
-          originalDocument.positionToOffset({
-            line: start.line,
-            character: start.character
-          }),
-          originalDocument.positionToOffset({
-            line: end.line,
-            character: end.character
-          })
-        ];
-        m.fix.range = m.fix.range.map(x => offset + x);
+        m.fix.forEach((fix) => {
+          const d = fix;
+          fix.range = [d.offset, d.offset + (d.deleteText?.length || 0)];
+          const start = originalDocument.offsetToPosition(fix.range[0]);
+          const end = originalDocument.offsetToPosition(fix.range[1]);
+          fix.range = [
+            originalDocument.positionToOffset({
+              line: start.line,
+              character: start.character
+            }),
+            originalDocument.positionToOffset({
+              line: end.line,
+              character: end.character
+            })
+          ];
+          fix.range = fix.range.map(x => offset + x);
+        });
       }
       m.range = [
         originalDocument.positionToOffset({
@@ -71,8 +72,8 @@ function runTemplateLint(node, context) {
           if (!msg.isFixable || !msg.fix) {
             return null;
           }
-          const range = msg.range;
-          return fixer.replaceTextRange(range, msg.fix.insertText || '');
+          const fixes = msg.fix;
+          return fixes.map(fix => fixer.replaceTextRange(fix.range, fix.insertText || ''));
         },
         loc: { start, end },
         message: msg.message,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-ember-template-lint",
-  "version": "0.7.0",
+  "version": "0.9.0",
   "description": "Provide linting for ember template",
   "keywords": [
     "eslint",