@qq99/eslint-plugin-solid 0.18.0-no-reactive-read-in-effect-callback.0

package/dist/index.mjs

@@ -0,0 +1,42 @@
+import {
+  require_typescript
+} from "./chunk-4UZNJ5MS.mjs";
+import {
+  require_v2_strict
+} from "./chunk-MHDQJMLE.mjs";
+import {
+  require_v2
+} from "./chunk-EBU4C5NV.mjs";
+import {
+  __commonJS,
+  __toESM,
+  init_plugin,
+  plugin,
+  require_recommended
+} from "./chunk-LE6SW2M3.mjs";
+
+// src/index.ts
+var require_index = __commonJS({
+  "src/index.ts"(exports, module) {
+    init_plugin();
+    var import_recommended = __toESM(require_recommended());
+    var import_typescript = __toESM(require_typescript());
+    var import_v2 = __toESM(require_v2());
+    var import_v2_strict = __toESM(require_v2_strict());
+    var pluginWithConfigs = {
+      ...plugin,
+      configs: {
+        recommended: import_recommended.default,
+        typescript: import_typescript.default,
+        v2: import_v2.default,
+        "v2-strict": import_v2_strict.default,
+        // aliases kept for compatibility with the 0.14.x flat config names
+        "flat/recommended": import_recommended.default,
+        "flat/typescript": import_typescript.default
+      }
+    };
+    module.exports = pluginWithConfigs;
+  }
+});
+export default require_index();
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["/**\n * FIXME: remove this comments and import when below issue is fixed.\n * This import is necessary for type generation due to a bug in the TypeScript compiler.\n * See: https://github.com/microsoft/TypeScript/issues/42873\n */\n// eslint-disable-next-line @typescript-eslint/no-unused-vars\nimport type { TSESLint } from \"@typescript-eslint/utils\";\n\nimport { plugin } from \"./plugin\";\nimport recommendedConfig from \"./configs/recommended\";\nimport typescriptConfig from \"./configs/typescript\";\nimport v2Config from \"./configs/v2\";\nimport v2StrictConfig from \"./configs/v2-strict\";\n\nconst pluginWithConfigs = {\n  ...plugin,\n  configs: {\n    recommended: recommendedConfig,\n    typescript: typescriptConfig,\n    v2: v2Config,\n    \"v2-strict\": v2StrictConfig,\n    // aliases kept for compatibility with the 0.14.x flat config names\n    \"flat/recommended\": recommendedConfig,\n    \"flat/typescript\": typescriptConfig,\n  },\n};\n\n// Must be `export = ` for eslint to load everything\nexport = pluginWithConfigs;\n"],"mappings":";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAQA;AACA,6BAA8B;AAC9B,4BAA6B;AAC7B,oBAAqB;AACrB,2BAA2B;AAE3B,QAAM,oBAAoB;AAAA,MACxB,GAAG;AAAA,MACH,SAAS;AAAA,QACP,aAAa,mBAAAA;AAAA,QACb,YAAY,kBAAAC;AAAA,QACZ,IAAI,UAAAC;AAAA,QACJ,aAAa,iBAAAC;AAAA;AAAA,QAEb,oBAAoB,mBAAAH;AAAA,QACpB,mBAAmB,kBAAAC;AAAA,MACrB;AAAA,IACF;AAGA,qBAAS;AAAA;AAAA;","names":["recommendedConfig","typescriptConfig","v2Config","v2StrictConfig"]}

package/package.json

