@wsxjs/eslint-plugin-wsx 0.0.5

package/dist/index.mjs

@@ -0,0 +1,358 @@
+// src/rules/render-method-required.ts
+var renderMethodRequired = {
+  meta: {
+    type: "problem",
+    docs: {
+      description: "require WSX components to implement render method",
+      category: "Possible Errors",
+      recommended: true
+    },
+    messages: {
+      missingRenderMethod: "WSX component '{{componentName}}' must implement a render() method"
+    },
+    schema: []
+    // 无配置选项
+  },
+  create(context) {
+    return {
+      ClassDeclaration(node) {
+        const isWebComponent = node.superClass && node.superClass.type === "Identifier" && node.superClass.name === "WebComponent";
+        if (!isWebComponent) return;
+        const componentName = node.id?.name || "Unknown";
+        const hasRenderMethod = node.body.body.some(
+          // eslint-disable-next-line @typescript-eslint/no-explicit-any
+          (member) => member.type === "MethodDefinition" && member.key.type === "Identifier" && member.key.name === "render" && member.value.body !== null
+        );
+        if (!hasRenderMethod) {
+          context.report({
+            node,
+            messageId: "missingRenderMethod",
+            data: { componentName }
+          });
+        }
+      }
+    };
+  }
+};
+
+// src/rules/no-react-imports.ts
+var noReactImports = {
+  meta: {
+    type: "problem",
+    docs: {
+      description: "disallow React imports in WSX files",
+      category: "Best Practices",
+      recommended: true
+    },
+    fixable: "code",
+    messages: {
+      noReactImport: "Do not import React in WSX files. Use 'h' function instead"
+    },
+    schema: []
+    // 无配置选项
+  },
+  create(context) {
+    const reactModules = [
+      "react",
+      "react-dom",
+      "react-dom/client",
+      "react-hooks",
+      "@types/react",
+      "@types/react-dom"
+    ];
+    return {
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      ImportDeclaration(node) {
+        const source = node.source.value;
+        if (typeof source === "string" && reactModules.some(
+          (module) => source === module || source.startsWith(module + "/")
+        )) {
+          context.report({
+            node,
+            messageId: "noReactImport",
+            fix(fixer) {
+              return fixer.remove(node);
+            }
+          });
+        }
+      }
+    };
+  }
+};
+
+// src/rules/web-component-naming.ts
+var webComponentNaming = {
+  meta: {
+    type: "suggestion",
+    docs: {
+      description: "enforce Web Component naming conventions",
+      category: "Stylistic Issues",
+      recommended: true
+    },
+    messages: {
+      tagNameNeedsHyphen: "Web Component tag name '{{tagName}}' must contain at least one hyphen",
+      tagNameReserved: "Tag name '{{tagName}}' conflicts with HTML standard elements"
+    },
+    schema: []
+    // 无配置选项
+  },
+  create(context) {
+    const htmlElements = /* @__PURE__ */ new Set([
+      "div",
+      "span",
+      "p",
+      "a",
+      "button",
+      "input",
+      "form",
+      "img",
+      "h1",
+      "h2",
+      "h3",
+      "ul",
+      "li",
+      "table",
+      "tr",
+      "td",
+      "th",
+      "section",
+      "article",
+      "header",
+      "footer"
+    ]);
+    return {
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      Decorator(node) {
+        if (node.expression.type === "CallExpression" && node.expression.callee.type === "Identifier" && node.expression.callee.name === "autoRegister") {
+          const args = node.expression.arguments;
+          if (args.length > 0 && args[0].type === "ObjectExpression") {
+            const tagNameProp = args[0].properties.find(
+              // eslint-disable-next-line @typescript-eslint/no-explicit-any
+              (prop) => prop.type === "Property" && prop.key && prop.key.type === "Identifier" && prop.key.name === "tagName"
+            );
+            if (tagNameProp && tagNameProp.type === "Property" && tagNameProp.value.type === "Literal") {
+              const tagName = tagNameProp.value.value;
+              if (typeof tagName === "string") {
+                if (htmlElements.has(tagName)) {
+                  context.report({
+                    node: tagNameProp.value,
+                    messageId: "tagNameReserved",
+                    data: { tagName }
+                  });
+                } else if (!tagName.includes("-")) {
+                  context.report({
+                    node: tagNameProp.value,
+                    messageId: "tagNameNeedsHyphen",
+                    data: { tagName }
+                  });
+                }
+              }
+            }
+          }
+        }
+      }
+    };
+  }
+};
+
+// src/configs/recommended.ts
+var recommendedConfig = {
+  parser: "@typescript-eslint/parser",
+  parserOptions: {
+    ecmaVersion: "latest",
+    sourceType: "module",
+    ecmaFeatures: {
+      jsx: true
+    },
+    jsxPragma: "h",
+    jsxFragmentName: "Fragment"
+  },
+  plugins: ["wsx"],
+  rules: {
+    // WSX 特定规则（移除 valid-jsx-pragma，由 Vite 处理）
+    "wsx/render-method-required": "error",
+    "wsx/no-react-imports": "error",
+    "wsx/web-component-naming": "warn",
+    // TypeScript 规则（推荐）
+    "@typescript-eslint/no-unused-vars": ["error", { argsIgnorePattern: "^_" }],
+    "@typescript-eslint/no-explicit-any": "warn",
+    "@typescript-eslint/explicit-function-return-type": "off",
+    "@typescript-eslint/explicit-module-boundary-types": "off",
+    "@typescript-eslint/no-non-null-assertion": "warn",
+    // 通用规则
+    "no-console": ["warn", { allow: ["warn", "error"] }],
+    "no-debugger": "error",
+    "no-unused-vars": "off",
+    // 使用 TypeScript 版本
+    "no-undef": "off",
+    // TypeScript 处理
+    "prefer-const": "error",
+    "no-var": "error",
+    "no-duplicate-imports": "error",
+    "no-trailing-spaces": "error",
+    "eol-last": "error",
+    "comma-dangle": ["error", "always-multiline"],
+    semi: ["error", "always"],
+    quotes: ["error", "double", { avoidEscape: true, allowTemplateLiterals: true }],
+    // 禁用 React 相关规则
+    "react/react-in-jsx-scope": "off",
+    "react/prop-types": "off",
+    "react/jsx-uses-react": "off",
+    "react/jsx-uses-vars": "off",
+    "react/jsx-key": "off",
+    "react/jsx-no-duplicate-props": "off",
+    "react/jsx-no-undef": "off",
+    "react/no-array-index-key": "off",
+    "react/no-unescaped-entities": "off"
+  },
+  globals: {
+    // 浏览器环境
+    window: "readonly",
+    document: "readonly",
+    console: "readonly",
+    // Node.js 环境
+    process: "readonly",
+    Buffer: "readonly",
+    __dirname: "readonly",
+    __filename: "readonly",
+    global: "readonly",
+    module: "readonly",
+    require: "readonly",
+    exports: "readonly",
+    // Web Components API
+    HTMLElement: "readonly",
+    customElements: "readonly",
+    CustomEvent: "readonly",
+    ShadowRoot: "readonly",
+    HTMLSlotElement: "readonly",
+    CSSStyleSheet: "readonly",
+    // WSX 特定
+    h: "readonly",
+    Fragment: "readonly"
+  },
+  settings: {
+    // 不需要 React 设置
+  }
+};
+
+// src/configs/flat.ts
+var flatConfig = {
+  name: "wsx/recommended",
+  files: ["**/*.wsx"],
+  languageOptions: {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    parser: "@typescript-eslint/parser",
+    ecmaVersion: "latest",
+    sourceType: "module",
+    parserOptions: {
+      ecmaFeatures: {
+        jsx: true
+      },
+      jsxPragma: "h",
+      jsxFragmentName: "Fragment"
+    },
+    globals: {
+      // Browser environment
+      window: "readonly",
+      document: "readonly",
+      console: "readonly",
+      // Node.js environment
+      process: "readonly",
+      Buffer: "readonly",
+      __dirname: "readonly",
+      __filename: "readonly",
+      global: "readonly",
+      module: "readonly",
+      require: "readonly",
+      exports: "readonly",
+      // Web Components API
+      HTMLElement: "readonly",
+      customElements: "readonly",
+      CustomEvent: "readonly",
+      ShadowRoot: "readonly",
+      HTMLSlotElement: "readonly",
+      CSSStyleSheet: "readonly",
+      // WSX specific
+      h: "readonly",
+      Fragment: "readonly"
+    }
+  },
+  plugins: {
+    wsx: {
+      rules: {
+        "render-method-required": renderMethodRequired,
+        "no-react-imports": noReactImports,
+        "web-component-naming": webComponentNaming
+      }
+    }
+  },
+  rules: {
+    // WSX specific rules
+    "wsx/render-method-required": "error",
+    "wsx/no-react-imports": "error",
+    "wsx/web-component-naming": "warn",
+    // TypeScript rules (recommended)
+    "@typescript-eslint/no-unused-vars": ["error", { argsIgnorePattern: "^_" }],
+    "@typescript-eslint/no-explicit-any": "warn",
+    "@typescript-eslint/explicit-function-return-type": "off",
+    "@typescript-eslint/explicit-module-boundary-types": "off",
+    "@typescript-eslint/no-non-null-assertion": "warn",
+    // General rules
+    "no-console": ["warn", { allow: ["warn", "error"] }],
+    "no-debugger": "error",
+    "no-unused-vars": "off",
+    // Use TypeScript version
+    "no-undef": "off",
+    // TypeScript handles this
+    "prefer-const": "error",
+    "no-var": "error",
+    "no-duplicate-imports": "error",
+    "no-trailing-spaces": "error",
+    "eol-last": "error",
+    "comma-dangle": ["error", "always-multiline"],
+    semi: ["error", "always"],
+    quotes: ["error", "double", { avoidEscape: true, allowTemplateLiterals: true }]
+  },
+  settings: {
+    // No React settings needed
+  }
+};
+function createFlatConfig(plugin2) {
+  return {
+    ...flatConfig,
+    plugins: {
+      wsx: plugin2
+    }
+  };
+}
+
+// src/index.ts
+var plugin = {
+  // 插件元信息
+  meta: {
+    name: "@wsxjs/eslint-plugin-wsx",
+    version: "0.0.2"
+  },
+  // 核心规则（移除 valid-jsx-pragma）
+  rules: {
+    "render-method-required": renderMethodRequired,
+    "no-react-imports": noReactImports,
+    "web-component-naming": webComponentNaming
+  },
+  // 配置预设
+  configs: {
+    recommended: recommendedConfig
+  }
+};
+var flat = {
+  recommended: createFlatConfig(plugin)
+};
+var rules = plugin.rules;
+var configs = plugin.configs;
+var index_default = plugin;
+export {
+  configs,
+  index_default as default,
+  flat,
+  rules
+};

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "@wsxjs/eslint-plugin-wsx",
+  "version": "0.0.5",
+  "description": "ESLint plugin for WSX Framework",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "src",
+    "!**/__tests__",
+    "!**/test"
+  ],
+  "keywords": [
+    "eslint",
+    "plugin",
+    "wsx",
+    "web-components"
+  ],
+  "dependencies": {
+    "@wsxjs/wsx-core": "0.0.5"
+  },
+  "devDependencies": {
+    "tsup": "^8.0.0",
+    "typescript": "^5.0.0",
+    "jest": "^29.0.0",
+    "@types/jest": "^29.0.0",
+    "ts-jest": "^29.0.0",
+    "@types/node": "^20.0.0",
+    "@types/estree": "^1.0.0",
+    "@typescript-eslint/utils": "^6.0.0",
+    "@typescript-eslint/rule-tester": "^6.0.0",
+    "@types/eslint": "^8.0.0",
+    "eslint": "^8.0.0"
+  },
+  "peerDependencies": {
+    "eslint": ">=8.0.0 || ^9.0.0"
+  },
+  "scripts": {
+    "build": "tsup src/index.ts --format cjs,esm --dts --cjs-interop",
+    "dev": "tsup src/index.ts --format cjs,esm --dts --watch",
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "test:coverage": "jest --coverage",
+    "typecheck": "tsc --noEmit",
+    "clean": "rm -rf dist coverage"
+  }
+}

