shelving 1.245.0 → 1.246.0

package/extract/PackageExtractor.d.ts

@@ -32,6 +32,7 @@ export interface PackageExtractorOptions {
  * - Static export keys (e.g. `"./api"`, `"./firestore/client"`) become one module each.
  * - Wildcard export keys (e.g. `"./util/*"`) expand against the source tree — one module per matching child file or subdirectory.
  * - Each export's *target* extension (e.g. the `.js` in `"./util/*.js"`) is mapped to source extensions via `extensions`, so built `.js` paths resolve to their `.ts` sources.
+ * - Each module's `title` is prefixed with the package `name` (e.g. `ui` → `shelving/ui`) so listings read as package subpaths.
  * - The `"."` root export is skipped — its content is the root tree element itself.
  * - Throws if a static export key has no matching source element in the tree.
  *

package/extract/PackageExtractor.js

@@ -16,6 +16,7 @@ const DEFAULT_EXTENSIONS = {
  * - Static export keys (e.g. `"./api"`, `"./firestore/client"`) become one module each.
  * - Wildcard export keys (e.g. `"./util/*"`) expand against the source tree — one module per matching child file or subdirectory.
  * - Each export's *target* extension (e.g. the `.js` in `"./util/*.js"`) is mapped to source extensions via `extensions`, so built `.js` paths resolve to their `.ts` sources.
+ * - Each module's `title` is prefixed with the package `name` (e.g. `ui` → `shelving/ui`) so listings read as package subpaths.
  * - The `"."` root export is skipped — its content is the root tree element itself.
  * - Throws if a static export key has no matching source element in the tree.
  *
@@ -56,7 +57,9 @@ export class PackageExtractor extends Extractor {
     async extract(packageJson) {
         const pkgPath = requirePath(packageJson, this._base, this.extract);
         const pkg = (await Bun.file(pkgPath).json());
-        const exports = pkg.exports ?? {};
+        const tree = this._tree;
+        // Read the package name alongside its exports — the name prefixes each module title (e.g. `ui` → `shelving/ui`).
+        const { name, exports = {} } = pkg;
         const modules = [];
         for (const [key, value] of Object.entries(exports)) {
             if (key === ".")
@@ -76,18 +79,21 @@ export class PackageExtractor extends Extractor {
                 modules.push(this._module.extract({ name: subpath, source }));
             }
         }
-        const tree = this._tree;
+        // Prefix the package name onto each module's title so listings read `shelving/ui` rather than a bare `ui`, making modules glanceable as package subpaths.
+        const children = name
+            ? modules.map(module => ({ ...module, props: { ...module.props, title: `${name}/${module.props.title ?? module.props.name}` } }))
+            : modules;
         // Canonical URL `path`s aren't stamped here — they're derived from tree structure when the tree is flattened (`flattenTree()`) in the UI layer.
         return {
             type: "tree-element",
-            key: pkg.name ?? tree.key,
+            key: name ?? tree.key,
             props: {
                 source: tree.props.source,
-                name: pkg.name ?? tree.props.name,
-                title: pkg.name ?? tree.props.title,
+                name: name ?? tree.props.name,
+                title: name ?? tree.props.title,
                 description: pkg.description ?? tree.props.description,
                 content: tree.props.content,
-                children: modules,
+                children,
             },
         };
     }

package/package.json

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