dx: simplify ESLint config (#477)

* add files to biome * replace js.recommended by used rules * wip * fixes * fixes * ts rules * fix all lint errors * fix import issues * add turbo * react config * remove configs.biome * update astro config * warn * astro * ts * no typed linting * disable projectService in astro files * disable typed rules * test * test * fix * lockfile * remove root lint:ts * Update package.json * update tsconfig * update * move getMessageTextContent to core * don't lint examples * no regex rule * no typed linting * exclude eslint-config from bundle-size * up * changeset
markprompt · Dec 27, 2024 · 279674a · 279674a
1 parent 4acd94d
commit 279674a
Show file tree

Hide file tree

Showing 64 changed files with 846 additions and 546 deletions.
diff --git a/.changeset/ten-trainers-accept.md b/.changeset/ten-trainers-accept.md
@@ -0,0 +1,8 @@
+---
+"@markprompt/docusaurus-theme-search": minor
+"@markprompt/react": minor
+"@markprompt/core": minor
+"@markprompt/web": minor
+---
+
+Fix linting issues
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -63,4 +63,4 @@ jobs:
         with:
           build-script: '"build:packages"'
           pattern: '{./packages/**/dist/**/*.{cjs,js},./packages/css/markprompt.css}'
-          exclude: '{**/*.map,**/*.d.{ts,cts},**/node_modules/**,./packages/**/node_modules/**/dist/**/*}'
+          exclude: '{**/*.map,**/*.d.{ts,cts},**/node_modules/**,./packages/**/node_modules/**/dist/**/*,./packages/eslint-config/dist/**/*}'
diff --git a/biome.jsonc b/biome.jsonc
@@ -46,8 +46,16 @@
         "useDateNow": "error"
       },
       "correctness": {
+        "noUndeclaredVariables": {
+          "level": "error"
+          // enable when biome@2.0.0 is released
+          // "options": {
+          //   "checkTypes": true
+          // }
+        },
         "noUnusedFunctionParameters": "error",
         "noUnusedImports": "error",
+        "noUnusedPrivateClassMembers": "error",
         "noUnusedVariables": "error",
         "useArrayLiterals": "error",
         "useHookAtTopLevel": "error"
@@ -56,6 +64,7 @@
         "noDefaultExport": "warn",
         "noNonNullAssertion": "warn",
         "useCollapsedElseIf": "error",
+        "useForOf": "error",
         "useThrowOnlyError": "error"
       },
       "suspicious": {
@@ -69,6 +78,15 @@
         "useAwait": "error",
         "useErrorMessage": "error",
         "useNumberToFixedDigitsArgument": "error"
+      },
+      "nursery": {
+        "noCommonJs": "error",
+        "noDuplicateElseIf": "error",
+        "noIrregularWhitespace": "error",
+        "noStaticElementInteractions": "error",
+        "useAdjacentOverloadSignatures": "error",
+        "useAriaPropsSupportedByRole": "error",
+        "useValidAutocomplete": "error"
       }
     }
   },
@@ -98,6 +116,32 @@
           }
         }
       }
+    },
+    {
+      // .d.ts files import types inside their declare, which isn't parsed correctly by Biome, yet.
+      "include": ["**/*.d.ts"],
+      "linter": {
+        "rules": {
+          "correctness": {
+            "noUndeclaredVariables": "off",
+            "noUnusedImports": "off"
+          }
+        }
+      }
+    },
+    {
+      "include": [
+        "examples/with-docusaurus*/sidebars.js",
+        "examples/with-docusaurus*/babel.config.js",
+        "examples/with-docusaurus*/docusaurus.config.ts"
+      ],
+      "linter": {
+        "rules": {
+          "nursery": {
+            "noCommonJs": "off"
+          }
+        }
+      }
     }
   ]
 }
diff --git a/eslint.config.mjs b/eslint.config.mjs
@@ -13,5 +13,4 @@ export default [
       ],
     },
   },
-  ...configs.biome,
 ];