package/src/configs/flat.ts

@@ -0,0 +1,105 @@
+/**
+ * ESLint Plugin WSX - Flat Config for ESLint 9+
+ *
+ * Modern flat config format for WSX framework
+ */
+
+import type { Linter } from "eslint";
+import { renderMethodRequired } from "../rules/render-method-required";
+import { noReactImports } from "../rules/no-react-imports";
+import { webComponentNaming } from "../rules/web-component-naming";
+
+export const flatConfig: Linter.FlatConfig = {
+    name: "wsx/recommended",
+    files: ["**/*.wsx"],
+    languageOptions: {
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        parser: "@typescript-eslint/parser" as any,
+        ecmaVersion: "latest",
+        sourceType: "module",
+        parserOptions: {
+            ecmaFeatures: {
+                jsx: true,
+            },
+            jsxPragma: "h",
+            jsxFragmentName: "Fragment",
+        },
+        globals: {
+            // Browser environment
+            window: "readonly",
+            document: "readonly",
+            console: "readonly",
+
+            // Node.js environment
+            process: "readonly",
+            Buffer: "readonly",
+            __dirname: "readonly",
+            __filename: "readonly",
+            global: "readonly",
+            module: "readonly",
+            require: "readonly",
+            exports: "readonly",
+
+            // Web Components API
+            HTMLElement: "readonly",
+            customElements: "readonly",
+            CustomEvent: "readonly",
+            ShadowRoot: "readonly",
+            HTMLSlotElement: "readonly",
+            CSSStyleSheet: "readonly",
+
+            // WSX specific
+            h: "readonly",
+            Fragment: "readonly",
+        },
+    },
+    plugins: {
+        wsx: {
+            rules: {
+                "render-method-required": renderMethodRequired,
+                "no-react-imports": noReactImports,
+                "web-component-naming": webComponentNaming,
+            },
+        },
+    },
+    rules: {
+        // WSX specific rules
+        "wsx/render-method-required": "error",
+        "wsx/no-react-imports": "error",
+        "wsx/web-component-naming": "warn",
+
+        // TypeScript rules (recommended)
+        "@typescript-eslint/no-unused-vars": ["error", { argsIgnorePattern: "^_" }],
+        "@typescript-eslint/no-explicit-any": "warn",
+        "@typescript-eslint/explicit-function-return-type": "off",
+        "@typescript-eslint/explicit-module-boundary-types": "off",
+        "@typescript-eslint/no-non-null-assertion": "warn",
+
+        // General rules
+        "no-console": ["warn", { allow: ["warn", "error"] }],
+        "no-debugger": "error",
+        "no-unused-vars": "off", // Use TypeScript version
+        "no-undef": "off", // TypeScript handles this
+        "prefer-const": "error",
+        "no-var": "error",
+        "no-duplicate-imports": "error",
+        "no-trailing-spaces": "error",
+        "eol-last": "error",
+        "comma-dangle": ["error", "always-multiline"],
+        semi: ["error", "always"],
+        quotes: ["error", "double", { avoidEscape: true, allowTemplateLiterals: true }],
+    },
+    settings: {
+        // No React settings needed
+    },
+};
+
+// Helper function to create a flat config with the plugin
+export function createFlatConfig(plugin: Record<string, unknown>): Linter.FlatConfig {
+    return {
+        ...flatConfig,
+        plugins: {
+            wsx: plugin,
+        },
+    };
+}

