shelving 1.245.0 → 1.246.1

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.1",
 	"author": "Dave Houlbrooke <dave@shax.com>",
 	"repository": {
 		"type": "git",

package/util/tree.d.ts

@@ -185,8 +185,9 @@ export interface SearchTreeOptions {
  * Search the descendants of a tree element and return the best-ranked matches.
  *
  * - Walks every descendant of `scope` (depth-first; `scope` itself is not a candidate), optionally narrowed by `options.filter`.
- * - Tokenises `query` with `getWords()` so quoted phrases match literally: `searchTree(root, '"hello world" foo')` scores the phrase `hello world` *and* the word `foo` independently, stacking their scores.
- * - Ranks each candidate (case-insensitive) per token, summing: `name` exact > `name` starts-with > `name` includes > `title` includes > `description` includes > `content` includes. A `name` match always outranks a content-only match.
+ * - Tokenises `query` with `getWords()` so quoted phrases match literally: `searchTree(root, '"hello world" foo')` matches the phrase `hello world` *and* the word `foo`.
+ * - Requires *every* token to match (AND, not OR): a candidate is only returned when each token matches at least one of its props. So `date util` returns only elements matching both `date` and `util`, not either alone.
+ * - Ranks each candidate (case-insensitive) per token, summing each token's best tier: `name` exact > `name` starts-with > `name` includes > `title` includes > `description` includes > `content` includes. A `name` match always outranks a content-only match.
  * - An empty `query` returns the (filtered) candidates in tree order — useful for a filter-only or "show everything" listing.
  *
  * @param scope The element whose descendants are searched.

package/util/tree.js

@@ -47,8 +47,9 @@ function _flatKey(element) {
  * Search the descendants of a tree element and return the best-ranked matches.
  *
  * - Walks every descendant of `scope` (depth-first; `scope` itself is not a candidate), optionally narrowed by `options.filter`.
- * - Tokenises `query` with `getWords()` so quoted phrases match literally: `searchTree(root, '"hello world" foo')` scores the phrase `hello world` *and* the word `foo` independently, stacking their scores.
- * - Ranks each candidate (case-insensitive) per token, summing: `name` exact > `name` starts-with > `name` includes > `title` includes > `description` includes > `content` includes. A `name` match always outranks a content-only match.
+ * - Tokenises `query` with `getWords()` so quoted phrases match literally: `searchTree(root, '"hello world" foo')` matches the phrase `hello world` *and* the word `foo`.
+ * - Requires *every* token to match (AND, not OR): a candidate is only returned when each token matches at least one of its props. So `date util` returns only elements matching both `date` and `util`, not either alone.
+ * - Ranks each candidate (case-insensitive) per token, summing each token's best tier: `name` exact > `name` starts-with > `name` includes > `title` includes > `description` includes > `content` includes. A `name` match always outranks a content-only match.
  * - An empty `query` returns the (filtered) candidates in tree order — useful for a filter-only or "show everything" listing.
  *
  * @param scope The element whose descendants are searched.
@@ -91,7 +92,7 @@ const _SCORE_NAME_INCLUDES = 100;
 const _SCORE_TITLE = 10;
 const _SCORE_DESCRIPTION = 4;
 const _SCORE_CONTENT = 1;
-/** Score one element's props against the (already lower-cased) query tokens — each token contributes its best-matching tier, summed. */
+/** Score one element's props against the (already lower-cased) query tokens — every token must match (AND), each contributing its best-matching tier, summed. */
 function _scoreElement(props, tokens) {
     const name = props.name.toLowerCase();
     const title = props.title?.toLowerCase() ?? "";
@@ -99,6 +100,7 @@ function _scoreElement(props, tokens) {
     const content = props.content?.toLowerCase() ?? "";
     let score = 0;
     for (const token of tokens) {
+        // Every token must match somewhere — a single token that matches nothing drops the candidate entirely (AND, not OR).
         if (name === token)
             score += _SCORE_NAME_EXACT;
         else if (name.startsWith(token))
@@ -111,6 +113,8 @@ function _scoreElement(props, tokens) {
             score += _SCORE_DESCRIPTION;
         else if (content.includes(token))
             score += _SCORE_CONTENT;
+        else
+            return 0;
     }
     return score;
 }