fix: render constructors as `new ClassName(params)` format by davanesh · Pull Request #11 · webpack/webpack-doc-kit

davanesh · 2026-03-12T20:34:26Z

Closes #2

What this does

Overrides the constructor partial to render constructors in the Node.js doc format instead of the default TypeDoc output.

Before:

Constructors

Constructor

options {ContainerPluginOptions}

After:

`new ContainerPlugin(options)`

options {ContainerPluginOptions}

Changes

Override constructor partial to format as new ClassName(params)
Optional params are wrapped in square brackets: new Stats([options])
Removed ### Constructors / Methods / Properties group headings
Removed *** horizontal rule separators between members
Override memberContainer to correctly pass heading levels down the chain

linux-foundation-easycla · 2026-03-12T20:34:35Z

The committers listed above are authorized under a signed CLA.

✅ login: davanesh / name: Davanesh Saminathan (362bbf9, 7e24ed9, 8e0768f)

avivkeller · 2026-03-12T20:38:49Z

@davanesh Can you rebase?

…ebpack#2)

davanesh · 2026-03-12T20:48:36Z

Done! Rebased and force pushed.

plugins/theme/index.mjs

avivkeller

I have a few changes that I think will be nice, but this is some great great work and I can't wait to see more!

avivkeller · 2026-03-12T21:19:46Z

plugins/theme/index.mjs

+      //DEBUG
+      // console.log("KIND:", model.kind, "NAME:", model.name, "CONSTRUCTOR KIND:", ReflectionKind.Constructor);


Let's remove this debug comment

Removed 👍

avivkeller · 2026-03-12T21:19:59Z

plugins/theme/index.mjs

+    declarationTitle: (model) => {
+      return this.helpers.typedListItem({
+        name: model.name,
+        type: model.type,
+        comment: model.comment,
+      });
+    },


Suggested change

declarationTitle: (model) => {

return this.helpers.typedListItem({

name: model.name,

type: model.type,

comment: model.comment,

});

},

declarationTitle: this.helpers.typedListItem,

avivkeller · 2026-03-12T21:21:17Z

plugins/theme/index.mjs

+    memberContainer: (model, options) => {
+      const md = [];
+      if (!this.router.hasOwnDocument(model) &&
+          ![ReflectionKind.Constructor].includes(model.kind)) {
+        md.push(
+          "#".repeat(options.headingLevel) + " " + 
+          this.partials.memberTitle(model)
+        );
+      }
+      md.push(this.partials.member(model, {
+        headingLevel: options.headingLevel + 1, // ← methods get ####
+        nested: options.nested,
+      }));
+      return md.filter(Boolean).join("\n\n");
+    },


I think overriding the constructor in memberTitle is better than outright skipping it? WDYT?

Oh that's a much cleaner approach! On it 🔥

avivkeller · 2026-03-12T21:37:29Z

(Rebased for CI/CD). Note that you'll need to run npm run lint:fix && npm run format + npm run generate-docs.

alexander-akait

@avivkeller We currently only support @deprecated, if we want to add them we need to add them to our schema generator, @experimental is not a problem, @beta and @legacy - not sure we need it, because @deprecated already handle such things

avivkeller

Can you revert the block quote changes, and other unrelated changes
Let's add a re-usable helper for signature creation

davanesh · 2026-03-13T17:35:13Z

On it!

davanesh · 2026-03-13T17:41:43Z

Done, reverted blockquote changes and moved constructor logic into a buildConstructorTitle helper 😊

davanesh · 2026-03-14T06:21:07Z

Addressed all feedback, reverted blockquote changes and extracted constructor logic into buildConstructorTitle helper. Ready for re-review

avivkeller · 2026-03-14T13:17:30Z

plugins/theme/helpers/index.mjs

+  buildConstructorTitle(model) {
+    const params = model.signatures?.[0]?.parameters ?? [];
+    const className = model.parent?.name ?? model.name;
+    const allOptional =
+      params.length > 0 && params.every((p) => p.flags?.isOptional);
+    const paramStr = allOptional
+      ? `[${params.map((p) => p.name).join(", ")}]`
+      : params.map((p) => (p.flags?.isOptional ? `[${p.name}]` : p.name)).join(", ");
+    return `\`new ${className}(${paramStr})\``;
  },


Let's redo this as a signatureTitle helper that returns ${className}(${paramsStr}), and re use for constructors, and all members

Replaced with a generic signatureTitle(name, params) helper reused for both constructors and all members

avivkeller · 2026-03-14T13:17:38Z

plugins/theme/helpers/index.mjs

    return entries.map(ctx.helpers.typedListItem).join("\n");
  },