@@ -0,0 +1,109 @@
+{
+  "name": "@qq99/eslint-plugin-solid",
+  "version": "0.18.0-no-reactive-read-in-effect-callback.0",
+  "description": "Solid-specific linting rules for ESLint.",
+  "keywords": [
+    "eslint",
+    "eslintplugin",
+    "solid",
+    "solidjs",
+    "reactivity"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/solidjs-community/eslint-plugin-solid"
+  },
+  "license": "MIT",
+  "author": "Josh Wilson <joshwilsonvu@gmail.com>",
+  "exports": {
+    ".": {
+      "types": {
+        "import": "./dist/index.d.mts",
+        "require": "./dist/index.d.ts"
+      },
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    },
+    "./configs/recommended": {
+      "types": {
+        "import": "./dist/configs/recommended.d.mts",
+        "require": "./dist/configs/recommended.d.ts"
+      },
+      "import": "./dist/configs/recommended.mjs",
+      "require": "./dist/configs/recommended.js"
+    },
+    "./configs/typescript": {
+      "types": {
+        "import": "./dist/configs/typescript.d.mts",
+        "require": "./dist/configs/typescript.d.ts"
+      },
+      "import": "./dist/configs/typescript.mjs",
+      "require": "./dist/configs/typescript.js"
+    },
+    "./configs/v2": {
+      "types": {
+        "import": "./dist/configs/v2.d.mts",
+        "require": "./dist/configs/v2.d.ts"
+      },
+      "import": "./dist/configs/v2.mjs",
+      "require": "./dist/configs/v2.js"
+    },
+    "./configs/v2-strict": {
+      "types": {
+        "import": "./dist/configs/v2-strict.d.mts",
+        "require": "./dist/configs/v2-strict.d.ts"
+      },
+      "import": "./dist/configs/v2-strict.mjs",
+      "require": "./dist/configs/v2-strict.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "src",
+    "dist",
+    "README.md"
+  ],
+  "dependencies": {
+    "@typescript-eslint/utils": "^8.0.0",
+    "estraverse": "^5.3.0",
+    "is-html": "^2.0.0",
+    "kebab-case": "^1.0.2",
+    "known-css-properties": "^0.30.0",
+    "style-to-object": "^1.0.6"
+  },
+  "devDependencies": {
+    "@babel/core": "^8.0.0",
+    "@babel/eslint-parser": "^8.0.1",
+    "@microsoft/api-extractor": "^7.47.6",
+    "@types/estraverse": "^5.1.7",
+    "@types/is-html": "^2.0.2",
+    "@typescript-eslint/eslint-plugin": "^8.67.0",
+    "@typescript-eslint/parser": "^8.67.0",
+    "eslint": "^10.0.0",
+    "markdown-magic": "^3.3.0",
+    "prettier": "^2.8.8",
+    "tsup": "^8.5.1",
+    "tsx": "^4.17.0",
+    "vitest": "^4.0.0"
+  },
+  "peerDependencies": {
+    "eslint": "^9.0.0 || ^10.0.0",
+    "typescript": ">=4.8.4"
+  },
+  "engines": {
+    "node": ">=22.0.0"
+  },
+  "scripts": {
+    "build": "tsup",
+    "test": "vitest --run",
+    "test:all": "PARSER=all vitest --run",
+    "test:babel": "PARSER=babel vitest --run",
+    "test:ts": "PARSER=ts vitest --run",
+    "test:watch": "vitest",
+    "turbo:build": "tsup",
+    "turbo:docs": "PARSER=none tsx scripts/docs.mts",
+    "turbo:test": "vitest --run"
+  }
+}

package/src/compat.ts

@@ -0,0 +1,53 @@
+import { type TSESLint, type TSESTree, ASTUtils } from "@typescript-eslint/utils";
+
+export type CompatContext =
+  | {
+      sourceCode: Readonly<TSESLint.SourceCode>;
+      getSourceCode: undefined;
+      getScope: undefined;
+      markVariableAsUsed: undefined;
+    }
+  | {
+      sourceCode?: Readonly<TSESLint.SourceCode>;
+      getSourceCode: () => Readonly<TSESLint.SourceCode>;
+      getScope: () => TSESLint.Scope.Scope;
+      markVariableAsUsed: (name: string) => void;
+    };
+
+export function getSourceCode(context: CompatContext) {
+  if (typeof context.getSourceCode === "function") {
+    return context.getSourceCode();
+  }
+  return context.sourceCode;
+}
+
+export function getScope(context: CompatContext, node: TSESTree.Node): TSESLint.Scope.Scope {
+  const sourceCode = getSourceCode(context);
+
+  if (typeof sourceCode.getScope === "function") {
+    return sourceCode.getScope(node); // >= v8, I think
+  }
+  if (typeof context.getScope === "function") {
+    return context.getScope();
+  }
+  return context.sourceCode.getScope(node);
+}
+
+export function findVariable(
+  context: CompatContext,
+  node: TSESTree.Identifier
+): TSESLint.Scope.Variable | null {
+  return ASTUtils.findVariable(getScope(context, node), node);
+}
+
+export function markVariableAsUsed(
+  context: CompatContext,
+  name: string,
+  node: TSESTree.Node
+): void {
+  if (typeof context.markVariableAsUsed === "function") {
+    context.markVariableAsUsed(name);
+  } else {
+    getSourceCode(context).markVariableAsUsed(name, node);
+  }
+}

package/src/configs/recommended.ts

@@ -0,0 +1,48 @@
+import type { TSESLint } from "@typescript-eslint/utils";
+
+import { plugin } from "../plugin";
+
+const recommended = {
+  plugins: {
+    solid: plugin,
+  },
+  languageOptions: {
+    sourceType: "module",
+    parserOptions: {
+      ecmaFeatures: {
+        jsx: true,
+      },
+    },
+  },
+  rules: {
+    // identifier usage is important
+    "solid/jsx-no-duplicate-props": 2,
+    "solid/jsx-no-undef": 2,
+    "solid/jsx-uses-vars": 2,
+    "solid/no-unknown-namespaces": 2,
+    // security problems
+    "solid/no-innerhtml": 2,
+    "solid/jsx-no-script-url": 2,
+    // reactivity
+    "solid/components-return-once": 1,
+    "solid/no-destructure": 2,
+    "solid/prefer-for": 2,
+    "solid/reactivity": 1,
+    "solid/event-handlers": 1,
+    // these rules are mostly style suggestions
+    "solid/imports": 1,
+    "solid/style-prop": 1,
+    "solid/no-react-deps": 1,
+    "solid/no-react-specific-props": 1,
+    "solid/self-closing-comp": 1,
+    "solid/no-array-handlers": 0,
+    // handled by Solid compiler, opt-in style suggestion
+    "solid/prefer-show": 0,
+    // only necessary for resource-constrained environments
+    "solid/no-proxy-apis": 0,
+    // deprecated
+    "solid/prefer-classlist": 0,
+  },
+} satisfies TSESLint.FlatConfig.Config;
+
+export = recommended;

package/src/configs/typescript.ts

@@ -0,0 +1,21 @@
+import type { TSESLint } from "@typescript-eslint/utils";
+import type { Linter } from "eslint";
+
+import recommended from "./recommended";
+
+const typescript = {
+  // no files; either apply to all files, or let users spread in this config
+  // and specify matching patterns. This is eslint-plugin-react's take.
+  plugins: recommended.plugins,
+  // no languageOptions; ESLint's default parser can't parse TypeScript,
+  // and parsers are configured in languageOptions, so let the user handle
+  // this rather than cause potential conflicts
+  rules: {
+    ...recommended.rules,
+    "solid/jsx-no-undef": [2, { typescriptEnabled: true }] satisfies Linter.RuleEntry,
+    // namespaces taken care of by TS
+    "solid/no-unknown-namespaces": 0,
+  },
+} satisfies TSESLint.FlatConfig.Config;
+
+export = typescript;

package/src/configs/v2-strict.ts

@@ -0,0 +1,28 @@
+import type { TSESLint } from "@typescript-eslint/utils";
+
+import v2 from "./v2";
+
+// Everything in the v2 config, plus opinionated rules that are valid patterns
+// in some apps (e.g. client-only) but hazards in others. Intended for teams
+// that want the plugin's strongest opinions.
+const v2Strict = {
+  plugins: v2.plugins,
+  languageOptions: v2.languageOptions,
+  settings: v2.settings,
+  rules: {
+    ...v2.rules,
+    // module-scope reactive state is shared across SSR requests
+    "solid/no-module-scope-reactive-primitive": 2,
+    // side-effectful setup in component bodies belongs in onSettled;
+    // warn-level because detection is a heuristic over a known-call list
+    "solid/prefer-onSettled-for-side-effects": 1,
+    // restating default prop/option values is noise
+    "solid/no-restated-default-options": 2,
+    // graduate the class-string heuristic to an error
+    "solid/prefer-structured-class": 2,
+    // graduate the half-unused signal check to an error
+    "solid/no-unused-signal": 2,
+  },
+} satisfies TSESLint.FlatConfig.Config;
+
+export = v2Strict;

package/src/configs/v2.ts

@@ -0,0 +1,68 @@
+import type { TSESLint } from "@typescript-eslint/utils";
+
+import { plugin } from "../plugin";
+import recommended from "./recommended";
+
+// The Solid 2.0 config. Sets `settings.solid.version: 2`, which switches
+// version-aware rules (reactivity, imports, no-unknown-namespaces,
+// event-handlers, jsx-no-undef) into strict 2.0 semantics, and enables the
+// 2.0-specific rules. Errors are reserved for near-certain bugs; heuristics
+// stay warnings. This is the config the official templates ship.
+const v2 = {
+  plugins: {
+    solid: plugin,
+  },
+  languageOptions: {
+    sourceType: "module",
+    parserOptions: {
+      ecmaFeatures: {
+        jsx: true,
+      },
+    },
+  },
+  settings: {
+    solid: { version: 2 },
+  },
+  rules: {
+    ...recommended.rules,
+    // 1.x APIs that no longer exist; prescriptive migration guidance
+    "solid/removed-api": 2,
+    // 2.0 requires the split createEffect(compute, effect) form
+    "solid/no-single-arg-create-effect": 2,
+    // the store read proxy is read-only; mutations go through the setter's draft
+    "solid/no-store-mutation-outside-setter": 2,
+    // writes inside memos/compute halves create cycles and throw in 2.0 dev
+    "solid/no-write-in-pure-computation": 2,
+    // the apply half receives a value outside tracking; reads must happen in compute
+    "solid/no-reactive-read-in-effect-callback": 2,
+    // signals that are never written (or never read) aren't being used as signals
+    "solid/no-unused-signal": 1,
+    // uncalled accessors as DOM attributes render stringified functions
+    "solid/no-accessor-as-prop": 2,
+    // enumerated attributes (draggable, tristate aria-*) want string tokens;
+    // boolean false removes the attribute, a different state than "false"
+    "solid/no-boolean-enumerated-attribute": 2,
+    // manual class-string building works but defeats granular class toggling
+    "solid/prefer-structured-class": 1,
+    // graduated from style to correctness in 2.0: only camelCase `onClick` is
+    // an event handler; lowercase forms are literal attributes
+    "solid/event-handlers": 2,
+    // className/htmlFor pass through as literal attributes the DOM ignores
+    "solid/no-react-specific-props": 2,
+    // server functions are core in 2.0; misplaced/ignored "use server"
+    // directives and broken module-level directive files are silent failures
+    "solid/valid-use-server": 2,
+    // a sync server function returns T during SSR but Promise<T> on the client
+    "solid/require-async-server-function": 2,
+    // editor-time mirror of the compiler's closure-capture validation
+    "solid/no-invalid-server-capture": 2,
+    // server functions never run where browser globals exist
+    "solid/no-browser-globals-in-server-function": 2,
+    // premise no longer exists in 2.0 (rule also self-gates on version)
+    "solid/no-react-deps": 0,
+    // anti-advice in 2.0: classList was removed in favor of class objects/arrays
+    "solid/prefer-classlist": 0,
+  },
+} satisfies TSESLint.FlatConfig.Config;
+
+export = v2;

package/src/deps.d.ts

@@ -0,0 +1 @@
+declare module "kebab-case";

package/src/index.ts

@@ -0,0 +1,29 @@
+/**
+ * FIXME: remove this comments and import when below issue is fixed.
+ * This import is necessary for type generation due to a bug in the TypeScript compiler.
+ * See: https://github.com/microsoft/TypeScript/issues/42873
+ */
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+import type { TSESLint } from "@typescript-eslint/utils";
+
+import { plugin } from "./plugin";
+import recommendedConfig from "./configs/recommended";
+import typescriptConfig from "./configs/typescript";
+import v2Config from "./configs/v2";
+import v2StrictConfig from "./configs/v2-strict";
+
+const pluginWithConfigs = {
+  ...plugin,
+  configs: {
+    recommended: recommendedConfig,
+    typescript: typescriptConfig,
+    v2: v2Config,
+    "v2-strict": v2StrictConfig,
+    // aliases kept for compatibility with the 0.14.x flat config names
+    "flat/recommended": recommendedConfig,
+    "flat/typescript": typescriptConfig,
+  },
+};
+
+// Must be `export = ` for eslint to load everything
+export = pluginWithConfigs;

package/src/plugin.ts

@@ -0,0 +1,92 @@
+/**
+ * FIXME: remove this comments and import when below issue is fixed.
+ * This import is necessary for type generation due to a bug in the TypeScript compiler.
+ * See: https://github.com/microsoft/TypeScript/issues/42873
+ */
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+import type { TSESLint } from "@typescript-eslint/utils";
+
+import componentsReturnOnce from "./rules/components-return-once";
+import eventHandlers from "./rules/event-handlers";
+import imports from "./rules/imports";
+import jsxNoDuplicateProps from "./rules/jsx-no-duplicate-props";
+import jsxNoScriptUrl from "./rules/jsx-no-script-url";
+import jsxNoUndef from "./rules/jsx-no-undef";
+import jsxUsesVars from "./rules/jsx-uses-vars";
+import noAccessorAsProp from "./rules/no-accessor-as-prop";
+import noBooleanEnumeratedAttribute from "./rules/no-boolean-enumerated-attribute";
+import noBrowserGlobalsInServerFunction from "./rules/no-browser-globals-in-server-function";
+import noDestructure from "./rules/no-destructure";
+import noInnerHTML from "./rules/no-innerhtml";
+import noInvalidServerCapture from "./rules/no-invalid-server-capture";
+import noModuleScopeReactivePrimitive from "./rules/no-module-scope-reactive-primitive";
+import noProxyApis from "./rules/no-proxy-apis";
+import noReactDeps from "./rules/no-react-deps";
+import noReactSpecificProps from "./rules/no-react-specific-props";
+import noReactiveReadInEffectCallback from "./rules/no-reactive-read-in-effect-callback";
+import noRestatedDefaultOptions from "./rules/no-restated-default-options";
+import noSingleArgCreateEffect from "./rules/no-single-arg-create-effect";
+import noStoreMutationOutsideSetter from "./rules/no-store-mutation-outside-setter";
+import noUnknownNamespaces from "./rules/no-unknown-namespaces";
+import noUnusedSignal from "./rules/no-unused-signal";
+import noWriteInPureComputation from "./rules/no-write-in-pure-computation";
+import preferClasslist from "./rules/prefer-classlist";
+import preferFor from "./rules/prefer-for";
+import preferOnSettledForSideEffects from "./rules/prefer-onSettled-for-side-effects";
+import preferShow from "./rules/prefer-show";
+import preferStructuredClass from "./rules/prefer-structured-class";
+import reactivity from "./rules/reactivity";
+import removedApi from "./rules/removed-api";
+import requireAsyncServerFunction from "./rules/require-async-server-function";
+import selfClosingComp from "./rules/self-closing-comp";
+import styleProp from "./rules/style-prop";
+import validUseServer from "./rules/valid-use-server";
+import noArrayHandlers from "./rules/no-array-handlers";
+// import validateJsxNesting from "./rules/validate-jsx-nesting";
+
+// Use require() so that `package.json` doesn't get copied to `dist`
+// eslint-disable-next-line @typescript-eslint/no-require-imports
+const { name, version } = require("../package.json");
+const meta = { name, version };
+
+const allRules = {
+  "components-return-once": componentsReturnOnce,
+  "event-handlers": eventHandlers,
+  imports,
+  "jsx-no-duplicate-props": jsxNoDuplicateProps,
+  "jsx-no-undef": jsxNoUndef,
+  "jsx-no-script-url": jsxNoScriptUrl,
+  "jsx-uses-vars": jsxUsesVars,
+  "no-accessor-as-prop": noAccessorAsProp,
+  "no-boolean-enumerated-attribute": noBooleanEnumeratedAttribute,
+  "no-browser-globals-in-server-function": noBrowserGlobalsInServerFunction,
+  "no-destructure": noDestructure,
+  "no-innerhtml": noInnerHTML,
+  "no-invalid-server-capture": noInvalidServerCapture,
+  "no-module-scope-reactive-primitive": noModuleScopeReactivePrimitive,
+  "no-proxy-apis": noProxyApis,
+  "no-react-deps": noReactDeps,
+  "no-react-specific-props": noReactSpecificProps,
+  "no-reactive-read-in-effect-callback": noReactiveReadInEffectCallback,
+  "no-restated-default-options": noRestatedDefaultOptions,
+  "no-single-arg-create-effect": noSingleArgCreateEffect,
+  "no-store-mutation-outside-setter": noStoreMutationOutsideSetter,
+  "no-unknown-namespaces": noUnknownNamespaces,
+  "no-unused-signal": noUnusedSignal,
+  "no-write-in-pure-computation": noWriteInPureComputation,
+  "prefer-classlist": preferClasslist,
+  "prefer-for": preferFor,
+  "prefer-onSettled-for-side-effects": preferOnSettledForSideEffects,
+  "prefer-show": preferShow,
+  "prefer-structured-class": preferStructuredClass,
+  reactivity,
+  "removed-api": removedApi,
+  "require-async-server-function": requireAsyncServerFunction,
+  "self-closing-comp": selfClosingComp,
+  "style-prop": styleProp,
+  "valid-use-server": validUseServer,
+  "no-array-handlers": noArrayHandlers,
+  // "validate-jsx-nesting": validateJsxNesting
+};
+
+export const plugin = { meta, rules: allRules };