Rename propDocBlockHandler to propDocblockHandler

reactjs · Mar 4, 2023 · dfc2f85 · dfc2f85
1 parent 98a1138
commit dfc2f85
Show file tree

Hide file tree

Showing 5 changed files with 11 additions and 6 deletions.
diff --git a/.changeset/gentle-plants-smell.md b/.changeset/gentle-plants-smell.md
@@ -0,0 +1,5 @@
+---
+'react-docgen': major
+---
+
+Rename `propDocBlockHandler` to `propDocblockHandler` for consistency
diff --git a/packages/react-docgen/src/config.ts b/packages/react-docgen/src/config.ts
@@ -9,7 +9,7 @@ import {
   contextTypeHandler,
   defaultPropsHandler,
   displayNameHandler,
-  propDocBlockHandler,
+  propDocblockHandler,
   propTypeCompositionHandler,
   propTypeHandler,
 } from './handlers/index.js';
@@ -52,7 +52,7 @@ export const defaultHandlers: Handler[] = [
   contextTypeHandler,
   childContextTypeHandler,
   propTypeCompositionHandler,
-  propDocBlockHandler,
+  propDocblockHandler,
   codeTypeHandler,
   defaultPropsHandler,
   componentDocblockHandler,

diff --git a/packages/react-docgen/src/handlers/componentMethodsJsDocHandler.ts b/packages/react-docgen/src/handlers/componentMethodsJsDocHandler.ts
@@ -29,7 +29,7 @@ function merge<T, U>(obj1: T, obj2: U): (T & U) | null {
 const componentMethodsJsDocHandler: Handler = function (
   documentation: Documentation,
 ): void {
-  let methods = documentation.get('methods') as MethodDescriptor[] | null;
+  let methods = documentation.get<MethodDescriptor[]>('methods');
 
   if (!methods) {
     return;

diff --git a/packages/react-docgen/src/handlers/index.ts b/packages/react-docgen/src/handlers/index.ts
@@ -8,7 +8,7 @@ export { default as componentMethodsJsDocHandler } from './componentMethodsJsDoc
 export { default as defaultPropsHandler } from './defaultPropsHandler.js';
 export { default as displayNameHandler } from './displayNameHandler.js';
 export { default as codeTypeHandler } from './codeTypeHandler.js';
-export { default as propDocBlockHandler } from './propDocBlockHandler.js';
+export { default as propDocblockHandler } from './propDocblockHandler.js';
 export { default as propTypeCompositionHandler } from './propTypeCompositionHandler.js';
 export {
   propTypeHandler,

diff --git a/...ocgen/src/handlers/propDocBlockHandler.ts → ...ocgen/src/handlers/propDocblockHandler.ts b/...ocgen/src/handlers/propDocBlockHandler.ts → ...ocgen/src/handlers/propDocblockHandler.ts
@@ -29,7 +29,7 @@ function resolveDocumentation(
   });
 }
 
-const propDocBlockHandler: Handler = function (
+const propDocblockHandler: Handler = function (
   documentation: Documentation,
   componentDefinition: NodePath<ComponentNode>,
 ): void {
@@ -49,4 +49,4 @@ const propDocBlockHandler: Handler = function (
   resolveDocumentation(documentation, propTypesPath);
 };
 
-export default propDocBlockHandler;
+export default propDocblockHandler;