@isdk/util 0.1.1

package/docs/functions/stringifyYaml.md

@@ -0,0 +1,45 @@
+[**@isdk/util**](../README.md)
+
+***
+
+[@isdk/util](../globals.md) / stringifyYaml
+
+# Function: stringifyYaml()
+
+> **stringifyYaml**(`content`, `options`?): `string`
+
+Defined in: [yaml.ts:85](https://github.com/isdk/util.js/blob/9d50730dc10248681409cd2901eedc5302b8836b/src/yaml.ts#L85)
+
+Converts a JavaScript object into a YAML string with optional custom tags.
+
+## Parameters
+
+### content
+
+`any`
+
+The JavaScript object to convert to YAML.
+
+### options?
+
+`DocumentOptions` & `SchemaOptions` & `ParseOptions` & `CreateNodeOptions` & `ToStringOptions`
+
+Optional stringification options, including custom tags.
+
+## Returns
+
+`string`
+
+The YAML string representation of the input object.
+
+## Example
+
+```typescript
+import { stringifyYaml } from './yaml';
+
+const data = {
+  example: 'value',
+};
+const yamlString = stringifyYaml(data);
+console.log(yamlString); // "example: value\n"
+```

package/docs/functions/traverseFolder.md

@@ -0,0 +1,44 @@
+[**@isdk/util**](../README.md)
+
+***
+
+[@isdk/util](../globals.md) / traverseFolder
+
+# Function: traverseFolder()
+
+> **traverseFolder**(`directoryPath`, `fileHandler`): `Promise`\<`void`\>
+
+Defined in: [traverse-folder.ts:38](https://github.com/isdk/util.js/blob/9d50730dc10248681409cd2901eedc5302b8836b/src/traverse-folder.ts#L38)
+
+Traverses a folder asynchronously and applies a handler to each file or directory.
+
+## Parameters
+
+### directoryPath
+
+`string`
+
+The root directory to start traversal.
+
+### fileHandler
+
+[`TraverseFolderHandler`](../type-aliases/TraverseFolderHandler.md)
+
+A handler function called for each file/directory.
+
+## Returns
+
+`Promise`\<`void`\>
+
+## Example
+
+```typescript
+await traverseFolder('/path/to/folder', async (filePath, entry) => {
+  console.log(`Found: ${filePath}`);
+  if (entry.name === 'stopfile.txt') {
+    console.log('Stopping traversal...');
+    return true; // Stops further traversal
+  }
+  return false; // Continues traversal
+});
+```

package/docs/functions/traverseFolderSync.md

@@ -0,0 +1,44 @@
+[**@isdk/util**](../README.md)
+
+***
+
+[@isdk/util](../globals.md) / traverseFolderSync
+
+# Function: traverseFolderSync()
+
+> **traverseFolderSync**(`directoryPath`, `fileHandler`): `void`
+
+Defined in: [traverse-folder.ts:66](https://github.com/isdk/util.js/blob/9d50730dc10248681409cd2901eedc5302b8836b/src/traverse-folder.ts#L66)
+
+Traverses a folder synchronously and applies a handler to each file or directory.
+
+## Parameters
+
+### directoryPath
+
+`string`
+
+The root directory to start traversal.
+
+### fileHandler
+
+[`TraverseFolderSyncHandler`](../type-aliases/TraverseFolderSyncHandler.md)
+
+A handler function called for each file/directory.
+
+## Returns
+
+`void`
+
+## Example
+
+```typescript
+traverseFolderSync('/path/to/folder', (filePath, entry) => {
+  console.log(`Found: ${filePath}`);
+  if (entry.name === 'stopfile.txt') {
+    console.log('Stopping traversal...');
+    return true; // Stops further traversal
+  }
+  return false; // Continues traversal
+});
+```

package/docs/globals.md

@@ -0,0 +1,36 @@
+[**@isdk/util**](README.md)
+
+***
+
+# @isdk/util
+
+## Classes
+
+- [ConfigFile](classes/ConfigFile.md)
+
+## Interfaces
+
+- [IncludeFiles](interfaces/IncludeFiles.md)
+
+## Type Aliases
+
+- [TraverseFolderHandler](type-aliases/TraverseFolderHandler.md)
+- [TraverseFolderSyncHandler](type-aliases/TraverseFolderSyncHandler.md)
+
+## Variables
+
+- [DefaultAllTextFiles](variables/DefaultAllTextFiles.md)
+
+## Functions
+
+- [getMultiLevelExtname](functions/getMultiLevelExtname.md)
+- [glob](functions/glob.md)
+- [isStringIn](functions/isStringIn.md)
+- [normalizeIncludeFiles](functions/normalizeIncludeFiles.md)
+- [parseFrontMatter](functions/parseFrontMatter.md)
+- [parseYaml](functions/parseYaml.md)
+- [registerYamlTag](functions/registerYamlTag.md)
+- [removeLeadingEmptyLines](functions/removeLeadingEmptyLines.md)
+- [stringifyYaml](functions/stringifyYaml.md)
+- [traverseFolder](functions/traverseFolder.md)
+- [traverseFolderSync](functions/traverseFolderSync.md)

package/docs/interfaces/IncludeFiles.md

@@ -0,0 +1,25 @@
+[**@isdk/util**](../README.md)
+
+***
+
+[@isdk/util](../globals.md) / IncludeFiles
+
+# Interface: IncludeFiles
+
+Defined in: [include-files.ts:6](https://github.com/isdk/util.js/blob/9d50730dc10248681409cd2901eedc5302b8836b/src/include-files.ts#L6)
+
+## Properties
+
+### exclude?
+
+> `optional` **exclude**: `string`[]
+
+Defined in: [include-files.ts:8](https://github.com/isdk/util.js/blob/9d50730dc10248681409cd2901eedc5302b8836b/src/include-files.ts#L8)
+
+***
+
+### include?
+
+> `optional` **include**: `string`[]
+
+Defined in: [include-files.ts:7](https://github.com/isdk/util.js/blob/9d50730dc10248681409cd2901eedc5302b8836b/src/include-files.ts#L7)

package/docs/type-aliases/TraverseFolderHandler.md

@@ -0,0 +1,33 @@
+[**@isdk/util**](../README.md)
+
+***
+
+[@isdk/util](../globals.md) / TraverseFolderHandler
+
+# Type Alias: TraverseFolderHandler()
+
+> **TraverseFolderHandler** = (`filePath`, `entry`) => `boolean` \| `void` \| `Promise`\<`boolean` \| `void`\>
+
+Defined in: [traverse-folder.ts:11](https://github.com/isdk/util.js/blob/9d50730dc10248681409cd2901eedc5302b8836b/src/traverse-folder.ts#L11)
+
+A handler function for asynchronous folder traversal.
+
+## Parameters
+
+### filePath
+
+`string`
+
+The full path of the file or directory.
+
+### entry
+
+`Dirent`
+
+The directory entry (file or folder).
+
+## Returns
+
+`boolean` \| `void` \| `Promise`\<`boolean` \| `void`\>
+
+Returns `true` to stop further traversal, or `false`/`void` to continue.

package/docs/type-aliases/TraverseFolderSyncHandler.md

@@ -0,0 +1,33 @@
+[**@isdk/util**](../README.md)
+
+***
+
+[@isdk/util](../globals.md) / TraverseFolderSyncHandler
+
+# Type Alias: TraverseFolderSyncHandler()
+
+> **TraverseFolderSyncHandler** = (`filePath`, `entry`) => `boolean` \| `void`
+
+Defined in: [traverse-folder.ts:18](https://github.com/isdk/util.js/blob/9d50730dc10248681409cd2901eedc5302b8836b/src/traverse-folder.ts#L18)
+
+A handler function for synchronous folder traversal.
+
+## Parameters
+
+### filePath
+
+`string`
+
+The full path of the file or directory.
+
+### entry
+
+`Dirent`
+
+The directory entry (file or folder).
+
+## Returns
+
+`boolean` \| `void`
+
+Returns `true` to stop further traversal, or `false` to continue.

package/docs/variables/DefaultAllTextFiles.md

@@ -0,0 +1,11 @@
+[**@isdk/util**](../README.md)
+
+***
+
+[@isdk/util](../globals.md) / DefaultAllTextFiles
+
+# Variable: DefaultAllTextFiles
+
+> `const` **DefaultAllTextFiles**: `string`[]
+
+Defined in: [include-files.ts:1](https://github.com/isdk/util.js/blob/9d50730dc10248681409cd2901eedc5302b8836b/src/include-files.ts#L1)

package/package.json

@@ -0,0 +1,68 @@
+{
+  "name": "@isdk/util",
+  "description": "a set of utility functions",
+  "version": "0.1.1",
+  "author": "Riceball LEE @snowyu",
+  "bugs": "https://github.com/isdk/util.js/issues",
+  "dependencies": {
+    "@isdk/glob": "^0.1.0",
+    "load-config-file": "2.0.0",
+    "yaml": "^2.7.0"
+  },
+  "devDependencies": {
+    "@eslint/eslintrc": "^3.3.1",
+    "@eslint/js": "^9.23.0",
+    "@types/chai": "^5",
+    "@types/jest": "^29.5.14",
+    "@types/node": "^18",
+    "eslint": "^9",
+    "eslint-config-prettier": "^10",
+    "shx": "^0.3.3",
+    "terser": "^5.39.0",
+    "tsup": "^8.4.0",
+    "tsx": "^4.19.3",
+    "typedoc": "^0.28.1",
+    "typedoc-plugin-markdown": "^4.6.0",
+    "typescript": "^5.7.3",
+    "typescript-eslint": "^8.28.0",
+    "vite": "^6.2.3",
+    "vitest": "^3.0.9"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "files": [
+    "docs",
+    "dist"
+  ],
+  "homepage": "https://github.com/isdk/util.js",
+  "keywords": [],
+  "license": "MIT",
+  "main": "dist/index.js",
+  "module": "./dist/index.mjs",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "require": "./dist/index.js",
+      "import": "./dist/index.mjs"
+    }
+  },
+  "repository": "isdk/util.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build-fast": "tsup",
+    "build": "pnpm run build-fast --dts-resolve --dts && pnpm run doc:md",
+    "clean": "rm -fr docs dist",
+    "doc": "typedoc --plugin none --out web",
+    "doc:md": "typedoc --plugin typedoc-plugin-markdown --out docs",
+    "style": "pnpm run format -c && pnpm run lint",
+    "style:fix": "pnpm run format:fix && pnpm run lint:fix",
+    "format": "prettier \"**/*.{ts,tsx,js,jsx,css,scss,sass,less,md}\"",
+    "format:fix": "pnpm run format --write",
+    "lint": "eslint .",
+    "lint:fix": "pnpm run lint --fix",
+    "test": "vitest run",
+    "release": "pnpm run clean && pnpm run build && git add -f docs && git ci -m 'docs: update API docs' && pnpm dlx commit-and-tag-version -s",
+    "release.alpha": "pnpm run release -- --prerelease alpha"
+  }
+}