@isdk/util 0.1.1

package/dist/traverse-folder.test.mjs

@@ -0,0 +1 @@
+import{traverseFolder as t,traverseFolderSync as e}from"./chunk-46TT3NZV.mjs";import{vi as r}from"./chunk-LOMQZH4U.mjs";import{init_esm_shims as s}from"./chunk-UJZVJIGI.mjs";s();import{Dirent as o,readdirSync as i}from"fs";import{readdir as c}from"fs/promises";import n from"path";var a=o;r.mock("fs/promises",(()=>({readdir:r.fn()}))),r.mock("fs",(()=>({readdirSync:r.fn(),Dirent:class{constructor(t){this.isFile=()=>!0,this.name=t}}}))),describe("traverseFolder",(()=>{it("should traverse all files and directories asynchronously",(async()=>{const e=[new a("file1.txt"),new a("file2.txt"),new a("subdir")];c.mockResolvedValue(e);const s=r.fn().mockImplementation((()=>!1));await t("/mock/path",s),expect(s).toHaveBeenCalledTimes(3),expect(s).toHaveBeenCalledWith(n.join("/mock/path","file1.txt"),e[0]),expect(s).toHaveBeenCalledWith(n.join("/mock/path","file2.txt"),e[1]),expect(s).toHaveBeenCalledWith(n.join("/mock/path","subdir"),e[2])})),it("should stop traversal when handler returns true",(async()=>{const e=[new a("file1.txt"),new a("file2.txt"),new a("file3.txt")];c.mockResolvedValue(e);const s=r.fn().mockImplementation((t=>t.endsWith("file2.txt")));await t("/mock/path",s),expect(s).toHaveBeenCalledTimes(2)}))})),describe("traverseFolderSync",(()=>{it("should traverse all files and directories synchronously",(()=>{const t=[new a("file1.txt"),new a("file2.txt"),new a("subdir")];i.mockReturnValue(t);const s=r.fn().mockImplementation((()=>!1));e("/mock/path",s),expect(s).toHaveBeenCalledTimes(3),expect(s).toHaveBeenCalledWith(n.join("/mock/path","file1.txt"),t[0]),expect(s).toHaveBeenCalledWith(n.join("/mock/path","file2.txt"),t[1]),expect(s).toHaveBeenCalledWith(n.join("/mock/path","subdir"),t[2])})),it("should stop traversal when handler returns true",(()=>{const t=[new a("file1.txt"),new a("file2.txt"),new a("file3.txt")];i.mockReturnValue(t);const s=r.fn().mockImplementation((t=>t.endsWith("file2.txt")));e("/mock/path",s),expect(s).toHaveBeenCalledTimes(2)}))}));

package/dist/yaml.d.mts

@@ -0,0 +1,59 @@
+import { ParseOptions, DocumentOptions, SchemaOptions, ToJSOptions, CreateNodeOptions, ToStringOptions } from 'yaml';
+
+/**
+ * Registers custom YAML tags to be used in parsing and stringifying YAML content.
+ *
+ * @param tags - A single tag or an array of tags to register.
+ *
+ * @example
+ * ```typescript
+ * import { registerYamlTag } from './yaml';
+ *
+ * const customTag = {
+ *   tag: '!custom',
+ *   resolve: (value) => `resolved-${value}`,
+ * };
+ * registerYamlTag(customTag);
+ * ```
+ */
+declare function registerYamlTag(tags: any): void;
+/**
+ * Parses a YAML string into a JavaScript object with optional custom tags.
+ *
+ * @param content - The YAML string to parse.
+ * @param options - Optional parsing options, including custom tags.
+ * @returns The parsed JavaScript object.
+ *
+ * @example
+ * ```typescript
+ * import { parseYaml } from './yaml';
+ *
+ * const yamlContent = `
+ *   example: !custom value
+ * `;
+ * const result = parseYaml(yamlContent);
+ * console.log(result); // { example: 'resolved-value' }
+ * ```
+ */
+declare function parseYaml(content: string, options?: ParseOptions & DocumentOptions & SchemaOptions & ToJSOptions): any;
+/**
+ * Converts a JavaScript object into a YAML string with optional custom tags.
+ *
+ * @param content - The JavaScript object to convert to YAML.
+ * @param options - Optional stringification options, including custom tags.
+ * @returns 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"
+ * ```
+ */
+declare function stringifyYaml(content: any, options?: DocumentOptions & SchemaOptions & ParseOptions & CreateNodeOptions & ToStringOptions): string;
+
+export { parseYaml, registerYamlTag, stringifyYaml };

