npm - @krymskyimaksym/eslint-plugin-react-api-client - Versions diffs - 0.1.0 → 0.2.0 - Mend

@krymskyimaksym/eslint-plugin-react-api-client 0.1.0 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (8) hide show

package/README.md CHANGED Viewed

@@ -1,6 +1,6 @@
 # @krymskyimaksym/eslint-plugin-react-api-client
-ESLint-правила для [`@krymskyimaksym/react-api-client`](../..).
+ESLint-правила для [`@krymskyimaksym/react-api-client`](https://www.npmjs.com/package/@krymskyimaksym/react-api-client) (требуется `^2.0.0`).
 ## Установка
@@ -29,7 +29,15 @@ module.exports = {
 }
 ```
-## Правила
+## Правила (recommended)
+| Rule | Severity | Autofix |
+|---|---|---|
+| `no-await-mutate` | error | ✓ |
+| `no-non-serializable-params` | error | — |
+| `require-query-key-when-endpoint-is-fn` | warn | — |
+## Описание
 ### `no-await-mutate` (error, autofix)
@@ -65,6 +73,20 @@ userApi.useFetch({ id: 1 }, { queryKey: ['user', 1] });
 возвращает одну и ту же строку для одних и тех же params. Явный
 `queryKey` снимает риск.
+### `no-non-serializable-params` (error)
+Запрещает функции и `Symbol` в объекте `params`. Они сломают
+`hashQueryKey` в рантайме (throw при первом mount):
+```ts
+// ❌
+api.useFetch({ id: 1, cb: () => 1 });
+api.useFetch({ tag: Symbol('x') });
+// ✅
+api.useFetch({ id: 1 });
+```
 ## License
 MIT

package/dist/index.d.mts CHANGED Viewed

@@ -2,6 +2,7 @@ import * as _typescript_eslint_utils_ts_eslint from '@typescript-eslint/utils/ts
 declare const rules: {
     'no-await-mutate': _typescript_eslint_utils_ts_eslint.RuleModule<"avoid", [], _typescript_eslint_utils_ts_eslint.RuleListener>;
+    'no-non-serializable-params': _typescript_eslint_utils_ts_eslint.RuleModule<"noFunction" | "noSymbol", [], _typescript_eslint_utils_ts_eslint.RuleListener>;
     'require-query-key-when-endpoint-is-fn': _typescript_eslint_utils_ts_eslint.RuleModule<"missing", [], _typescript_eslint_utils_ts_eslint.RuleListener>;
 };
 declare const configs: {
@@ -9,6 +10,7 @@ declare const configs: {
         plugins: string[];
         rules: {
             '@krymskyimaksym/react-api-client/no-await-mutate': string;
+            '@krymskyimaksym/react-api-client/no-non-serializable-params': string;
             '@krymskyimaksym/react-api-client/require-query-key-when-endpoint-is-fn': string;
         };
     };
@@ -16,6 +18,7 @@ declare const configs: {
 declare const _default: {
     rules: {
         'no-await-mutate': _typescript_eslint_utils_ts_eslint.RuleModule<"avoid", [], _typescript_eslint_utils_ts_eslint.RuleListener>;
+        'no-non-serializable-params': _typescript_eslint_utils_ts_eslint.RuleModule<"noFunction" | "noSymbol", [], _typescript_eslint_utils_ts_eslint.RuleListener>;
         'require-query-key-when-endpoint-is-fn': _typescript_eslint_utils_ts_eslint.RuleModule<"missing", [], _typescript_eslint_utils_ts_eslint.RuleListener>;
     };
     configs: {
@@ -23,6 +26,7 @@ declare const _default: {
             plugins: string[];
             rules: {
                 '@krymskyimaksym/react-api-client/no-await-mutate': string;
+                '@krymskyimaksym/react-api-client/no-non-serializable-params': string;
                 '@krymskyimaksym/react-api-client/require-query-key-when-endpoint-is-fn': string;
             };
         };

package/dist/index.d.ts CHANGED Viewed

@@ -2,6 +2,7 @@ import * as _typescript_eslint_utils_ts_eslint from '@typescript-eslint/utils/ts
 declare const rules: {
     'no-await-mutate': _typescript_eslint_utils_ts_eslint.RuleModule<"avoid", [], _typescript_eslint_utils_ts_eslint.RuleListener>;
+    'no-non-serializable-params': _typescript_eslint_utils_ts_eslint.RuleModule<"noFunction" | "noSymbol", [], _typescript_eslint_utils_ts_eslint.RuleListener>;
     'require-query-key-when-endpoint-is-fn': _typescript_eslint_utils_ts_eslint.RuleModule<"missing", [], _typescript_eslint_utils_ts_eslint.RuleListener>;
 };
 declare const configs: {
@@ -9,6 +10,7 @@ declare const configs: {
         plugins: string[];
         rules: {
             '@krymskyimaksym/react-api-client/no-await-mutate': string;
+            '@krymskyimaksym/react-api-client/no-non-serializable-params': string;
             '@krymskyimaksym/react-api-client/require-query-key-when-endpoint-is-fn': string;
         };
     };
@@ -16,6 +18,7 @@ declare const configs: {
 declare const _default: {
     rules: {
         'no-await-mutate': _typescript_eslint_utils_ts_eslint.RuleModule<"avoid", [], _typescript_eslint_utils_ts_eslint.RuleListener>;
+        'no-non-serializable-params': _typescript_eslint_utils_ts_eslint.RuleModule<"noFunction" | "noSymbol", [], _typescript_eslint_utils_ts_eslint.RuleListener>;
         'require-query-key-when-endpoint-is-fn': _typescript_eslint_utils_ts_eslint.RuleModule<"missing", [], _typescript_eslint_utils_ts_eslint.RuleListener>;
     };
     configs: {
@@ -23,6 +26,7 @@ declare const _default: {
             plugins: string[];
             rules: {
                 '@krymskyimaksym/react-api-client/no-await-mutate': string;
+                '@krymskyimaksym/react-api-client/no-non-serializable-params': string;
                 '@krymskyimaksym/react-api-client/require-query-key-when-endpoint-is-fn': string;
             };
         };

package/dist/index.js CHANGED Viewed

@@ -14,7 +14,7 @@ var noAwaitMutate = createRule({
     type: "problem",
     docs: {
       description: "mutate() returns void; await it has no effect. Use mutateAsync for awaitable mutations.",
-      recommended: "error"
+      recommended: "recommended"
     },
     fixable: "code",
     schema: [],
@@ -46,13 +46,64 @@ var noAwaitMutate = createRule({
 var createRule2 = utils.ESLintUtils.RuleCreator(
   (name) => `https://github.com/krymskyimaksym/react-api-client/tree/main/packages/eslint-plugin/docs/${name}.md`
 );
