Generate docs for hooks

Since hooks have been released a while back, it would be nice to be able to generate docs for them.

For example, for a simple hook:

import {useState} from 'react';

/**
 * A hook to do something
 *
 * @param {object} params
 * @param {boolean} [params.disabled] Disable the thing
 * @returns {boolean}
 */
const useMyHook = (params) => {
  const [isUsing, setUsing] = useState(false);
  // Some logic here to invoke setUsing()
  return isUsing;
};

export default useMyHook;

There is not way to generate some docs. Or is there and I just can’t find it?

NOTE: I am actually using react-styleguidist which uses this lib to generate component docs.

[trevordmiller]

“Hooks are generally an implementation detail of a component and not part of its public API”

I believe this is true for app projects. But for libraries where custom hooks are a part of the public facing interface, this is often not the case in my experience. For example:

• Redux
• Apollo

etc.

Our organization has a good amount of custom hooks like these that are a part of libraries we expose publicly. It would be really nice if these could be auto-documented with react-docgen with the rest of our React code. Although technically “just functions” they are still coupled with React so IMO it makes sense to support them in this library.

I would imagine the most common users are using tools like Storybook or react-styleguidist that use react-docgen under the hood, where auto documentation of their hooks would be helpful.

[dagerikhl]

Valid point.

A JSDoc annotation is an option.

Another option is using the convention that hooks are prefixed by use.... This isn’t consistently reliable, but a pretty well established convention and fronted by the React team, so it might be viable.

Would supporting functions as a whole be another option? Perhaps behind a flag to allow people to opt out of the functionality? Not sure what impact this would have on this library.