Add more return types

Author: danez

packages/react-docgen-cli/src/commands/parse/command.ts

@@ -23,7 +23,7 @@ const defaultIgnoreGlobs = [
 const defaultHandlers = Object.keys(builtinHandlers);
 const defaultResolvers = ['find-exported-component'];
 
-function collect(value: string, previous: string[]) {
+function collect(value: string, previous: string[]): string[] {
   if (
     !previous ||
     previous === defaultIgnoreGlobs ||

packages/react-docgen-cli/src/commands/parse/output/outputError.ts

@@ -1,8 +1,10 @@
 import { relative } from 'path';
 import chalk from 'chalk';
 
-function isReactDocgenError(error: NodeJS.ErrnoException) {
-  return error instanceof Error && error.code?.startsWith('ERR_REACTDOCGEN');
+function isReactDocgenError(error: NodeJS.ErrnoException): boolean {
+  return Boolean(
+    error instanceof Error && error.code?.startsWith('ERR_REACTDOCGEN'),
+  );
 }
 
 function outputReactDocgenError(
@@ -38,7 +40,7 @@ export default function outputError(
   error: Error,
   filePath: string,
   options: { failOnWarning: boolean },
-) {
+): boolean {
   if (isReactDocgenError(error)) {
     return outputReactDocgenError(error, filePath, options);
   } else {

packages/react-docgen-cli/src/commands/parse/output/outputResult.ts

@@ -4,7 +4,7 @@ import type { Documentation } from 'react-docgen';
 export default async function outputResult(
   documentation: Record<string, Documentation[]>,
   { pretty = false, output }: { pretty: boolean; output: string | undefined },
-) {
+): Promise<void> {
   const result = JSON.stringify(
     documentation,
     undefined,

packages/react-docgen-cli/tests/integration/utils/withFixture.ts

@@ -1,6 +1,6 @@
 import { rm, stat } from 'fs/promises';
 import { dirname, join } from 'path';
-import type { ExecaError } from 'execa';
+import type { ExecaError, ExecaReturnValue } from 'execa';
 import { execaNode } from 'execa';
 import copy from 'cpy';
 import { temporaryDirectory } from 'tempy';
@@ -22,7 +22,9 @@ export default async function withFixture(
 ): Promise<void> {
   const tempDir = temporaryDirectory();
 
-  async function run(args: readonly string[]) {
+  async function run(
+    args: readonly string[],
+  ): Promise<ExecaError | ExecaReturnValue<string>> {
     try {
       return await execaNode(cliBinary, args, {
         cwd: tempDir,

packages/react-docgen/src/resolver/FindAllDefinitionsResolver.ts

@@ -19,7 +19,7 @@ interface TraverseState {
   foundDefinitions: Set<ComponentNodePath>;
 }
 
-function classVisitor(path: NodePath, state: TraverseState) {
+function classVisitor(path: NodePath, state: TraverseState): void {
   if (isReactComponentClass(path)) {
     normalizeClassDefinition(path);
     state.foundDefinitions.add(path);
@@ -36,7 +36,7 @@ function statelessVisitor(
     | ObjectMethod
   >,
   state: TraverseState,
-) {
+): void {
   if (isStatelessComponent(path)) {
     state.foundDefinitions.add(path);
   }

packages/react-docgen/src/utils/getMemberValuePath.ts

@@ -27,7 +27,8 @@ type SupportedNodes =
 
 const postprocessPropTypes = (
   path: NodePath<ClassMethod | Expression | ObjectMethod>,
-) => (path.isFunction() ? resolveFunctionDefinitionToReturnValue(path) : path);
+): NodePath<ClassMethod | Expression | ObjectMethod> | null =>
+  path.isFunction() ? resolveFunctionDefinitionToReturnValue(path) : path;
 
 const POSTPROCESS_MEMBERS = new Map([['propTypes', postprocessPropTypes]]);
 

packages/react-docgen/src/utils/getPropType.ts

@@ -95,7 +95,10 @@ function getPropTypeOneOfType(
   return type;
 }
 
-function getPropTypeArrayOf(type: PropTypeDescriptor, argumentPath: NodePath) {
+function getPropTypeArrayOf(
+  type: PropTypeDescriptor,
+  argumentPath: NodePath,
+): PropTypeDescriptor {
   const docs = getDocblock(argumentPath);
 
   if (docs) {
@@ -112,7 +115,10 @@ function getPropTypeArrayOf(type: PropTypeDescriptor, argumentPath: NodePath) {
   return type;
 }
 
-function getPropTypeObjectOf(type: PropTypeDescriptor, argumentPath: NodePath) {
+function getPropTypeObjectOf(
+  type: PropTypeDescriptor,
+  argumentPath: NodePath,
+): PropTypeDescriptor {
   const docs = getDocblock(argumentPath);
 
   if (docs) {
@@ -155,7 +161,10 @@ function isCyclicReference(
 /**
  * Handles shape and exact prop types
  */
-function getPropTypeShapish(type: PropTypeDescriptor, argumentPath: NodePath) {
+function getPropTypeShapish(
+  type: PropTypeDescriptor,
+  argumentPath: NodePath,
+): PropTypeDescriptor {
   if (!argumentPath.isObjectExpression()) {
     argumentPath = resolveToValue(argumentPath);
   }
@@ -254,7 +263,7 @@ function callPropTypeHandler(
   name: PropTypeDescriptor['name'],
   handler: PropTypeHandler,
   argumentPath: NodePath | undefined,
-) {
+): PropTypeDescriptor {
   let type: PropTypeDescriptor = { name };
 
   if (argumentPath) {

packages/react-docgen/src/utils/getTypeFromReactComponent.ts

@@ -92,18 +92,14 @@ export function applyToTypeProperties(
       .get('members')
       .forEach((propertyPath) => callback(propertyPath, typeParams));
   } else if (path.isInterfaceDeclaration()) {
-    if (path.node.extends) {
-      applyExtends(documentation, path, callback, typeParams);
-    }
+    applyExtends(documentation, path, callback, typeParams);
 
     path
       .get('body')
       .get('properties')
       .forEach((propertyPath) => callback(propertyPath, typeParams));
   } else if (path.isTSInterfaceDeclaration()) {
-    if (path.node.extends) {
-      applyExtends(documentation, path, callback, typeParams);
-    }
+    applyExtends(documentation, path, callback, typeParams);
 
     path
       .get('body')
@@ -133,36 +129,47 @@ function applyExtends(
   path: NodePath<InterfaceDeclaration | TSInterfaceDeclaration>,
   callback: (propertyPath: NodePath, params: TypeParameters | null) => void,
   typeParams: TypeParameters | null,
-) {
-  (
-    path.get('extends') as Array<
-      NodePath<InterfaceExtends | TSExpressionWithTypeArguments>
-    >
-  ).forEach((extendsPath) => {
-    const resolvedPath = resolveGenericTypeAnnotation(extendsPath);
-
-    if (resolvedPath) {
-      if (
-        resolvedPath.has('typeParameters') &&
-        extendsPath.node.typeParameters
-      ) {
-        typeParams = getTypeParameters(
-          resolvedPath.get('typeParameters') as NodePath<
-            TSTypeParameterDeclaration | TypeParameterDeclaration
-          >,
-          extendsPath.get('typeParameters') as NodePath<
-            TSTypeParameterInstantiation | TypeParameterInstantiation
-          >,
+): void {
+  const classExtends = path.get('extends');
+
+  if (!Array.isArray(classExtends)) {
+    return;
+  }
+
+  classExtends.forEach(
+    (
+      extendsPath: NodePath<InterfaceExtends | TSExpressionWithTypeArguments>,
+    ) => {
+      const resolvedPath = resolveGenericTypeAnnotation(extendsPath);
+
+      if (resolvedPath) {
+        if (
+          resolvedPath.has('typeParameters') &&
+          extendsPath.node.typeParameters
+        ) {
+          typeParams = getTypeParameters(
+            resolvedPath.get('typeParameters') as NodePath<
+              TSTypeParameterDeclaration | TypeParameterDeclaration
+            >,
+            extendsPath.get('typeParameters') as NodePath<
+              TSTypeParameterInstantiation | TypeParameterInstantiation
+            >,
+            typeParams,
+          );
+        }
+        applyToTypeProperties(
+          documentation,
+          resolvedPath,
+          callback,
           typeParams,
         );
-      }
-      applyToTypeProperties(documentation, resolvedPath, callback, typeParams);
-    } else {
-      const idPath = getTypeIdentifier(extendsPath);
+      } else {
+        const idPath = getTypeIdentifier(extendsPath);
 
-      if (idPath && idPath.isIdentifier()) {
-        documentation.addComposes(idPath.node.name);
+        if (idPath && idPath.isIdentifier()) {
+          documentation.addComposes(idPath.node.name);
+        }
       }
-    }
-  });
+    },
+  );
 }

packages/react-docgen/src/utils/ts-types/index.ts

@@ -162,7 +162,7 @@ export default function initialize(scopeClass: typeof BaseScope): void {
   scopeClass.prototype.registerDeclaration = registerDeclaration;
 
   scopeClass.prototype._realCrawl = scopeClass.prototype.crawl;
-  scopeClass.prototype.crawl = function (this: BaseScope) {
+  scopeClass.prototype.crawl = function (this: BaseScope): void {
     this.typeBindings = Object.create(null);
     this._realCrawl();
   };

packages/react-docgen/tests/NodePathSerializer.ts

@@ -2,12 +2,16 @@ import { NodePath } from '@babel/traverse';
 import { removePropertiesDeep } from '@babel/types';
 import type { expect } from 'vitest';
 
-function removeUndefinedProperties(node) {
+function removeUndefinedProperties(
+  node: Record<string, unknown>,
+): Record<string, unknown> {
   for (const key of Object.keys(node)) {
     if (node[key] === undefined) {
       delete node[key];
     } else if (node[key] === Object(node[key])) {
-      node[key] = removeUndefinedProperties(node[key]);
+      node[key] = removeUndefinedProperties(
+        node[key] as Record<string, unknown>,
+      );
     }
   }