shelving 1.240.0 → 1.241.0

package/extract/TypescriptExtractor.js

@@ -336,6 +336,7 @@ function _getReturns(statement, source, jsDocReturns, name) {
  * - Members declared with the `override` modifier are skipped — the base class already documents them, so a subclass page lists only its newly-introduced API.
  * - Members declared with the `declare` modifier are skipped — they're ambient type-only re-declarations (e.g. narrowing an inherited property's type), not new API.
  * - Getters/setters fold into a single `property` element per name; a getter with no matching setter is `readonly`.
+ * - `static` members are labelled `static method` / `static property` so the docs site groups them in their own sections, separate from instance `method` / `property`, and their rendered signature is prefixed with the `static ` keyword.
  */
 function _getClassMembers(statement, source, className) {
     if (!ts.isClassDeclaration(statement) && !ts.isInterfaceDeclaration(statement))
@@ -355,13 +356,17 @@ function _getClassMembers(statement, source, className) {
         // Skip `declare` members — ambient type-only re-declarations (e.g. a subclass narrowing an inherited property's type), not new API.
         if (modifiers?.some(m => m.kind === ts.SyntaxKind.DeclareKeyword))
             continue;
+        // `static` members are grouped and labelled separately from instance members (`static method` / `static property`),
+        // and carry the `static ` keyword in their rendered signature.
+        const isStatic = modifiers?.some(m => m.kind === ts.SyntaxKind.StaticKeyword);
+        const staticPrefix = isStatic ? "static " : "";
         const memberJSDoc = _getJSDoc(member, source);
         const content = _buildJSDocContent(memberJSDoc?.description, memberJSDoc?.unhandled);
         const description = extractMarkdownProps(memberJSDoc?.description ?? "").description;
         if (ts.isMethodDeclaration(member) || ts.isMethodSignature(member)) {
             const params = member.parameters.map(p => p.getText(source)).join(", ");
             const ret = member.type ? member.type.getText(source) : "void";
-            const signature = `${name}(${params}): ${ret}`;
+            const signature = `${staticPrefix}${name}(${params}): ${ret}`;
             const key = name;
             const existingIndex = members.findIndex(m => m.key === key);
             const existing = members[existingIndex];
@@ -380,7 +385,7 @@ function _getClassMembers(statement, source, className) {
                         title: `${name}()`,
                         description,
                         content,
-                        kind: "method",
+                        kind: isStatic ? "static method" : "method",
                         class: className,
                         signatures: [signature],
                     },
@@ -398,10 +403,10 @@ function _getClassMembers(statement, source, className) {
                     title: name,
                     description,
                     content,
-                    kind: "property",
+                    kind: isStatic ? "static property" : "property",
                     class: className,
                     readonly,
-                    signatures: type ? [`${readonly ? "readonly " : ""}${name}: ${type}`] : undefined,
+                    signatures: type ? [`${staticPrefix}${readonly ? "readonly " : ""}${name}: ${type}`] : undefined,
                 },
             });
         }
@@ -418,7 +423,7 @@ function _getClassMembers(statement, source, className) {
                         ...existing.props,
                         // A getter + setter pair is writable — drop the read-only flag and the `readonly ` signature prefix.
                         readonly: undefined,
-                        signatures: type ? [`${name}: ${type}`] : existing.props.signatures,
+                        signatures: type ? [`${staticPrefix}${name}: ${type}`] : existing.props.signatures,
                     },
                 };
             }
@@ -431,10 +436,10 @@ function _getClassMembers(statement, source, className) {
                         title: name,
                         description,
                         content,
-                        kind: "property",
+                        kind: isStatic ? "static property" : "property",
                         class: className,
                         readonly: ts.isGetAccessor(member) || undefined,
-                        signatures: type ? [`${ts.isGetAccessor(member) ? "readonly " : ""}${name}: ${type}`] : undefined,
+                        signatures: type ? [`${staticPrefix}${ts.isGetAccessor(member) ? "readonly " : ""}${name}: ${type}`] : undefined,
                     },
                 });
             }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "shelving",
