path-treeify 1.2.0 → 1.3.0-beta.1a88b75

package/README.md

@@ -1,4 +1,7 @@
-# path-treeify
+<div align="center">
+  <img alt="LOGO" width="320" src="https://assets-amu.pages.dev/path-treeify/logo.png">
+</div>
+<br/>
 
 > 📖 [中文文档 (Chinese README)](https://github.com/isaaxite/path-treeify/blob/main/docs/README.zh-CN.md)
 
@@ -14,6 +17,9 @@
   <a href="https://nodejs.org">
     <img alt="node" src="https://img.shields.io/node/v/path-treeify">
   </a>
+  <a href="https://github.com/isaaxite/path-treeify/blob/main/CHANGELOG.md">
+    <img alt="CHANGELOG" src="https://img.shields.io/badge/changelog-maintained-brightgreen">
+  </a>
   <a href="https://github.com/isaaxite/path-treeify/blob/main/LICENSE">
     <img alt="GitHub License" src="https://img.shields.io/github/license/isaaxite/path-treeify">
   </a>
@@ -29,6 +35,12 @@
   <a href="https://github.com/isaaxite/path-treeify/commits/main/">
     <img alt="GitHub last commit" src="https://img.shields.io/github/last-commit/isaaxite/path-treeify">
   </a>
+  <a href='https://github.com/isaaxite/path-treeify/actions/workflows/unittests.yml'>
+    <img src='https://github.com/isaaxite/path-treeify/actions/workflows/unittests.yml/badge.svg' alt='Test CI Status' />
+  </a>
+  <a href='https://coveralls.io/github/isaaxite/path-treeify'>
+    <img src='https://coveralls.io/repos/github/isaaxite/path-treeify/badge.svg' alt='Coverage Status' />
+  </a>
 </div>
 
 ---
@@ -38,9 +50,11 @@
 - 🌲 Builds a recursive tree from one or more directory paths
 - 🔗 Each node carries a `parent` circular reference for upward traversal
 - 📍 Each node exposes a `getPath()` method to retrieve its own paths directly
-- 🔍 Optional `filter` callback to include/exclude directories during scanning
+- 🏷️ Each node has a `type` field — `PathTreeNodeKind.Dir` or `PathTreeNodeKind.File`
+- 👁️ `fileVisible` option includes files as leaf nodes alongside directories
+- 🔍 Optional `filter` callback applied at **every depth**, including top-level entries
 - ⚡ `build()` scans the entire `base` directory with zero configuration
-- 🎛️ `buildBy()` accepts either a directory name array or a filter function
+- 🎛️ `buildBy()` accepts either a path segment array or a top-level filter function
 - 📦 Ships as both ESM (`index.mjs`) and CJS (`index.cjs`) with full TypeScript types
 - 🚫 Zero runtime dependencies
 
@@ -67,18 +81,27 @@ yarn add path-treeify
 ## Quick Start
 
 ```ts
-import { PathTreeify } from 'path-treeify';
+import { PathTreeify, PathTreeNodeKind } from 'path-treeify';
 
+// Directories only (default)
 const treeify = new PathTreeify({ base: '/your/project/root' });
+const tree = treeify.build();
 
-// Scan specific directories by name
-const tree = treeify.buildBy(['src', 'tests']);
-
-// Scan with a filter function over all top-level directories
-const filtered = treeify.buildBy(name => !name.startsWith('.') && name !== 'node_modules');
-
-// Or scan everything under base at once
-const fullTree = treeify.build();
+// Include files as leaf nodes
+const treeifyWithFiles = new PathTreeify({
+  base: '/your/project/root',
+  fileVisible: true,
+});
+const fullTree = treeifyWithFiles.build();
+
+// Check node type
+for (const child of tree.children) {
+  if (child.type === PathTreeNodeKind.Dir) {
+    console.log('dir:', child.value);
+  } else if (child.type === PathTreeNodeKind.File) {
+    console.log('file:', child.value);
+  }
+}
 ```
 
 ---
@@ -89,10 +112,11 @@ const fullTree = treeify.build();
 
 Creates a new instance.
 
-| Option   | Type                          | Required | Description                                        |
-|----------|-------------------------------|----------|----------------------------------------------------|
-| `base`   | `string`                      | ✅        | Absolute path to the root directory to scan from  |
-| `filter` | `FilterFunction` (see below)  | ❌        | Called for every directory found during deep traversal |
+| Option        | Type                         | Required | Description                                                              |
+|---------------|------------------------------|----------|--------------------------------------------------------------------------|
+| `base`        | `string`                     | ✅        | Absolute path to the root directory to scan from                        |
+| `filter`      | `FilterFunction` (see below) | ❌        | Applied at **every depth** — top-level entries included                 |
+| `fileVisible` | `boolean`                    | ❌        | When `true`, files are included as leaf nodes. Defaults to `false`      |
 
 `base` must exist and be a directory, otherwise the constructor throws.
 
@@ -100,23 +124,23 @@ Creates a new instance.
 
 ### `FilterFunction`
 
-Used as the `filter` option in the constructor. Applied recursively during deep traversal of the tree.
+Used as the `filter` option in the constructor. Applied at every level of the tree, including the immediate children of `base`.
 
 ```ts
 type FilterFunction = (params: {
-  name: string;    // directory name (leaf segment)
+  name: string;    // entry name (file or directory name)
   dirPath: string; // absolute path of the parent directory
 }) => boolean;
 ```
 
-Return `true` to **include** the directory and recurse into it; `false` to **skip** it.
+Return `true` to **include** the entry; `false` to **skip** it entirely.
 
-**Example — skip hidden directories and `node_modules` at every level:**
+**Example — exclude `node_modules` and hidden entries at every depth:**
 
 ```ts
 const treeify = new PathTreeify({
   base: '/your/project',
-  filter: ({ name }) => !name.startsWith('.') && name !== 'node_modules',
+  filter: ({ name }) => name !== 'node_modules' && !name.startsWith('.'),
 });
 ```
 
@@ -124,7 +148,7 @@ const treeify = new PathTreeify({
 
 ### `build(): PathTreeNode`
 
-Scans **all** subdirectories directly under `base` and returns a synthetic root `PathTreeNode`. This is the zero-configuration shorthand.
+Scans all entries directly under `base` that pass the instance-level `filter` and returns a synthetic root `PathTreeNode`. When `fileVisible` is `true`, files are included as leaf nodes.
 
 ```ts
 const tree = treeify.build();
@@ -132,62 +156,70 @@ const tree = treeify.build();
 
 ---
 
-### `buildBy(dirNames: string[]): PathTreeNode`
+### `buildBy(segments: string[]): PathTreeNode`
 
-Builds a tree from the given list of directory names (relative to `base`).
+Builds a tree from the given list of relative path segments. When `fileVisible` is `true`, file paths are also accepted.
 
 ```ts
 const tree = treeify.buildBy(['src', 'docs', 'tests']);
+
+// With fileVisible: true, files can also be specified
+const treeWithFiles = new PathTreeify({ base: '/your/project', fileVisible: true });
+treeWithFiles.buildBy(['src', 'README.md']);
 ```
 
-- Leading and trailing slashes are stripped automatically.
-- Throws if any name does not resolve to a valid directory under `base`.
+- Both `/` and `\` separators are normalised automatically.
+- Leading/trailing slashes and empty segments are stripped.
+- Throws if any segment does not resolve to a valid entry under `base`.
 
-### `buildBy(filter: (dirName: string) => boolean): PathTreeNode`
+### `buildBy(filter: (segment: string) => boolean): PathTreeNode`
 
-Collects all top-level subdirectories under `base`, applies the given filter function, then builds a tree from the matching names.
+Collects all top-level entries under `base`, applies the predicate to select which ones to include, then builds a tree. The instance-level `filter` still applies during deep traversal.
 
 ```ts
 const tree = treeify.buildBy(name => name !== 'node_modules' && !name.startsWith('.'));
 ```
 
-> Note: this `filter` operates only on the **top-level** directory names under `base`. For filtering at every depth, pass a `filter` to the constructor instead.
+> **Note:** the predicate passed to `buildBy(fn)` only selects which **top-level** entries to include. To filter entries at every depth, pass a `filter` to the constructor.
 
 ---
 
-### `getPathBy(node: PathTreeNode): { relative: string; absolute: string }`
+### `PathTreeNode`
 
-Walks a node's `parent` chain to reconstruct its full path. Equivalent to calling `node.getPath()` directly.
+`PathTreeNode` is an **interface** — each node exposes a `getPath()` method to retrieve its paths without needing the `PathTreeify` instance.
 
 ```ts
-const { relative, absolute } = treeify.getPathBy(node);
+interface PathTreeNode {
+  parent:   PathTreeNode | null;  // null only on the synthetic root
+  value:    string;               // entry name for this node
+  children: PathTreeNode[];       // empty for file nodes
+  type:     PathTreeNodeKind;     // Dir, File, or Unknown
+
+  getPath(): { relative: string; absolute: string };
+}
 ```
 
+> ⚠️ **Circular references** — `parent` points back up the tree. Use `JSON.stringify` replacers or a library like `flatted` if you need to serialize the result.
+
 ---
 
-### `PathTreeNode`
+### `PathTreeNodeKind`
 
-`PathTreeNode` is a **class** with its own `getPath()` method, so you can retrieve a node's path without passing it back to the `PathTreeify` instance.
+An enum classifying each node's filesystem type.
 
 ```ts
-class PathTreeNode {
-  parent:   PathTreeNode | null; // null only on the synthetic root
-  value:    string;              // directory name for this node
-  children: PathTreeNode[];
-
-  getPath(): { relative: string; absolute: string };
+enum PathTreeNodeKind {
+  Dir     = 'dir',
+  File    = 'file',
+  Unknown = 'unknown', // assigned before the type is resolved
 }
 ```
 
-**`node.getPath()`** returns the same result as `treeify.getPathBy(node)` — both are available for convenience.
-
-> ⚠️ **Circular references** — `parent` points back up the tree. Use `JSON.stringify` replacers or a library like `flatted` if you need to serialize the result.
-
 ---
 
 ## Examples
 
-### Scan an entire base directory
+### Directories only (default)
 
 ```ts
 import { PathTreeify } from 'path-treeify';
@@ -196,19 +228,17 @@ const treeify = new PathTreeify({ base: '/your/project' });
 const tree = treeify.build();
 ```
 
-### Scan specific directories
+### Include files as leaf nodes
 
 ```ts
-const tree = treeify.buildBy(['src', 'tests', 'docs']);
-```
-
-### Filter top-level directories
-
-```ts
-const tree = treeify.buildBy(name => name !== 'node_modules' && !name.startsWith('.'));
+const treeify = new PathTreeify({
+  base: '/your/project',
+  fileVisible: true,
+});
+const tree = treeify.build();
 ```
 
-### Filter at every depth via constructor
+### Exclude directories at every depth via constructor filter
 
 ```ts
 const treeify = new PathTreeify({
@@ -218,13 +248,25 @@ const treeify = new PathTreeify({
 const tree = treeify.build();
 ```
 
+### Scan specific paths
+
+```ts
+const tree = treeify.buildBy(['src', 'tests', 'docs']);
+```
+
+### Select top-level entries with a predicate
+
+```ts
+const tree = treeify.buildBy(name => name !== 'node_modules' && !name.startsWith('.'));
+```
+
 ### Retrieve paths via `node.getPath()`
 
 ```ts
 function printPaths(node) {
   for (const child of node.children) {
     const { absolute } = child.getPath();
-    console.log(absolute);
+    console.log(`[${child.type}] ${absolute}`);
     printPaths(child);
   }
 }
@@ -235,7 +277,7 @@ printPaths(tree);
 ### CommonJS usage
 
 ```js
-const { PathTreeify } = require('path-treeify');
+const { PathTreeify, PathTreeNodeKind } = require('path-treeify');
 
 const treeify = new PathTreeify({ base: __dirname });
 const tree = treeify.build();

package/dist/index.cjs

@@ -1 +1 @@
-"use strict";var t=require("fs"),r=require("path");class e{static isValid(r){try{return t.accessSync(r,t.constants.F_OK),!0}catch{return!1}}static isDirectory(r){try{return t.statSync(r).isDirectory()}catch{return!1}}}class i{constructor(t){this.parent=null,this.value="",this.children=[],this.base=t}getPath(){let t="",e=this;for(;e.parent;)t=t?`${e.value}${r.sep}${t}`:e.value,e=e.parent;return{relative:t,absolute:r.resolve(this.base,t)}}}exports.PathTreeify=class{constructor({filter:t,base:r}){if(void 0!==t&&(this.validateFilter(t),this.filter=t),!r||!e.isValid(r))throw new Error(`${r} is not a valid path!`);if(!e.isDirectory(r))throw new Error(`${r} is not a dirPath!`);this.base=r}validateFilter(t){if("function"!=typeof t)throw new TypeError("filter must be a function");if(1!==t.length)throw new TypeError("filter must accept exactly one parameter");try{if("boolean"!=typeof t({name:"test",postPath:"/test"}))throw new TypeError("filter must return a boolean")}catch(t){throw new TypeError("filter function threw an error during test: "+t)}}initNode(t=null){const r=new i(this.base);return t&&(r.parent=t),r}buildChildren(e,i){const s=t.readdirSync(e),a=[];for(const n of s){const s=r.join(e,n);if(!t.statSync(s).isDirectory())continue;if(this.filter&&!this.filter({dirPath:e,name:n}))continue;const o=this.initNode();o.value=n,o.parent=i,o.children=this.buildChildren(s,o),a.push(o)}return a}checkRelativePaths(t){if(!Array.isArray(t))throw new Error("Expected array, got "+typeof t);for(let i=0;i<t.length;i++){const s=t[i];if("string"!=typeof s)throw new Error(`Item at index ${i} is not a string, got ${typeof s}`);const a=r.resolve(this.base,s);if(!e.isValid(a))throw new Error(`Path does not exist or is not accessible: ${a} (from relative path: ${s})`);if(!e.isDirectory(a))throw new Error(`Path is not a directory: ${a} (from relative path: ${s})`)}}formatDirnames(t){return t.map(t=>t.replace(/^\/+|\/+$/g,"")).filter(t=>""!==t)}getAllDirNamesUnderBase(){return t.readdirSync(this.base).filter(t=>{const i=r.resolve(this.base,t);return e.isDirectory(i)})}buildByDirNames(t){const e=this.initNode();this.checkRelativePaths(t);const i=this.formatDirnames(t);for(const t of i){const i=this.initNode();i.value=t,i.parent=e,i.children=this.buildChildren(r.resolve(this.base,t),i),e.children.push(i)}return e}buildByFilter(t){const r=this.getAllDirNamesUnderBase();return this.buildByDirNames(r.filter(t))}getPathBy(t){let e="",i=t;for(;i.parent;)e=e?`${i.value}${r.sep}${e}`:i.value,i=i.parent;return{relative:e,absolute:r.resolve(this.base,e)}}buildBy(t){if(Array.isArray(t))return this.buildByDirNames(t);if("function"==typeof t)return this.buildByFilter(t);throw new TypeError("buildBy: expected an array of strings or a filter function, but received "+typeof t)}build(){const t=this.getAllDirNamesUnderBase();return this.buildByDirNames(t)}};
+"use strict";var e,t=require("fs"),i=require("path");class r{static isValid(e){try{return t.accessSync(e,t.constants.F_OK),!0}catch{return!1}}static isDirectory(e){try{return t.statSync(e).isDirectory()}catch{return!1}}static isFile(e){try{return t.statSync(e).isFile()}catch{return!1}}}exports.PathTreeNodeKind=void 0,(e=exports.PathTreeNodeKind||(exports.PathTreeNodeKind={})).Dir="dir",e.File="file",e.Unknown="unknown";class s{constructor(e){this.base=e.base}getPath(){let e="",t=this;for(;t.parent;)e=e?`${t.value}${i.sep}${e}`:t.value,t=t.parent;return{relative:e,absolute:i.resolve(this.base,e)}}}exports.PathTreeify=class{constructor({filter:e,base:t,fileVisible:i}){if(this.fileVisible=!1,"boolean"==typeof i&&i&&(this.fileVisible=i),void 0!==e&&(this.validateFilter(e),this.userFilter=e),!t||!r.isValid(t))throw new Error(`${t} is not a valid path!`);if(!r.isDirectory(t))throw new Error(`${t} is not a dirPath!`);this.base=t,this.pathTreeNodeShared=new s({base:t})}applyFilter(e,t){return!(!this.fileVisible&&!r.isDirectory(e))&&(!this.userFilter||this.userFilter({name:t,dirPath:i.dirname(e)}))}validateFilter(e){if("function"!=typeof e)throw new TypeError("filter must be a function")}initNode(){const e=Object.create(this.pathTreeNodeShared);return e.parent=null,e.value="",e.children=[],e.type=exports.PathTreeNodeKind.Unknown,e}buildChildren(e,s){const n=[],o=t.readdirSync(e);for(const t of o){const o=i.join(e,t);if(!this.applyFilter(o,t))continue;const a=this.initNode();a.value=t,a.parent=s,n.push(a),this.fileVisible&&r.isFile(o)?a.type=exports.PathTreeNodeKind.File:(a.type=exports.PathTreeNodeKind.Dir,a.children=this.buildChildren(o,a))}return n}checkRelativePaths(e){if(!Array.isArray(e))throw new Error("Expected array, got "+typeof e);for(let t=0;t<e.length;t++){const s=e[t];if("string"!=typeof s)throw new Error(`Item at index ${t} is not a string, got ${typeof s}`);const n=i.resolve(this.base,s);if(!r.isValid(n))throw new Error(`Path does not exist or is not accessible: ${n} (from relative path: ${s})`);if(!(r.isDirectory(n)||this.fileVisible&&r.isFile(n)))throw new Error(`Path is not a directory: ${n} (from relative path: ${s})`)}}formatSegments(e){return e.map(e=>e.split(/[/\\]/).filter(Boolean).join(i.sep)).filter(Boolean)}getAllEntriesUnderBase(){return t.readdirSync(this.base).filter(e=>{const t=i.resolve(this.base,e);return this.applyFilter(t,e)})}buildBySegments(e){const t=this.initNode(),s=this.formatSegments(e);this.checkRelativePaths(s);for(const e of s){const s=i.resolve(this.base,e),n=this.initNode();n.value=e,n.parent=t,t.children.push(n),this.fileVisible&&r.isFile(s)?n.type=exports.PathTreeNodeKind.File:(n.type=exports.PathTreeNodeKind.Dir,n.children=this.buildChildren(s,n))}return t}buildByFilter(e){const t=this.getAllEntriesUnderBase();return this.buildBySegments(t.filter(e))}buildBy(e){if(Array.isArray(e))return this.buildBySegments(e);if("function"==typeof e)return this.buildByFilter(e);throw new TypeError("buildBy: expected an array of strings or a filter function, but received "+typeof e)}build(){const e=this.getAllEntriesUnderBase();return this.buildBySegments(e)}};

package/dist/index.mjs

@@ -1 +1 @@
-import{readdirSync as t,statSync as r,accessSync as e,constants as i}from"fs";import{join as s,resolve as a,sep as n}from"path";class o{static isValid(t){try{return e(t,i.F_OK),!0}catch{return!1}}static isDirectory(t){try{return r(t).isDirectory()}catch{return!1}}}class l{constructor(t){this.parent=null,this.value="",this.children=[],this.base=t}getPath(){let t="",r=this;for(;r.parent;)t=t?`${r.value}${n}${t}`:r.value,r=r.parent;return{relative:t,absolute:a(this.base,t)}}}class h{constructor({filter:t,base:r}){if(void 0!==t&&(this.validateFilter(t),this.filter=t),!r||!o.isValid(r))throw new Error(`${r} is not a valid path!`);if(!o.isDirectory(r))throw new Error(`${r} is not a dirPath!`);this.base=r}validateFilter(t){if("function"!=typeof t)throw new TypeError("filter must be a function");if(1!==t.length)throw new TypeError("filter must accept exactly one parameter");try{if("boolean"!=typeof t({name:"test",postPath:"/test"}))throw new TypeError("filter must return a boolean")}catch(t){throw new TypeError("filter function threw an error during test: "+t)}}initNode(t=null){const r=new l(this.base);return t&&(r.parent=t),r}buildChildren(e,i){const a=t(e),n=[];for(const t of a){const a=s(e,t);if(!r(a).isDirectory())continue;if(this.filter&&!this.filter({dirPath:e,name:t}))continue;const o=this.initNode();o.value=t,o.parent=i,o.children=this.buildChildren(a,o),n.push(o)}return n}checkRelativePaths(t){if(!Array.isArray(t))throw new Error("Expected array, got "+typeof t);for(let r=0;r<t.length;r++){const e=t[r];if("string"!=typeof e)throw new Error(`Item at index ${r} is not a string, got ${typeof e}`);const i=a(this.base,e);if(!o.isValid(i))throw new Error(`Path does not exist or is not accessible: ${i} (from relative path: ${e})`);if(!o.isDirectory(i))throw new Error(`Path is not a directory: ${i} (from relative path: ${e})`)}}formatDirnames(t){return t.map(t=>t.replace(/^\/+|\/+$/g,"")).filter(t=>""!==t)}getAllDirNamesUnderBase(){return t(this.base).filter(t=>{const r=a(this.base,t);return o.isDirectory(r)})}buildByDirNames(t){const r=this.initNode();this.checkRelativePaths(t);const e=this.formatDirnames(t);for(const t of e){const e=this.initNode();e.value=t,e.parent=r,e.children=this.buildChildren(a(this.base,t),e),r.children.push(e)}return r}buildByFilter(t){const r=this.getAllDirNamesUnderBase();return this.buildByDirNames(r.filter(t))}getPathBy(t){let r="",e=t;for(;e.parent;)r=r?`${e.value}${n}${r}`:e.value,e=e.parent;return{relative:r,absolute:a(this.base,r)}}buildBy(t){if(Array.isArray(t))return this.buildByDirNames(t);if("function"==typeof t)return this.buildByFilter(t);throw new TypeError("buildBy: expected an array of strings or a filter function, but received "+typeof t)}build(){const t=this.getAllDirNamesUnderBase();return this.buildByDirNames(t)}}export{h as PathTreeify};
+import{readdirSync as t,accessSync as e,constants as i,statSync as r}from"fs";import{dirname as s,join as n,resolve as l,sep as o}from"path";class a{static isValid(t){try{return e(t,i.F_OK),!0}catch{return!1}}static isDirectory(t){try{return r(t).isDirectory()}catch{return!1}}static isFile(t){try{return r(t).isFile()}catch{return!1}}}var h;!function(t){t.Dir="dir",t.File="file",t.Unknown="unknown"}(h||(h={}));class c{constructor(t){this.base=t.base}getPath(){let t="",e=this;for(;e.parent;)t=t?`${e.value}${o}${t}`:e.value,e=e.parent;return{relative:t,absolute:l(this.base,t)}}}class u{constructor({filter:t,base:e,fileVisible:i}){if(this.fileVisible=!1,"boolean"==typeof i&&i&&(this.fileVisible=i),void 0!==t&&(this.validateFilter(t),this.userFilter=t),!e||!a.isValid(e))throw new Error(`${e} is not a valid path!`);if(!a.isDirectory(e))throw new Error(`${e} is not a dirPath!`);this.base=e,this.pathTreeNodeShared=new c({base:e})}applyFilter(t,e){return!(!this.fileVisible&&!a.isDirectory(t))&&(!this.userFilter||this.userFilter({name:e,dirPath:s(t)}))}validateFilter(t){if("function"!=typeof t)throw new TypeError("filter must be a function")}initNode(){const t=Object.create(this.pathTreeNodeShared);return t.parent=null,t.value="",t.children=[],t.type=h.Unknown,t}buildChildren(e,i){const r=[],s=t(e);for(const t of s){const s=n(e,t);if(!this.applyFilter(s,t))continue;const l=this.initNode();l.value=t,l.parent=i,r.push(l),this.fileVisible&&a.isFile(s)?l.type=h.File:(l.type=h.Dir,l.children=this.buildChildren(s,l))}return r}checkRelativePaths(t){if(!Array.isArray(t))throw new Error("Expected array, got "+typeof t);for(let e=0;e<t.length;e++){const i=t[e];if("string"!=typeof i)throw new Error(`Item at index ${e} is not a string, got ${typeof i}`);const r=l(this.base,i);if(!a.isValid(r))throw new Error(`Path does not exist or is not accessible: ${r} (from relative path: ${i})`);if(!(a.isDirectory(r)||this.fileVisible&&a.isFile(r)))throw new Error(`Path is not a directory: ${r} (from relative path: ${i})`)}}formatSegments(t){return t.map(t=>t.split(/[/\\]/).filter(Boolean).join(o)).filter(Boolean)}getAllEntriesUnderBase(){return t(this.base).filter(t=>{const e=l(this.base,t);return this.applyFilter(e,t)})}buildBySegments(t){const e=this.initNode(),i=this.formatSegments(t);this.checkRelativePaths(i);for(const t of i){const i=l(this.base,t),r=this.initNode();r.value=t,r.parent=e,e.children.push(r),this.fileVisible&&a.isFile(i)?r.type=h.File:(r.type=h.Dir,r.children=this.buildChildren(i,r))}return e}buildByFilter(t){const e=this.getAllEntriesUnderBase();return this.buildBySegments(e.filter(t))}buildBy(t){if(Array.isArray(t))return this.buildBySegments(t);if("function"==typeof t)return this.buildByFilter(t);throw new TypeError("buildBy: expected an array of strings or a filter function, but received "+typeof t)}build(){const t=this.getAllEntriesUnderBase();return this.buildBySegments(t)}}export{h as PathTreeNodeKind,u as PathTreeify};

package/dist/types/index.d.ts

@@ -1,93 +1,128 @@
-/** A filter function that determines whether a directory should be included in the tree */
+/** A filter function that determines whether an entry should be included in the tree */
 type FilterFunction = (params: {
     name: string;
     dirPath: string;
 }) => boolean;
 /** Constructor options for PathTreeify */
 interface PathTreeifyProps {
+    /** The root directory to scan */
     base: string;
+    /** Optional filter applied to every entry during recursive traversal */
     filter?: FilterFunction;
+    /** When true, files are included as leaf nodes alongside directories. Defaults to false */
+    fileVisible?: boolean;
 }
-/** Represents a single node (directory) in the path tree */
-declare class PathTreeNode {
-    /** The root base path used to resolve absolute paths */
-    private base;
+/** Classification of a node in the path tree */
+export declare enum PathTreeNodeKind {
+    Dir = "dir",
+    File = "file",
+    /** Assigned before the node's type has been resolved */
+    Unknown = "unknown"
+}
+/**
+ * Public interface for a node in the path tree.
+ * Consumers receive this type; the internal implementation class is not exported.
+ */
+export interface PathTreeNode {
     /** Reference to the parent node; null for the root node */
     parent: PathTreeNode | null;
-    /** The directory name of this node (not a full path) */
+    /** The entry name of this node (not a full path) */
     value: string;
-    /** Child nodes representing subdirectories */
+    /** Child nodes; non-empty only for directory nodes */
     children: PathTreeNode[];
-    constructor(base: string);
+    /** Whether this node is a directory, a file, or not yet resolved */
+    type: PathTreeNodeKind;
     /**
-     * Walks up the parent chain to compute this node's relative and absolute paths.
-     * @returns An object containing the relative path from base and the absolute path
+     * Walks up the parent chain to compute this node's paths.
+     * @returns `relative` — path from the tree root; `absolute` — fully resolved path on disk
      */
     getPath(): {
         relative: string;
         absolute: string;
     };
 }
-/** Builds a tree of directory nodes rooted at a given base path */
+/** Builds a tree of {@link PathTreeNode} entries rooted at a given base path */
 export declare class PathTreeify {
     /** The root directory to scan */
     private base;
-    /** Optional filter applied to each directory during traversal */
-    private filter?;
-    constructor({ filter, base }: Partial<PathTreeifyProps>);
     /**
-     * Validates that the provided filter is a function, accepts one parameter,
-     * and returns a boolean. Throws a TypeError if any condition is violated.
+     * Shared prototype instance for nodes produced by this builder.
+     * All nodes created via {@link initNode} inherit `base` and `getPath` from this object,
+     * avoiding per-node storage of the base path string.
+     */
+    private pathTreeNodeShared;
+    /**
+     * Optional user-supplied filter. When set, every entry must pass this predicate
+     * in addition to the built-in visibility check.
+     */
+    private userFilter?;
+    /** When true, files are included as leaf nodes during traversal. Defaults to false */
+    private fileVisible;
+    constructor({ filter, base, fileVisible }: Partial<PathTreeifyProps>);
+    /**
+     * Determines whether a given entry should be included in the tree.
+     * - If {@link fileVisible} is false, non-directory entries are always excluded.
+     * - If a {@link userFilter} is set, the entry must also satisfy it.
+     * @param absPath - Absolute path of the entry to test
+     * @param name - Entry name (filename or directory name)
+     */
+    private applyFilter;
+    /**
+     * Asserts that the provided value is a callable {@link FilterFunction}.
+     * Throws a TypeError if the check fails.
      */
     private validateFilter;
     /**
-     * Creates and optionally attaches a new PathTreeNode to a parent.
-     * @param parent - The parent node to attach to, or null for the root
+     * Creates a new unattached {@link PathTreeNode}.
+     * The node's prototype is set to {@link pathTreeNodeShared} so that `base` and
+     * `getPath` are inherited without being stored on each instance individually.
      */
     private initNode;
     /**
-     * Recursively reads a directory and builds child nodes for each subdirectory.
-     * Applies the instance-level filter if one is set.
+     * Recursively reads {@link dirPath} and builds child nodes for each entry that
+     * passes {@link applyFilter}. Directories are traversed depth-first;
+     * files (when {@link fileVisible} is true) become leaf nodes.
      * @param dirPath - Absolute path of the directory to read
-     * @param parent - The parent node to attach children to
+     * @param parent - The parent node to attach child nodes to
      */
     private buildChildren;
     /**
-     * Validates that each entry in the array is a string pointing to
-     * an accessible directory relative to the base path.
-     * @param relativeDirNames - Array of relative directory path strings to validate
+     * Validates that every entry in {@link relativeSegments} refers to an accessible
+     * path under {@link base}. When {@link fileVisible} is false, each path must be
+     * a directory; when true, regular files are also accepted.
+     * @param relativeSegments - Relative path strings to validate
      */
     private checkRelativePaths;
     /**
-     * Strips leading and trailing slashes from each directory name
-     * and removes any resulting empty strings.
+     * Normalises an array of path strings by splitting on both slash styles,
+     * dropping empty segments, and rejoining with the platform separator.
+     * Entries that reduce to an empty string (e.g. `"///"`) are removed.
+     * @param segments - Raw path strings to normalise
      */
-    private formatDirnames;
-    /** Returns the names of all immediate subdirectories under the base path */
-    private getAllDirNamesUnderBase;
+    private formatSegments;
     /**
-     * Builds a tree rooted at base, containing only the specified subdirectories.
-     * @param dirNames - Relative directory names to include as top-level nodes
+     * Returns the names of all immediate entries under {@link base} that pass
+     * {@link applyFilter}.
      */
-    private buildByDirNames;
+    private getAllEntriesUnderBase;
     /**
-     * Builds a tree using only the subdirectories under base that pass the given filter.
-     * @param filter - A predicate applied to each top-level directory name
+     * Builds a subtree containing only the entries identified by {@link segments}.
+     * Paths are normalised via {@link formatSegments} and validated before use.
+     * @param segments - Relative paths to include as top-level nodes
      */
-    private buildByFilter;
+    private buildBySegments;
     /**
-     * Computes the relative and absolute paths for a given node
-     * by walking up the parent chain.
+     * Builds a subtree from top-level entries whose names satisfy {@link filter}.
+     * Note: this predicate only affects top-level selection, not recursive traversal.
+     * For recursive filtering use the `filter` constructor option.
+     * @param filter - Predicate applied to each top-level entry name
      */
-    getPathBy(node: PathTreeNode): {
-        relative: string;
-        absolute: string;
-    };
-    /** Overload: build the tree from an explicit list of relative directory names */
-    buildBy(dirNames: string[]): PathTreeNode;
-    /** Overload: build the tree from a predicate applied to top-level directory names */
-    buildBy(filter: (dirName: string) => boolean): PathTreeNode;
-    /** Builds a full tree from all immediate subdirectories under the base path */
+    private buildByFilter;
+    /** Overload: build the tree from an explicit list of relative path segments */
+    buildBy(segments: string[]): PathTreeNode;
+    /** Overload: build the tree from a predicate applied to top-level entry names */
+    buildBy(filter: (segment: string) => boolean): PathTreeNode;
+    /** Builds a full tree from all immediate entries under the base path */
     build(): PathTreeNode;
 }
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "path-treeify",
-  "version": "1.2.0",
+  "version": "1.3.0-beta.1a88b75",
   "description": "Convert a path or an array of paths into a tree-structured JavaScript object, where each node has a `parent` property that holds a circular reference to its parent node.",
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",
@@ -24,8 +24,11 @@
     "dist/**/*.d.ts"
   ],
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1",
-    "clean": "rimraf ./dist",
+    "test": "ava",
+    "test:coverage": "c8 ava",
+    "test:junit": "mkdir -p reports && ava --tap | tap-xunit --package=path-treeify > reports/junit.xml",
+    "test:report": "rimraf reports && npm run test:coverage && npm run test:junit",
+    "clean": "rimraf dist",
     "build": "npm run clean && rollup -c",
     "build:dev": "NODE_ENV=development npm run build",
     "build:prod": "NODE_ENV=production npm run build",
@@ -34,6 +37,29 @@
     "publish:beta": "npm publish --tag beta --access public",
     "publish:latest": "npm publish --tag latest --access public"
   },
+  "ava": {
+    "files": [
+      "tests/**/*.mjs"
+    ],
+    "nodeArguments": [
+      "--experimental-vm-modules"
+    ]
+  },
+  "c8": {
+    "reports-dir": "reports/coverage",
+    "reporter": [
+      "html",
+      "lcov"
+    ],
+    "exclude": [
+      "tests/**",
+      "node_modules/**"
+    ],
+    "lines": 80,
+    "statements": 80,
+    "functions": 80,
+    "branches": 75
+  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/isaaxite/path-treeify.git"
@@ -62,10 +88,14 @@
     "@rollup/plugin-terser": "^1.0.0",
     "@rollup/plugin-typescript": "^12.3.0",
     "@types/node": "^25.5.0",
+    "ava": "^7.0.0",
+    "c8": "^11.0.0",
     "nodemon": "^3.1.14",
     "rimraf": "^6.1.3",
     "rollup": "^4.59.0",
+    "tap-xunit": "^2.4.1",
     "tslib": "^2.8.1",
+    "tsx": "^4.21.0",
     "typescript": "^5.9.3"
   },
   "engines": {