package/dist/yaml.d.ts

@@ -0,0 +1,59 @@
+import { ParseOptions, DocumentOptions, SchemaOptions, ToJSOptions, CreateNodeOptions, ToStringOptions } from 'yaml';
+
+/**
+ * Registers custom YAML tags to be used in parsing and stringifying YAML content.
+ *
+ * @param tags - A single tag or an array of tags to register.
+ *
+ * @example
+ * ```typescript
+ * import { registerYamlTag } from './yaml';
+ *
+ * const customTag = {
+ *   tag: '!custom',
+ *   resolve: (value) => `resolved-${value}`,
+ * };
+ * registerYamlTag(customTag);
+ * ```
+ */
+declare function registerYamlTag(tags: any): void;
+/**
+ * Parses a YAML string into a JavaScript object with optional custom tags.
+ *
+ * @param content - The YAML string to parse.
+ * @param options - Optional parsing options, including custom tags.
+ * @returns The parsed JavaScript object.
+ *
+ * @example
+ * ```typescript
+ * import { parseYaml } from './yaml';
+ *
+ * const yamlContent = `
+ *   example: !custom value
+ * `;
+ * const result = parseYaml(yamlContent);
+ * console.log(result); // { example: 'resolved-value' }
+ * ```
+ */
+declare function parseYaml(content: string, options?: ParseOptions & DocumentOptions & SchemaOptions & ToJSOptions): any;
+/**
+ * Converts a JavaScript object into a YAML string with optional custom tags.
+ *
+ * @param content - The JavaScript object to convert to YAML.
+ * @param options - Optional stringification options, including custom tags.
+ * @returns 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"
+ * ```
+ */
+declare function stringifyYaml(content: any, options?: DocumentOptions & SchemaOptions & ParseOptions & CreateNodeOptions & ToStringOptions): string;
+
+export { parseYaml, registerYamlTag, stringifyYaml };

package/dist/yaml.js

@@ -0,0 +1 @@
+"use strict";var e,t=Object.defineProperty,r=Object.getOwnPropertyDescriptor,f=Object.getOwnPropertyNames,o=Object.prototype.hasOwnProperty,n={};((e,r)=>{for(var f in r)t(e,f,{get:r[f],enumerable:!0})})(n,{parseYaml:()=>a,registerYamlTag:()=>u,stringifyYaml:()=>c}),module.exports=(e=n,((e,n,i,s)=>{if(n&&"object"==typeof n||"function"==typeof n)for(let u of f(n))o.call(e,u)||u===i||t(e,u,{get:()=>n[u],enumerable:!(s=r(n,u))||s.enumerable});return e})(t({},"__esModule",{value:!0}),e));var i=require("yaml"),s=[];function u(e){Array.isArray(e)||(e=[e]);for(const t of e){-1===s.indexOf(t)&&s.push(t)}}function a(e,t){if(t)if(t.customTags){if(Array.isArray(t.customTags))t.customTags=s.concat(t.customTags);else if("function"==typeof t.customTags){const e=t.customTags;t.customTags=t=>e(s.concat(t))}}else t.customTags=s;else t={customTags:s};return(0,i.parse)(e,t)}function c(e,t){if(t)if(t.customTags){if(Array.isArray(t.customTags))t.customTags=s.concat(t.customTags);else if("function"==typeof t.customTags){const e=t.customTags;t.customTags=t=>e(s.concat(t))}}else t.customTags=s;else t={customTags:s};return(0,i.stringify)(e,t)}

package/dist/yaml.mjs

@@ -0,0 +1 @@
+import{parseYaml as m,registerYamlTag as o,stringifyYaml as r}from"./chunk-OTEAFARC.mjs";import"./chunk-UJZVJIGI.mjs";export{m as parseYaml,o as registerYamlTag,r as stringifyYaml};

package/docs/README.md

