chore: Add TODO comments

rosen-bridge · Nov 25, 2024 · 8f4c751 · 8f4c751
1 parent a2767ab
commit 8f4c751
Show file tree

Hide file tree

Showing 7 changed files with 32 additions and 1 deletion.
diff --git a/eslint.config.mjs b/eslint.config.mjs
@@ -67,6 +67,10 @@ export default [
       ...reactHooks.configs.recommended.rules,
     },
   },
+  /**
+   * TODO: revise the global ESLint configuration rules
+   * local:ergo/rosen-bridge/ui#442
+   */
   {
     rules: {
       'no-undef': 'off',

diff --git a/networks/bitcoin/unitTests/src/generateTx.test.ts b/networks/bitcoin/unitTests/src/generateTx.test.ts
@@ -52,6 +52,10 @@ describe('generateUnsignedTx', () => {
       fromAddress,
       amount,
       data,
+      /**
+       * TODO: remove the inline ESLint comment
+       * local:ergo/rosen-bridge/ui#441
+       */
       // eslint-disable-next-line @typescript-eslint/no-explicit-any
       {} as any,
     );
@@ -176,6 +180,10 @@ describe('generateUnsignedTx', () => {
         fromAddress,
         amount,
         data,
+        /**
+         * TODO: remove the inline ESLint comment
+         * local:ergo/rosen-bridge/ui#441
+         */
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
         {} as any,
       );

diff --git a/packages/swr-helpers/src/fetcher.ts b/packages/swr-helpers/src/fetcher.ts
@@ -12,6 +12,10 @@ axios.defaults.baseURL = '/api';
  * @param params
  */
 const fetcher = async (
+  /**
+   * TODO: remove the inline ESLint comment
+   * local:ergo/rosen-bridge/ui#441
+   */
   key: // eslint-disable-next-line @typescript-eslint/no-explicit-any
   [url: string, params?: Record<string, any>, method?: 'get' | 'put'] | string,
 ) => {

diff --git a/packages/swr-helpers/src/mutator.ts b/packages/swr-helpers/src/mutator.ts
@@ -6,6 +6,10 @@ import JSONBigInt from 'json-bigint';
  * @param url
  * @param params
  */
+/**
+ * TODO: remove the inline ESLint comment
+ * local:ergo/rosen-bridge/ui#441
+ */
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 const mutator = async (url: string, { arg }: { arg: any }) => {
   const response = await axios.post(url, arg, {

diff --git a/packages/swr-mock/src/SWRConfig.tsx b/packages/swr-mock/src/SWRConfig.tsx
@@ -4,6 +4,10 @@ import { mockMiddlewareFactory } from './mockMiddlewareFactory';
 export interface SWRConfigProps {
   children: React.ReactNode;
   useMockedApis: boolean;
+  /**
+   * TODO: remove the inline ESLint comment
+   * local:ergo/rosen-bridge/ui#441
+   */
   fakeData: {
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     withStringKeys: Record<string, any>;

diff --git a/packages/swr-mock/src/mockMiddlewareFactory.ts b/packages/swr-mock/src/mockMiddlewareFactory.ts
@@ -1,3 +1,7 @@
+/**
+ * TODO: remove the inline ESLint comment
+ * local:ergo/rosen-bridge/ui#441
+ */
 /* eslint-disable */
 
 import { Key, Middleware, SWRHook } from 'swr';

diff --git a/packages/ui-kit/src/hooks/useTheme.ts b/packages/ui-kit/src/hooks/useTheme.ts
@@ -1,4 +1,7 @@
 export { useTheme } from '@mui/material';
-
+/**
+ * TODO: remove the inline ESLint comment
+ * local:ergo/rosen-bridge/ui#441
+ */
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export const isLegacyTheme = (theme: any) => !theme.palette.neutral;