@isdk/util 0.3.7 → 0.3.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (65) hide show
  1. package/dist/index.d.mts +85 -31
  2. package/dist/index.d.ts +85 -31
  3. package/dist/index.js +1 -1
  4. package/dist/index.mjs +1 -1
  5. package/docs/classes/BinarySemaphore.md +25 -25
  6. package/docs/classes/ConfigFile.md +6 -6
  7. package/docs/classes/Deque.md +13 -13
  8. package/docs/classes/IntSet.md +12 -12
  9. package/docs/classes/Semaphore.md +26 -26
  10. package/docs/classes/SignalGate.md +9 -9
  11. package/docs/functions/RateLimit.md +1 -1
  12. package/docs/functions/arrayHasAll.md +1 -1
  13. package/docs/functions/extNameLevel.md +1 -1
  14. package/docs/functions/extractCodeBlock.md +22 -62
  15. package/docs/functions/extractTopLevelCodeBlocks.md +37 -0
  16. package/docs/functions/filenameReservedRegex.md +1 -1
  17. package/docs/functions/findPort.md +13 -5
  18. package/docs/functions/getMultiLevelExtname.md +1 -1
  19. package/docs/functions/glob.md +1 -1
  20. package/docs/functions/isStringIn.md +1 -1
  21. package/docs/functions/isValidFilename.md +1 -1
  22. package/docs/functions/isValidFilepath.md +1 -1
  23. package/docs/functions/normalizeIncludeFiles.md +1 -1
  24. package/docs/functions/omitDeepBy.md +1 -1
  25. package/docs/functions/omitEmptyDeep.md +1 -1
  26. package/docs/functions/parseCodeBlockSelector.md +34 -0
  27. package/docs/functions/parseFrontMatter.md +1 -1
  28. package/docs/functions/parseYaml.md +1 -1
  29. package/docs/functions/reControlCharsRegex.md +1 -1
  30. package/docs/functions/registerYamlTag.md +1 -1
  31. package/docs/functions/removeLeadingEmptyLines.md +1 -1
  32. package/docs/functions/sanitizeFilename.md +1 -1
  33. package/docs/functions/sanitizeFilepath.md +1 -1
  34. package/docs/functions/sleep.md +1 -1
  35. package/docs/functions/stringifyYaml.md +1 -1
  36. package/docs/functions/toCamelCase.md +1 -1
  37. package/docs/functions/toCapitalCase.md +1 -1
  38. package/docs/functions/toPascalCase.md +1 -1
  39. package/docs/functions/traverseFolder.md +1 -1
  40. package/docs/functions/traverseFolderSync.md +1 -1
  41. package/docs/functions/yieldExec.md +1 -1
  42. package/docs/globals.md +5 -0
  43. package/docs/interfaces/BinarySemaphoreAcquireOptions.md +2 -2
  44. package/docs/interfaces/BinarySemaphoreOptions.md +5 -5
  45. package/docs/interfaces/BinarySemaphoreReleaseOptions.md +2 -2
  46. package/docs/interfaces/BinarySemaphoreReleaserFunc.md +3 -3
  47. package/docs/interfaces/CodeBlockSelectorPart.md +36 -0
  48. package/docs/interfaces/CodeString.md +3 -3
  49. package/docs/interfaces/ExtractCodeBlockOptions.md +27 -6
  50. package/docs/interfaces/FindPortOptions.md +25 -0
  51. package/docs/interfaces/IncludeFiles.md +3 -3
  52. package/docs/interfaces/LoadConfigFileOptions.md +3 -3
  53. package/docs/interfaces/SanitizeFilenameOptions.md +3 -3
  54. package/docs/interfaces/SemaphoreOptions.md +7 -7
  55. package/docs/interfaces/SemaphoreTaskItem.md +5 -5
  56. package/docs/type-aliases/CodeBlockCombinator.md +18 -0
  57. package/docs/type-aliases/SemaphoreIsReadyFuncType.md +1 -1
  58. package/docs/type-aliases/StringifyFunc.md +1 -1
  59. package/docs/type-aliases/TraverseFolderHandler.md +1 -1
  60. package/docs/type-aliases/TraverseFolderSyncHandler.md +1 -1
  61. package/docs/variables/DefaultAllTextFiles.md +1 -1
  62. package/docs/variables/DefaultAsyncSemaphoreCapacity.md +1 -1
  63. package/docs/variables/FilenameReservedRegex.md +1 -1
  64. package/docs/variables/WindowsReservedNameRegex.md +1 -1
  65. package/package.json +1 -1
package/docs/interfaces/SemaphoreTaskItem.md CHANGED
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: SemaphoreTaskItem
8
8
 
