eslint-plugin-ember-template-lint 0.1.0

package/LICENSE.md

@@ -0,0 +1,15 @@
+ISC License (ISC)
+
+Copyright 2017, 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
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.

package/README.md

@@ -0,0 +1,44 @@
+# eslint-plugin-hbs-template
+
+Provide linting for hbs templates files
+
+## Installation
+
+You'll first need to install [ESLint](http://eslint.org):
+
+```
+$ npm i eslint --save-dev
+```
+
+Next, install `eslint-plugin-ember-template-lint`:
+
+```
+$ npm install eslint-plugin-ember-template-lint --save-dev
+```
+
+**Note:** If you installed ESLint globally (using the `-g` flag) then you must also install `eslint-plugin-ember-template-lint` globally.
+
+## Usage
+
+Add `hbs` to the plugins section of your `.eslintrc` configuration file. You can omit the `eslint-plugin-` prefix:
+
+### 2. Modify your `.eslintrc.js`
+
+```js
+// .eslintrc.js
+// optional:
+require('eslint-plugin-ember-template-lint/lib/ember-teplate-lint/config').registerPlugin('ember-template-lint-plugin-prettier');
+
+module.exports = {
+  extends: [
+    'eslint:recommended',
+    'plugin:ember-template-lint/recommended',
+    //optional:
+    'plugin:ember-template-lint/ember-template-lint-plugin-prettier:recommended'
+  ]
+};
+```
+
+
+
+

package/lib/index.js

@@ -0,0 +1,32 @@
+/**
+ * @fileoverview Provide linting for hbs template literals inside of JavaScript
+ * @author Peter Banka
+ */
+'use strict';
+
+//------------------------------------------------------------------------------
+// Requirements
+//------------------------------------------------------------------------------
+
+const configs = require('./config');
+const base = require('./config/base');
+const templateRules = require('./ember-teplate-lint/info');
+const processor = require('./processor');
+
+//------------------------------------------------------------------------------
+// Plugin Definition
+//------------------------------------------------------------------------------
+
+
+module.exports = {
+  rules: {
+    ...templateRules.rules
+  },
+  configs: {
+    base,
+    ...configs
+  },
+  processors: {
+    'noop': processor,
+  }
+};

package/lib/rules/config.js

@@ -0,0 +1,86 @@
+'use strict';
+const synckit = require('synckit');
+const DocumentLines = require('../utils/document');
+
+//------------------------------------------------------------------------------
+// Rule Definition
+//------------------------------------------------------------------------------
+
+const runTemplateLint = (text, filename, context, scopeVars=[], offset=0, options) => {
+  try {
+    const syncFn = synckit.createSyncFn(require.resolve('./hbs-worker'));
+    const response = syncFn(filename, text, options);
+    const lintMessages = response.messages;
+    const diffs = response.diff;
+    const document = new DocumentLines(text);
+    diffs.forEach((d) => {
+      d.range = [d.offset, d.offset + d.deleteText.length];
+    });
+    lintMessages.forEach((m) => {
+      m.range = [
+        document.positionToOffset({
+          line: m.line - 1,
+          character: m.column - 1
+        }),
+        document.positionToOffset({
+          line: m.endLine - 1,
+          character: m.endColumn - 1
+        })];
+      const isInside = (d) => d.range[0] >= m.range[0] && d.range[1] <= m.range[1];
+      const doesContain = (d) => d.range[0] < m.range[0] && d.range[1] > m.range[1];
+      const idx = diffs.findIndex(d => isInside(d) || doesContain(d));
+      if (idx !== -1) {
+        const d = diffs.splice(idx, 1);
+        m.fix = d[0];
+        m.fix.range = m.fix.range.map(x => offset + x);
+      }
+      m.range = m.range.map(x => offset + x);
+    });
+
+    if (diffs.length) {
+      diffs.forEach((d) => {
+        const range = d.range[0];
+        const [start, end] = range.map(index =>
+          context.getSourceCode().getLocFromIndex(index)
+        );
+        context.report({
+          fix: (fixer) => {
+            return fixer.replaceTextRange(range, d.fix.insertText || '');
+          },
+          loc: { start, end },
+          message: 'template error',
+        });
+      });
+    }
+
+    lintMessages.forEach((msg) => {
+      if (msg.rule === 'no-implicit-this') {
+        if (scopeVars.includes(msg.source)) {
+          return;
+        }
+      }
+      const [start, end] = msg.range.map(index =>
+        context.getSourceCode().getLocFromIndex(index)
+      );
+
+      context.report({
+        rule: msg.rule,
+        fix: (fixer) => {
+          if (!msg.isFixable || !msg.fix) {
+            return null;
+          }
+          const range = msg.range;
+          return fixer.replaceTextRange(range, msg.fix.insertText || '');
+        },
+        loc: { start, end },
+        message: msg.message,
+      });
+    });
+  } catch(e) {
+    console.error(e);
+  }
+};
+
+module.exports = {
+  runTemplateLint
+};

package/lib/rules/hbs-worker.js

