eslint-plugin-ember-template-lint 0.14.0 → 0.16.0

package/README.md

@@ -57,14 +57,24 @@ require('eslint-plugin-ember-template-lint/lib/ember-teplate-lint/config').regis
 
 
 module.exports = {
-  extends: [
-    'eslint:recommended',
-    'plugin:@typescript-eslint/base',
-    'plugin:ember-template-lint/config',
-    'plugin:ember-template-lint/recommended',
-    //optional:
-    'plugin:ember-template-lint/ember-template-lint-plugin-prettier:recommended'
-  ]
+  overrides: [
+    {
+      files: ['**/*.hbs'],
+      parser: 'ember-template-lint/lib/parser/hbs-parser',
+      extends: [
+        'plugin:ember-template-lint/config',
+        'plugin:ember-template-lint/recommended',
+      ],
+    },
+    {
+      files: ['**/*.gjs'],
+      parser: 'ember-eslint-parser',
+      extends: [
+        'plugin:ember-template-lint/config',
+        'plugin:ember-template-lint/recommended',
+      ],
+    },
+  ],
 };
 ```
 

package/lib/rules/hbs-worker.js

@@ -53,14 +53,6 @@ async function _applyFixes(options, results, columnOffset) {
         fileConfig,
       });
 
-      if (ruleName === 'prettier') {
-        const getPrettierOptions = rule.getPrettierOptions;
-        rule.getPrettierOptions = function () {
-          const options = getPrettierOptions.call(this);
-          return Object.assign(options, fileConfig.rules[ruleName]?.config || {});
-        };
-      }
-
       let visitor = await rule.getVisitor();
       let { code } = transform(templateInfo.template, () => visitor);
 
@@ -126,6 +118,16 @@ runAsWorker(async (filename, text, options, columnOffset=0) => {
   const lint = new Lint.default(options);
   process.env.emberTemplateLintFileName = filename;
   process.env.emberTemplateLintFixMode = false;
+  await lint.loadConfig();
+  let fileConfig = lint._moduleStatusCache.getConfigForFile(options);
+  if (fileConfig.loadedRules['prettier']) {
+    const rule = fileConfig.loadedRules['prettier'].prototype;
+    const getPrettierOptions = rule.getPrettierOptions;
+    rule.getPrettierOptions = function () {
+      const options = getPrettierOptions.call(this);
+      return Object.assign(options, fileConfig.rules.prettier?.config || {});
+    };
+  }
 
   const messages = await lint.verify({
     source: text,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-ember-template-lint",
-  "version": "0.14.0",
+  "version": "0.16.0",
   "description": "Provide linting for ember template",
   "keywords": [
     "eslint",
@@ -19,18 +19,18 @@
     "@glimmer/syntax": "^0.84.3",
     "@typescript-eslint/parser": "^5.59.7",
     "@typescript-eslint/typescript-estree": "^5.59.7",
-    "ember-template-imports": "^3.4.2",
-    "ember-template-lint": "^5.7.3",
-    "ember-template-recast": "^6.1.4",
+    "ember-eslint-parser": "^0.5.6",
+    "ember-template-recast": "^6.1.5",
+    "ember-template-lint": "^6.0.0",
     "prettier-linter-helpers": "^1.0.0",
     "synckit": "^0.8.5",
     "typescript": "^5.0.4"
   },
   "peerDependencies": {
-    "ember-template-lint": "^5.7.3"
+    "ember-template-lint": "^6.0.0"
   },
   "devDependencies": {
-    "ember-template-lint-plugin-prettier": "^4.1.0",
+    "ember-template-lint-plugin-prettier": "^5.0.0",
     "eslint": "^8.41.0",
     "eslint-plugin-jest": "^27.2.1",
     "eslint-plugin-node": "^11.1.0",
@@ -46,6 +46,6 @@
   },
   "license": "ISC",
   "files": [
-    "lib/**/*.js"
+    "lib/rules/*.js"
   ]
 }

package/lib/config/base.js

@@ -1,20 +0,0 @@
-module.exports = {
-  root: true,
-
-  plugins: ['ember-template-lint'],
-
-  rules: {},
-
-  overrides: [
-    {
-      files: ['**/*.hbs'],
-      parser: require.resolve('../parser/hbs-parser'),
-      processor: 'ember-template-lint/noop'
-    },
-    {
-      files: ['**/*.gts', '**/*.gjs'],
-      parser: require.resolve('../parser/gts-parser'),
-      processor: 'ember-template-lint/noop'
-    },
-  ],
-};

package/lib/config/index.js

@@ -1,20 +0,0 @@
-const info = require('../ember-teplate-lint/info');
-const base = require('./base');
-
-const configs = {};
-
-Object.entries(info.configs).forEach(([name, config]) => {
-  Object.entries(config.rules).forEach(([name, conf]) => {
-    if (typeof conf == 'boolean') {
-      config.rules[name] = [conf ? 'error' : 'off'];
-    }
-  });
-  configs[name] = {...base, rules: config.rules};
-});
-configs['config'] = {
-  ...base,
-  rules: info.configuredRules
-};
-
-module.exports = configs;
-

package/lib/ember-teplate-lint/config.js

@@ -1,18 +0,0 @@
-const templateLintConfig = {
-  rules: {},
-  plugins: [],
-};
-
-function registerRule(name, config) {
-  templateLintConfig.rules[name] = Array.isArray(config) ? config[0] : config;
-}
-
-function registerPlugin(name) {
-  templateLintConfig.plugins.push(name);
-}
-
-module.exports = {
-  registerRule,
-  registerPlugin,
-  templateLintConfig
-};

package/lib/ember-teplate-lint/info.js

@@ -1,106 +0,0 @@
-const synckit = require('synckit');
-const syncFn = synckit.createSyncFn(require.resolve('./worker'));
-const { runTemplateLint } = require('../rules/lint');
-const { registerRule, templateLintConfig } = require('../ember-teplate-lint/config');
-
-const lintWithEslintConfigs = syncFn({ config: templateLintConfig });
-const lintConfigs = syncFn();
-
-const activeRules = new Map();
-const allMessages = {};
-
-const reporter = {
-  setup(context) {
-    this.getSourceCode = context.getSourceCode;
-    this.getPhysicalFilename = context.getPhysicalFilename;
-  },
-  report(message) {
-    message.meta = {
-      fixable: 'code'
-    };
-    allMessages[message.rule] = allMessages[message.rule] || [];
-    allMessages[message.rule].push(message);
-  }
-};
-
-class Rule {
-
-  constructor(name) {
-    this.create = this.create.bind(this);
-    this.name = name;
-    this.meta = {
-      fixable: 'code'
-    };
-  }
-  create(context) {
-    const rule = this;
-    let options = context.options;
-    if (options.length === 0) {
-      options = true;
-    }
-    registerRule(this.name, options);
-    const visitor = {
-      enter(node) {
-        if (!activeRules.get(node)) {
-          activeRules.set(node, 0);
-          reporter.setup(context);
-          runTemplateLint(node, reporter);
-        }
-        activeRules.set(node, activeRules.get(node) + 1);
-      },
-      exit(node) {
-        const messages = allMessages[rule.name] || [];
-        messages.forEach(m => context.report(m));
-        activeRules.set(node, activeRules.get(node) - 1);
-        allMessages[rule.name] = [];
-      },
-    };
-    return {
-      'Program': (node) => node.isHbs && visitor.enter(node),
-      'Program:exit': (node) => node.isHbs && visitor.exit(node),
-      '__TEMPLATE__Template': visitor.enter,
-      '__TEMPLATE__Template:exit': visitor.exit,
-    };
-  }
-}
-
-function createRules(rules) {
-  const created = rules.map(r => new Rule(r));
-  const map = {};
-  created.forEach(r => {
-    map[r.name] = r;
-  });
-  return map;
-}
-
-const configs = {
-  ...lintWithEslintConfigs.configs,
-  ...lintConfigs.configs
-};
-
-const rules = [...new Set([...lintConfigs.rules, ...lintWithEslintConfigs.rules])];
-
-delete configs.recommended.overrides;
-
-Object.values(configs).forEach((config) => {
-  const rules = {};
-  Object.entries(config.rules).forEach(([rule, conf]) => {
-    rules['ember-template-lint/' + rule] = conf;
-  });
-  config.rules = rules;
-});
-
-
-const configuredRules = {};
-Object.entries(lintConfigs.configuredRules).forEach(([name, conf]) => {
-  configuredRules['ember-template-lint/' + name] = conf.config && [conf.severity];
-  if (typeof conf.config !== 'boolean') {
-    configuredRules['ember-template-lint/' + name].push(conf.config);
-  }
-});
-
-module.exports = {
-  configs: configs,
-  rules: createRules(rules),
-  configuredRules: configuredRules
-};

package/lib/ember-teplate-lint/worker.js

@@ -1,12 +0,0 @@
-const { runAsWorker } = require('synckit');
-
-runAsWorker(async (options) => {
-  const Lint = await import('ember-template-lint');
-  const lint = new Lint.default(options);
-  await lint.loadConfig();
-  return {
-    configs: lint.config.loadedConfigurations,
-    rules: Object.keys(lint.config.loadedRules),
-    configuredRules: lint.config.rules,
-  };
-});

package/lib/parser/gts-parser.js

@@ -1,57 +0,0 @@
-const gts =  require('ember-template-imports');
-const typescriptParser =  require('@typescript-eslint/parser');
-const typescriptEstree = require('@typescript-eslint/typescript-estree');
-
-
-function replaceRange(s, start, end, substitute) {
-  return s.substring(0, start) + substitute + s.substring(end);
-}
-
-module.exports = {
-  parseForESLint(code, options) {
-    let jsCode = code;
-    const templateInfos = gts.parseTemplates(jsCode, options.filePath);
-    templateInfos.forEach((tpl) => {
-      const range = [tpl.start.index, tpl.end.index + tpl.end[0].length];
-      tpl.range = range;
-      const template = jsCode.slice(...range);
-      const lines = template.split('\n');
-      lines.forEach((line, i) => {
-        lines[i] = ' '.repeat(line.length);
-      });
-      const emptyText = '[`' + lines.join('\n').slice(4) + '`]';
-      jsCode = replaceRange(jsCode, ...range, emptyText);
-      const ast = {
-        type: '__TEMPLATE__Template',
-      };
-      ast.range = range;
-      ast.contents = template;
-      tpl.ast = ast;
-    });
-    const result = typescriptParser.parseForESLint(jsCode, options);
-    const visitorKeys = {...result.visitorKeys, '__TEMPLATE__Template': []};
-    result.ast.tokens.forEach((token) => {
-      if (token.type === 'Template') {
-        const range = [token.range[0] - 1, token.range[1] + 1];
-        const template = templateInfos.find(t => t.range[0] >= range[0] && t.range[1] <= range[1]);
-        if (!template) return;
-        const ast = template.ast;
-        ast.loc = token.loc;
-        Object.assign(token, ast);
-      }
-    });
-    typescriptEstree.simpleTraverse(result.ast, {
-      enter(node) {
-        if (node.type === 'TemplateLiteral') {
-          const range = [node.range[0] - 1, node.range[1] + 1];
-          const template = templateInfos.find(t => t.range[0] >= range[0] && t.range[1] <= range[1]);
-          if (!template) return;
-          const ast = template.ast;
-          Object.assign(node, ast);
-        }
-      }
-    });
-
-    return { ...result, visitorKeys };
-  }
-};

package/lib/parser/hbs-parser.js

@@ -1,57 +0,0 @@
-
-class Scope {
-  type = 'global';
-  variables = [];
-  through= [];
-  set = new Map();
-  upper = null;
-  childScopes = [];
-  references = [];
-  block = null;
-}
-
-class ScopeManager {
-  globalScope = new Scope();
-  scopes = [this.globalScope];
-
-  acquire() {
-    return;
-  }
-
-  getDeclaredVariables() {
-    return [];
-  }
-}
-
-module.exports = {
-  parseForESLint(code) {
-    const comments = [];
-    const types = new Set(['Program']);
-    const ast = {};
-    ast.body = [];
-    ast.tokens = [ast];
-    ast.range = [0, code.length];
-    const lines = code.split('\n');
-    ast.loc = {
-      start: {
-        line: 1,
-        column: 1
-      },
-      end: {
-        line: lines.length,
-        column: lines[lines.length - 1].length
-      }
-    };
-    ast.comments = comments;
-    const visitorKeys = {};
-    types.forEach((t) => {
-      visitorKeys[t] = [];
-    });
-    ast.type = 'Program';
-    ast.isHbs = true;
-    ast.contents = code;
-    const scope = new ScopeManager();
-    scope.globalScope.block = ast;
-    return { ast, scopeManager: scope, visitorKeys };
-  }
-};

package/lib/processor.js

@@ -1,11 +0,0 @@
-
-
-module.exports = {
-  preprocess: (text, filename) => {
-    return [{text: text, filename}];
-  },
-  postprocess: (messages) => {
-    return messages.flat();
-  },
-  supportsAutofix: true
-};

package/lib/utils/document.js

@@ -1,100 +0,0 @@
-/**
- * @typedef {{ line: number; character: number }} Position
- */
-
-// Helper class to convert line/column from and to offset
-// taken and adapt from https://github.com/typed-ember/glint/blob/main/packages/core/src/language-server/util/position.ts
-class DocumentLines {
-  /**
-   * @param {string} contents
-   */
-  constructor(contents) {
-    this.lineStarts = computeLineStarts(contents);
-  }
-
-  /**
-   * @param {Position} position
-   * @return {number}
-   */
-  positionToOffset(position) {
-    const { line, character } = position;
-    return this.lineStarts[line] + character;
-  }
-
-  /**
-   *
-   * @param {number} position
-   * @return {Position}
-   */
-  offsetToPosition(position) {
-    const lineStarts = this.lineStarts;
-    let line = 0;
-    while (line + 1 < lineStarts.length && lineStarts[line + 1] <= position) {
-      line++;
-    }
-    const character = position - lineStarts[line];
-    return { line, character };
-  }
-}
-
-/**
- * @returns {number[]}
- * @param {string} text
- */
-function computeLineStarts(text) {
-  const result = [];
-  let pos = 0;
-  let lineStart = 0;
-  while (pos < text.length) {
-    const ch = text.codePointAt(pos);
-    pos++;
-    switch (ch) {
-    case 13 /* carriageReturn */: {
-      if (text.codePointAt(pos) === 10 /* lineFeed */) {
-        pos++;
-      }
-    }
-    // falls through
-    case 10 /* lineFeed */: {
-      result.push(lineStart);
-      lineStart = pos;
-      break;
-    }
-    default: {
-      if (ch > 127 /* maxAsciiCharacter */ && isLineBreak(ch)) {
-        result.push(lineStart);
-        lineStart = pos;
-      }
-      break;
-    }
-    }
-  }
-  result.push(lineStart);
-  return result;
-}
-
-/* istanbul ignore next */
-/**
- * @param {number} ch
- * @return {boolean}
- */
-function isLineBreak(ch) {
-  // ES5 7.3:
-  // The ECMAScript line terminator characters are listed in Table 3.
-  //     Table 3: Line Terminator Characters
-  //     Code Unit Value     Name                    Formal Name
-  //     \u000A              Line Feed               <LF>
-  //     \u000D              Carriage Return         <CR>
-  //     \u2028              Line separator          <LS>
-  //     \u2029              Paragraph separator     <PS>
-  // Only the characters in Table 3 are treated as line terminators. Other new line or line
-  // breaking characters are treated as white space but not as line terminators.
-  return (
-    ch === 10 /* lineFeed */ ||
-    ch === 13 /* carriageReturn */ ||
-    ch === 8232 /* lineSeparator */ ||
-    ch === 8233 /* paragraphSeparator */
-  );
-}
-
-module.exports = DocumentLines;