9
- Defined in: [src/async-semaphore.ts:52](https://github.com/isdk/util.js/blob/20d48780d60e0a0a6f6a696a3efdfa46d4cb3b1e/src/async-semaphore.ts#L52)
9
+ Defined in: [src/async-semaphore.ts:52](https://github.com/isdk/util.js/blob/30c54a8a455a9593000448de2a45f94a197d73de/src/async-semaphore.ts#L52)
10
10
 
11
11
  ## Extends
12
12
 
@@ -22,7 +22,7 @@ Defined in: [src/async-semaphore.ts:52](https://github.com/isdk/util.js/blob/20d
22
22
 
23
23
  > **reject**: (`reason?`) => `void`
24
24
 
25
- Defined in: [src/async-semaphore.ts:54](https://github.com/isdk/util.js/blob/20d48780d60e0a0a6f6a696a3efdfa46d4cb3b1e/src/async-semaphore.ts#L54)
25
+ Defined in: [src/async-semaphore.ts:54](https://github.com/isdk/util.js/blob/30c54a8a455a9593000448de2a45f94a197d73de/src/async-semaphore.ts#L54)
26
26
 
27
27
  #### Parameters
28
28
 
@@ -40,7 +40,7 @@ Defined in: [src/async-semaphore.ts:54](https://github.com/isdk/util.js/blob/20d
40
40
 
41
41
  > **resolve**: (`value`) => `void`
42
42
 
43
- Defined in: [src/async-semaphore.ts:53](https://github.com/isdk/util.js/blob/20d48780d60e0a0a6f6a696a3efdfa46d4cb3b1e/src/async-semaphore.ts#L53)
43
+ Defined in: [src/async-semaphore.ts:53](https://github.com/isdk/util.js/blob/30c54a8a455a9593000448de2a45f94a197d73de/src/async-semaphore.ts#L53)
44
44
 
45
45
  #### Parameters
46
46
 
@@ -58,7 +58,7 @@ Defined in: [src/async-semaphore.ts:53](https://github.com/isdk/util.js/blob/20d
58
58
 
59
59
  > `optional` **signal**: `AbortSignal`
60
60
 
61
- Defined in: [src/async-semaphore.ts:29](https://github.com/isdk/util.js/blob/20d48780d60e0a0a6f6a696a3efdfa46d4cb3b1e/src/async-semaphore.ts#L29)
61
+ Defined in: [src/async-semaphore.ts:29](https://github.com/isdk/util.js/blob/30c54a8a455a9593000448de2a45f94a197d73de/src/async-semaphore.ts#L29)
62
62
 
63
63
  #### Inherited from
64
64
 
@@ -70,4 +70,4 @@ Defined in: [src/async-semaphore.ts:29](https://github.com/isdk/util.js/blob/20d
70
70
 
71
71
  > `optional` **token**: `any`
72
72
 
73
- Defined in: [src/async-semaphore.ts:55](https://github.com/isdk/util.js/blob/20d48780d60e0a0a6f6a696a3efdfa46d4cb3b1e/src/async-semaphore.ts#L55)
73
+ Defined in: [src/async-semaphore.ts:55](https://github.com/isdk/util.js/blob/30c54a8a455a9593000448de2a45f94a197d73de/src/async-semaphore.ts#L55)
package/docs/type-aliases/CodeBlockCombinator.md ADDED
@@ -0,0 +1,18 @@
1
+ [**@isdk/util**](../README.md)
2
+
3
+ ***
4
+
5
+ [@isdk/util](../globals.md) / CodeBlockCombinator
6
+
7
+ # Type Alias: CodeBlockCombinator
8
+
9
+ > **CodeBlockCombinator** = `">"` \| `" "` \| `"+"` \| `"~"`
10
+
11
+ Defined in: [src/extract-code-block.ts:29](https://github.com/isdk/util.js/blob/30c54a8a455a9593000448de2a45f94a197d73de/src/extract-code-block.ts#L29)
12
+
13
+ Supported combinators for code block selectors.
14
+
15
+ - `>` (Direct Child): Matches top-level code blocks within the current context.
16
+ - ` ` (Descendant): Matches all code blocks within the current context, including deeply nested ones. (Planned)
17
+ - `+` (Adjacent Sibling): Matches the very next code block at the same nesting level. (Planned)
18
+ - `~` (General Sibling): Matches all subsequent code blocks at the same nesting level. (Planned)
package/docs/type-aliases/SemaphoreIsReadyFuncType.md CHANGED
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **SemaphoreIsReadyFuncType** = () => `Promise`\<`boolean`\> \| `boolean`
10
10
 
11
- Defined in: [src/async-semaphore.ts:11](https://github.com/isdk/util.js/blob/20d48780d60e0a0a6f6a696a3efdfa46d4cb3b1e/src/async-semaphore.ts#L11)
11
+ Defined in: [src/async-semaphore.ts:11](https://github.com/isdk/util.js/blob/30c54a8a455a9593000448de2a45f94a197d73de/src/async-semaphore.ts#L11)
12
12
 
13
13
  ## Returns
14
14
 
package/docs/type-aliases/StringifyFunc.md CHANGED
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **StringifyFunc** = (`content`) => `string`
10
10
 
11
- Defined in: [src/config-file.ts:18](https://github.com/isdk/util.js/blob/20d48780d60e0a0a6f6a696a3efdfa46d4cb3b1e/src/config-file.ts#L18)
11
+ Defined in: [src/config-file.ts:18](https://github.com/isdk/util.js/blob/30c54a8a455a9593000448de2a45f94a197d73de/src/config-file.ts#L18)
12
12
 
13
13
  ## Parameters
14
14
 
package/docs/type-aliases/TraverseFolderHandler.md CHANGED
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **TraverseFolderHandler** = (`filePath`, `entry`) => `boolean` \| `void` \| `Promise`\<`boolean` \| `void`\>
10
10
 
11
- Defined in: [src/traverse-folder.ts:11](https://github.com/isdk/util.js/blob/20d48780d60e0a0a6f6a696a3efdfa46d4cb3b1e/src/traverse-folder.ts#L11)
11
+ Defined in: [src/traverse-folder.ts:11](https://github.com/isdk/util.js/blob/30c54a8a455a9593000448de2a45f94a197d73de/src/traverse-folder.ts#L11)
12
12
 
13
13
  A handler function for asynchronous folder traversal.
14
14
 
package/docs/type-aliases/TraverseFolderSyncHandler.md CHANGED
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **TraverseFolderSyncHandler** = (`filePath`, `entry`) => `boolean` \| `void`
10
10
 
11
- Defined in: [src/traverse-folder.ts:21](https://github.com/isdk/util.js/blob/20d48780d60e0a0a6f6a696a3efdfa46d4cb3b1e/src/traverse-folder.ts#L21)
11
+ Defined in: [src/traverse-folder.ts:21](https://github.com/isdk/util.js/blob/30c54a8a455a9593000448de2a45f94a197d73de/src/traverse-folder.ts#L21)
12
12
 
13
13
  A handler function for synchronous folder traversal.
14
14
 
package/docs/variables/DefaultAllTextFiles.md CHANGED
@@ -8,4 +8,4 @@
8
8
 
9
9
  > `const` **DefaultAllTextFiles**: `string`[]
10
10
 
11
- Defined in: [src/include-files.ts:1](https://github.com/isdk/util.js/blob/20d48780d60e0a0a6f6a696a3efdfa46d4cb3b1e/src/include-files.ts#L1)
11
+ Defined in: [src/include-files.ts:1](https://github.com/isdk/util.js/blob/30c54a8a455a9593000448de2a45f94a197d73de/src/include-files.ts#L1)
package/docs/variables/DefaultAsyncSemaphoreCapacity.md CHANGED
@@ -8,4 +8,4 @@
8
8
 
9
9
  > `const` **DefaultAsyncSemaphoreCapacity**: `32` = `32`
10
10
 
11
- Defined in: [src/async-semaphore.ts:9](https://github.com/isdk/util.js/blob/20d48780d60e0a0a6f6a696a3efdfa46d4cb3b1e/src/async-semaphore.ts#L9)
11
+ Defined in: [src/async-semaphore.ts:9](https://github.com/isdk/util.js/blob/30c54a8a455a9593000448de2a45f94a197d73de/src/async-semaphore.ts#L9)
package/docs/variables/FilenameReservedRegex.md CHANGED
@@ -8,7 +8,7 @@
8
8
 
9
9
  > `const` **FilenameReservedRegex**: `RegExp`
10
10
 
11
- Defined in: [src/filename.ts:9](https://github.com/isdk/util.js/blob/20d48780d60e0a0a6f6a696a3efdfa46d4cb3b1e/src/filename.ts#L9)
11
+ Defined in: [src/filename.ts:9](https://github.com/isdk/util.js/blob/30c54a8a455a9593000448de2a45f94a197d73de/src/filename.ts#L9)
12
12
 
13
13
  Regular expression pattern for reserved characters in a filename.
14
14
  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 CHANGED
@@ -8,6 +8,6 @@
8
8
 
9
9
  > `const` **WindowsReservedNameRegex**: `RegExp`
10
10
 
11
- Defined in: [src/filename.ts:14](https://github.com/isdk/util.js/blob/20d48780d60e0a0a6f6a696a3efdfa46d4cb3b1e/src/filename.ts#L14)
11
+ Defined in: [src/filename.ts:14](https://github.com/isdk/util.js/blob/30c54a8a455a9593000448de2a45f94a197d73de/src/filename.ts#L14)
12
12
 
13
13
  Regular expression pattern for reserved names on Windows systems.
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@isdk/util",
3
3
  "description": "a set of utility functions",
4
- "version": "0.3.7",
4
+ "version": "0.3.9",
5
5
  "author": "Riceball LEE @snowyu",
6
6
  "bugs": "https://github.com/isdk/util.js/issues",
7
7
  "dependencies": {