@@ -0,0 +1,10 @@
+**@isdk/util**
+
+***
+
+# Utility Functions
+
+This package provides a set of utility functions.
+
+[![Version](https://img.shields.io/npm/v/@isdk/util.svg)](https://npmjs.org/package/@isdk/util)
+[![Downloads/week](https://img.shields.io/npm/dw/@isdk/util.svg)](https://npmjs.org/package/@isdk/util)

package/docs/classes/ConfigFile.md

@@ -0,0 +1,169 @@
+[**@isdk/util**](../README.md)
+
+***
+
+[@isdk/util](../globals.md) / ConfigFile
+
+# Class: ConfigFile
+
+Defined in: [config-file.ts:45](https://github.com/isdk/util.js/blob/9d50730dc10248681409cd2901eedc5302b8836b/src/config-file.ts#L45)
+
+Represents a configuration file utility class that provides methods to load and save configuration files.
+It supports multiple file formats such as YAML, JSON, etc., by registering corresponding parsers and stringifiers.
+
+## Example
+
+```typescript
+// Register a custom file type handler
+ConfigFile.register('.custom', (content) => {
+  return { data: content.toUpperCase() }; // Example parser
+}, (obj) => {
+  return obj.data.toLowerCase(); // Example stringifier
+});
+
+// Save a configuration file
+ConfigFile.save('config.custom', { key: 'value' });
+
+// Load a configuration file
+const config = ConfigFile.load('config.custom');
+console.log(config); // Output: { key: 'value' }
+```
+
+## Constructors
+
+### Constructor
+
+> **new ConfigFile**(): `ConfigFile`
+
+#### Returns
+
+`ConfigFile`
+
+## Properties
+
+### stringifys
+
+> `static` **stringifys**: `Record`\<`string`, `StringifyFunc`\> = `{}`
+
+Defined in: [config-file.ts:49](https://github.com/isdk/util.js/blob/9d50730dc10248681409cd2901eedc5302b8836b/src/config-file.ts#L49)
+
+A record of registered stringify functions for different file extensions.
+
+## Methods
+
+### load()
+
+> `static` **load**(`filename`, `options`?): `any`
+
+Defined in: [config-file.ts:84](https://github.com/isdk/util.js/blob/9d50730dc10248681409cd2901eedc5302b8836b/src/config-file.ts#L84)
+
+Loads a configuration file based on the provided filename and options.
+
+#### Parameters
+
+##### filename
+
+`string`
+
+The path to the configuration file.
+
+##### options?
+
+`LoadConfigFileOptions`
+
+Additional options for loading the configuration file.
+
+#### Returns
+
+`any`
+
+The parsed configuration object.
+
+#### Example
+
+```typescript
+const config = ConfigFile.load('config.yaml');
+console.log(config); // Output: { key: 'value' }
+```
+
+***
+
+### register()
+
+> `static` **register**(`extname`, `parser`, `stringify`): `void`
+
+Defined in: [config-file.ts:63](https://github.com/isdk/util.js/blob/9d50730dc10248681409cd2901eedc5302b8836b/src/config-file.ts#L63)
+
+Registers a parser and stringifier for specific file extensions.
+
+#### Parameters
+
+##### extname
+
+The file extension(s) to register the parser and stringifier for.
+
+`string` | `string`[]
+
+##### parser
+
+(`content`) => `any`
+
+A function that parses the file content into an object.
+
+##### stringify
+
+`StringifyFunc`
+
+A function that converts an object back into file content.
+
+#### Returns
+
+`void`
+
+#### Example
+
+```typescript
+ConfigFile.register(['.json'], JSON.parse, (obj) => JSON.stringify(obj, null, 2));
+```
+
+***
+
+### save()
+
+> `static` **save**(`filename`, `config`, `options`?): `string`
+
+Defined in: [config-file.ts:101](https://github.com/isdk/util.js/blob/9d50730dc10248681409cd2901eedc5302b8836b/src/config-file.ts#L101)
+
+Saves a configuration object to a file with the specified filename and options.
+
+#### Parameters
+
+##### filename
+
+`string`
+
+The path where the configuration file should be saved.
+
+##### config
+
+`any`
+
+The configuration object to save.
+
+##### options?
+
+`LoadConfigFileOptions`
+
+Additional options for saving the configuration file.
+
+#### Returns
+
+`string`
+
+The final filename where the configuration was saved.
+
+#### Example
+
+```typescript
+ConfigFile.save('config.json', { key: 'value' });
+```

package/docs/functions/getMultiLevelExtname.md

@@ -0,0 +1,33 @@
+[**@isdk/util**](../README.md)
+
+***
+
+[@isdk/util](../globals.md) / getMultiLevelExtname
+
+# Function: getMultiLevelExtname()
+
+> **getMultiLevelExtname**(`filename`, `level`): `string`
+
+Defined in: [get-multi-level-extname.ts:9](https://github.com/isdk/util.js/blob/9d50730dc10248681409cd2901eedc5302b8836b/src/get-multi-level-extname.ts#L9)
+
+Retrieves multi-level file extension
+
+## Parameters
+
+### filename
+
+`string`
+
+The file name
+
+### level
+
+`number` = `1`
+
+The level, default is 1, indicating the number of extension levels to retrieve
+
+## Returns
+
+`string`
+
+Returns a concatenated string of multiple extensions, or an empty string if no extension is found

package/docs/functions/glob.md

@@ -0,0 +1,56 @@
+[**@isdk/util**](../README.md)
+
+***
+
+[@isdk/util](../globals.md) / glob
+
+# Function: glob()
+
+> **glob**(`filepath`, `pattern`, `rootDir`?): `undefined` \| `boolean`
+
+Defined in: [glob.ts:29](https://github.com/isdk/util.js/blob/9d50730dc10248681409cd2901eedc5302b8836b/src/glob.ts#L29)
+
+Matches a file path against a list of glob patterns.
+
+This function checks if the given `filepath` matches any of the provided glob `pattern`s.
+If a `rootDir` is specified, the `filepath` will first be converted to a relative path
+based on the `rootDir`.
+
+## Parameters
+
+### filepath
+
+`string`
+
+The file path to match.
+
+### pattern
+
+`string`[]
+
+An array of glob patterns to match against.
+
+### rootDir?
+
+`string`
+
+(Optional) The root directory used to calculate the relative path of `filepath`.
+
+## Returns
+
+`undefined` \| `boolean`
+
+Returns `true` if the `filepath` matches any of the patterns, otherwise `false`.
+
+## Example
+
+```typescript
+import { glob } from './glob';
+
+const filepath = '/home/user/project/src/index.ts';
+const patterns = ['src/*.ts', '!src/test.ts'];
+const rootDir = '/home/user/project';
+
+const result = glob(filepath, patterns, rootDir);
+console.log(result); // true
+```

package/docs/functions/isStringIn.md

@@ -0,0 +1,43 @@
+[**@isdk/util**](../README.md)
+
+***
+
+[@isdk/util](../globals.md) / isStringIn
+
+# Function: isStringIn()
+
+> **isStringIn**(`str`, `arr`): `boolean`
+
+Defined in: [is-string-in.ts:17](https://github.com/isdk/util.js/blob/9d50730dc10248681409cd2901eedc5302b8836b/src/is-string-in.ts#L17)
+
+Checks if a given string exists within an array of strings or a single string.
+
+## Parameters
+
+### str
+
+`string`
+
+The string to search for.
+
+### arr
+
+An array of strings or a single string to search within.
+
+`string` | `string`[]
+
+## Returns
+
+`boolean`
+
+Returns `true` if the string is found, otherwise `false`.
+
+## Example
+
+```typescript
+const result = isStringIn("apple", ["banana", "apple", "cherry"]);
+console.log(result); // true
+
+const singleResult = isStringIn("hello", "hello");
+console.log(singleResult); // true
+```

package/docs/functions/normalizeIncludeFiles.md

@@ -0,0 +1,49 @@
+[**@isdk/util**](../README.md)
+
+***
+
+[@isdk/util](../globals.md) / normalizeIncludeFiles
+
+# Function: normalizeIncludeFiles()
+
+> **normalizeIncludeFiles**(`files`?, `defaultFiles`?): `string`[]
+
+Defined in: [include-files.ts:34](https://github.com/isdk/util.js/blob/9d50730dc10248681409cd2901eedc5302b8836b/src/include-files.ts#L34)
+
+Normalizes a list of file patterns for glob matching.
+
+This function takes either an array of file patterns or an object containing `include` and `exclude` arrays,
+and returns a normalized array of file patterns. If no patterns are provided, it defaults to including
+all text-based files as defined in `DefaultAllTextFiles`.
+
+## Parameters
+
+### files?
+
+Either an array of file patterns or an object with `include` and `exclude` properties.
+
+`string`[] | [`IncludeFiles`](../interfaces/IncludeFiles.md)
+
+### defaultFiles?
+
+`string`[] = `DefaultAllTextFiles`
+
+An optional array of default file patterns to use if no include patterns are specified.
+                      Defaults to `DefaultAllTextFiles`.
+
+## Returns
+
+`string`[]
+
+A normalized array of file patterns, with excluded patterns prefixed by `!`.
+
+## Example
+
+```typescript
+const result = normalizeIncludeFiles({
+  include: ['*.ts', '*.js'],
+  exclude: ['node_modules/**']
+});
+console.log(result);
+// Output: ['*.ts', '*.js', '!node_modules/**']
+```

package/docs/functions/parseFrontMatter.md

@@ -0,0 +1,33 @@
+[**@isdk/util**](../README.md)
+
+***
+
+[@isdk/util](../globals.md) / parseFrontMatter
+
+# Function: parseFrontMatter()
+
+> **parseFrontMatter**(`value`, `delimiter`): `object`
+
+Defined in: [front-matter.ts:6](https://github.com/isdk/util.js/blob/9d50730dc10248681409cd2901eedc5302b8836b/src/front-matter.ts#L6)
+
+## Parameters
+
+### value
+
+`string`
+
+### delimiter
+
+`string` = `FrontMatterDelimiter`
+
+## Returns
+
+`object`
+
+### content
+
+> **content**: `string`
+
+### data
+
+> **data**: `any`

package/docs/functions/parseYaml.md

@@ -0,0 +1,45 @@
+[**@isdk/util**](../README.md)
+
+***
+
+[@isdk/util](../globals.md) / parseYaml
+
+# Function: parseYaml()
+
+> **parseYaml**(`content`, `options`?): `any`
+
+Defined in: [yaml.ts:51](https://github.com/isdk/util.js/blob/9d50730dc10248681409cd2901eedc5302b8836b/src/yaml.ts#L51)
+
+Parses a YAML string into a JavaScript object with optional custom tags.
+
+## Parameters
+
+### content
+
+`string`
+
+The YAML string to parse.
+
+### options?
+
+`ParseOptions` & `DocumentOptions` & `SchemaOptions` & `ToJSOptions`
+
+Optional parsing options, including custom tags.
+
+## Returns
+
+`any`
+
+The parsed JavaScript object.
+
+## Example
+
+```typescript
+import { parseYaml } from './yaml';
+
+const yamlContent = `
+  example: !custom value
+`;
+const result = parseYaml(yamlContent);
+console.log(result); // { example: 'resolved-value' }
+```

package/docs/functions/registerYamlTag.md

@@ -0,0 +1,37 @@
+[**@isdk/util**](../README.md)
+
+***
+
+[@isdk/util](../globals.md) / registerYamlTag
+
+# Function: registerYamlTag()
+
+> **registerYamlTag**(`tags`): `void`
+
+Defined in: [yaml.ts:23](https://github.com/isdk/util.js/blob/9d50730dc10248681409cd2901eedc5302b8836b/src/yaml.ts#L23)
+
+Registers custom YAML tags to be used in parsing and stringifying YAML content.
+
+## Parameters
+
+### tags
+
+`any`
+
+A single tag or an array of tags to register.
+
+## Returns
+
+`void`
+
+## Example
+
+```typescript
+import { registerYamlTag } from './yaml';
+
+const customTag = {
+  tag: '!custom',
+  resolve: (value) => `resolved-${value}`,
+};
+registerYamlTag(customTag);
+```

package/docs/functions/removeLeadingEmptyLines.md

@@ -0,0 +1,39 @@
+[**@isdk/util**](../README.md)
+
+***
+
+[@isdk/util](../globals.md) / removeLeadingEmptyLines
+
+# Function: removeLeadingEmptyLines()
+
+> **removeLeadingEmptyLines**(`text`): `string`
+
+Defined in: [remove-leading-empty-lines.ts:16](https://github.com/isdk/util.js/blob/9d50730dc10248681409cd2901eedc5302b8836b/src/remove-leading-empty-lines.ts#L16)
+
+Removes all leading empty lines or "#" comments line from the given string.
+
+This function trims any sequence of empty lines that appear at the beginning
+of the input string. It accounts for different newline characters including
+'\n', '\r\n', and also considers lines that contain only whitespace characters.
+
+## Parameters
+
+### text
+
+`string`
+
+The string from which to remove leading empty lines.
+
+## Returns
+
+`string`
+
+The string with leading empty lines removed.
+
+## Example
+
+```ts
+const sampleText = '# This is a comment\n\nHello, world!\n';
+const cleanedText = removeLeadingEmptyLines(sampleText);
+// cleanedText is now 'Hello, world!\n'
+```