@isdk/util 0.3.6 → 0.3.8

package/docs/interfaces/ExtractCodeBlockOptions.md

@@ -0,0 +1,64 @@
+[**@isdk/util**](../README.md)
+
+***
+
+[@isdk/util](../globals.md) / ExtractCodeBlockOptions
+
+# Interface: ExtractCodeBlockOptions
+
+Defined in: [src/extract-code-block.ts:53](https://github.com/isdk/util.js/blob/2279f0b4363625d4cd214e9bab0415d49b594498/src/extract-code-block.ts#L53)
+
+Options for extracting code blocks.
+
+## Properties
+
+### all?
+
+> `optional` **all**: `boolean`
+
+Defined in: [src/extract-code-block.ts:71](https://github.com/isdk/util.js/blob/2279f0b4363625d4cd214e9bab0415d49b594498/src/extract-code-block.ts#L71)
+
+Optional. If true, returns an array of all matching code blocks.
+
+***
+
+### index?
+
+> `optional` **index**: `number`
+
+Defined in: [src/extract-code-block.ts:67](https://github.com/isdk/util.js/blob/2279f0b4363625d4cd214e9bab0415d49b594498/src/extract-code-block.ts#L67)
+
+Optional. The 0-based index of the code block to extract from the final result set.
+Supports negative indexing: -1 means the last one, -2 means the second to last, etc.
+Defaults to -1.
+
+***
+
+### lang?
+
+> `optional` **lang**: `string`
+
+Defined in: [src/extract-code-block.ts:61](https://github.com/isdk/util.js/blob/2279f0b4363625d4cd214e9bab0415d49b594498/src/extract-code-block.ts#L61)
+
+Optional. The expected language identifier or a CSS-like selector path.
+Supports aliases (e.g., 'js' for 'javascript').
+
+#### Examples
+
+```ts
+'ts' - Find the last TypeScript block.
+```
+
+```ts
+'md > ts' - Find ts blocks inside md blocks.
+```
+
+***
+
+### langMap?
+
+> `optional` **langMap**: `Record`\<`string`, `string`\>
+
+Defined in: [src/extract-code-block.ts:75](https://github.com/isdk/util.js/blob/2279f0b4363625d4cd214e9bab0415d49b594498/src/extract-code-block.ts#L75)
+
+Optional. A map of language aliases to their normalized names.

package/docs/interfaces/IncludeFiles.md

@@ -6,7 +6,7 @@
 
 # Interface: IncludeFiles
 
-Defined in: [src/include-files.ts:6](https://github.com/isdk/util.js/blob/61856e5b1bbb9d976eeb1fdfe1a4d88a26997dec/src/include-files.ts#L6)
+Defined in: [src/include-files.ts:6](https://github.com/isdk/util.js/blob/2279f0b4363625d4cd214e9bab0415d49b594498/src/include-files.ts#L6)
 
 ## Properties
 
@@ -14,7 +14,7 @@ Defined in: [src/include-files.ts:6](https://github.com/isdk/util.js/blob/61856e
 
 > `optional` **exclude**: `string`[]
 
-Defined in: [src/include-files.ts:8](https://github.com/isdk/util.js/blob/61856e5b1bbb9d976eeb1fdfe1a4d88a26997dec/src/include-files.ts#L8)
+Defined in: [src/include-files.ts:8](https://github.com/isdk/util.js/blob/2279f0b4363625d4cd214e9bab0415d49b594498/src/include-files.ts#L8)
 
 ***
 
@@ -22,4 +22,4 @@ Defined in: [src/include-files.ts:8](https://github.com/isdk/util.js/blob/61856e
 
 > `optional` **include**: `string`[]
 
-Defined in: [src/include-files.ts:7](https://github.com/isdk/util.js/blob/61856e5b1bbb9d976eeb1fdfe1a4d88a26997dec/src/include-files.ts#L7)
+Defined in: [src/include-files.ts:7](https://github.com/isdk/util.js/blob/2279f0b4363625d4cd214e9bab0415d49b594498/src/include-files.ts#L7)

package/docs/interfaces/LoadConfigFileOptions.md

@@ -6,7 +6,7 @@
 
 # Interface: LoadConfigFileOptions
 
-Defined in: [src/config-file.ts:20](https://github.com/isdk/util.js/blob/61856e5b1bbb9d976eeb1fdfe1a4d88a26997dec/src/config-file.ts#L20)
+Defined in: [src/config-file.ts:20](https://github.com/isdk/util.js/blob/2279f0b4363625d4cd214e9bab0415d49b594498/src/config-file.ts#L20)
 
 ## Properties
 
@@ -14,7 +14,7 @@ Defined in: [src/config-file.ts:20](https://github.com/isdk/util.js/blob/61856e5
 
 > `optional` **externalFile**: `string`
 
-Defined in: [src/config-file.ts:22](https://github.com/isdk/util.js/blob/61856e5b1bbb9d976eeb1fdfe1a4d88a26997dec/src/config-file.ts#L22)
+Defined in: [src/config-file.ts:22](https://github.com/isdk/util.js/blob/2279f0b4363625d4cd214e9bab0415d49b594498/src/config-file.ts#L22)
 
 ***
 
@@ -22,4 +22,4 @@ Defined in: [src/config-file.ts:22](https://github.com/isdk/util.js/blob/61856e5
 
 > `optional` **extLevel**: `number`
 
-Defined in: [src/config-file.ts:21](https://github.com/isdk/util.js/blob/61856e5b1bbb9d976eeb1fdfe1a4d88a26997dec/src/config-file.ts#L21)
+Defined in: [src/config-file.ts:21](https://github.com/isdk/util.js/blob/2279f0b4363625d4cd214e9bab0415d49b594498/src/config-file.ts#L21)

package/docs/interfaces/SanitizeFilenameOptions.md

@@ -6,7 +6,7 @@
 
 # Interface: SanitizeFilenameOptions
 
-Defined in: [src/filename.ts:83](https://github.com/isdk/util.js/blob/61856e5b1bbb9d976eeb1fdfe1a4d88a26997dec/src/filename.ts#L83)
+Defined in: [src/filename.ts:96](https://github.com/isdk/util.js/blob/2279f0b4363625d4cd214e9bab0415d49b594498/src/filename.ts#L96)
 
 ## Properties
 
@@ -14,7 +14,7 @@ Defined in: [src/filename.ts:83](https://github.com/isdk/util.js/blob/61856e5b1b
 
 > `optional` **maxLength**: `number`
 
-Defined in: [src/filename.ts:85](https://github.com/isdk/util.js/blob/61856e5b1bbb9d976eeb1fdfe1a4d88a26997dec/src/filename.ts#L85)
+Defined in: [src/filename.ts:98](https://github.com/isdk/util.js/blob/2279f0b4363625d4cd214e9bab0415d49b594498/src/filename.ts#L98)
 
 ***
 
@@ -22,4 +22,4 @@ Defined in: [src/filename.ts:85](https://github.com/isdk/util.js/blob/61856e5b1b
 
 > `optional` **replacement**: `string`
 
-Defined in: [src/filename.ts:84](https://github.com/isdk/util.js/blob/61856e5b1bbb9d976eeb1fdfe1a4d88a26997dec/src/filename.ts#L84)
+Defined in: [src/filename.ts:97](https://github.com/isdk/util.js/blob/2279f0b4363625d4cd214e9bab0415d49b594498/src/filename.ts#L97)

package/docs/interfaces/SemaphoreOptions.md

@@ -6,7 +6,7 @@
 
 # Interface: SemaphoreOptions
 
-Defined in: [src/async-semaphore.ts:42](https://github.com/isdk/util.js/blob/61856e5b1bbb9d976eeb1fdfe1a4d88a26997dec/src/async-semaphore.ts#L42)
+Defined in: [src/async-semaphore.ts:42](https://github.com/isdk/util.js/blob/2279f0b4363625d4cd214e9bab0415d49b594498/src/async-semaphore.ts#L42)
 
 ## Extends
 
@@ -18,7 +18,7 @@ Defined in: [src/async-semaphore.ts:42](https://github.com/isdk/util.js/blob/618
 
 > `optional` **capacity**: `number`
 
-Defined in: [src/async-semaphore.ts:25](https://github.com/isdk/util.js/blob/61856e5b1bbb9d976eeb1fdfe1a4d88a26997dec/src/async-semaphore.ts#L25)
+Defined in: [src/async-semaphore.ts:25](https://github.com/isdk/util.js/blob/2279f0b4363625d4cd214e9bab0415d49b594498/src/async-semaphore.ts#L25)
 
 #### Inherited from
 
@@ -30,7 +30,7 @@ Defined in: [src/async-semaphore.ts:25](https://github.com/isdk/util.js/blob/618
 
 > `optional` **initFn**: () => `any`
 
-Defined in: [src/async-semaphore.ts:22](https://github.com/isdk/util.js/blob/61856e5b1bbb9d976eeb1fdfe1a4d88a26997dec/src/async-semaphore.ts#L22)
+Defined in: [src/async-semaphore.ts:22](https://github.com/isdk/util.js/blob/2279f0b4363625d4cd214e9bab0415d49b594498/src/async-semaphore.ts#L22)
 
 #### Returns
 
@@ -46,7 +46,7 @@ Defined in: [src/async-semaphore.ts:22](https://github.com/isdk/util.js/blob/618
 
 > `optional` **isReadyFn**: [`SemaphoreIsReadyFuncType`](../type-aliases/SemaphoreIsReadyFuncType.md)
 
-Defined in: [src/async-semaphore.ts:44](https://github.com/isdk/util.js/blob/61856e5b1bbb9d976eeb1fdfe1a4d88a26997dec/src/async-semaphore.ts#L44)
+Defined in: [src/async-semaphore.ts:44](https://github.com/isdk/util.js/blob/2279f0b4363625d4cd214e9bab0415d49b594498/src/async-semaphore.ts#L44)
 
 ***
 
@@ -54,7 +54,7 @@ Defined in: [src/async-semaphore.ts:44](https://github.com/isdk/util.js/blob/618
 
 > `optional` **maxConcurrency**: `number`
 
-Defined in: [src/async-semaphore.ts:43](https://github.com/isdk/util.js/blob/61856e5b1bbb9d976eeb1fdfe1a4d88a26997dec/src/async-semaphore.ts#L43)
+Defined in: [src/async-semaphore.ts:43](https://github.com/isdk/util.js/blob/2279f0b4363625d4cd214e9bab0415d49b594498/src/async-semaphore.ts#L43)
 
 ***
 
@@ -62,7 +62,7 @@ Defined in: [src/async-semaphore.ts:43](https://github.com/isdk/util.js/blob/618
 
 > `optional` **pauseFn**: () => `void`
 
-Defined in: [src/async-semaphore.ts:23](https://github.com/isdk/util.js/blob/61856e5b1bbb9d976eeb1fdfe1a4d88a26997dec/src/async-semaphore.ts#L23)
+Defined in: [src/async-semaphore.ts:23](https://github.com/isdk/util.js/blob/2279f0b4363625d4cd214e9bab0415d49b594498/src/async-semaphore.ts#L23)
 
 #### Returns
 
@@ -78,7 +78,7 @@ Defined in: [src/async-semaphore.ts:23](https://github.com/isdk/util.js/blob/618
 
 > `optional` **resumeFn**: () => `void`
 
-Defined in: [src/async-semaphore.ts:24](https://github.com/isdk/util.js/blob/61856e5b1bbb9d976eeb1fdfe1a4d88a26997dec/src/async-semaphore.ts#L24)
+Defined in: [src/async-semaphore.ts:24](https://github.com/isdk/util.js/blob/2279f0b4363625d4cd214e9bab0415d49b594498/src/async-semaphore.ts#L24)
 
 #### Returns
 

package/docs/interfaces/SemaphoreTaskItem.md

@@ -6,7 +6,7 @@
 
 # Interface: SemaphoreTaskItem
 
-Defined in: [src/async-semaphore.ts:52](https://github.com/isdk/util.js/blob/61856e5b1bbb9d976eeb1fdfe1a4d88a26997dec/src/async-semaphore.ts#L52)
+Defined in: [src/async-semaphore.ts:52](https://github.com/isdk/util.js/blob/2279f0b4363625d4cd214e9bab0415d49b594498/src/async-semaphore.ts#L52)
 
 ## Extends
 
@@ -22,7 +22,7 @@ Defined in: [src/async-semaphore.ts:52](https://github.com/isdk/util.js/blob/618
 
 > **reject**: (`reason?`) => `void`
 
-Defined in: [src/async-semaphore.ts:54](https://github.com/isdk/util.js/blob/61856e5b1bbb9d976eeb1fdfe1a4d88a26997dec/src/async-semaphore.ts#L54)
+Defined in: [src/async-semaphore.ts:54](https://github.com/isdk/util.js/blob/2279f0b4363625d4cd214e9bab0415d49b594498/src/async-semaphore.ts#L54)
 
 #### Parameters
 
@@ -40,7 +40,7 @@ Defined in: [src/async-semaphore.ts:54](https://github.com/isdk/util.js/blob/618
 
 > **resolve**: (`value`) => `void`
 
-Defined in: [src/async-semaphore.ts:53](https://github.com/isdk/util.js/blob/61856e5b1bbb9d976eeb1fdfe1a4d88a26997dec/src/async-semaphore.ts#L53)
+Defined in: [src/async-semaphore.ts:53](https://github.com/isdk/util.js/blob/2279f0b4363625d4cd214e9bab0415d49b594498/src/async-semaphore.ts#L53)
 
 #### Parameters
 
@@ -58,7 +58,7 @@ Defined in: [src/async-semaphore.ts:53](https://github.com/isdk/util.js/blob/618
 
 > `optional` **signal**: `AbortSignal`
 
-Defined in: [src/async-semaphore.ts:29](https://github.com/isdk/util.js/blob/61856e5b1bbb9d976eeb1fdfe1a4d88a26997dec/src/async-semaphore.ts#L29)
+Defined in: [src/async-semaphore.ts:29](https://github.com/isdk/util.js/blob/2279f0b4363625d4cd214e9bab0415d49b594498/src/async-semaphore.ts#L29)
 
 #### Inherited from
 
@@ -70,4 +70,4 @@ Defined in: [src/async-semaphore.ts:29](https://github.com/isdk/util.js/blob/618
 
 > `optional` **token**: `any`
 
-Defined in: [src/async-semaphore.ts:55](https://github.com/isdk/util.js/blob/61856e5b1bbb9d976eeb1fdfe1a4d88a26997dec/src/async-semaphore.ts#L55)
+Defined in: [src/async-semaphore.ts:55](https://github.com/isdk/util.js/blob/2279f0b4363625d4cd214e9bab0415d49b594498/src/async-semaphore.ts#L55)

package/docs/type-aliases/CodeBlockCombinator.md

@@ -0,0 +1,18 @@
+[**@isdk/util**](../README.md)
+
+***
+
+[@isdk/util](../globals.md) / CodeBlockCombinator
+
+# Type Alias: CodeBlockCombinator
+
+> **CodeBlockCombinator** = `">"` \| `" "` \| `"+"` \| `"~"`
+
+Defined in: [src/extract-code-block.ts:29](https://github.com/isdk/util.js/blob/2279f0b4363625d4cd214e9bab0415d49b594498/src/extract-code-block.ts#L29)
+
+Supported combinators for code block selectors.
+
+- `>` (Direct Child): Matches top-level code blocks within the current context.
+- ` ` (Descendant): Matches all code blocks within the current context, including deeply nested ones. (Planned)
+- `+` (Adjacent Sibling): Matches the very next code block at the same nesting level. (Planned)
+- `~` (General Sibling): Matches all subsequent code blocks at the same nesting level. (Planned)

package/docs/type-aliases/SemaphoreIsReadyFuncType.md

@@ -8,7 +8,7 @@
 
 > **SemaphoreIsReadyFuncType** = () => `Promise`\<`boolean`\> \| `boolean`
 
-Defined in: [src/async-semaphore.ts:11](https://github.com/isdk/util.js/blob/61856e5b1bbb9d976eeb1fdfe1a4d88a26997dec/src/async-semaphore.ts#L11)
+Defined in: [src/async-semaphore.ts:11](https://github.com/isdk/util.js/blob/2279f0b4363625d4cd214e9bab0415d49b594498/src/async-semaphore.ts#L11)
 
 ## Returns
 

package/docs/type-aliases/StringifyFunc.md

@@ -8,7 +8,7 @@
 
 > **StringifyFunc** = (`content`) => `string`
 
-Defined in: [src/config-file.ts:18](https://github.com/isdk/util.js/blob/61856e5b1bbb9d976eeb1fdfe1a4d88a26997dec/src/config-file.ts#L18)
+Defined in: [src/config-file.ts:18](https://github.com/isdk/util.js/blob/2279f0b4363625d4cd214e9bab0415d49b594498/src/config-file.ts#L18)
 
 ## Parameters
 

package/docs/type-aliases/TraverseFolderHandler.md

@@ -8,7 +8,7 @@
 
 > **TraverseFolderHandler** = (`filePath`, `entry`) => `boolean` \| `void` \| `Promise`\<`boolean` \| `void`\>
 
-Defined in: [src/traverse-folder.ts:11](https://github.com/isdk/util.js/blob/61856e5b1bbb9d976eeb1fdfe1a4d88a26997dec/src/traverse-folder.ts#L11)
+Defined in: [src/traverse-folder.ts:11](https://github.com/isdk/util.js/blob/2279f0b4363625d4cd214e9bab0415d49b594498/src/traverse-folder.ts#L11)
 
 A handler function for asynchronous folder traversal.
 

package/docs/type-aliases/TraverseFolderSyncHandler.md

@@ -8,7 +8,7 @@
 
 > **TraverseFolderSyncHandler** = (`filePath`, `entry`) => `boolean` \| `void`
 
-Defined in: [src/traverse-folder.ts:18](https://github.com/isdk/util.js/blob/61856e5b1bbb9d976eeb1fdfe1a4d88a26997dec/src/traverse-folder.ts#L18)
+Defined in: [src/traverse-folder.ts:21](https://github.com/isdk/util.js/blob/2279f0b4363625d4cd214e9bab0415d49b594498/src/traverse-folder.ts#L21)
 
 A handler function for synchronous folder traversal.
 

package/docs/variables/DefaultAllTextFiles.md

@@ -8,4 +8,4 @@
 
 > `const` **DefaultAllTextFiles**: `string`[]
 
-Defined in: [src/include-files.ts:1](https://github.com/isdk/util.js/blob/61856e5b1bbb9d976eeb1fdfe1a4d88a26997dec/src/include-files.ts#L1)
+Defined in: [src/include-files.ts:1](https://github.com/isdk/util.js/blob/2279f0b4363625d4cd214e9bab0415d49b594498/src/include-files.ts#L1)

package/docs/variables/DefaultAsyncSemaphoreCapacity.md

@@ -8,4 +8,4 @@
 
 > `const` **DefaultAsyncSemaphoreCapacity**: `32` = `32`
 
-Defined in: [src/async-semaphore.ts:9](https://github.com/isdk/util.js/blob/61856e5b1bbb9d976eeb1fdfe1a4d88a26997dec/src/async-semaphore.ts#L9)
+Defined in: [src/async-semaphore.ts:9](https://github.com/isdk/util.js/blob/2279f0b4363625d4cd214e9bab0415d49b594498/src/async-semaphore.ts#L9)

package/docs/variables/FilenameReservedRegex.md

@@ -8,7 +8,7 @@
 
 > `const` **FilenameReservedRegex**: `RegExp`
 
-Defined in: [src/filename.ts:8](https://github.com/isdk/util.js/blob/61856e5b1bbb9d976eeb1fdfe1a4d88a26997dec/src/filename.ts#L8)
+Defined in: [src/filename.ts:9](https://github.com/isdk/util.js/blob/2279f0b4363625d4cd214e9bab0415d49b594498/src/filename.ts#L9)
 
 Regular expression pattern for reserved characters in a filename.
 do not use /g global option here: when the regex is executed multiple times, it will always begin where it left off last time.

package/docs/variables/WindowsReservedNameRegex.md

@@ -8,6 +8,6 @@
 
 > `const` **WindowsReservedNameRegex**: `RegExp`
 
-Defined in: [src/filename.ts:13](https://github.com/isdk/util.js/blob/61856e5b1bbb9d976eeb1fdfe1a4d88a26997dec/src/filename.ts#L13)
+Defined in: [src/filename.ts:14](https://github.com/isdk/util.js/blob/2279f0b4363625d4cd214e9bab0415d49b594498/src/filename.ts#L14)
 
 Regular expression pattern for reserved names on Windows systems.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@isdk/util",
   "description": "a set of utility functions",
-  "version": "0.3.6",
+  "version": "0.3.8",
   "author": "Riceball LEE @snowyu",
   "bugs": "https://github.com/isdk/util.js/issues",
   "dependencies": {
@@ -22,6 +22,7 @@
     "@types/node": "^25",
     "eslint": "^10",
     "eslint-config-prettier": "^10",
+    "prettier": "^3.8.1",
     "shx": "^0.4.0",
     "terser": "^5.46.0",
     "tsup": "^8.5.1",