package/src/configs/recommended.ts

@@ -0,0 +1,90 @@
+/**
+ * ESLint Plugin WSX - 推荐配置
+ *
+ * 为 WSX 文件提供推荐的 ESLint 配置
+ */
+
+import { WSXConfig } from "../types";
+
+export const recommendedConfig: WSXConfig = {
+    parser: "@typescript-eslint/parser",
+    parserOptions: {
+        ecmaVersion: "latest",
+        sourceType: "module",
+        ecmaFeatures: {
+            jsx: true,
+        },
+        jsxPragma: "h",
+        jsxFragmentName: "Fragment",
+    },
+    plugins: ["wsx"],
+    rules: {
+        // WSX 特定规则（移除 valid-jsx-pragma，由 Vite 处理）
+        "wsx/render-method-required": "error",
+        "wsx/no-react-imports": "error",
+        "wsx/web-component-naming": "warn",
+
+        // TypeScript 规则（推荐）
+        "@typescript-eslint/no-unused-vars": ["error", { argsIgnorePattern: "^_" }],
+        "@typescript-eslint/no-explicit-any": "warn",
+        "@typescript-eslint/explicit-function-return-type": "off",
+        "@typescript-eslint/explicit-module-boundary-types": "off",
+        "@typescript-eslint/no-non-null-assertion": "warn",
+
+        // 通用规则
+        "no-console": ["warn", { allow: ["warn", "error"] }],
+        "no-debugger": "error",
+        "no-unused-vars": "off", // 使用 TypeScript 版本
+        "no-undef": "off", // TypeScript 处理
+        "prefer-const": "error",
+        "no-var": "error",
+        "no-duplicate-imports": "error",
+        "no-trailing-spaces": "error",
+        "eol-last": "error",
+        "comma-dangle": ["error", "always-multiline"],
+        semi: ["error", "always"],
+        quotes: ["error", "double", { avoidEscape: true, allowTemplateLiterals: true }],
+
+        // 禁用 React 相关规则
+        "react/react-in-jsx-scope": "off",
+        "react/prop-types": "off",
+        "react/jsx-uses-react": "off",
+        "react/jsx-uses-vars": "off",
+        "react/jsx-key": "off",
+        "react/jsx-no-duplicate-props": "off",
+        "react/jsx-no-undef": "off",
+        "react/no-array-index-key": "off",
+        "react/no-unescaped-entities": "off",
+    },
+    globals: {
+        // 浏览器环境
+        window: "readonly",
+        document: "readonly",
+        console: "readonly",
+
+        // Node.js 环境
+        process: "readonly",
+        Buffer: "readonly",
+        __dirname: "readonly",
+        __filename: "readonly",
+        global: "readonly",
+        module: "readonly",
+        require: "readonly",
+        exports: "readonly",
+
+        // Web Components API
+        HTMLElement: "readonly",
+        customElements: "readonly",
+        CustomEvent: "readonly",
+        ShadowRoot: "readonly",
+        HTMLSlotElement: "readonly",
+        CSSStyleSheet: "readonly",
+
+        // WSX 特定
+        h: "readonly",
+        Fragment: "readonly",
+    },
+    settings: {
+        // 不需要 React 设置
+    },
+};

