@hardlydifficult/collections 1.0.4 → 1.0.6

package/README.md

@@ -1,6 +1,6 @@
 # @hardlydifficult/collections
 
-Array chunking and path depth grouping utilities for batched parallel processing.
+A TypeScript utility library providing array chunking and path depth grouping functions.
 
 ## Installation
 
@@ -13,118 +13,69 @@ npm install @hardlydifficult/collections
 ```typescript
 import { chunk, groupByDepth } from "@hardlydifficult/collections";
 
-// Split an array into fixed-size chunks
+// Split an array into chunks
 const items = [1, 2, 3, 4, 5];
-const chunks = chunk(items, 2);
-// => [[1, 2], [3, 4], [5]]
+console.log(chunk(items, 2)); 
+// → [[1, 2], [3, 4], [5]]
 
-// Group filesystem paths by directory depth (deepest first)
+// Group filesystem paths by directory depth
 const paths = ["src/app", "src", "src/utils/helper"];
-const grouped = groupByDepth(paths);
-// => [
-//      { depth: 3, paths: ["src/app"] },
-//      { depth: 1, paths: ["src"] }
-//    ]
+console.log(groupByDepth(paths));
+// → [{ depth: 3, paths: ["src/app"] }, { depth: 2, paths: ["src"] }, { depth: 1, paths: ["src/utils/helper"] }]
 ```
 
-Process items in parallel batches using chunking:
+## Chunk Arrays
 
-```typescript
-import { chunk } from "@hardlydifficult/collections";
-
-const items = [1, 2, 3, 4, 5, 6, 7];
-const batches = chunk(items, 3);
-// [[1, 2, 3], [4, 5, 6], [7]]
-
-for (const batch of batches) {
-  await Promise.allSettled(batch.map(processItem));
-}
-```
-
-## Array Utilities
-
-### chunk
-
-Splits an array into sub-arrays of a specified maximum size.
-
-```typescript
-chunk<T>(arr: readonly T[], size: number): T[][]
-```
-
-| Parameter | Type              | Description                         |
-|-----------|-------------------|-------------------------------------|
-| `arr`     | `readonly T[]`    | The array to split                  |
-| `size`    | `number`          | Maximum size of each sub-array      |
+Split an array into fixed-size subarrays.
 
-The final chunk may be smaller than the specified size. Useful for limiting concurrency in batched operations.
+### `chunk`
 
-**Examples:**
-- **Full-sized chunks only**: `chunk([1,2,3,4,5,6], 2)` → `[[1,2], [3,4], [5,6]]`
-- **Final smaller chunk**: `chunk([1,2,3,4,5], 3)` → `[[1,2,3], [4,5]]`
-- **Single oversized chunk**: `chunk([1,2,3], 5)` → `[[1,2,3]]`
-- **Empty input**: `chunk([], 3)` → `[]`
+Splits an array into chunks of a specified maximum size. The last chunk may be smaller than the requested size.
 
 ```typescript
 import { chunk } from "@hardlydifficult/collections";
 
 const result = chunk([1, 2, 3, 4, 5, 6, 7], 3);
-// => [[1, 2, 3], [4, 5, 6], [7]]
+// → [[1, 2, 3], [4, 5, 6], [7]]
 ```
 
-## Path Utilities
+**Signature**
 
-### groupByDepth
+| Parameter | Type              | Description              |
+|-----------|-------------------|--------------------------|
+| `arr`     | `readonly T[]`    | Input array to chunk     |
+| `size`    | `number`          | Maximum chunk size       |
+| **Returns** | `T[][]`         | Array of subarrays       |
 
-Groups path strings by their slash-separated depth, sorted deepest-first for bottom-up directory processing.
+## Group Paths by Depth
 
-```typescript
-groupByDepth(paths: readonly string[]): { depth: number; paths: string[] }[]
-```
-
-| Parameter | Type              | Description                        |
-|-----------|-------------------|------------------------------------|
-| `paths`   | `readonly string[]` | Filesystem paths to group         |
-
-The depth is determined by counting slash-separated segments (e.g., `"a/b/c"` has depth `3`). Empty string `""` is treated as depth `0`.
-
-**Rules:**
-- An empty string (`""`) is treated as depth `0` (root)
-- Each `/` increases depth by 1
-- Paths are grouped by depth, and groups are sorted deepest-first
-
-**Examples:**
+Organize filesystem paths by slash-delimited depth, sorted deepest-first for bottom-up directory processing.
 
-- **Mixed depths**:
-  ```typescript
-  groupByDepth(["a/b/c", "a/b", "a", ""]);
-  // [
-  //   { depth: 3, paths: ["a/b/c"] },
-  //   { depth: 2, paths: ["a/b"] },
-  //   { depth: 1, paths: ["a"] },
-  //   { depth: 0, paths: [""] },
-  // ]
-  ```
+### `groupByDepth`
 
-- **Same depth grouping**:
-  ```typescript
-  groupByDepth(["x/y", "a/b", "m/n"]);
-  // [{ depth: 2, paths: ["x/y", "a/b", "m/n"] }]
-  ```
-
-- **Empty input**: `groupByDepth([])` → `[]`
+Groups an array of path strings by the number of `/`-separated segments. Paths with deeper nesting appear first in the result, enabling bottom-up processing.
 
 ```typescript
 import { groupByDepth } from "@hardlydifficult/collections";
 
-const dirs = ["src/services/summarize", "src/services", "src", "src/utils"];
-const grouped = groupByDepth(dirs);
-// [
-//   { depth: 3, paths: ["src/services/summarize"] },
-//   { depth: 2, paths: ["src/services", "src/utils"] },
-//   { depth: 1, paths: ["src"] },
+const paths = ["src/app/index.ts", "src/app", "src", "README.md"];
+const result = groupByDepth(paths);
+// → [
+//   { depth: 3, paths: ["src/app/index.ts"] },
+//   { depth: 2, paths: ["src/app"] },
+//   { depth: 1, paths: ["src", "README.md"] }
 // ]
+```
+
+**Signature**
+
+| Parameter | Type               | Description                        |
+|-----------|--------------------|------------------------------------|
+| `paths`   | `readonly string[]`| Array of path strings              |
+| **Returns** | `{ depth: number; paths: string[] }[]` | Groups sorted deepest-first |
+
+**Notes**
 
-for (const { paths: dirsAtDepth } of grouped) {
-  await Promise.allSettled(dirsAtDepth.map(summarizeDir));
-}
-```
+- Empty string paths (`""`) are assigned depth `0`.
+- Paths are grouped in descending order of depth (deepest first).
+- Order of paths within each depth group matches their appearance in the input array.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hardlydifficult/collections",
-  "version": "1.0.4",
+  "version": "1.0.6",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "files": [