-
-  stabilityBlockquote(comment) {


Unrelated removal

plugins/theme/index.mjs

avivkeller · 2026-03-14T13:18:13Z

plugins/theme/partials/index.mjs

+  memberContainer: (model, options) => {
+    const md = [];
+    if (!ctx.router.hasOwnDocument(model)) {
+      md.push(
+        "#".repeat(options.headingLevel) + " " +
+        ctx.partials.memberTitle(model)
+      );
+    }
+    md.push(ctx.partials.member(model, {
+      headingLevel: options.headingLevel + 1,
+      nested: options.nested,
+    }));
+    return md.filter(Boolean).join("\n\n");
+  },
+
+  constructor: (model, options) => {
+    return model.signatures?.map(signature => {
+      const params = signature.parameters ?? [];
+      return params.length ? ctx.helpers.typedList(params) : "";
+    }).filter(Boolean).join("\n\n") ?? "";
+  },
+
+  members: (model, options) => {
+    const items = model.filter(
+      (item) => !ctx.router.hasOwnDocument(item)
+    );
+    return items
+      .map(item =>
+        ctx.partials.memberContainer(item, {
+          headingLevel: options.headingLevel,
+          groupTitle: options.groupTitle,
+        })
+      )
+      .filter(Boolean)
+      .join("\n\n");
+  },
+
+  groups: (model, options) => {
+    return (model.groups ?? [])
+      .flatMap(group => {
+        const isPropertiesGroup = group.children?.every(
+          child => child.kind === ReflectionKind.Property
+        );
+        if (isPropertiesGroup) return [];
+        const children = group.children?.filter(
+          child => child.isDeclaration()
+        ) ?? [];
+        if (!children.length) return [];
+        return [
+          ctx.partials.members(children, {
+            headingLevel: options.headingLevel,
+            groupTitle: group.title,
+          })
+        ];
+      })
+      .filter(Boolean)
+      .join("\n\n");
+  },
+
+  body: (model, options) => {
+    if (model.groups?.length) {
+      return ctx.partials.groups(model, {
+        headingLevel: options.headingLevel,
+        kind: model.kind,
+      });
+    }
+    return "";
+  },
+
+  declarationTitle: (model) => {
+    return ctx.helpers.typedListItem({
+      name: model.name,
+      type: model.type,
+      comment: model.comment,
+    });
+  },
+


…elper, restore templates

fix: render constructors as \new ClassName(params)\ format (closes w…

e72176d

…ebpack#2)

davanesh force-pushed the fix/constructor-rendering branch from 6c923d3 to e72176d Compare March 12, 2026 20:46

avivkeller reviewed Mar 12, 2026

View reviewed changes

plugins/theme/index.mjs Show resolved Hide resolved

avivkeller reviewed Mar 12, 2026

View reviewed changes

avivkeller force-pushed the fix/constructor-rendering branch from e72176d to 2f0b9c9 Compare March 12, 2026 21:37

refactor: move changes to helpers/index and partials/index

e2b9d89

davanesh force-pushed the fix/constructor-rendering branch from 2f0b9c9 to e2b9d89 Compare March 13, 2026 08:32

Merge branch 'main' into fix/constructor-rendering

b587f4c

alexander-akait reviewed Mar 13, 2026

View reviewed changes

avivkeller requested changes Mar 13, 2026

View reviewed changes

refactor: extract constructor title into buildConstructorTitle helper

8e0768f

Merge branch 'main' into fix/constructor-rendering

362bbf9

avivkeller reviewed Mar 14, 2026

View reviewed changes

refactor: replace buildConstructorTitle with generic signatureTitle h…

7e24ed9

…elper, restore templates

avivkeller closed this Mar 14, 2026

		//DEBUG
		// console.log("KIND:", model.kind, "NAME:", model.name, "CONSTRUCTOR KIND:", ReflectionKind.Constructor);

Conversation

davanesh commented Mar 12, 2026

What this does

Constructors

Constructor

new ContainerPlugin(options)

Changes

Uh oh!

linux-foundation-easycla bot commented Mar 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

avivkeller commented Mar 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

davanesh commented Mar 12, 2026

Uh oh!

Uh oh!

avivkeller left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

avivkeller commented Mar 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

alexander-akait left a comment

Choose a reason for hiding this comment

Uh oh!

avivkeller left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

davanesh commented Mar 13, 2026

Uh oh!

davanesh commented Mar 13, 2026

Uh oh!

davanesh commented Mar 14, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

`new ContainerPlugin(options)`

linux-foundation-easycla bot commented Mar 12, 2026 •

edited

Loading

avivkeller commented Mar 12, 2026 •

edited

Loading

avivkeller commented Mar 12, 2026 •

edited

Loading

avivkeller left a comment •

edited

Loading