@html-eslint/eslint-plugin 0.27.0 → 0.28.0-alpha.0

package/lib/rules/no-inline-styles.js

@@ -1,10 +1,16 @@
 /**
  * @typedef { import("../types").RuleModule } RuleModule
+ * @typedef { import("../types").RuleListener } RuleListener
  */
 
 const { RULE_CATEGORY } = require("../constants");
 const { findAttr } = require("./utils/node");
-
+const { parse } = require("@html-eslint/template-parser");
+const {
+  shouldCheckTaggedTemplateExpression,
+  shouldCheckTemplateLiteral,
+} = require("./utils/settings");
+const { getSourceCode } = require("./utils/source-code");
 const MESSAGE_IDS = {
   INLINE_STYLE: "unexpectedInlineStyle",
 };
@@ -30,7 +36,10 @@ module.exports = {
   },
 
   create(context) {
-    return {
+    /**
+     * @type {RuleListener}
+     */
+    const visitors = {
       Tag(node) {
         const styleAttr = findAttr(node, "style");
         if (styleAttr) {
@@ -41,5 +50,19 @@ module.exports = {
         }
       },
     };
+
+    return {
+      ...visitors,
+      TaggedTemplateExpression(node) {
+        if (shouldCheckTaggedTemplateExpression(node, context)) {
+          parse(node.quasi, getSourceCode(context), visitors);
+        }
+      },
+      TemplateLiteral(node) {
+        if (shouldCheckTemplateLiteral(node, context)) {
+          parse(node, getSourceCode(context), visitors);
+        }
+      },
+    };
   },
 };

package/lib/rules/utils/settings.js

@@ -0,0 +1,88 @@
+/**
+ * @typedef {import("../../types").MaybeHTMLSettings} MaybeHTMLSettings
+ * @typedef {import("../../types").HTMLSettings} HTMLSettings
+ * @typedef {import("../../types").Context} Context
+ * @typedef {import("estree").TaggedTemplateExpression} TaggedTemplateExpression
+ * @typedef {import("estree").TemplateLiteral} TemplateLiteral
+ */
+
+const { getSourceCode } = require("../utils/source-code");
+
+const DEFAULT_SETTINGS = {
+  templateLiterals: {
+    tags: ["^html$"],
+    comments: ["^\\s*html\\s*$"],
+  },
+};
+
+/**
+ * @type {HTMLSettings | null}
+ */
+let cachedSettings = null;
+
+/**
+ * @param {{ html?: MaybeHTMLSettings }} settings
+ * @returns {HTMLSettings}
+ */
+function getSettings(settings) {
+  const tags =
+    (settings &&
+      settings.html &&
+      settings.html.templateLiterals &&
+      settings.html.templateLiterals.tags) ||
+    DEFAULT_SETTINGS.templateLiterals.tags;
+
+  const comments =
+    (settings &&
+      settings.html &&
+      settings.html.templateLiterals &&
+      settings.html.templateLiterals.comments) ||
+    DEFAULT_SETTINGS.templateLiterals.comments;
+
+  if (cachedSettings) {
+    return cachedSettings;
+  }
+  cachedSettings = {
+    templateLiterals: {
+      tags: tags.map((tag) => new RegExp(tag, "u")),
+      comments: comments.map((comment) => new RegExp(comment, "u")),
+    },
+  };
+  return cachedSettings;
+}
+
+/**
+ * @param {TaggedTemplateExpression} node
+ * @param {Context} context
+ * @returns {boolean}
+ */
+function shouldCheckTaggedTemplateExpression(node, context) {
+  const { templateLiterals } = getSettings(context.settings);
+  const tags = templateLiterals.tags;
+  const tagNode = node.tag;
+  return !!(
+    tagNode.type === "Identifier" && tags.some((tag) => tag.test(tagNode.name))
+  );
+}
+
+/**
+ *
+ * @param {TemplateLiteral} node
+ * @param {Context} context
+ * @returns {boolean}
+ */
+function shouldCheckTemplateLiteral(node, context) {
+  const sourceCode = getSourceCode(context);
+  const { templateLiterals } = getSettings(context.settings);
+  const comments = sourceCode.getCommentsBefore(node);
+  const last = comments[comments.length - 1];
+  return !!(
+    last &&
+    templateLiterals.comments.some((comment) => comment.test(last.value))
+  );
+}
+
+module.exports = {
+  shouldCheckTemplateLiteral,
+  shouldCheckTaggedTemplateExpression,
+};

package/lib/rules/utils/source-code.js

@@ -0,0 +1,14 @@
+/**
+ * @typedef {import("../../types").Context} Context
+ */
+
+/**
+ * @param {Context} context
+ */
+function getSourceCode(context) {
+  return context.sourceCode || context.getSourceCode();
+}
+
+module.exports = {
+  getSourceCode,
+};

package/lib/types.d.ts

@@ -1,4 +1,4 @@
-import ESTree from "estree";
+import ESTree, { TaggedTemplateExpression, TemplateLiteral } from "estree";
 import ESLint from "eslint";
 import * as ESHtml from "es-html-parser";
 
@@ -200,12 +200,14 @@ interface RuleListener {
   CommentClose?: (node: CommentCloseNode) => void;
   CommentContent?: (node: CommentContentNode) => void;
   Doctype?: (node: DoctypeNode) => void;
-  DoctypeOpen: (node: DoctypeOpenNode) => void;
+  DoctypeOpen?: (node: DoctypeOpenNode) => void;
   DoctypeClose?: (node: DoctypeCloseNode) => void;
   DoctypeAttribute?: (node: DoctypeAttributeNode) => void;
   DoctypeAttributeValue?: (node: DoctypeAttributeValueNode) => void;
   DoctypeAttributeWrapperStart?: (node: DoctypeAttributeWrapperStart) => void;
   DoctypeAttributeWrapperEnd?: (node: DoctypeAttributeWrapperEnd) => void;
+  TaggedTemplateExpression?: (node: TaggedTemplateExpression) => void;
+  TemplateLiteral?: (node: TemplateLiteral) => void;
 }
 
 export interface RuleModule extends ESLint.Rule.RuleModule {
@@ -258,7 +260,7 @@ type ReportDescriptorLocation = {
   column?: number;
 };
 
-interface Context extends Omit<ESLint.Rule.RuleContext, "report"> {
+export interface Context extends Omit<ESLint.Rule.RuleContext, "report"> {
   report(descriptor: ReportDescriptor): void;
 }
 
@@ -275,3 +277,17 @@ export type ContentNode =
   | StyleTagNode
   | TagNode
   | TextNode;
+
+export type MaybeHTMLSettings = {
+  templateLiterals?: {
+    tags?: string[];
+    comments?: string[];
+  };
+};
+
+export type HTMLSettings = {
+  templateLiterals: {
+    tags: RegExp[];
+    comments: RegExp[];
+  };
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@html-eslint/eslint-plugin",
-  "version": "0.27.0",
+  "version": "0.28.0-alpha.0",
   "description": "ESLint plugin for html",
   "author": "yeonjuan",
   "homepage": "https://github.com/yeonjuan/html-eslint#readme",
@@ -45,11 +45,13 @@
     "accessibility"
   ],
   "devDependencies": {
-    "@html-eslint/parser": "^0.27.0",
-    "@types/eslint": "^8.56.2",
+    "@html-eslint/parser": "^0.28.0-alpha.0",
+    "@html-eslint/template-parser": "^0.28.0-alpha.0",
+    "@types/eslint": "^9.6.1",
     "@types/estree": "^0.0.47",
     "es-html-parser": "^0.0.8",
+    "espree": "^10.3.0",
     "typescript": "^4.4.4"
   },
-  "gitHead": "a7c09dfb3090bb779d6fe62fda814d4d7ca07d4a"
+  "gitHead": "4c4e3388a4d8541ade0201fb06690e46098ab9bf"
 }

package/types/rules/no-inline-styles.d.ts

@@ -1,4 +1,5 @@
 declare const _exports: RuleModule;
 export = _exports;
 export type RuleModule = import("../types").RuleModule;
+export type RuleListener = import("../types").RuleListener;
 //# sourceMappingURL=no-inline-styles.d.ts.map

package/types/rules/no-inline-styles.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"no-inline-styles.d.ts","sourceRoot":"","sources":["../../lib/rules/no-inline-styles.js"],"names":[],"mappings":"wBAYU,UAAU;;yBAXN,OAAO,UAAU,EAAE,UAAU"}
+{"version":3,"file":"no-inline-styles.d.ts","sourceRoot":"","sources":["../../lib/rules/no-inline-styles.js"],"names":[],"mappings":"wBAkBU,UAAU;;yBAjBN,OAAO,UAAU,EAAE,UAAU;2BAC7B,OAAO,UAAU,EAAE,YAAY"}

package/types/rules/utils/settings.d.ts

@@ -0,0 +1,19 @@
+export type MaybeHTMLSettings = import("../../types").MaybeHTMLSettings;
+export type HTMLSettings = import("../../types").HTMLSettings;
+export type Context = import("../../types").Context;
+export type TaggedTemplateExpression = import("estree").TaggedTemplateExpression;
+export type TemplateLiteral = import("estree").TemplateLiteral;
+/**
+ *
+ * @param {TemplateLiteral} node
+ * @param {Context} context
+ * @returns {boolean}
+ */
+export function shouldCheckTemplateLiteral(node: TemplateLiteral, context: Context): boolean;
+/**
+ * @param {TaggedTemplateExpression} node
+ * @param {Context} context
+ * @returns {boolean}
+ */
+export function shouldCheckTaggedTemplateExpression(node: TaggedTemplateExpression, context: Context): boolean;
+//# sourceMappingURL=settings.d.ts.map

package/types/rules/utils/settings.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"settings.d.ts","sourceRoot":"","sources":["../../../lib/rules/utils/settings.js"],"names":[],"mappings":"gCACa,OAAO,aAAa,EAAE,iBAAiB;2BACvC,OAAO,aAAa,EAAE,YAAY;sBAClC,OAAO,aAAa,EAAE,OAAO;uCAC7B,OAAO,QAAQ,EAAE,wBAAwB;8BACzC,OAAO,QAAQ,EAAE,eAAe;AA8D7C;;;;;GAKG;AACH,iDAJW,eAAe,WACf,OAAO,GACL,OAAO,CAWnB;AA7BD;;;;GAIG;AACH,0DAJW,wBAAwB,WACxB,OAAO,GACL,OAAO,CASnB"}

package/types/rules/utils/source-code.d.ts

@@ -0,0 +1,9 @@
+export type Context = import("../../types").Context;
+/**
+ * @typedef {import("../../types").Context} Context
+ */
+/**
+ * @param {Context} context
+ */
+export function getSourceCode(context: Context): import("eslint").SourceCode;
+//# sourceMappingURL=source-code.d.ts.map

package/types/rules/utils/source-code.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"source-code.d.ts","sourceRoot":"","sources":["../../../lib/rules/utils/source-code.js"],"names":[],"mappings":"sBACa,OAAO,aAAa,EAAE,OAAO;AAD1C;;GAEG;AAEH;;GAEG;AACH,uCAFW,OAAO,+BAIjB"}