-var requireQueryKeyWhenEndpointIsFn = createRule2({
+var noNonSerializableParams = createRule2({
+  name: "no-non-serializable-params",
+  meta: {
+    type: "problem",
+    docs: {
+      description: "Params for useFetch/usePaginate/useQuery must be serializable. Functions and Symbol break hashQueryKey at runtime.",
+      recommended: "recommended"
+    },
+    schema: [],
+    messages: {
+      noFunction: "\u041D\u0435\u0441\u0435\u0440\u0438\u0430\u043B\u0438\u0437\u0443\u0435\u043C\u043E\u0435 \u0437\u043D\u0430\u0447\u0435\u043D\u0438\u0435 \u0432 params (\u0444\u0443\u043D\u043A\u0446\u0438\u044F): \u0441\u043B\u043E\u043C\u0430\u0435\u0442 hashQueryKey \u0432 \u0440\u0430\u043D\u0442\u0430\u0439\u043C\u0435. \u0412\u044B\u043D\u0435\u0441\u0438 callback \u043D\u0430\u0440\u0443\u0436\u0443 \u0445\u0443\u043A\u0430.",
+      noSymbol: "\u041D\u0435\u0441\u0435\u0440\u0438\u0430\u043B\u0438\u0437\u0443\u0435\u043C\u043E\u0435 \u0437\u043D\u0430\u0447\u0435\u043D\u0438\u0435 \u0432 params (Symbol): \u0441\u043B\u043E\u043C\u0430\u0435\u0442 hashQueryKey \u0432 \u0440\u0430\u043D\u0442\u0430\u0439\u043C\u0435."
+    }
+  },
+  defaultOptions: [],
+  create(context) {
+    const HOOK_NAMES = /* @__PURE__ */ new Set(["useFetch", "usePaginate", "useQuery"]);
+    function checkObjectExpression(obj) {
+      for (const prop of obj.properties) {
+        if (prop.type !== "Property") continue;
+        const v = prop.value;
+        if (v.type === "ArrowFunctionExpression" || v.type === "FunctionExpression") {
+          context.report({ node: v, messageId: "noFunction" });
+          continue;
+        }
+        if (v.type === "CallExpression" && v.callee.type === "Identifier" && v.callee.name === "Symbol") {
+          context.report({ node: v, messageId: "noSymbol" });
+        }
+      }
+    }
+    return {
+      CallExpression(node) {
+        if (node.callee.type !== "MemberExpression") {
+          if (node.callee.type === "Identifier" && node.callee.name === "useQuery") {
+            return;
+          }
+          return;
+        }
+        const prop = node.callee.property;
+        if (prop.type !== "Identifier" || !HOOK_NAMES.has(prop.name)) return;
+        const paramsArg = node.arguments[0];
+        if (!paramsArg) return;
+        if (paramsArg.type !== "ObjectExpression") return;
+        checkObjectExpression(paramsArg);
+      }
+    };
+  }
+});
+var createRule3 = utils.ESLintUtils.RuleCreator(
+  (name) => `https://github.com/krymskyimaksym/react-api-client/tree/main/packages/eslint-plugin/docs/${name}.md`
+);
+var requireQueryKeyWhenEndpointIsFn = createRule3({
   name: "require-query-key-when-endpoint-is-fn",
   meta: {
     type: "suggestion",
     docs: {
       description: "When apiClient is created from an endpoint function, useFetch should specify explicit queryKey.",
-      recommended: "warn"
+      recommended: "recommended"
     },
     schema: [],
     messages: {
@@ -105,6 +156,7 @@ var requireQueryKeyWhenEndpointIsFn = createRule2({
 // src/index.ts
 var rules = {
   "no-await-mutate": noAwaitMutate,
+  "no-non-serializable-params": noNonSerializableParams,
   "require-query-key-when-endpoint-is-fn": requireQueryKeyWhenEndpointIsFn
 };
 var configs = {
@@ -112,6 +164,7 @@ var configs = {
     plugins: ["@krymskyimaksym/react-api-client"],
     rules: {
       "@krymskyimaksym/react-api-client/no-await-mutate": "error",
+      "@krymskyimaksym/react-api-client/no-non-serializable-params": "error",
       "@krymskyimaksym/react-api-client/require-query-key-when-endpoint-is-fn": "warn"
     }
   }

package/dist/index.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"sources":["../src/rules/no-await-mutate.ts","../src/rules/require-query-key-when-endpoint-is-fn.ts","../src/index.ts"],"names":["ESLintUtils","createRule"],"mappings":";;;;;;;AAEA,IAAM,aAAaA,iBAAA,CAAY,WAAA;AAAA,EAC7B,CAAA,IAAA,KACE,4FAA4F,IAAI,CAAA,GAAA;AACpG,CAAA;AASO,IAAM,gBAAgB,UAAA,CAAW;AAAA,EACtC,IAAA,EAAM,iBAAA;AAAA,EACN,IAAA,EAAM;AAAA,IACJ,IAAA,EAAM,SAAA;AAAA,IACN,IAAA,EAAM;AAAA,MACJ,WAAA,EACE,yFAAA;AAAA,MACF,WAAA,EAAa;AAAA,KACf;AAAA,IACA,OAAA,EAAS,MAAA;AAAA,IACT,QAAQ,EAAC;AAAA,IACT,QAAA,EAAU;AAAA,MACR,KAAA,EACE;AAAA;AACJ,GACF;AAAA,EACA,gBAAgB,EAAC;AAAA,EACjB,OAAO,OAAA,EAAS;AACd,IAAA,OAAO;AAAA,MACL,gBAAgB,IAAA,EAAgC;AAC9C,QAAA,MAAM,MAAM,IAAA,CAAK,QAAA;AACjB,QAAA,IAAI,GAAA,CAAI,SAAS,gBAAA,EAAkB;AACnC,QAAA,MAAM,SAAS,GAAA,CAAI,MAAA;AACnB,QAAA,IAAI,MAAA,CAAO,SAAS,kBAAA,EAAoB;AACxC,QAAA,MAAM,OAAO,MAAA,CAAO,QAAA;AACpB,QAAA,IAAI,IAAA,CAAK,IAAA,KAAS,YAAA,IAAgB,IAAA,CAAK,SAAS,QAAA,EAAU;AAE1D,QAAA,OAAA,CAAQ,MAAA,CAAO;AAAA,UACb,IAAA;AAAA,UACA,SAAA,EAAW,OAAA;AAAA,UACX,IAAI,KAAA,EAAO;AACT,YAAA,OAAO,KAAA,CAAM,WAAA,CAAY,IAAA,EAAM,aAAa,CAAA;AAAA,UAC9C;AAAA,SACD,CAAA;AAAA,MACH;AAAA,KACF;AAAA,EACF;AACF,CAAC,CAAA;ACjDD,IAAMC,cAAaD,iBAAAA,CAAY,WAAA;AAAA,EAC7B,CAAA,IAAA,KACE,4FAA4F,IAAI,CAAA,GAAA;AACpG,CAAA;AAcO,IAAM,kCAAkCC,WAAAA,CAAW;AAAA,EACxD,IAAA,EAAM,uCAAA;AAAA,EACN,IAAA,EAAM;AAAA,IACJ,IAAA,EAAM,YAAA;AAAA,IACN,IAAA,EAAM;AAAA,MACJ,WAAA,EACE,iGAAA;AAAA,MACF,WAAA,EAAa;AAAA,KACf;AAAA,IACA,QAAQ,EAAC;AAAA,IACT,QAAA,EAAU;AAAA,MACR,OAAA,EACE;AAAA;AACJ,GACF;AAAA,EACA,gBAAgB,EAAC;AAAA,EACjB,OAAO,OAAA,EAAS;AACd,IAAA,MAAM,kBAAA,uBAAyB,GAAA,EAAY;AAE3C,IAAA,OAAO;AAAA;AAAA,MAEL,mBAAmB,IAAA,EAAmC;AACpD,QAAA,IAAI,IAAA,CAAK,EAAA,CAAG,IAAA,KAAS,YAAA,EAAc;AACnC,QAAA,IAAI,CAAC,IAAA,CAAK,IAAA,IAAQ,IAAA,CAAK,IAAA,CAAK,SAAS,gBAAA,EAAkB;AACvD,QAAA,MAAM,OAAO,IAAA,CAAK,IAAA;AAClB,QAAA,IACE,IAAA,CAAK,MAAA,CAAO,IAAA,KAAS,YAAA,IACpB,IAAA,CAAK,OAAO,IAAA,KAAS,WAAA,IAAe,IAAA,CAAK,MAAA,CAAO,IAAA,KAAS,aAAA;AAE1D,UAAA;AACF,QAAA,MAAM,QAAA,GAAW,IAAA,CAAK,SAAA,CAAU,CAAC,CAAA;AACjC,QAAA,IAAI,CAAC,QAAA,EAAU;AACf,QAAA,IACE,QAAA,CAAS,IAAA,KAAS,yBAAA,IAClB,QAAA,CAAS,SAAS,oBAAA,EAClB;AACA,UAAA,kBAAA,CAAmB,GAAA,CAAI,IAAA,CAAK,EAAA,CAAG,IAAI,CAAA;AAAA,QACrC;AAAA,MACF,CAAA;AAAA;AAAA,MAGA,eAAe,IAAA,EAA+B;AAC5C,QAAA,IAAI,IAAA,CAAK,MAAA,CAAO,IAAA,KAAS,kBAAA,EAAoB;AAC7C,QAAA,MAAM,GAAA,GAAM,KAAK,MAAA,CAAO,MAAA;AACxB,QAAA,MAAM,IAAA,GAAO,KAAK,MAAA,CAAO,QAAA;AACzB,QAAA,IAAI,GAAA,CAAI,SAAS,YAAA,EAAc;AAC/B,QAAA,IAAI,CAAC,kBAAA,CAAmB,GAAA,CAAI,GAAA,CAAI,IAAI,CAAA,EAAG;AACvC,QAAA,IAAI,IAAA,CAAK,SAAS,YAAA,EAAc;AAChC,QAAA,IAAI,IAAA,CAAK,IAAA,KAAS,UAAA,IAAc,IAAA,CAAK,SAAS,aAAA,EAAe;AAE7D,QAAA,MAAM,UAAA,GAAa,IAAA,CAAK,SAAA,CAAU,CAAC,CAAA;AACnC,QAAA,IAAI,CAAC,UAAA,EAAY;AACf,UAAA,OAAA,CAAQ,MAAA,CAAO,EAAE,IAAA,EAAM,SAAA,EAAW,WAAW,CAAA;AAC7C,UAAA;AAAA,QACF;AACA,QAAA,IAAI,UAAA,CAAW,SAAS,kBAAA,EAAoB;AAC5C,QAAA,MAAM,WAAA,GAAc,WAAW,UAAA,CAAW,IAAA;AAAA,UACxC,CAAA,CAAA,KACE,CAAA,CAAE,IAAA,KAAS,UAAA,IACX,CAAA,CAAE,IAAI,IAAA,KAAS,YAAA,IACf,CAAA,CAAE,GAAA,CAAI,IAAA,KAAS;AAAA,SACnB;AACA,QAAA,IAAI,CAAC,WAAA,EAAa;AAChB,UAAA,OAAA,CAAQ,MAAA,CAAO,EAAE,IAAA,EAAM,SAAA,EAAW,WAAW,CAAA;AAAA,QAC/C;AAAA,MACF;AAAA,KACF;AAAA,EACF;AACF,CAAC,CAAA;;;ACpFM,IAAM,KAAA,GAAQ;AAAA,EACnB,iBAAA,EAAmB,aAAA;AAAA,EACnB,uCAAA,EAAyC;AAC3C;AAEO,IAAM,OAAA,GAAU;AAAA,EACrB,WAAA,EAAa;AAAA,IACX,OAAA,EAAS,CAAC,kCAAkC,CAAA;AAAA,IAC5C,KAAA,EAAO;AAAA,MACL,kDAAA,EAAoD,OAAA;AAAA,MACpD,wEAAA,EACE;AAAA;AACJ;AAEJ;AAEA,IAAO,aAAA,GAAQ,EAAE,KAAA,EAAO,OAAA","file":"index.js","sourcesContent":["import { ESLintUtils, TSESTree } from '@typescript-eslint/utils';\n\nconst createRule = ESLintUtils.RuleCreator(\n name =>\n `https://github.com/krymskyimaksym/react-api-client/tree/main/packages/eslint-plugin/docs/${name}.md`,\n);\n\n/*\n Запрещает `await x.mutate(...)` — `mutate` возвращает `void`, а не\n * `Promise`. Для последовательной логики или try/catch используй\n * `mutateAsync`.\n \n Эвристика: `await <expr>.mutate(...)`.\n /\nexport const noAwaitMutate = createRule({\n name: 'no-await-mutate',\n meta: {\n type: 'problem',\n docs: {\n description:\n 'mutate() returns void; await it has no effect. Use mutateAsync for awaitable mutations.',\n recommended: 'error',\n },\n fixable: 'code',\n schema: [],\n messages: {\n avoid:\n '`mutate` возвращает void — await не сработает. Используй `mutateAsync` для await/try-catch.',\n },\n },\n defaultOptions: [],\n create(context) {\n return {\n AwaitExpression(node: TSESTree.AwaitExpression) {\n const arg = node.argument;\n if (arg.type !== 'CallExpression') return;\n const callee = arg.callee;\n if (callee.type !== 'MemberExpression') return;\n const prop = callee.property;\n if (prop.type !== 'Identifier' \|\| prop.name !== 'mutate') return;\n\n context.report({\n node,\n messageId: 'avoid',\n fix(fixer) {\n return fixer.replaceText(prop, 'mutateAsync');\n },\n });\n },\n };\n },\n});\n","import { ESLintUtils, TSESTree } from '@typescript-eslint/utils';\n\nconst createRule = ESLintUtils.RuleCreator(\n name =>\n `https://github.com/krymskyimaksym/react-api-client/tree/main/packages/eslint-plugin/docs/${name}.md`,\n);\n\n/\n Если `apiClient(fn, ...)` создан с endpoint-функцией, и где-то\n * вызывается `<api>.useFetch(params)` без `queryKey` в options —\n * предупредить. По умолчанию ключ генерится из endpoint+params, но при\n * endpoint-функции стабильность ключа зависит от того, что функция\n * возвращает одну и ту же строку для одних и тех же params. Явный\n * `queryKey` снимает риск.\n \n Эвристика статическая: ищем `const xxxApi = apiClient(SomethingFn, ...)`,\n * запоминаем имя, потом ругаемся на `xxxApi.useFetch(...)` без queryKey\n * в options-объекте.\n */\nexport const requireQueryKeyWhenEndpointIsFn = createRule({\n name: 'require-query-key-when-endpoint-is-fn',\n meta: {\n type: 'suggestion',\n docs: {\n description:\n 'When apiClient is created from an endpoint function, useFetch should specify explicit queryKey.',\n recommended: 'warn',\n },\n schema: [],\n messages: {\n missing:\n 'apiClient с endpoint-функцией: укажи `queryKey` явно, чтобы ключ кэша был стабильным.',\n },\n },\n defaultOptions: [],\n create(context) {\n const apisWithFnEndpoint = new Set<string>();\n\n return {\n // const xApi = apiClient(fn, ...)\n VariableDeclarator(node: TSESTree.VariableDeclarator) {\n if (node.id.type !== 'Identifier') return;\n if (!node.init \|\| node.init.type !== 'CallExpression') return;\n const call = node.init;\n if (\n call.callee.type !== 'Identifier' \|\|\n (call.callee.name !== 'apiClient' && call.callee.name !== 'apiPaginate')\n )\n return;\n const firstArg = call.arguments[0];\n if (!firstArg) return;\n if (\n firstArg.type === 'ArrowFunctionExpression' \|\|\n firstArg.type === 'FunctionExpression'\n ) {\n apisWithFnEndpoint.add(node.id.name);\n }\n },\n\n // xApi.useFetch(params, options?)\n CallExpression(node: TSESTree.CallExpression) {\n if (node.callee.type !== 'MemberExpression') return;\n const obj = node.callee.object;\n const prop = node.callee.property;\n if (obj.type !== 'Identifier') return;\n if (!apisWithFnEndpoint.has(obj.name)) return;\n if (prop.type !== 'Identifier') return;\n if (prop.name !== 'useFetch' && prop.name !== 'usePaginate') return;\n\n const optionsArg = node.arguments[1];\n if (!optionsArg) {\n context.report({ node, messageId: 'missing' });\n return;\n }\n if (optionsArg.type !== 'ObjectExpression') return; // не статически анализируем\n const hasQueryKey = optionsArg.properties.some(\n p =>\n p.type === 'Property' &&\n p.key.type === 'Identifier' &&\n p.key.name === 'queryKey',\n );\n if (!hasQueryKey) {\n context.report({ node, messageId: 'missing' });\n }\n },\n };\n },\n});\n","import { noAwaitMutate } from './rules/no-await-mutate';\nimport { requireQueryKeyWhenEndpointIsFn } from './rules/require-query-key-when-endpoint-is-fn';\n\nexport const rules = {\n 'no-await-mutate': noAwaitMutate,\n 'require-query-key-when-endpoint-is-fn': requireQueryKeyWhenEndpointIsFn,\n};\n\nexport const configs = {\n recommended: {\n plugins: ['@krymskyimaksym/react-api-client'],\n rules: {\n '@krymskyimaksym/react-api-client/no-await-mutate': 'error',\n '@krymskyimaksym/react-api-client/require-query-key-when-endpoint-is-fn':\n 'warn',\n },\n },\n};\n\nexport default { rules, configs };\n"]}
1	+ {"version":3,"sources":["../src/rules/no-await-mutate.ts","../src/rules/no-non-serializable-params.ts","../src/rules/require-query-key-when-endpoint-is-fn.ts","../src/index.ts"],"names":["ESLintUtils","createRule"],"mappings":";;;;;;;AAEA,IAAM,aAAaA,iBAAA,CAAY,WAAA;AAAA,EAC7B,CAAA,IAAA,KACE,4FAA4F,IAAI,CAAA,GAAA;AACpG,CAAA;AASO,IAAM,gBAAgB,UAAA,CAAW;AAAA,EACtC,IAAA,EAAM,iBAAA;AAAA,EACN,IAAA,EAAM;AAAA,IACJ,IAAA,EAAM,SAAA;AAAA,IACN,IAAA,EAAM;AAAA,MACJ,WAAA,EACE,yFAAA;AAAA,MACF,WAAA,EAAa;AAAA,KACf;AAAA,IACA,OAAA,EAAS,MAAA;AAAA,IACT,QAAQ,EAAC;AAAA,IACT,QAAA,EAAU;AAAA,MACR,KAAA,EACE;AAAA;AACJ,GACF;AAAA,EACA,gBAAgB,EAAC;AAAA,EACjB,OAAO,OAAA,EAAS;AACd,IAAA,OAAO;AAAA,MACL,gBAAgB,IAAA,EAAgC;AAC9C,QAAA,MAAM,MAAM,IAAA,CAAK,QAAA;AACjB,QAAA,IAAI,GAAA,CAAI,SAAS,gBAAA,EAAkB;AACnC,QAAA,MAAM,SAAS,GAAA,CAAI,MAAA;AACnB,QAAA,IAAI,MAAA,CAAO,SAAS,kBAAA,EAAoB;AACxC,QAAA,MAAM,OAAO,MAAA,CAAO,QAAA;AACpB,QAAA,IAAI,IAAA,CAAK,IAAA,KAAS,YAAA,IAAgB,IAAA,CAAK,SAAS,QAAA,EAAU;AAE1D,QAAA,OAAA,CAAQ,MAAA,CAAO;AAAA,UACb,IAAA;AAAA,UACA,SAAA,EAAW,OAAA;AAAA,UACX,IAAI,KAAA,EAAO;AACT,YAAA,OAAO,KAAA,CAAM,WAAA,CAAY,IAAA,EAAM,aAAa,CAAA;AAAA,UAC9C;AAAA,SACD,CAAA;AAAA,MACH;AAAA,KACF;AAAA,EACF;AACF,CAAC,CAAA;ACjDD,IAAMC,cAAaD,iBAAAA,CAAY,WAAA;AAAA,EAC7B,CAAA,IAAA,KACE,4FAA4F,IAAI,CAAA,GAAA;AACpG,CAAA;AAaO,IAAM,0BAA0BC,WAAAA,CAAW;AAAA,EAChD,IAAA,EAAM,4BAAA;AAAA,EACN,IAAA,EAAM;AAAA,IACJ,IAAA,EAAM,SAAA;AAAA,IACN,IAAA,EAAM;AAAA,MACJ,WAAA,EACE,oHAAA;AAAA,MACF,WAAA,EAAa;AAAA,KACf;AAAA,IACA,QAAQ,EAAC;AAAA,IACT,QAAA,EAAU;AAAA,MACR,UAAA,EACE,uaAAA;AAAA,MACF,QAAA,EACE;AAAA;AACJ,GACF;AAAA,EACA,gBAAgB,EAAC;AAAA,EACjB,OAAO,OAAA,EAAS;AACd,IAAA,MAAM,6BAAa,IAAI,GAAA,CAAI,CAAC,UAAA,EAAY,aAAA,EAAe,UAAU,CAAC,CAAA;AAElE,IAAA,SAAS,sBAAsB,GAAA,EAAgC;AAC7D,MAAA,KAAA,MAAW,IAAA,IAAQ,IAAI,UAAA,EAAY;AACjC,QAAA,IAAI,IAAA,CAAK,SAAS,UAAA,EAAY;AAC9B,QAAA,MAAM,IAAI,IAAA,CAAK,KAAA;AACf,QAAA,IACE,CAAA,CAAE,IAAA,KAAS,yBAAA,IACX,CAAA,CAAE,SAAS,oBAAA,EACX;AACA,UAAA,OAAA,CAAQ,OAAO,EAAE,IAAA,EAAM,CAAA,EAAG,SAAA,EAAW,cAAc,CAAA;AACnD,UAAA;AAAA,QACF;AACA,QAAA,IACE,CAAA,CAAE,IAAA,KAAS,gBAAA,IACX,CAAA,CAAE,MAAA,CAAO,SAAS,YAAA,IAClB,CAAA,CAAE,MAAA,CAAO,IAAA,KAAS,QAAA,EAClB;AACA,UAAA,OAAA,CAAQ,OAAO,EAAE,IAAA,EAAM,CAAA,EAAG,SAAA,EAAW,YAAY,CAAA;AAAA,QACnD;AAAA,MACF;AAAA,IACF;AAEA,IAAA,OAAO;AAAA,MACL,eAAe,IAAA,EAA+B;AAC5C,QAAA,IAAI,IAAA,CAAK,MAAA,CAAO,IAAA,KAAS,kBAAA,EAAoB;AAG3C,UAAA,IACE,KAAK,MAAA,CAAO,IAAA,KAAS,gBACrB,IAAA,CAAK,MAAA,CAAO,SAAS,UAAA,EACrB;AACA,YAAA;AAAA,UACF;AACA,UAAA;AAAA,QACF;AACA,QAAA,MAAM,IAAA,GAAO,KAAK,MAAA,CAAO,QAAA;AACzB,QAAA,IAAI,IAAA,CAAK,SAAS,YAAA,IAAgB,CAAC,WAAW,GAAA,CAAI,IAAA,CAAK,IAAI,CAAA,EAAG;AAC9D,QAAA,MAAM,SAAA,GAAY,IAAA,CAAK,SAAA,CAAU,CAAC,CAAA;AAClC,QAAA,IAAI,CAAC,SAAA,EAAW;AAChB,QAAA,IAAI,SAAA,CAAU,SAAS,kBAAA,EAAoB;AAC3C,QAAA,qBAAA,CAAsB,SAAS,CAAA;AAAA,MACjC;AAAA,KACF;AAAA,EACF;AACF,CAAC,CAAA;AChFD,IAAMA,cAAaD,iBAAAA,CAAY,WAAA;AAAA,EAC7B,CAAA,IAAA,KACE,4FAA4F,IAAI,CAAA,GAAA;AACpG,CAAA;AAcO,IAAM,kCAAkCC,WAAAA,CAAW;AAAA,EACxD,IAAA,EAAM,uCAAA;AAAA,EACN,IAAA,EAAM;AAAA,IACJ,IAAA,EAAM,YAAA;AAAA,IACN,IAAA,EAAM;AAAA,MACJ,WAAA,EACE,iGAAA;AAAA,MACF,WAAA,EAAa;AAAA,KACf;AAAA,IACA,QAAQ,EAAC;AAAA,IACT,QAAA,EAAU;AAAA,MACR,OAAA,EACE;AAAA;AACJ,GACF;AAAA,EACA,gBAAgB,EAAC;AAAA,EACjB,OAAO,OAAA,EAAS;AACd,IAAA,MAAM,kBAAA,uBAAyB,GAAA,EAAY;AAE3C,IAAA,OAAO;AAAA;AAAA,MAEL,mBAAmB,IAAA,EAAmC;AACpD,QAAA,IAAI,IAAA,CAAK,EAAA,CAAG,IAAA,KAAS,YAAA,EAAc;AACnC,QAAA,IAAI,CAAC,IAAA,CAAK,IAAA,IAAQ,IAAA,CAAK,IAAA,CAAK,SAAS,gBAAA,EAAkB;AACvD,QAAA,MAAM,OAAO,IAAA,CAAK,IAAA;AAClB,QAAA,IACE,IAAA,CAAK,MAAA,CAAO,IAAA,KAAS,YAAA,IACpB,IAAA,CAAK,OAAO,IAAA,KAAS,WAAA,IAAe,IAAA,CAAK,MAAA,CAAO,IAAA,KAAS,aAAA;AAE1D,UAAA;AACF,QAAA,MAAM,QAAA,GAAW,IAAA,CAAK,SAAA,CAAU,CAAC,CAAA;AACjC,QAAA,IAAI,CAAC,QAAA,EAAU;AACf,QAAA,IACE,QAAA,CAAS,IAAA,KAAS,yBAAA,IAClB,QAAA,CAAS,SAAS,oBAAA,EAClB;AACA,UAAA,kBAAA,CAAmB,GAAA,CAAI,IAAA,CAAK,EAAA,CAAG,IAAI,CAAA;AAAA,QACrC;AAAA,MACF,CAAA;AAAA;AAAA,MAGA,eAAe,IAAA,EAA+B;AAC5C,QAAA,IAAI,IAAA,CAAK,MAAA,CAAO,IAAA,KAAS,kBAAA,EAAoB;AAC7C,QAAA,MAAM,GAAA,GAAM,KAAK,MAAA,CAAO,MAAA;AACxB,QAAA,MAAM,IAAA,GAAO,KAAK,MAAA,CAAO,QAAA;AACzB,QAAA,IAAI,GAAA,CAAI,SAAS,YAAA,EAAc;AAC/B,QAAA,IAAI,CAAC,kBAAA,CAAmB,GAAA,CAAI,GAAA,CAAI,IAAI,CAAA,EAAG;AACvC,QAAA,IAAI,IAAA,CAAK,SAAS,YAAA,EAAc;AAChC,QAAA,IAAI,IAAA,CAAK,IAAA,KAAS,UAAA,IAAc,IAAA,CAAK,SAAS,aAAA,EAAe;AAE7D,QAAA,MAAM,UAAA,GAAa,IAAA,CAAK,SAAA,CAAU,CAAC,CAAA;AACnC,QAAA,IAAI,CAAC,UAAA,EAAY;AACf,UAAA,OAAA,CAAQ,MAAA,CAAO,EAAE,IAAA,EAAM,SAAA,EAAW,WAAW,CAAA;AAC7C,UAAA;AAAA,QACF;AACA,QAAA,IAAI,UAAA,CAAW,SAAS,kBAAA,EAAoB;AAC5C,QAAA,MAAM,WAAA,GAAc,WAAW,UAAA,CAAW,IAAA;AAAA,UACxC,CAAA,CAAA,KACE,CAAA,CAAE,IAAA,KAAS,UAAA,IACX,CAAA,CAAE,IAAI,IAAA,KAAS,YAAA,IACf,CAAA,CAAE,GAAA,CAAI,IAAA,KAAS;AAAA,SACnB;AACA,QAAA,IAAI,CAAC,WAAA,EAAa;AAChB,UAAA,OAAA,CAAQ,MAAA,CAAO,EAAE,IAAA,EAAM,SAAA,EAAW,WAAW,CAAA;AAAA,QAC/C;AAAA,MACF;AAAA,KACF;AAAA,EACF;AACF,CAAC,CAAA;;;ACnFM,IAAM,KAAA,GAAQ;AAAA,EACnB,iBAAA,EAAmB,aAAA;AAAA,EACnB,4BAAA,EAA8B,uBAAA;AAAA,EAC9B,uCAAA,EAAyC;AAC3C;AAEO,IAAM,OAAA,GAAU;AAAA,EACrB,WAAA,EAAa;AAAA,IACX,OAAA,EAAS,CAAC,kCAAkC,CAAA;AAAA,IAC5C,KAAA,EAAO;AAAA,MACL,kDAAA,EAAoD,OAAA;AAAA,MACpD,6DAAA,EAA+D,OAAA;AAAA,MAC/D,wEAAA,EACE;AAAA;AACJ;AAEJ;AAEA,IAAO,aAAA,GAAQ,EAAE,KAAA,EAAO,OAAA","file":"index.js","sourcesContent":["import { ESLintUtils, TSESTree } from '@typescript-eslint/utils';\n\nconst createRule = ESLintUtils.RuleCreator(\n name =>\n `https://github.com/krymskyimaksym/react-api-client/tree/main/packages/eslint-plugin/docs/${name}.md`,\n);\n\n/*\n Запрещает `await x.mutate(...)` — `mutate` возвращает `void`, а не\n * `Promise`. Для последовательной логики или try/catch используй\n * `mutateAsync`.\n \n Эвристика: `await <expr>.mutate(...)`.\n /\nexport const noAwaitMutate = createRule({\n name: 'no-await-mutate',\n meta: {\n type: 'problem',\n docs: {\n description:\n 'mutate() returns void; await it has no effect. Use mutateAsync for awaitable mutations.',\n recommended: 'recommended',\n },\n fixable: 'code',\n schema: [],\n messages: {\n avoid:\n '`mutate` возвращает void — await не сработает. Используй `mutateAsync` для await/try-catch.',\n },\n },\n defaultOptions: [],\n create(context) {\n return {\n AwaitExpression(node: TSESTree.AwaitExpression) {\n const arg = node.argument;\n if (arg.type !== 'CallExpression') return;\n const callee = arg.callee;\n if (callee.type !== 'MemberExpression') return;\n const prop = callee.property;\n if (prop.type !== 'Identifier' \|\| prop.name !== 'mutate') return;\n\n context.report({\n node,\n messageId: 'avoid',\n fix(fixer) {\n return fixer.replaceText(prop, 'mutateAsync');\n },\n });\n },\n };\n },\n});\n","import { ESLintUtils, TSESTree } from '@typescript-eslint/utils';\n\nconst createRule = ESLintUtils.RuleCreator(\n name =>\n `https://github.com/krymskyimaksym/react-api-client/tree/main/packages/eslint-plugin/docs/${name}.md`,\n);\n\n/\n Запрещает несериализуемые значения в `params` для `useFetch` /\n * `usePaginate` / `useQuery`. Функции и Symbol сломают `hashQueryKey`\n * (он `throw`-ает на них), а это приведёт к рантайм-ошибке при mount'е.\n \n Ловим статически:\n * - стрелочные/функциональные выражения как значения свойств;\n * - вызовы `Symbol(...)` как значения свойств.\n \n Эвристика — без типов; ловит самые частые случаи.\n /\nexport const noNonSerializableParams = createRule({\n name: 'no-non-serializable-params',\n meta: {\n type: 'problem',\n docs: {\n description:\n 'Params for useFetch/usePaginate/useQuery must be serializable. Functions and Symbol break hashQueryKey at runtime.',\n recommended: 'recommended',\n },\n schema: [],\n messages: {\n noFunction:\n 'Несериализуемое значение в params (функция): сломает hashQueryKey в рантайме. Вынеси callback наружу хука.',\n noSymbol:\n 'Несериализуемое значение в params (Symbol): сломает hashQueryKey в рантайме.',\n },\n },\n defaultOptions: [],\n create(context) {\n const HOOK_NAMES = new Set(['useFetch', 'usePaginate', 'useQuery']);\n\n function checkObjectExpression(obj: TSESTree.ObjectExpression) {\n for (const prop of obj.properties) {\n if (prop.type !== 'Property') continue;\n const v = prop.value;\n if (\n v.type === 'ArrowFunctionExpression' \|\|\n v.type === 'FunctionExpression'\n ) {\n context.report({ node: v, messageId: 'noFunction' });\n continue;\n }\n if (\n v.type === 'CallExpression' &&\n v.callee.type === 'Identifier' &&\n v.callee.name === 'Symbol'\n ) {\n context.report({ node: v, messageId: 'noSymbol' });\n }\n }\n }\n\n return {\n CallExpression(node: TSESTree.CallExpression) {\n if (node.callee.type !== 'MemberExpression') {\n // useQuery(key, fn, opts) — первый аргумент это key,\n // не params; пропускаем.\n if (\n node.callee.type === 'Identifier' &&\n node.callee.name === 'useQuery'\n ) {\n return;\n }\n return;\n }\n const prop = node.callee.property;\n if (prop.type !== 'Identifier' \|\| !HOOK_NAMES.has(prop.name)) return;\n const paramsArg = node.arguments[0];\n if (!paramsArg) return;\n if (paramsArg.type !== 'ObjectExpression') return;\n checkObjectExpression(paramsArg);\n },\n };\n },\n});\n","import { ESLintUtils, TSESTree } from '@typescript-eslint/utils';\n\nconst createRule = ESLintUtils.RuleCreator(\n name =>\n `https://github.com/krymskyimaksym/react-api-client/tree/main/packages/eslint-plugin/docs/${name}.md`,\n);\n\n/\n Если `apiClient(fn, ...)` создан с endpoint-функцией, и где-то\n * вызывается `<api>.useFetch(params)` без `queryKey` в options —\n * предупредить. По умолчанию ключ генерится из endpoint+params, но при\n * endpoint-функции стабильность ключа зависит от того, что функция\n * возвращает одну и ту же строку для одних и тех же params. Явный\n * `queryKey` снимает риск.\n \n Эвристика статическая: ищем `const xxxApi = apiClient(SomethingFn, ...)`,\n * запоминаем имя, потом ругаемся на `xxxApi.useFetch(...)` без queryKey\n * в options-объекте.\n */\nexport const requireQueryKeyWhenEndpointIsFn = createRule({\n name: 'require-query-key-when-endpoint-is-fn',\n meta: {\n type: 'suggestion',\n docs: {\n description:\n 'When apiClient is created from an endpoint function, useFetch should specify explicit queryKey.',\n recommended: 'recommended',\n },\n schema: [],\n messages: {\n missing:\n 'apiClient с endpoint-функцией: укажи `queryKey` явно, чтобы ключ кэша был стабильным.',\n },\n },\n defaultOptions: [],\n create(context) {\n const apisWithFnEndpoint = new Set<string>();\n\n return {\n // const xApi = apiClient(fn, ...)\n VariableDeclarator(node: TSESTree.VariableDeclarator) {\n if (node.id.type !== 'Identifier') return;\n if (!node.init \|\| node.init.type !== 'CallExpression') return;\n const call = node.init;\n if (\n call.callee.type !== 'Identifier' \|\|\n (call.callee.name !== 'apiClient' && call.callee.name !== 'apiPaginate')\n )\n return;\n const firstArg = call.arguments[0];\n if (!firstArg) return;\n if (\n firstArg.type === 'ArrowFunctionExpression' \|\|\n firstArg.type === 'FunctionExpression'\n ) {\n apisWithFnEndpoint.add(node.id.name);\n }\n },\n\n // xApi.useFetch(params, options?)\n CallExpression(node: TSESTree.CallExpression) {\n if (node.callee.type !== 'MemberExpression') return;\n const obj = node.callee.object;\n const prop = node.callee.property;\n if (obj.type !== 'Identifier') return;\n if (!apisWithFnEndpoint.has(obj.name)) return;\n if (prop.type !== 'Identifier') return;\n if (prop.name !== 'useFetch' && prop.name !== 'usePaginate') return;\n\n const optionsArg = node.arguments[1];\n if (!optionsArg) {\n context.report({ node, messageId: 'missing' });\n return;\n }\n if (optionsArg.type !== 'ObjectExpression') return; // не статически анализируем\n const hasQueryKey = optionsArg.properties.some(\n p =>\n p.type === 'Property' &&\n p.key.type === 'Identifier' &&\n p.key.name === 'queryKey',\n );\n if (!hasQueryKey) {\n context.report({ node, messageId: 'missing' });\n }\n },\n };\n },\n});\n","import { noAwaitMutate } from './rules/no-await-mutate';\nimport { noNonSerializableParams } from './rules/no-non-serializable-params';\nimport { requireQueryKeyWhenEndpointIsFn } from './rules/require-query-key-when-endpoint-is-fn';\n\nexport const rules = {\n 'no-await-mutate': noAwaitMutate,\n 'no-non-serializable-params': noNonSerializableParams,\n 'require-query-key-when-endpoint-is-fn': requireQueryKeyWhenEndpointIsFn,\n};\n\nexport const configs = {\n recommended: {\n plugins: ['@krymskyimaksym/react-api-client'],\n rules: {\n '@krymskyimaksym/react-api-client/no-await-mutate': 'error',\n '@krymskyimaksym/react-api-client/no-non-serializable-params': 'error',\n '@krymskyimaksym/react-api-client/require-query-key-when-endpoint-is-fn':\n 'warn',\n },\n },\n};\n\nexport default { rules, configs };\n"]}

package/dist/index.mjs CHANGED Viewed

@@ -10,7 +10,7 @@ var noAwaitMutate = createRule({
     type: "problem",
     docs: {
       description: "mutate() returns void; await it has no effect. Use mutateAsync for awaitable mutations.",
-      recommended: "error"
+      recommended: "recommended"
     },
     fixable: "code",
     schema: [],
@@ -42,13 +42,64 @@ var noAwaitMutate = createRule({
 var createRule2 = ESLintUtils.RuleCreator(
   (name) => `https://github.com/krymskyimaksym/react-api-client/tree/main/packages/eslint-plugin/docs/${name}.md`
 );
-var requireQueryKeyWhenEndpointIsFn = createRule2({
+var noNonSerializableParams = createRule2({
+  name: "no-non-serializable-params",
+  meta: {
+    type: "problem",
+    docs: {
+      description: "Params for useFetch/usePaginate/useQuery must be serializable. Functions and Symbol break hashQueryKey at runtime.",
+      recommended: "recommended"
+    },
+    schema: [],
+    messages: {
+      noFunction: "\u041D\u0435\u0441\u0435\u0440\u0438\u0430\u043B\u0438\u0437\u0443\u0435\u043C\u043E\u0435 \u0437\u043D\u0430\u0447\u0435\u043D\u0438\u0435 \u0432 params (\u0444\u0443\u043D\u043A\u0446\u0438\u044F): \u0441\u043B\u043E\u043C\u0430\u0435\u0442 hashQueryKey \u0432 \u0440\u0430\u043D\u0442\u0430\u0439\u043C\u0435. \u0412\u044B\u043D\u0435\u0441\u0438 callback \u043D\u0430\u0440\u0443\u0436\u0443 \u0445\u0443\u043A\u0430.",
+      noSymbol: "\u041D\u0435\u0441\u0435\u0440\u0438\u0430\u043B\u0438\u0437\u0443\u0435\u043C\u043E\u0435 \u0437\u043D\u0430\u0447\u0435\u043D\u0438\u0435 \u0432 params (Symbol): \u0441\u043B\u043E\u043C\u0430\u0435\u0442 hashQueryKey \u0432 \u0440\u0430\u043D\u0442\u0430\u0439\u043C\u0435."
+    }
+  },
+  defaultOptions: [],
+  create(context) {
+    const HOOK_NAMES = /* @__PURE__ */ new Set(["useFetch", "usePaginate", "useQuery"]);
+    function checkObjectExpression(obj) {
+      for (const prop of obj.properties) {
+        if (prop.type !== "Property") continue;
+        const v = prop.value;
+        if (v.type === "ArrowFunctionExpression" || v.type === "FunctionExpression") {
+          context.report({ node: v, messageId: "noFunction" });
+          continue;
+        }
+        if (v.type === "CallExpression" && v.callee.type === "Identifier" && v.callee.name === "Symbol") {
+          context.report({ node: v, messageId: "noSymbol" });
+        }
+      }
+    }
+    return {
+      CallExpression(node) {
+        if (node.callee.type !== "MemberExpression") {
+          if (node.callee.type === "Identifier" && node.callee.name === "useQuery") {
+            return;
+          }
+          return;
+        }
+        const prop = node.callee.property;
+        if (prop.type !== "Identifier" || !HOOK_NAMES.has(prop.name)) return;
+        const paramsArg = node.arguments[0];
+        if (!paramsArg) return;
+        if (paramsArg.type !== "ObjectExpression") return;
+        checkObjectExpression(paramsArg);
+      }
+    };
+  }
+});
+var createRule3 = ESLintUtils.RuleCreator(
+  (name) => `https://github.com/krymskyimaksym/react-api-client/tree/main/packages/eslint-plugin/docs/${name}.md`
+);
+var requireQueryKeyWhenEndpointIsFn = createRule3({
   name: "require-query-key-when-endpoint-is-fn",
   meta: {
     type: "suggestion",
     docs: {
       description: "When apiClient is created from an endpoint function, useFetch should specify explicit queryKey.",
-      recommended: "warn"
+      recommended: "recommended"
     },
     schema: [],
     messages: {
@@ -101,6 +152,7 @@ var requireQueryKeyWhenEndpointIsFn = createRule2({
 // src/index.ts
 var rules = {
   "no-await-mutate": noAwaitMutate,
+  "no-non-serializable-params": noNonSerializableParams,
   "require-query-key-when-endpoint-is-fn": requireQueryKeyWhenEndpointIsFn
 };
 var configs = {
@@ -108,6 +160,7 @@ var configs = {
     plugins: ["@krymskyimaksym/react-api-client"],
     rules: {
       "@krymskyimaksym/react-api-client/no-await-mutate": "error",
+      "@krymskyimaksym/react-api-client/no-non-serializable-params": "error",
       "@krymskyimaksym/react-api-client/require-query-key-when-endpoint-is-fn": "warn"
     }
   }

package/dist/index.mjs.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"sources":["../src/rules/no-await-mutate.ts","../src/rules/require-query-key-when-endpoint-is-fn.ts","../src/index.ts"],"names":["createRule","ESLintUtils"],"mappings":";;;AAEA,IAAM,aAAa,WAAA,CAAY,WAAA;AAAA,EAC7B,CAAA,IAAA,KACE,4FAA4F,IAAI,CAAA,GAAA;AACpG,CAAA;AASO,IAAM,gBAAgB,UAAA,CAAW;AAAA,EACtC,IAAA,EAAM,iBAAA;AAAA,EACN,IAAA,EAAM;AAAA,IACJ,IAAA,EAAM,SAAA;AAAA,IACN,IAAA,EAAM;AAAA,MACJ,WAAA,EACE,yFAAA;AAAA,MACF,WAAA,EAAa;AAAA,KACf;AAAA,IACA,OAAA,EAAS,MAAA;AAAA,IACT,QAAQ,EAAC;AAAA,IACT,QAAA,EAAU;AAAA,MACR,KAAA,EACE;AAAA;AACJ,GACF;AAAA,EACA,gBAAgB,EAAC;AAAA,EACjB,OAAO,OAAA,EAAS;AACd,IAAA,OAAO;AAAA,MACL,gBAAgB,IAAA,EAAgC;AAC9C,QAAA,MAAM,MAAM,IAAA,CAAK,QAAA;AACjB,QAAA,IAAI,GAAA,CAAI,SAAS,gBAAA,EAAkB;AACnC,QAAA,MAAM,SAAS,GAAA,CAAI,MAAA;AACnB,QAAA,IAAI,MAAA,CAAO,SAAS,kBAAA,EAAoB;AACxC,QAAA,MAAM,OAAO,MAAA,CAAO,QAAA;AACpB,QAAA,IAAI,IAAA,CAAK,IAAA,KAAS,YAAA,IAAgB,IAAA,CAAK,SAAS,QAAA,EAAU;AAE1D,QAAA,OAAA,CAAQ,MAAA,CAAO;AAAA,UACb,IAAA;AAAA,UACA,SAAA,EAAW,OAAA;AAAA,UACX,IAAI,KAAA,EAAO;AACT,YAAA,OAAO,KAAA,CAAM,WAAA,CAAY,IAAA,EAAM,aAAa,CAAA;AAAA,UAC9C;AAAA,SACD,CAAA;AAAA,MACH;AAAA,KACF;AAAA,EACF;AACF,CAAC,CAAA;ACjDD,IAAMA,cAAaC,WAAAA,CAAY,WAAA;AAAA,EAC7B,CAAA,IAAA,KACE,4FAA4F,IAAI,CAAA,GAAA;AACpG,CAAA;AAcO,IAAM,kCAAkCD,WAAAA,CAAW;AAAA,EACxD,IAAA,EAAM,uCAAA;AAAA,EACN,IAAA,EAAM;AAAA,IACJ,IAAA,EAAM,YAAA;AAAA,IACN,IAAA,EAAM;AAAA,MACJ,WAAA,EACE,iGAAA;AAAA,MACF,WAAA,EAAa;AAAA,KACf;AAAA,IACA,QAAQ,EAAC;AAAA,IACT,QAAA,EAAU;AAAA,MACR,OAAA,EACE;AAAA;AACJ,GACF;AAAA,EACA,gBAAgB,EAAC;AAAA,EACjB,OAAO,OAAA,EAAS;AACd,IAAA,MAAM,kBAAA,uBAAyB,GAAA,EAAY;AAE3C,IAAA,OAAO;AAAA;AAAA,MAEL,mBAAmB,IAAA,EAAmC;AACpD,QAAA,IAAI,IAAA,CAAK,EAAA,CAAG,IAAA,KAAS,YAAA,EAAc;AACnC,QAAA,IAAI,CAAC,IAAA,CAAK,IAAA,IAAQ,IAAA,CAAK,IAAA,CAAK,SAAS,gBAAA,EAAkB;AACvD,QAAA,MAAM,OAAO,IAAA,CAAK,IAAA;AAClB,QAAA,IACE,IAAA,CAAK,MAAA,CAAO,IAAA,KAAS,YAAA,IACpB,IAAA,CAAK,OAAO,IAAA,KAAS,WAAA,IAAe,IAAA,CAAK,MAAA,CAAO,IAAA,KAAS,aAAA;AAE1D,UAAA;AACF,QAAA,MAAM,QAAA,GAAW,IAAA,CAAK,SAAA,CAAU,CAAC,CAAA;AACjC,QAAA,IAAI,CAAC,QAAA,EAAU;AACf,QAAA,IACE,QAAA,CAAS,IAAA,KAAS,yBAAA,IAClB,QAAA,CAAS,SAAS,oBAAA,EAClB;AACA,UAAA,kBAAA,CAAmB,GAAA,CAAI,IAAA,CAAK,EAAA,CAAG,IAAI,CAAA;AAAA,QACrC;AAAA,MACF,CAAA;AAAA;AAAA,MAGA,eAAe,IAAA,EAA+B;AAC5C,QAAA,IAAI,IAAA,CAAK,MAAA,CAAO,IAAA,KAAS,kBAAA,EAAoB;AAC7C,QAAA,MAAM,GAAA,GAAM,KAAK,MAAA,CAAO,MAAA;AACxB,QAAA,MAAM,IAAA,GAAO,KAAK,MAAA,CAAO,QAAA;AACzB,QAAA,IAAI,GAAA,CAAI,SAAS,YAAA,EAAc;AAC/B,QAAA,IAAI,CAAC,kBAAA,CAAmB,GAAA,CAAI,GAAA,CAAI,IAAI,CAAA,EAAG;AACvC,QAAA,IAAI,IAAA,CAAK,SAAS,YAAA,EAAc;AAChC,QAAA,IAAI,IAAA,CAAK,IAAA,KAAS,UAAA,IAAc,IAAA,CAAK,SAAS,aAAA,EAAe;AAE7D,QAAA,MAAM,UAAA,GAAa,IAAA,CAAK,SAAA,CAAU,CAAC,CAAA;AACnC,QAAA,IAAI,CAAC,UAAA,EAAY;AACf,UAAA,OAAA,CAAQ,MAAA,CAAO,EAAE,IAAA,EAAM,SAAA,EAAW,WAAW,CAAA;AAC7C,UAAA;AAAA,QACF;AACA,QAAA,IAAI,UAAA,CAAW,SAAS,kBAAA,EAAoB;AAC5C,QAAA,MAAM,WAAA,GAAc,WAAW,UAAA,CAAW,IAAA;AAAA,UACxC,CAAA,CAAA,KACE,CAAA,CAAE,IAAA,KAAS,UAAA,IACX,CAAA,CAAE,IAAI,IAAA,KAAS,YAAA,IACf,CAAA,CAAE,GAAA,CAAI,IAAA,KAAS;AAAA,SACnB;AACA,QAAA,IAAI,CAAC,WAAA,EAAa;AAChB,UAAA,OAAA,CAAQ,MAAA,CAAO,EAAE,IAAA,EAAM,SAAA,EAAW,WAAW,CAAA;AAAA,QAC/C;AAAA,MACF;AAAA,KACF;AAAA,EACF;AACF,CAAC,CAAA;;;ACpFM,IAAM,KAAA,GAAQ;AAAA,EACnB,iBAAA,EAAmB,aAAA;AAAA,EACnB,uCAAA,EAAyC;AAC3C;AAEO,IAAM,OAAA,GAAU;AAAA,EACrB,WAAA,EAAa;AAAA,IACX,OAAA,EAAS,CAAC,kCAAkC,CAAA;AAAA,IAC5C,KAAA,EAAO;AAAA,MACL,kDAAA,EAAoD,OAAA;AAAA,MACpD,wEAAA,EACE;AAAA;AACJ;AAEJ;AAEA,IAAO,aAAA,GAAQ,EAAE,KAAA,EAAO,OAAA","file":"index.mjs","sourcesContent":["import { ESLintUtils, TSESTree } from '@typescript-eslint/utils';\n\nconst createRule = ESLintUtils.RuleCreator(\n name =>\n `https://github.com/krymskyimaksym/react-api-client/tree/main/packages/eslint-plugin/docs/${name}.md`,\n);\n\n/*\n Запрещает `await x.mutate(...)` — `mutate` возвращает `void`, а не\n * `Promise`. Для последовательной логики или try/catch используй\n * `mutateAsync`.\n \n Эвристика: `await <expr>.mutate(...)`.\n /\nexport const noAwaitMutate = createRule({\n name: 'no-await-mutate',\n meta: {\n type: 'problem',\n docs: {\n description:\n 'mutate() returns void; await it has no effect. Use mutateAsync for awaitable mutations.',\n recommended: 'error',\n },\n fixable: 'code',\n schema: [],\n messages: {\n avoid:\n '`mutate` возвращает void — await не сработает. Используй `mutateAsync` для await/try-catch.',\n },\n },\n defaultOptions: [],\n create(context) {\n return {\n AwaitExpression(node: TSESTree.AwaitExpression) {\n const arg = node.argument;\n if (arg.type !== 'CallExpression') return;\n const callee = arg.callee;\n if (callee.type !== 'MemberExpression') return;\n const prop = callee.property;\n if (prop.type !== 'Identifier' \|\| prop.name !== 'mutate') return;\n\n context.report({\n node,\n messageId: 'avoid',\n fix(fixer) {\n return fixer.replaceText(prop, 'mutateAsync');\n },\n });\n },\n };\n },\n});\n","import { ESLintUtils, TSESTree } from '@typescript-eslint/utils';\n\nconst createRule = ESLintUtils.RuleCreator(\n name =>\n `https://github.com/krymskyimaksym/react-api-client/tree/main/packages/eslint-plugin/docs/${name}.md`,\n);\n\n/\n Если `apiClient(fn, ...)` создан с endpoint-функцией, и где-то\n * вызывается `<api>.useFetch(params)` без `queryKey` в options —\n * предупредить. По умолчанию ключ генерится из endpoint+params, но при\n * endpoint-функции стабильность ключа зависит от того, что функция\n * возвращает одну и ту же строку для одних и тех же params. Явный\n * `queryKey` снимает риск.\n \n Эвристика статическая: ищем `const xxxApi = apiClient(SomethingFn, ...)`,\n * запоминаем имя, потом ругаемся на `xxxApi.useFetch(...)` без queryKey\n * в options-объекте.\n */\nexport const requireQueryKeyWhenEndpointIsFn = createRule({\n name: 'require-query-key-when-endpoint-is-fn',\n meta: {\n type: 'suggestion',\n docs: {\n description:\n 'When apiClient is created from an endpoint function, useFetch should specify explicit queryKey.',\n recommended: 'warn',\n },\n schema: [],\n messages: {\n missing:\n 'apiClient с endpoint-функцией: укажи `queryKey` явно, чтобы ключ кэша был стабильным.',\n },\n },\n defaultOptions: [],\n create(context) {\n const apisWithFnEndpoint = new Set<string>();\n\n return {\n // const xApi = apiClient(fn, ...)\n VariableDeclarator(node: TSESTree.VariableDeclarator) {\n if (node.id.type !== 'Identifier') return;\n if (!node.init \|\| node.init.type !== 'CallExpression') return;\n const call = node.init;\n if (\n call.callee.type !== 'Identifier' \|\|\n (call.callee.name !== 'apiClient' && call.callee.name !== 'apiPaginate')\n )\n return;\n const firstArg = call.arguments[0];\n if (!firstArg) return;\n if (\n firstArg.type === 'ArrowFunctionExpression' \|\|\n firstArg.type === 'FunctionExpression'\n ) {\n apisWithFnEndpoint.add(node.id.name);\n }\n },\n\n // xApi.useFetch(params, options?)\n CallExpression(node: TSESTree.CallExpression) {\n if (node.callee.type !== 'MemberExpression') return;\n const obj = node.callee.object;\n const prop = node.callee.property;\n if (obj.type !== 'Identifier') return;\n if (!apisWithFnEndpoint.has(obj.name)) return;\n if (prop.type !== 'Identifier') return;\n if (prop.name !== 'useFetch' && prop.name !== 'usePaginate') return;\n\n const optionsArg = node.arguments[1];\n if (!optionsArg) {\n context.report({ node, messageId: 'missing' });\n return;\n }\n if (optionsArg.type !== 'ObjectExpression') return; // не статически анализируем\n const hasQueryKey = optionsArg.properties.some(\n p =>\n p.type === 'Property' &&\n p.key.type === 'Identifier' &&\n p.key.name === 'queryKey',\n );\n if (!hasQueryKey) {\n context.report({ node, messageId: 'missing' });\n }\n },\n };\n },\n});\n","import { noAwaitMutate } from './rules/no-await-mutate';\nimport { requireQueryKeyWhenEndpointIsFn } from './rules/require-query-key-when-endpoint-is-fn';\n\nexport const rules = {\n 'no-await-mutate': noAwaitMutate,\n 'require-query-key-when-endpoint-is-fn': requireQueryKeyWhenEndpointIsFn,\n};\n\nexport const configs = {\n recommended: {\n plugins: ['@krymskyimaksym/react-api-client'],\n rules: {\n '@krymskyimaksym/react-api-client/no-await-mutate': 'error',\n '@krymskyimaksym/react-api-client/require-query-key-when-endpoint-is-fn':\n 'warn',\n },\n },\n};\n\nexport default { rules, configs };\n"]}
1	+ {"version":3,"sources":["../src/rules/no-await-mutate.ts","../src/rules/no-non-serializable-params.ts","../src/rules/require-query-key-when-endpoint-is-fn.ts","../src/index.ts"],"names":["createRule","ESLintUtils"],"mappings":";;;AAEA,IAAM,aAAa,WAAA,CAAY,WAAA;AAAA,EAC7B,CAAA,IAAA,KACE,4FAA4F,IAAI,CAAA,GAAA;AACpG,CAAA;AASO,IAAM,gBAAgB,UAAA,CAAW;AAAA,EACtC,IAAA,EAAM,iBAAA;AAAA,EACN,IAAA,EAAM;AAAA,IACJ,IAAA,EAAM,SAAA;AAAA,IACN,IAAA,EAAM;AAAA,MACJ,WAAA,EACE,yFAAA;AAAA,MACF,WAAA,EAAa;AAAA,KACf;AAAA,IACA,OAAA,EAAS,MAAA;AAAA,IACT,QAAQ,EAAC;AAAA,IACT,QAAA,EAAU;AAAA,MACR,KAAA,EACE;AAAA;AACJ,GACF;AAAA,EACA,gBAAgB,EAAC;AAAA,EACjB,OAAO,OAAA,EAAS;AACd,IAAA,OAAO;AAAA,MACL,gBAAgB,IAAA,EAAgC;AAC9C,QAAA,MAAM,MAAM,IAAA,CAAK,QAAA;AACjB,QAAA,IAAI,GAAA,CAAI,SAAS,gBAAA,EAAkB;AACnC,QAAA,MAAM,SAAS,GAAA,CAAI,MAAA;AACnB,QAAA,IAAI,MAAA,CAAO,SAAS,kBAAA,EAAoB;AACxC,QAAA,MAAM,OAAO,MAAA,CAAO,QAAA;AACpB,QAAA,IAAI,IAAA,CAAK,IAAA,KAAS,YAAA,IAAgB,IAAA,CAAK,SAAS,QAAA,EAAU;AAE1D,QAAA,OAAA,CAAQ,MAAA,CAAO;AAAA,UACb,IAAA;AAAA,UACA,SAAA,EAAW,OAAA;AAAA,UACX,IAAI,KAAA,EAAO;AACT,YAAA,OAAO,KAAA,CAAM,WAAA,CAAY,IAAA,EAAM,aAAa,CAAA;AAAA,UAC9C;AAAA,SACD,CAAA;AAAA,MACH;AAAA,KACF;AAAA,EACF;AACF,CAAC,CAAA;ACjDD,IAAMA,cAAaC,WAAAA,CAAY,WAAA;AAAA,EAC7B,CAAA,IAAA,KACE,4FAA4F,IAAI,CAAA,GAAA;AACpG,CAAA;AAaO,IAAM,0BAA0BD,WAAAA,CAAW;AAAA,EAChD,IAAA,EAAM,4BAAA;AAAA,EACN,IAAA,EAAM;AAAA,IACJ,IAAA,EAAM,SAAA;AAAA,IACN,IAAA,EAAM;AAAA,MACJ,WAAA,EACE,oHAAA;AAAA,MACF,WAAA,EAAa;AAAA,KACf;AAAA,IACA,QAAQ,EAAC;AAAA,IACT,QAAA,EAAU;AAAA,MACR,UAAA,EACE,uaAAA;AAAA,MACF,QAAA,EACE;AAAA;AACJ,GACF;AAAA,EACA,gBAAgB,EAAC;AAAA,EACjB,OAAO,OAAA,EAAS;AACd,IAAA,MAAM,6BAAa,IAAI,GAAA,CAAI,CAAC,UAAA,EAAY,aAAA,EAAe,UAAU,CAAC,CAAA;AAElE,IAAA,SAAS,sBAAsB,GAAA,EAAgC;AAC7D,MAAA,KAAA,MAAW,IAAA,IAAQ,IAAI,UAAA,EAAY;AACjC,QAAA,IAAI,IAAA,CAAK,SAAS,UAAA,EAAY;AAC9B,QAAA,MAAM,IAAI,IAAA,CAAK,KAAA;AACf,QAAA,IACE,CAAA,CAAE,IAAA,KAAS,yBAAA,IACX,CAAA,CAAE,SAAS,oBAAA,EACX;AACA,UAAA,OAAA,CAAQ,OAAO,EAAE,IAAA,EAAM,CAAA,EAAG,SAAA,EAAW,cAAc,CAAA;AACnD,UAAA;AAAA,QACF;AACA,QAAA,IACE,CAAA,CAAE,IAAA,KAAS,gBAAA,IACX,CAAA,CAAE,MAAA,CAAO,SAAS,YAAA,IAClB,CAAA,CAAE,MAAA,CAAO,IAAA,KAAS,QAAA,EAClB;AACA,UAAA,OAAA,CAAQ,OAAO,EAAE,IAAA,EAAM,CAAA,EAAG,SAAA,EAAW,YAAY,CAAA;AAAA,QACnD;AAAA,MACF;AAAA,IACF;AAEA,IAAA,OAAO;AAAA,MACL,eAAe,IAAA,EAA+B;AAC5C,QAAA,IAAI,IAAA,CAAK,MAAA,CAAO,IAAA,KAAS,kBAAA,EAAoB;AAG3C,UAAA,IACE,KAAK,MAAA,CAAO,IAAA,KAAS,gBACrB,IAAA,CAAK,MAAA,CAAO,SAAS,UAAA,EACrB;AACA,YAAA;AAAA,UACF;AACA,UAAA;AAAA,QACF;AACA,QAAA,MAAM,IAAA,GAAO,KAAK,MAAA,CAAO,QAAA;AACzB,QAAA,IAAI,IAAA,CAAK,SAAS,YAAA,IAAgB,CAAC,WAAW,GAAA,CAAI,IAAA,CAAK,IAAI,CAAA,EAAG;AAC9D,QAAA,MAAM,SAAA,GAAY,IAAA,CAAK,SAAA,CAAU,CAAC,CAAA;AAClC,QAAA,IAAI,CAAC,SAAA,EAAW;AAChB,QAAA,IAAI,SAAA,CAAU,SAAS,kBAAA,EAAoB;AAC3C,QAAA,qBAAA,CAAsB,SAAS,CAAA;AAAA,MACjC;AAAA,KACF;AAAA,EACF;AACF,CAAC,CAAA;AChFD,IAAMA,cAAaC,WAAAA,CAAY,WAAA;AAAA,EAC7B,CAAA,IAAA,KACE,4FAA4F,IAAI,CAAA,GAAA;AACpG,CAAA;AAcO,IAAM,kCAAkCD,WAAAA,CAAW;AAAA,EACxD,IAAA,EAAM,uCAAA;AAAA,EACN,IAAA,EAAM;AAAA,IACJ,IAAA,EAAM,YAAA;AAAA,IACN,IAAA,EAAM;AAAA,MACJ,WAAA,EACE,iGAAA;AAAA,MACF,WAAA,EAAa;AAAA,KACf;AAAA,IACA,QAAQ,EAAC;AAAA,IACT,QAAA,EAAU;AAAA,MACR,OAAA,EACE;AAAA;AACJ,GACF;AAAA,EACA,gBAAgB,EAAC;AAAA,EACjB,OAAO,OAAA,EAAS;AACd,IAAA,MAAM,kBAAA,uBAAyB,GAAA,EAAY;AAE3C,IAAA,OAAO;AAAA;AAAA,MAEL,mBAAmB,IAAA,EAAmC;AACpD,QAAA,IAAI,IAAA,CAAK,EAAA,CAAG,IAAA,KAAS,YAAA,EAAc;AACnC,QAAA,IAAI,CAAC,IAAA,CAAK,IAAA,IAAQ,IAAA,CAAK,IAAA,CAAK,SAAS,gBAAA,EAAkB;AACvD,QAAA,MAAM,OAAO,IAAA,CAAK,IAAA;AAClB,QAAA,IACE,IAAA,CAAK,MAAA,CAAO,IAAA,KAAS,YAAA,IACpB,IAAA,CAAK,OAAO,IAAA,KAAS,WAAA,IAAe,IAAA,CAAK,MAAA,CAAO,IAAA,KAAS,aAAA;AAE1D,UAAA;AACF,QAAA,MAAM,QAAA,GAAW,IAAA,CAAK,SAAA,CAAU,CAAC,CAAA;AACjC,QAAA,IAAI,CAAC,QAAA,EAAU;AACf,QAAA,IACE,QAAA,CAAS,IAAA,KAAS,yBAAA,IAClB,QAAA,CAAS,SAAS,oBAAA,EAClB;AACA,UAAA,kBAAA,CAAmB,GAAA,CAAI,IAAA,CAAK,EAAA,CAAG,IAAI,CAAA;AAAA,QACrC;AAAA,MACF,CAAA;AAAA;AAAA,MAGA,eAAe,IAAA,EAA+B;AAC5C,QAAA,IAAI,IAAA,CAAK,MAAA,CAAO,IAAA,KAAS,kBAAA,EAAoB;AAC7C,QAAA,MAAM,GAAA,GAAM,KAAK,MAAA,CAAO,MAAA;AACxB,QAAA,MAAM,IAAA,GAAO,KAAK,MAAA,CAAO,QAAA;AACzB,QAAA,IAAI,GAAA,CAAI,SAAS,YAAA,EAAc;AAC/B,QAAA,IAAI,CAAC,kBAAA,CAAmB,GAAA,CAAI,GAAA,CAAI,IAAI,CAAA,EAAG;AACvC,QAAA,IAAI,IAAA,CAAK,SAAS,YAAA,EAAc;AAChC,QAAA,IAAI,IAAA,CAAK,IAAA,KAAS,UAAA,IAAc,IAAA,CAAK,SAAS,aAAA,EAAe;AAE7D,QAAA,MAAM,UAAA,GAAa,IAAA,CAAK,SAAA,CAAU,CAAC,CAAA;AACnC,QAAA,IAAI,CAAC,UAAA,EAAY;AACf,UAAA,OAAA,CAAQ,MAAA,CAAO,EAAE,IAAA,EAAM,SAAA,EAAW,WAAW,CAAA;AAC7C,UAAA;AAAA,QACF;AACA,QAAA,IAAI,UAAA,CAAW,SAAS,kBAAA,EAAoB;AAC5C,QAAA,MAAM,WAAA,GAAc,WAAW,UAAA,CAAW,IAAA;AAAA,UACxC,CAAA,CAAA,KACE,CAAA,CAAE,IAAA,KAAS,UAAA,IACX,CAAA,CAAE,IAAI,IAAA,KAAS,YAAA,IACf,CAAA,CAAE,GAAA,CAAI,IAAA,KAAS;AAAA,SACnB;AACA,QAAA,IAAI,CAAC,WAAA,EAAa;AAChB,UAAA,OAAA,CAAQ,MAAA,CAAO,EAAE,IAAA,EAAM,SAAA,EAAW,WAAW,CAAA;AAAA,QAC/C;AAAA,MACF;AAAA,KACF;AAAA,EACF;AACF,CAAC,CAAA;;;ACnFM,IAAM,KAAA,GAAQ;AAAA,EACnB,iBAAA,EAAmB,aAAA;AAAA,EACnB,4BAAA,EAA8B,uBAAA;AAAA,EAC9B,uCAAA,EAAyC;AAC3C;AAEO,IAAM,OAAA,GAAU;AAAA,EACrB,WAAA,EAAa;AAAA,IACX,OAAA,EAAS,CAAC,kCAAkC,CAAA;AAAA,IAC5C,KAAA,EAAO;AAAA,MACL,kDAAA,EAAoD,OAAA;AAAA,MACpD,6DAAA,EAA+D,OAAA;AAAA,MAC/D,wEAAA,EACE;AAAA;AACJ;AAEJ;AAEA,IAAO,aAAA,GAAQ,EAAE,KAAA,EAAO,OAAA","file":"index.mjs","sourcesContent":["import { ESLintUtils, TSESTree } from '@typescript-eslint/utils';\n\nconst createRule = ESLintUtils.RuleCreator(\n name =>\n `https://github.com/krymskyimaksym/react-api-client/tree/main/packages/eslint-plugin/docs/${name}.md`,\n);\n\n/*\n Запрещает `await x.mutate(...)` — `mutate` возвращает `void`, а не\n * `Promise`. Для последовательной логики или try/catch используй\n * `mutateAsync`.\n \n Эвристика: `await <expr>.mutate(...)`.\n /\nexport const noAwaitMutate = createRule({\n name: 'no-await-mutate',\n meta: {\n type: 'problem',\n docs: {\n description:\n 'mutate() returns void; await it has no effect. Use mutateAsync for awaitable mutations.',\n recommended: 'recommended',\n },\n fixable: 'code',\n schema: [],\n messages: {\n avoid:\n '`mutate` возвращает void — await не сработает. Используй `mutateAsync` для await/try-catch.',\n },\n },\n defaultOptions: [],\n create(context) {\n return {\n AwaitExpression(node: TSESTree.AwaitExpression) {\n const arg = node.argument;\n if (arg.type !== 'CallExpression') return;\n const callee = arg.callee;\n if (callee.type !== 'MemberExpression') return;\n const prop = callee.property;\n if (prop.type !== 'Identifier' \|\| prop.name !== 'mutate') return;\n\n context.report({\n node,\n messageId: 'avoid',\n fix(fixer) {\n return fixer.replaceText(prop, 'mutateAsync');\n },\n });\n },\n };\n },\n});\n","import { ESLintUtils, TSESTree } from '@typescript-eslint/utils';\n\nconst createRule = ESLintUtils.RuleCreator(\n name =>\n `https://github.com/krymskyimaksym/react-api-client/tree/main/packages/eslint-plugin/docs/${name}.md`,\n);\n\n/\n Запрещает несериализуемые значения в `params` для `useFetch` /\n * `usePaginate` / `useQuery`. Функции и Symbol сломают `hashQueryKey`\n * (он `throw`-ает на них), а это приведёт к рантайм-ошибке при mount'е.\n \n Ловим статически:\n * - стрелочные/функциональные выражения как значения свойств;\n * - вызовы `Symbol(...)` как значения свойств.\n \n Эвристика — без типов; ловит самые частые случаи.\n /\nexport const noNonSerializableParams = createRule({\n name: 'no-non-serializable-params',\n meta: {\n type: 'problem',\n docs: {\n description:\n 'Params for useFetch/usePaginate/useQuery must be serializable. Functions and Symbol break hashQueryKey at runtime.',\n recommended: 'recommended',\n },\n schema: [],\n messages: {\n noFunction:\n 'Несериализуемое значение в params (функция): сломает hashQueryKey в рантайме. Вынеси callback наружу хука.',\n noSymbol:\n 'Несериализуемое значение в params (Symbol): сломает hashQueryKey в рантайме.',\n },\n },\n defaultOptions: [],\n create(context) {\n const HOOK_NAMES = new Set(['useFetch', 'usePaginate', 'useQuery']);\n\n function checkObjectExpression(obj: TSESTree.ObjectExpression) {\n for (const prop of obj.properties) {\n if (prop.type !== 'Property') continue;\n const v = prop.value;\n if (\n v.type === 'ArrowFunctionExpression' \|\|\n v.type === 'FunctionExpression'\n ) {\n context.report({ node: v, messageId: 'noFunction' });\n continue;\n }\n if (\n v.type === 'CallExpression' &&\n v.callee.type === 'Identifier' &&\n v.callee.name === 'Symbol'\n ) {\n context.report({ node: v, messageId: 'noSymbol' });\n }\n }\n }\n\n return {\n CallExpression(node: TSESTree.CallExpression) {\n if (node.callee.type !== 'MemberExpression') {\n // useQuery(key, fn, opts) — первый аргумент это key,\n // не params; пропускаем.\n if (\n node.callee.type === 'Identifier' &&\n node.callee.name === 'useQuery'\n ) {\n return;\n }\n return;\n }\n const prop = node.callee.property;\n if (prop.type !== 'Identifier' \|\| !HOOK_NAMES.has(prop.name)) return;\n const paramsArg = node.arguments[0];\n if (!paramsArg) return;\n if (paramsArg.type !== 'ObjectExpression') return;\n checkObjectExpression(paramsArg);\n },\n };\n },\n});\n","import { ESLintUtils, TSESTree } from '@typescript-eslint/utils';\n\nconst createRule = ESLintUtils.RuleCreator(\n name =>\n `https://github.com/krymskyimaksym/react-api-client/tree/main/packages/eslint-plugin/docs/${name}.md`,\n);\n\n/\n Если `apiClient(fn, ...)` создан с endpoint-функцией, и где-то\n * вызывается `<api>.useFetch(params)` без `queryKey` в options —\n * предупредить. По умолчанию ключ генерится из endpoint+params, но при\n * endpoint-функции стабильность ключа зависит от того, что функция\n * возвращает одну и ту же строку для одних и тех же params. Явный\n * `queryKey` снимает риск.\n \n Эвристика статическая: ищем `const xxxApi = apiClient(SomethingFn, ...)`,\n * запоминаем имя, потом ругаемся на `xxxApi.useFetch(...)` без queryKey\n * в options-объекте.\n */\nexport const requireQueryKeyWhenEndpointIsFn = createRule({\n name: 'require-query-key-when-endpoint-is-fn',\n meta: {\n type: 'suggestion',\n docs: {\n description:\n 'When apiClient is created from an endpoint function, useFetch should specify explicit queryKey.',\n recommended: 'recommended',\n },\n schema: [],\n messages: {\n missing:\n 'apiClient с endpoint-функцией: укажи `queryKey` явно, чтобы ключ кэша был стабильным.',\n },\n },\n defaultOptions: [],\n create(context) {\n const apisWithFnEndpoint = new Set<string>();\n\n return {\n // const xApi = apiClient(fn, ...)\n VariableDeclarator(node: TSESTree.VariableDeclarator) {\n if (node.id.type !== 'Identifier') return;\n if (!node.init \|\| node.init.type !== 'CallExpression') return;\n const call = node.init;\n if (\n call.callee.type !== 'Identifier' \|\|\n (call.callee.name !== 'apiClient' && call.callee.name !== 'apiPaginate')\n )\n return;\n const firstArg = call.arguments[0];\n if (!firstArg) return;\n if (\n firstArg.type === 'ArrowFunctionExpression' \|\|\n firstArg.type === 'FunctionExpression'\n ) {\n apisWithFnEndpoint.add(node.id.name);\n }\n },\n\n // xApi.useFetch(params, options?)\n CallExpression(node: TSESTree.CallExpression) {\n if (node.callee.type !== 'MemberExpression') return;\n const obj = node.callee.object;\n const prop = node.callee.property;\n if (obj.type !== 'Identifier') return;\n if (!apisWithFnEndpoint.has(obj.name)) return;\n if (prop.type !== 'Identifier') return;\n if (prop.name !== 'useFetch' && prop.name !== 'usePaginate') return;\n\n const optionsArg = node.arguments[1];\n if (!optionsArg) {\n context.report({ node, messageId: 'missing' });\n return;\n }\n if (optionsArg.type !== 'ObjectExpression') return; // не статически анализируем\n const hasQueryKey = optionsArg.properties.some(\n p =>\n p.type === 'Property' &&\n p.key.type === 'Identifier' &&\n p.key.name === 'queryKey',\n );\n if (!hasQueryKey) {\n context.report({ node, messageId: 'missing' });\n }\n },\n };\n },\n});\n","import { noAwaitMutate } from './rules/no-await-mutate';\nimport { noNonSerializableParams } from './rules/no-non-serializable-params';\nimport { requireQueryKeyWhenEndpointIsFn } from './rules/require-query-key-when-endpoint-is-fn';\n\nexport const rules = {\n 'no-await-mutate': noAwaitMutate,\n 'no-non-serializable-params': noNonSerializableParams,\n 'require-query-key-when-endpoint-is-fn': requireQueryKeyWhenEndpointIsFn,\n};\n\nexport const configs = {\n recommended: {\n plugins: ['@krymskyimaksym/react-api-client'],\n rules: {\n '@krymskyimaksym/react-api-client/no-await-mutate': 'error',\n '@krymskyimaksym/react-api-client/no-non-serializable-params': 'error',\n '@krymskyimaksym/react-api-client/require-query-key-when-endpoint-is-fn':\n 'warn',\n },\n },\n};\n\nexport default { rules, configs };\n"]}

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@krymskyimaksym/eslint-plugin-react-api-client",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "ESLint rules for @krymskyimaksym/react-api-client",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",