package/src/index.ts

@@ -0,0 +1,46 @@
+/**
+ * ESLint Plugin for WSX (Web Components JSX) - TypeScript 版本
+ *
+ * 提供针对 WSX 框架的专用 ESLint 规则和配置
+ * 注意：不包含 valid-jsx-pragma 规则，因为 Vite 插件已处理 JSX pragma
+ */
+
+import { renderMethodRequired } from "./rules/render-method-required";
+import { noReactImports } from "./rules/no-react-imports";
+import { webComponentNaming } from "./rules/web-component-naming";
+import { recommendedConfig } from "./configs/recommended";
+import { createFlatConfig } from "./configs/flat";
+import { WSXPlugin } from "./types";
+
+const plugin: WSXPlugin = {
+    // 插件元信息
+    meta: {
+        name: "@wsxjs/eslint-plugin-wsx",
+        version: "0.0.2",
+    },
+
+    // 核心规则（移除 valid-jsx-pragma）
+    rules: {
+        "render-method-required": renderMethodRequired,
+        "no-react-imports": noReactImports,
+        "web-component-naming": webComponentNaming,
+    },
+
+    // 配置预设
+    configs: {
+        recommended: recommendedConfig,
+    },
+};
+
+// Export for ESLint 9 flat config
+export const flat = {
+    recommended: createFlatConfig(plugin),
+};
+
+// Export individual rules for manual configuration
+export const rules = plugin.rules;
+
+// Export configs
+export const configs = plugin.configs;
+
+export default plugin;