diff --git a/examples/with-function-calling/pages/index.tsx b/examples/with-function-calling/pages/index.tsx
@@ -6,7 +6,7 @@ import {
 import Head from 'next/head';
 import type { OpenAI } from 'openai';
 import { useCallback, useState } from 'react';
-import type { JSX } from 'react';
+import type { FormEvent, JSX } from 'react';
 
 interface ChatCompletionExecution {
   run?: (args: unknown) => void;
@@ -44,7 +44,7 @@ export default function IndexPage(): JSX.Element {
   const [streamedMessage, setStreamedMessage] = useState('');
 
   const submitForm = useCallback(
-    async (event: React.FormEvent<HTMLFormElement>) => {
+    async (event: FormEvent<HTMLFormElement>) => {
       event.preventDefault();
 
       setStreamedMessage('Fetching response...');
@@ -92,7 +92,7 @@ export default function IndexPage(): JSX.Element {
           tool.run?.(toolCall.function?.arguments);
           setStreamedMessage(
             `Calling: ${tool.function.name}\n\nArguments:\n\n${
-              toolCall.function?.arguments || {}
+              toolCall.function?.arguments || JSON.stringify({})
             }`,
           );
         }
@@ -108,7 +108,12 @@ export default function IndexPage(): JSX.Element {
         <meta charSet="utf-8" />
       </Head>
       <div className="Container">
-        <form className="InputForm" onSubmit={submitForm}>
+        <form
+          className="InputForm"
+          onSubmit={(event) => {
+            void submitForm(event);
+          }}
+        >
           <label className="label" htmlFor="input">
             Input
           </label>

diff --git a/examples/with-next/pages/_document.tsx b/examples/with-next/pages/_document.tsx
@@ -1,7 +1,8 @@
 import { Html, Head, Main, NextScript } from 'next/document';
 import Script from 'next/script';
+import type { JSX } from 'react';
 
-export default function Document(): React.JSX.Element {
+export default function Document(): JSX.Element {
   return (
     <Html>
       <Head>

diff --git a/examples/with-next/pages/index.tsx b/examples/with-next/pages/index.tsx
@@ -7,13 +7,13 @@ import { SearchIcon } from '../components/icons';
 
 export default function IndexPage(): JSX.Element {
   useEffect(() => {
-    const handleKeyDown = (event: KeyboardEvent): void => {
+    const handleKeyDown = async (event: KeyboardEvent): Promise<void> => {
       if (
         (event.key === 'k' && event.ctrlKey) ||
         (event.key === 'k' && event.metaKey)
       ) {
         event.preventDefault();
-        openMarkprompt();
+        await openMarkprompt();
       }
     };
 

diff --git a/examples/with-standalone-ticket-deflection/eslint.config.js b/examples/with-standalone-ticket-deflection/eslint.config.js
@@ -1,7 +1,3 @@
 import { configs } from '@markprompt/eslint-config';
 
-export default [
-  ...configs.base(import.meta.dirname),
-  ...configs.react,
-  ...configs.biome,
-];
+export default [...configs.base(import.meta.dirname), ...configs.react];
diff --git a/package.json b/package.json
@@ -14,7 +14,6 @@
     "lint:css": "stylelint \"**/*.css\"",
     "lint:js": "eslint .",
     "lint:md": "remark . --frail",
-    "lint:ts": "pnpm build:packages",
     "lint": "turbo run lint:biome lint:css lint:js lint:md lint:ts",
     "postinstall": "manypkg check",
     "prepare": "husky",

diff --git a/packages/core/eslint.config.js b/packages/core/eslint.config.js
@@ -16,5 +16,4 @@ export default [
     },
   },
   ...configs.vitest,
-  ...configs.biome,
 ];
diff --git a/packages/core/src/chat/index.test.ts b/packages/core/src/chat/index.test.ts
@@ -48,7 +48,7 @@ describe('submitChat', () => {
   let status = 200;
 
   const server = setupServer(
-    http.post(`${DEFAULT_OPTIONS.apiUrl!}/chat`, async ({ request }) => {
+    http.post(`${DEFAULT_OPTIONS.apiUrl}/chat`, async ({ request }) => {
       req = request;
       requestBody = (await request.json()) as SubmitChatOptions;
 
@@ -75,7 +75,7 @@ describe('submitChat', () => {
         start(controller) {
           if (Array.isArray(response)) {
             let i = 0;
-            for (const chunk of response) {
+            for (const chunk of response as string[]) {
               controller.enqueue(
                 encoder.encode(
                   formatEvent({
@@ -356,7 +356,7 @@ describe('submitChat', () => {
       'testKey',
       { stream: false },
     )) {
-      await expect(json).toStrictEqual({
+      expect(json).toStrictEqual({
         content: 'According to my calculator 1 + 2 = 3',
         role: 'assistant',
         messageId,

diff --git a/packages/core/src/chat/index.ts b/packages/core/src/chat/index.ts
@@ -111,7 +111,7 @@ export async function* submitChat(
   checkAbortSignal(options.signal);
 
   if (res.headers.get('Content-Type')?.includes('application/json')) {
-    const json = await res.json();
+    const json: unknown = await res.json();
 
     if (
       isChatCompletion(json) &&
@@ -150,8 +150,13 @@ export async function* submitChat(
     const text = await res.text();
 
     try {
-      const json = JSON.parse(text);
-      if (json.error) {
+      const json: unknown = JSON.parse(text);
+      if (
+        json &&
+        typeof json === 'object' &&
+        'error' in json &&
+        typeof json.error === 'string'
+      ) {
         throw new Error(json.error);
       }
     } catch {
@@ -182,7 +187,7 @@ export async function* submitChat(
       continue;
     }
 
-    const json = JSON.parse(event.data);
+    const json: unknown = JSON.parse(event.data);
 
     if (!isChatCompletionChunk(json)) {
       throw new Error('Malformed response from Markprompt API', {

diff --git a/packages/core/src/chat/types.ts b/packages/core/src/chat/types.ts
@@ -53,7 +53,7 @@ export const COMPLETIONS_MODELS = [
 
 export type CompletionsModel = ArrayToUnion<typeof COMPLETIONS_MODELS>;
 
-export const EMBEDDINGS_MODEL = 'text-embedding-ada-002' as const;
+export const EMBEDDINGS_MODEL = 'text-embedding-ada-002';
 
 export type EmbeddingsModel = typeof EMBEDDINGS_MODEL;
 

diff --git a/packages/core/src/chat/utils.ts b/packages/core/src/chat/utils.ts
@@ -59,14 +59,16 @@ export function checkAbortSignal(signal?: AbortSignal): void {
       throw signal.reason;
     }
 
-    throw new Error(signal.reason);
+    throw new Error(
+      typeof signal.reason === 'string' ? signal.reason : 'Aborted',
+    );
   }
 }
 
 export const parseEncodedJSONHeader = (
   response: Response,
   name: string,
-): unknown | undefined => {
+): unknown => {
   try {
     const headerValue = response.headers.get(name);
     if (headerValue) {

diff --git a/packages/core/src/feedback.ts b/packages/core/src/feedback.ts
@@ -48,7 +48,7 @@ export async function submitFeedback(
   const resolvedOptions = defaults(cloneableOpts, {
     ...DEFAULT_OPTIONS,
     ...DEFAULT_SUBMIT_FEEDBACK_OPTIONS,
-  });
+  }) as SubmitFeedbackOptions & BaseOptions;
 
   try {
     const response = await fetch(
@@ -69,8 +69,21 @@ export async function submitFeedback(
     );
 
     if (!response.ok) {
-      const error = (await response.json())?.error;
-      throw new Error(`Failed to submit feedback: ${error || 'Unknown error'}`);
+      const json: unknown = await response.json();
+      if (
+        json &&
+        typeof json === 'object' &&
+        'error' in json &&
+        typeof json.error === 'string'
+      ) {
+        throw new Error(`Failed to submit feedback: ${json.error}`, {
+          cause: json,
+        });
+      }
+
+      throw new Error(`Failed to submit feedback: 'Unknown error'`, {
+        cause: json,
+      });
     }
   } catch (error) {
     if (error instanceof DOMException && error.name === 'AbortError') {
@@ -111,7 +124,7 @@ export async function submitCSAT(
   const resolvedOptions = defaults(cloneableOpts, {
     ...DEFAULT_OPTIONS,
     ...DEFAULT_SUBMIT_FEEDBACK_OPTIONS,
-  });
+  }) as SubmitFeedbackOptions & BaseOptions;
 
   try {
     const response = await fetch(
@@ -129,8 +142,21 @@ export async function submitCSAT(
     );
 
     if (!response.ok) {
-      const error = (await response.json())?.error;
-      throw new Error(`Failed to submit feedback: ${error || 'Unknown error'}`);
+      const json: unknown = await response.json();
+      if (
+        json &&
+        typeof json === 'object' &&
+        'error' in json &&
+        typeof json.error === 'string'
+      ) {
+        throw new Error(`Failed to submit feedback: ${json.error}`, {
+          cause: json,
+        });
+      }
+
+      throw new Error(`Failed to submit feedback: 'Unknown error'`, {
+        cause: json,
+      });
     }
   } catch (error) {
     if (error instanceof DOMException && error.name === 'AbortError') {
@@ -169,7 +195,7 @@ export async function submitCSATReason(
   const resolvedOptions = defaults(cloneableOpts, {
     ...DEFAULT_OPTIONS,
     ...DEFAULT_SUBMIT_FEEDBACK_OPTIONS,
-  });
+  }) as SubmitFeedbackOptions & BaseOptions;
 
   try {
     const response = await fetch(
@@ -187,8 +213,21 @@ export async function submitCSATReason(
     );
 
     if (!response.ok) {
-      const error = (await response.json())?.error;
-      throw new Error(`Failed to submit feedback: ${error || 'Unknown error'}`);
+      const json: unknown = await response.json();
+      if (
+        json &&
+        typeof json === 'object' &&
+        'error' in json &&
+        typeof json.error === 'string'
+      ) {
+        throw new Error(`Failed to submit feedback: ${json.error}`, {
+          cause: json,
+        });
+      }
+
+      throw new Error(`Failed to submit feedback: 'Unknown error'`, {
+        cause: json,
+      });
     }
   } catch (error) {
     if (error instanceof DOMException && error.name === 'AbortError') {

diff --git a/packages/core/src/search.test.ts b/packages/core/src/search.test.ts
@@ -81,7 +81,7 @@ let status = 200;
 let wait = 0;
 
 const server = setupServer(
-  http.get(`${DEFAULT_OPTIONS.apiUrl!}/search`, async ({ request }) => {
+  http.get(`${DEFAULT_OPTIONS.apiUrl}/search`, async ({ request }) => {
     const url = new URL(request.url);
     const limit = url.searchParams.get('limit');
     let data = searchResults;
-Original file line number
+Diff line change
@@ Expand Up / @@ -13,5 +13,4 @@ export default [ @@
           ],
         },
       },
-      ...configs.biome,
     ];