-	"version": "1.240.0",
+	"version": "1.241.0",
 	"author": "Dave Houlbrooke <dave@shax.com>",
 	"repository": {
 		"type": "git",

package/ui/docs/DocumentationKind.d.ts

@@ -8,7 +8,7 @@ import type { UIColor } from "../style/Color.js";
  * @see https://dhoulb.github.io/shelving/ui/docs/DocumentationKind/DocumentationKindProps
  */
 export interface DocumentationKindProps extends TagProps {
-    /** The documentation kind (e.g. `"component"`, `"function"`, `"class"`, `"interface"`, `"type"`, `"constant"`, `"method"`, `"property"`). */
+    /** The documentation kind (e.g. `"component"`, `"function"`, `"class"`, `"interface"`, `"type"`, `"constant"`, `"method"`, `"static method"`, `"property"`, `"static property"`). */
     readonly kind: string;
 }
 /**

package/ui/docs/DocumentationKind.js

@@ -12,10 +12,12 @@ const KIND_COLOR = {
     class: "purple",
     function: "blue",
     method: "blue",
+    "static method": "blue",
     interface: "aqua",
     type: "aqua",
     constant: "green",
     property: "yellow",
+    "static property": "yellow",
 };
 /**
  * Get the raw colour variant for a documented symbol's `kind`, or `undefined` for an unknown kind.

package/ui/docs/DocumentationKind.tsx

@@ -10,7 +10,7 @@ import { Row } from "../style/Flex.js";
  * @see https://dhoulb.github.io/shelving/ui/docs/DocumentationKind/DocumentationKindProps
  */
 export interface DocumentationKindProps extends TagProps {
-	/** The documentation kind (e.g. `"component"`, `"function"`, `"class"`, `"interface"`, `"type"`, `"constant"`, `"method"`, `"property"`). */
+	/** The documentation kind (e.g. `"component"`, `"function"`, `"class"`, `"interface"`, `"type"`, `"constant"`, `"method"`, `"static method"`, `"property"`, `"static property"`). */
 	readonly kind: string;
 }
 
@@ -25,10 +25,12 @@ const KIND_COLOR: { readonly [K in string]?: UIColor } = {
 	class: "purple",
 	function: "blue",
 	method: "blue",
+	"static method": "blue",
 	interface: "aqua",
 	type: "aqua",
 	constant: "green",
 	property: "yellow",
+	"static property": "yellow",
 };
 
 /**

package/ui/docs/DocumentationPage.js

@@ -30,6 +30,8 @@ const KIND_SECTIONS = {
     interface: "Interfaces",
     type: "Types",
     constant: "Constants",
+    "static method": "Static methods",
+    "static property": "Static properties",
     method: "Methods",
     property: "Properties",
 };

package/ui/docs/DocumentationPage.test.tsx

@@ -41,4 +41,20 @@ describe("DocumentationPage", () => {
 		expect(html).not.toContain("Functions");
 		expect(html).not.toContain("Interfaces");
 	});
+
+	test("groups static members into their own sections, before instance sections", () => {
+		const html = render(
+			<DocumentationPage path="/Color" name="Color" kind="class">
+				{[doc("from", "static method"), doc("DEFAULT", "static property"), doc("toString", "method"), doc("red", "property")]}
+			</DocumentationPage>,
+			"./Color",
+		);
+		expect(html).toContain("Static methods");
+		expect(html).toContain("Static properties");
+		expect(html).toContain("Methods");
+		expect(html).toContain("Properties");
+		// Static sections render before their instance counterparts (the `Methods` / `Properties` headings use a capital, so they don't match inside `Static methods`).
+		expect(html.indexOf("Static methods")).toBeLessThan(html.indexOf("Methods"));
+		expect(html.indexOf("Static properties")).toBeLessThan(html.indexOf("Properties"));
+	});
 });

package/ui/docs/DocumentationPage.tsx

@@ -33,6 +33,8 @@ const KIND_SECTIONS = {
 	interface: "Interfaces",
 	type: "Types",
 	constant: "Constants",
+	"static method": "Static methods",
+	"static property": "Static properties",
 	method: "Methods",
 	property: "Properties",
 };