@@ -0,0 +1,21 @@
+const { runAsWorker } = require('synckit');
+const { generateDifferences } = require('prettier-linter-helpers');
+
+runAsWorker(async (filename, text, options) => {
+  const Lint = await import('ember-template-lint');
+  const lint = new Lint.default(options);
+  process.env.emberTemplateLintFileName = filename;
+  process.env.emberTemplateLintFixMode = false;
+  const messages = await lint.verify({
+    source: text
+  });
+  process.env.emberTemplateLintFixMode = true;
+  const fixedText = (await lint.verifyAndFix({
+    source: text
+  })).output;
+  const diff = generateDifferences(text, fixedText);
+  return {
+    messages,
+    diff
+  };
+});

package/lib/rules/lint.js

@@ -0,0 +1,83 @@
+'use strict';
+const synckit = require('synckit');
+const DocumentLines = require('../utils/document');
+const { templateLintConfig } = require('../ember-teplate-lint/config');
+
+function runTemplateLint(text, filename, context, scopeVars=[], offset=0) {
+  try {
+    const syncFn = synckit.createSyncFn(require.resolve('./hbs-worker'));
+    const response = syncFn(filename, text, { config: templateLintConfig });
+    const lintMessages = response.messages;
+    const diffs = response.diff;
+    const document = new DocumentLines(text);
+    diffs.forEach((d) => {
+      d.range = [d.offset, d.offset + d.deleteText.length];
+    });
+    lintMessages.forEach((m) => {
+      m.range = [
+        document.positionToOffset({
+          line: m.line - 1,
+          character: m.column - 1
+        }),
+        document.positionToOffset({
+          line: m.endLine - 1,
+          character: m.endColumn - 1
+        })];
+      const isInside = (d) => d.range[0] >= m.range[0] && d.range[1] <= m.range[1];
+      const doesContain = (d) => d.range[0] <= m.range[0] && d.range[1] >= m.range[1];
+      const idx = diffs.findIndex(d => isInside(d) || doesContain(d));
+      if (idx !== -1) {
+        const d = diffs.splice(idx, 1);
+        m.fix = d[0];
+        m.fix.range = m.fix.range.map(x => offset + x);
+      }
+      m.range = m.range.map(x => offset + x);
+    });
+
+    if (diffs.length) {
+      diffs.forEach((d) => {
+        const range = d.range;
+        const [start, end] = range.map(index =>
+          context.getSourceCode().getLocFromIndex(index)
+        );
+        context.report({
+          fix: (fixer) => {
+            return fixer.replaceTextRange(range, d.fix.insertText || '');
+          },
+          loc: { start, end },
+          message: 'template error',
+        });
+      });
+    }
+
+    lintMessages.forEach((msg) => {
+      if (msg.rule === 'no-implicit-this') {
+        if (scopeVars.includes(msg.source)) {
+          return;
+        }
+      }
+      const [start, end] = msg.range.map(index =>
+        context.getSourceCode().getLocFromIndex(index)
+      );
+
+      context.report({
+        rule: msg.rule,
+        fix: (fixer) => {
+          if (!msg.isFixable || !msg.fix) {
+            return null;
+          }
+          const range = msg.range;
+          return fixer.replaceTextRange(range, msg.fix.insertText || '');
+        },
+        loc: { start, end },
+        message: msg.message,
+      });
+    });
+  } catch(e) {
+    console.error(e);
+  }
+}
+
+module.exports = {
+  runTemplateLint
+};

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "eslint-plugin-ember-template-lint",
+  "version": "0.1.0",
+  "description": "Provide linting for ember template",
+  "keywords": [
+    "eslint",
+    "eslintplugin",
+    "eslint-plugin"
+  ],
+  "author": "Patrick Pircher",
+  "main": "lib/index.js",
+  "repository": "patricklx/eslint-plugin-ember-template-lint",
+  "scripts": {
+    "test": "jest",
+    "lint:js": "eslint --cache .",
+    "test:watch": "jest --watchAll"
+  },
+  "dependencies": {
+    "@glimmer/syntax": "^0.84.3",
+    "typescript": "^5.0.4",
+    "@typescript-eslint/parser": "^5.59.7",
+    "@typescript-eslint/typescript-estree": "^5.59.7",
+    "ember-template-imports": "^3.4.2",
+    "prettier-linter-helpers": "^1.0.0",
+    "ember-template-lint": "^5.7.3",
+    "synckit": "^0.8.5"
+  },
+  "peerDependencies": {
+    "ember-template-lint": "^5.7.3"
+  },
+  "devDependencies": {
+    "ember-template-lint-plugin-prettier": "^4.1.0",
+    "eslint": "^8.41.0",
+    "eslint-plugin-jest": "^27.2.1",
+    "eslint-plugin-node": "^11.1.0",
+    "jest": "^29.5.0"
+  },
+  "jest": {
+    "testMatch": [
+      "**/tests/**/*.js"
+    ]
+  },
+  "engines": {
+    "node": ">=12.0.0"
+  },
+  "license": "ISC",
+  "files": [
+    "lib/rules/*.js"
+  ]
+}