DX - Add JSDOC for Hooks To improve developer coding experience.

[balmacefa]

How Can I know what this hook does, arguments and expected outcomes without going to the documentation, repetition of coding or experience?

Propusal

Include JSDoc to the expose .d.td file located at node_modules > payload > dist > globals > config > types.d.ts
For reference I'll use BeforeValidateHook. See Docs -> https://payloadcms.com/docs/hooks/collections#beforechange

node_modules > payload > dist > globals > config > types.d.ts
/**
 * Represents a hook that is executed before a change is made. See Docs -> https://payloadcms.com/docs/hooks/collections#beforechange
 * Expects the Return data to either create or update a document with. Or pass to the next hook. Return for no changes.
 * @param args - The arguments passed to the hook.
 * @param args.context - The request context.
 * @param args.data - The data associated with the change.
 * @param args.global - The global configuration.
 * @param args.originalDoc - The original document, if available.
 * @param args.req - The request object.
 * @returns The data to either create or update a document with.
 */
export type BeforeChangeHook = (args: {
    context: RequestContext;
    data: any;
    /** The global which this hook is being run on */
    global: SanitizedGlobalConfig;
    originalDoc?: any;
    req: PayloadRequest;
}) => any;

---

Result

On this way We can tell what the contract of this hook on the editor.