Chore: Stricter type-aware eslint

Author: SBoudrias

eslint.config.js

@@ -42,12 +42,19 @@ export default tseslint.config(
   },
   {
     files: ['**/*.mts', '**/*.ts'],
-    extends: [...tseslint.configs.recommendedTypeChecked],
+    extends: [...tseslint.configs.strictTypeChecked],
     languageOptions: {
       parserOptions: {
         projectService: true,
       },
     },
+    rules: {
+      '@typescript-eslint/restrict-template-expressions': 'off',
+      '@typescript-eslint/no-invalid-void-type': 'off',
+      '@typescript-eslint/no-non-null-assertion': 'off',
+      '@typescript-eslint/no-confusing-void-expression': 'off',
+      '@typescript-eslint/no-unnecessary-type-parameters': 'off',
+    },
   },
   {
     files: ['**/*.cjs'],

packages/checkbox/src/index.ts

@@ -223,7 +223,7 @@ export default createPrompt(
 
     const message = theme.style.message(config.message, status);
 
-    let description;
+    let description: string | undefined;
     const page = usePagination({
       items,
       active,
@@ -283,6 +283,7 @@ export default createPrompt(
       if (
         items.length > pageSize &&
         (theme.helpMode === 'always' ||
+          // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
           (theme.helpMode === 'auto' && firstRender.current))
       ) {
         helpTipBottom = `\n${theme.style.help('(Use arrow keys to reveal more choices)')}`;

packages/core/src/lib/create-prompt.ts

@@ -92,7 +92,7 @@ export function createPrompt<Value, Config>(view: ViewFunction<Value, Config>) {
               effectScheduler.clearAll();
               return answer;
             },
-            (error) => {
+            (error: unknown) => {
               effectScheduler.clearAll();
               throw error;
             },
@@ -101,7 +101,7 @@ export function createPrompt<Value, Config>(view: ViewFunction<Value, Config>) {
           .finally(() => {
             cleanups.forEach((cleanup) => cleanup());
 
-            screen.done({ clearContent: Boolean(context?.clearPromptOnDone) });
+            screen.done({ clearContent: Boolean(context.clearPromptOnDone) });
             output.end();
           })
           // Once cleanup is done, let the expose promise resolve/reject to the internal one.

packages/core/src/lib/hook-engine.ts

@@ -68,7 +68,7 @@ export function withUpdates<R, T extends (...args: any[]) => R>(
 ): (...args: Parameters<T>) => R {
   const wrapped = (...args: Parameters<T>): R => {
     const store = getStore();
-    let shouldUpdate = false;
+    let shouldUpdate = false as boolean;
     const oldHandleChange = store.handleChange;
     store.handleChange = () => {
       shouldUpdate = true;
@@ -125,7 +125,7 @@ export function handleChange() {
 }
 
 export const effectScheduler = {
-  queue(cb: (readline: InquirerReadline) => void) {
+  queue(cb: (readline: InquirerReadline) => void | (() => void)) {
     const store = getStore();
     const { index } = store;
 

packages/demo/src/demos/timeout.ts

@@ -5,7 +5,7 @@ async function demo() {
   const answer = await input(
     { message: 'Enter a value (timing out in 5 seconds)' },
     { signal: AbortSignal.timeout(5000) },
-  ).catch((error) => {
+  ).catch((error: unknown) => {
     if (error instanceof Error && error.name === 'AbortPromptError') {
       return 'Default value';
     }

packages/editor/src/index.ts

@@ -36,24 +36,26 @@ export default createPrompt<string, EditorConfig>((config, done) => {
     rl.pause();
 
     // Note: The bind call isn't strictly required. But we need it for our mocks to work as expected.
-    const editCallback = AsyncResource.bind(async (error: Error, answer: string) => {
-      rl.resume();
-      if (error) {
-        setError(error.toString());
-      } else {
-        setStatus('loading');
-        const isValid = await validate(answer);
-        if (isValid === true) {
-          setError(undefined);
-          setStatus('done');
-          done(answer);
+    const editCallback = AsyncResource.bind(
+      async (error: Error | undefined, answer: string) => {
+        rl.resume();
+        if (error) {
+          setError(error.toString());
         } else {
-          setValue(answer);
-          setError(isValid || 'You must provide a valid value');
-          setStatus('idle');
+          setStatus('loading');
+          const isValid = await validate(answer);
+          if (isValid === true) {
+            setError(undefined);
+            setStatus('done');
+            done(answer);
+          } else {
+            setValue(answer);
+            setError(isValid || 'You must provide a valid value');
+            setStatus('idle');
+          }
         }
-      }
-    });
+      },
+    );
 
     editAsync(value, (error, answer) => void editCallback(error, answer), { postfix });
   }

packages/inquirer/src/ui/prompt.ts

@@ -51,7 +51,7 @@ export const _ = {
         .filter(Boolean)
         .reduce(
           // @ts-expect-error implicit any on res[key]
-          (res, key) => (res !== null && res !== undefined ? res[key] : res),
+          (res: object | undefined, key) => (res == null ? res : res[key]),
           obj,
         );
     const result = travel(/[,[\]]+?/) || travel(/[,.[\]]+?/);
@@ -351,6 +351,7 @@ export default class PromptsRunner<A extends Answers> {
               cleanupSignal = undefined;
             };
 
+            // eslint-disable-next-line @typescript-eslint/use-unknown-in-catch-callback-variable
             activePrompt.run().then(resolve, reject).finally(cleanup);
           })
       : prompt;
@@ -360,7 +361,7 @@ export default class PromptsRunner<A extends Answers> {
     if (moduleSignal?.aborted) {
       this.abortController.abort(moduleSignal.reason);
     } else if (moduleSignal) {
-      const abort = () => this.abortController?.abort(moduleSignal.reason);
+      const abort = () => this.abortController.abort(moduleSignal.reason);
       moduleSignal.addEventListener('abort', abort);
       cleanupModuleSignal = () => {
         moduleSignal.removeEventListener('abort', abort);
@@ -384,7 +385,7 @@ export default class PromptsRunner<A extends Answers> {
    * Close the interface and cleanup listeners
    */
   close = () => {
-    this.abortController?.abort();
+    this.abortController.abort();
   };
 
   private shouldRun = async (question: Question<A>): Promise<boolean> => {

packages/rawlist/src/index.ts

@@ -97,9 +97,7 @@ export default createPrompt(
         }
 
         if (isSelectableChoice(selectedChoice)) {
-          setValue(
-            selectedChoice.short ?? selectedChoice.name ?? String(selectedChoice.value),
-          );
+          setValue(selectedChoice.short);
           setStatus('done');
           done(selectedChoice.value);
         } else if (value === '') {

packages/search/src/index.ts

@@ -257,7 +257,7 @@ export default createPrompt(
 
     let searchStr;
     if (status === 'done' && selectedChoice) {
-      const answer = selectedChoice.short ?? selectedChoice.name;
+      const answer = selectedChoice.short;
       return `${prefix} ${message} ${theme.style.answer(answer)}`;
     } else {
       searchStr = theme.style.searchTerm(searchTerm);