@goast/core 0.4.0-beta4 → 0.4.0

package/esm/src/utils/source-builder.test.js

@@ -0,0 +1,506 @@
+import "../../_dnt.test_polyfills.js";
+import { EOL } from 'node:os';
+import { expect } from '../../deps/jsr.io/@std/expect/1.0.5/mod.js';
+import { beforeEach, describe, it } from '../../deps/jsr.io/@std/testing/1.0.3/bdd.js';
+import { builderTemplate, SourceBuilder } from './source-builder.js';
+import { appendValueGroup } from './string-builder/utils.js';
+describe('SourceBuilder', () => {
+    let sb;
+    beforeEach(() => {
+        sb = new SourceBuilder();
+    });
+    describe('constructor', () => {
+        it('should initialize with default options', () => {
+            const options = sb.options;
+            expect(options.indent).toEqual({ type: 'spaces', count: 2 });
+            expect(options.newLine).toBe(EOL);
+        });
+    });
+    describe('fromString', () => {
+        it('should create a new instance of SourceBuilder with the given string', () => {
+            const str = 'test string';
+            const sb = SourceBuilder.fromString(str);
+            expect(sb.toString()).toEqual(str);
+        });
+        it('should create a new instance of SourceBuilder with the given string and options', () => {
+            const str = 'test string';
+            const options = {
+                indent: { type: 'tabs' },
+                newLine: '\n-',
+            };
+            const sb = SourceBuilder.fromString(str, options);
+            expect(sb.toString()).toEqual(str);
+            // TODO: Uncomment as soon as @std/expect has new version (https://github.com/denoland/std/pull/6065)
+            // expect(sb.options).toEqual(expect.objectContaining(options));
+        });
+    });
+    describe('build', () => {
+        it('should build a string using a callback function that receives a `SourceBuilder` instance', () => {
+            const buildAction = (builder) => {
+                builder.append('hello');
+                builder.append('world');
+            };
+            const result = SourceBuilder.build(buildAction);
+            expect(result).toEqual('helloworld');
+        });
+        it('should build a string using a callback function that receives a `SourceBuilder` instance and options', () => {
+            const buildAction = (builder) => {
+                builder.appendLine('hello');
+                builder.indent((b) => b.append('world'));
+            };
+            const options = {
+                indent: { type: 'spaces', count: 4 },
+                newLine: '\r\n\t',
+            };
+            const result = SourceBuilder.build(buildAction, options);
+            expect(result).toEqual(`hello${options.newLine}    world`);
+        });
+    });
+    describe('append', () => {
+        it('should handle consecutive line breaks', () => {
+            sb.append('line1', EOL, EOL, EOL, 'line2');
+            expect(sb.toString()).toBe(`line1${EOL}${EOL}${EOL}line2`);
+        });
+        it('should handle mixed line breaks', () => {
+            sb.append('line1\r\n', '\n', 'line2\r', '\r', 'line3\n', 'line4');
+            expect(sb.toString()).toBe(`line1${EOL}${EOL}line2line3${EOL}line4`);
+        });
+        it('should handle strings with special chars', () => {
+            sb.append('line1 {', EOL, 'line2}');
+            expect(sb.toString()).toBe(`line1 {${EOL}line2}`);
+        });
+        it('should handle long strings without line breaks', () => {
+            sb.append('This is a long string without any line breaks.');
+            expect(sb.toString()).toBe('This is a long string without any line breaks.');
+        });
+        it('should handle multiple calls', () => {
+            sb.append('line1', EOL);
+            sb.append('line2', EOL);
+            sb.append('line3', EOL);
+            expect(sb.toString()).toBe(`line1${EOL}line2${EOL}line3${EOL}`);
+        });
+        it('should handle empty input', () => {
+            sb.append('', '', '', EOL, '', '');
+            expect(sb.toString()).toBe(EOL);
+        });
+        it('should apply the provided builder function to the source builder', () => {
+            const builder = new SourceBuilder().append((b) => b.append('foo'));
+            expect(builder.toString()).toBe('foo');
+        });
+    });
+    describe('appendIf', () => {
+        it('should append the string when condition is true', () => {
+            sb.appendIf(true, 'line1', EOL);
+            expect(sb.toString()).toBe(`line1${EOL}`);
+        });
+        it('should not append the string when condition is false', () => {
+            sb.appendIf(false, 'line1', EOL);
+            expect(sb.toString()).toBe('');
+        });
+        it('should append the string when condition is a function returning true', () => {
+            sb.appendIf(() => true, 'line1', EOL);
+            expect(sb.toString()).toBe(`line1${EOL}`);
+        });
+        it('should not append the string when condition is a function returning false', () => {
+            sb.appendIf(() => false, 'line1', EOL);
+            expect(sb.toString()).toBe('');
+        });
+    });
+    describe('appendLineIf', () => {
+        it('should append the string when condition is true', () => {
+            sb.appendLineIf(true, 'line1');
+            expect(sb.toString()).toBe(`line1${EOL}`);
+        });
+        it('should not append the string when condition is false', () => {
+            sb.appendLineIf(false, 'line1');
+            expect(sb.toString()).toBe('');
+        });
+        it('should append the string when condition is a function returning true', () => {
+            sb.appendLineIf(() => true, 'line1');
+            expect(sb.toString()).toBe(`line1${EOL}`);
+        });
+        it('should not append the string when condition is a function returning false', () => {
+            sb.appendLineIf(() => false, 'line1');
+            expect(sb.toString()).toBe('');
+        });
+    });
+    describe('prependIf', () => {
+        it('should prepend the specified value if the condition is true', () => {
+            const builder = new SourceBuilder().append('bar').prependIf(true, 'foo');
+            expect(builder.toString()).toBe('foobar');
+        });
+        it('should not prepend the specified value if the condition is false', () => {
+            const builder = new SourceBuilder().append('bar').prependIf(false, 'foo');
+            expect(builder.toString()).toBe('bar');
+        });
+    });
+    describe('prependLineIf', () => {
+        it('should prepend the specified value with a line terminator if the condition is true', () => {
+            const builder = new SourceBuilder().append('bar').prependLineIf(true, 'foo');
+            expect(builder.toString()).toBe(`foo${EOL}bar`);
+        });
+        it('should not prepend the specified value if the condition is false', () => {
+            const builder = new SourceBuilder().append('bar').prependLineIf(false, 'foo');
+            expect(builder.toString()).toBe('bar');
+        });
+    });
+    describe('appendWithLinePrefix', () => {
+        it('should append the specified values with the specified line prefix', () => {
+            const builder = new SourceBuilder().appendWithLinePrefix('// ', 'foo', 'bar');
+            expect(builder.toString()).toBe('// foobar');
+        });
+        it('should handle null and undefined values', () => {
+            const builder = new SourceBuilder().appendWithLinePrefix('// ', 'foo', null, undefined, 'bar');
+            expect(builder.toString()).toBe('// foobar');
+        });
+        it('should apply the provided builder function with the specified line prefix', () => {
+            const builder = new SourceBuilder().appendWithLinePrefix('// ', (b) => {
+                b.appendLine('foo');
+                b.appendLine('bar');
+            });
+            expect(builder.toString()).toBe(`// foo${EOL}// bar${EOL}`);
+        });
+        it('should apply the provided builder function with the specified line prefix and indentation', () => {
+            const builder = new SourceBuilder().indent((b) => b.appendWithLinePrefix('// ', (b) => {
+                b.appendLine('foo');
+                b.appendLine('bar');
+            }));
+            expect(builder.toString()).toBe(`  // foo${EOL}  // bar${EOL}`);
+        });
+        it('should write indents after the prefix', () => {
+            const builder = new SourceBuilder().indent((b) => b.appendWithLinePrefix('// ', (b) => {
+                b.indent((b) => b.appendLine('foo'));
+            }));
+            expect(builder.toString()).toBe(`  //   foo${EOL}`);
+        });
+    });
+    describe('appendLineWithLinePrefix', () => {
+        it('should append the specified values as a new line with the specified line prefix', () => {
+            const builder = new SourceBuilder().appendLineWithLinePrefix('// ', 'foo', 'bar');
+            expect(builder.toString()).toBe('// foobar' + EOL);
+        });
+        it('should handle null and undefined values', () => {
+            const builder = new SourceBuilder().appendLineWithLinePrefix('// ', 'foo', null, undefined, 'bar');
+            expect(builder.toString()).toBe('// foobar' + EOL);
+        });
+    });
+    describe('ensurePreviousLineEmpty', () => {
+        it('should insert one empty line when current line is empty', () => {
+            sb.append('line1', EOL, 'line2', EOL);
+            sb.ensurePreviousLineEmpty();
+            expect(sb.toString()).toBe(`line1${EOL}line2${EOL}${EOL}`);
+        });
+        it('should insert two empty lines when current line is not empty', () => {
+            sb.append('line1', EOL, 'line2');
+            sb.ensurePreviousLineEmpty();
+            expect(sb.toString()).toBe(`line1${EOL}line2${EOL}${EOL}`);
+        });
+        it('should not insert an empty line when already empty', () => {
+            sb.append('line1', EOL, 'line2', EOL, EOL);
+            sb.ensurePreviousLineEmpty();
+            expect(sb.toString()).toBe(`line1${EOL}line2${EOL}${EOL}`);
+        });
+    });
+    describe('ensureCurrentLineEmpty', () => {
+        it('should insert an empty line', () => {
+            sb.append('line1', EOL, 'line2');
+            sb.ensureCurrentLineEmpty();
+            expect(sb.toString()).toBe(`line1${EOL}line2${EOL}`);
+        });
+        it('should not insert an empty line when already empty', () => {
+            sb.append('line1', EOL, 'line2', EOL);
+            sb.ensureCurrentLineEmpty();
+            expect(sb.toString()).toBe(`line1${EOL}line2${EOL}`);
+        });
+    });
+    describe('pretendPreviousLineEmpty', () => {
+        it('should pretend the previous line is empty', () => {
+            sb.appendLine('line1').append('a').pretendPreviousLineEmpty().ensurePreviousLineEmpty().append('b');
+            expect(sb.toString()).toBe(`line1${EOL}ab`);
+        });
+    });
+    describe('pretendCurrentLineEmpty', () => {
+        it('should pretend the previous line is empty', () => {
+            sb.append('a').pretendCurrentLineEmpty().ensureCurrentLineEmpty().append('b');
+            expect(sb.toString()).toBe(`ab`);
+        });
+    });
+    describe('if', () => {
+        it('should append the content when condition is true', () => {
+            sb.if(true, (x) => x.append('stuff'));
+            expect(sb.toString()).toBe(`stuff`);
+        });
+        it('should not append the content when condition is false', () => {
+            sb.if(false, (x) => x.append('stuff'));
+            expect(sb.toString()).toBe(``);
+        });
+        it('should append the content when condition function returns true', () => {
+            sb.if(() => true, (x) => x.append('stuff'));
+            expect(sb.toString()).toBe(`stuff`);
+        });
+        it('should not append the content when condition function returns false', () => {
+            sb.if(() => false, (x) => x.append('stuff'));
+            expect(sb.toString()).toBe(``);
+        });
+        it('should append the correct content when condition is true', () => {
+            sb.if(true, (x) => x.append('stuff'), (x) => x.append('other stuff'));
+            expect(sb.toString()).toBe(`stuff`);
+        });
+        it('should append the correct content when condition is false', () => {
+            sb.if(false, (x) => x.append('stuff'), (x) => x.append('other stuff'));
+            expect(sb.toString()).toBe(`other stuff`);
+        });
+        it('should append the correct content when condition function returns true', () => {
+            sb.if(() => true, (x) => x.append('stuff'), (x) => x.append('other stuff'));
+            expect(sb.toString()).toBe(`stuff`);
+        });
+        it('should append the correct content when condition function returns false', () => {
+            sb.if(() => false, (x) => x.append('stuff'), (x) => x.append('other stuff'));
+            expect(sb.toString()).toBe(`other stuff`);
+        });
+    });
+    describe('indent', () => {
+        it('should correctly indent the content (fn)', () => {
+            sb.append('line1', EOL);
+            sb.indent((innerSb) => {
+                innerSb.append('line2', EOL);
+            });
+            sb.append('line3', EOL);
+            expect(sb.toString()).toBe(`line1${EOL}  line2${EOL}line3${EOL}`);
+        });
+        it('should correctly indent the content (string)', () => {
+            sb.append('line1', EOL);
+            sb.indent('line2\n');
+            sb.append('line3', EOL);
+            expect(sb.toString()).toBe(`line1${EOL}  line2${EOL}line3${EOL}`);
+        });
+        it('should correctly handle nested indentation', () => {
+            sb.indent((innerSb1) => {
+                innerSb1.append('line1', EOL);
+                innerSb1.indent((innerSb2) => {
+                    innerSb2.append('line2', EOL);
+                });
+                innerSb1.append('line3', EOL);
+            });
+            expect(sb.toString()).toBe(`  line1${EOL}    line2${EOL}  line3${EOL}`);
+        });
+        it('should correctly handle multiline strings (fn)', () => {
+            sb.indent((innerSb) => {
+                innerSb.append(`line1${EOL}line2`, EOL);
+            });
+            expect(sb.toString()).toBe(`  line1${EOL}  line2${EOL}`);
+        });
+        it('should correctly handle multiline strings (string)', () => {
+            sb.indent('line1\nline2\n');
+            expect(sb.toString()).toBe(`  line1${EOL}  line2${EOL}`);
+        });
+        it('should nest indentations', () => {
+            sb.appendLine('(')
+                .indent((b1) => {
+                b1.appendLine('(')
+                    .indent((b2) => {
+                    b2.appendLine('line1');
+                })
+                    .appendLine(')');
+            })
+                .appendLine(')');
+            expect(sb.toString()).toBe(`(${EOL}  (${EOL}    line1${EOL}  )${EOL})${EOL}`);
+        });
+    });
+    describe('indentIf', () => {
+        it('should indent when condition is true', () => {
+            sb.indentIf(true, (x) => x.append('stuff'));
+            expect(sb.toString()).toBe(`  stuff`);
+        });
+        it('should not indent when condition is false', () => {
+            sb.indentIf(false, (x) => x.append('stuff'));
+            expect(sb.toString()).toBe(`stuff`);
+        });
+        it('should indent when condition function returns true', () => {
+            sb.indentIf(() => true, (x) => x.append('stuff'));
+            expect(sb.toString()).toBe(`  stuff`);
+        });
+        it('should not indent when condition function returns false', () => {
+            sb.indentIf(() => false, (x) => x.append('stuff'));
+            expect(sb.toString()).toBe(`stuff`);
+        });
+    });
+    describe('parenthesize', () => {
+        it('should parenthesize the content with the given brackets string', () => {
+            sb.parenthesize('{}', (x) => x.append('stuff'));
+            expect(sb.toString()).toBe(`{stuff}`);
+        });
+        it('should parenthesize the content with the given brackets array', () => {
+            sb.parenthesize(['{', '}'], (x) => x.append('stuff'));
+            expect(sb.toString()).toBe(`{stuff}`);
+        });
+        it('should parenthesize and indent the content (fn)', () => {
+            sb.parenthesize('()', (x) => x.append(`${EOL}stuff${EOL}`));
+            expect(sb.toString()).toBe(`(${EOL}  stuff${EOL})`);
+        });
+        it('should parenthesize and indent the content (string)', () => {
+            sb.parenthesize('()', `${EOL}stuff${EOL}`);
+            expect(sb.toString()).toBe(`(${EOL}  stuff${EOL})`);
+        });
+        it('should parenthesize but not indent the content when indent is false', () => {
+            sb.parenthesize('()', (x) => x.append(`${EOL}stuff${EOL}`), { indent: false });
+            expect(sb.toString()).toBe(`(${EOL}stuff${EOL})`);
+        });
+        it('should parenthesize the content with the given brackets string (multiline)', () => {
+            sb.parenthesize('{}', (x) => x.append('stuff'), { multiline: true });
+            expect(sb.toString()).toBe(`{${EOL}  stuff${EOL}}`);
+        });
+        it('should parenthesize the content with the given brackets array (multiline)', () => {
+            sb.parenthesize(['{', '}'], (x) => x.append('stuff'), { multiline: true });
+            expect(sb.toString()).toBe(`{${EOL}  stuff${EOL}}`);
+        });
+        it('should parenthesize and indent the content (fn) (multiline)', () => {
+            sb.parenthesize('()', (x) => x.append(`${EOL}stuff${EOL}`), { multiline: true });
+            expect(sb.toString()).toBe(`(${EOL}${EOL}  stuff${EOL})`);
+        });
+        it('should parenthesize and indent the content (string) (multiline)', () => {
+            sb.parenthesize('()', `${EOL}stuff${EOL}`, { multiline: true });
+            expect(sb.toString()).toBe(`(${EOL}${EOL}  stuff${EOL})`);
+        });
+        it('should parenthesize but not indent the content when indent is false (multiline)', () => {
+            sb.parenthesize('()', (x) => x.append(`${EOL}stuff${EOL}`), { multiline: true, indent: false });
+            expect(sb.toString()).toBe(`(${EOL}${EOL}stuff${EOL})`);
+        });
+        it('should ignore first ensurePreviousLineEmpty', () => {
+            sb.parenthesize('()', (x) => x.ensurePreviousLineEmpty().append('stuff'), { multiline: true });
+            expect(sb.toString()).toBe(`(${EOL}  stuff${EOL})`);
+        });
+        it('should not ignore first ensurePreviousLineEmpty if disabled', () => {
+            sb.parenthesize('()', (x) => x.ensurePreviousLineEmpty().append('stuff'), {
+                multiline: true,
+                pretendEmpty: false,
+            });
+            expect(sb.toString()).toBe(`(${EOL}${EOL}  stuff${EOL})`);
+        });
+    });
+    describe('parenthesizeIf', () => {
+        it('should parenthesize when condition is true (fn)', () => {
+            sb.parenthesizeIf(true, '()', (x) => x.append('stuff'));
+            expect(sb.toString()).toBe(`(stuff)`);
+        });
+        it('should parenthesize when condition is true (string)', () => {
+            sb.parenthesizeIf(true, '()', 'stuff');
+            expect(sb.toString()).toBe(`(stuff)`);
+        });
+        it('should not parenthesize when condition is false', () => {
+            sb.parenthesizeIf(false, '()', (x) => x.append('stuff'));
+            expect(sb.toString()).toBe(`stuff`);
+        });
+        it('should parenthesize when condition function returns true', () => {
+            sb.parenthesizeIf(() => true, '()', (x) => x.append('stuff'));
+            expect(sb.toString()).toBe(`(stuff)`);
+        });
+        it('should not parenthesize when condition function returns false', () => {
+            sb.parenthesizeIf(() => false, '()', (x) => x.append('stuff'));
+            expect(sb.toString()).toBe(`stuff`);
+        });
+        it('should parenthesize when condition is true (fn) (multiline)', () => {
+            sb.parenthesizeIf(true, '()', (x) => x.append('stuff'), { multiline: true });
+            expect(sb.toString()).toBe(`(${EOL}  stuff${EOL})`);
+        });
+        it('should parenthesize when condition is true (string) (multiline)', () => {
+            sb.parenthesizeIf(true, '()', 'stuff', { multiline: true });
+            expect(sb.toString()).toBe(`(${EOL}  stuff${EOL})`);
+        });
+        it('should not parenthesize when condition is false (multiline)', () => {
+            sb.parenthesizeIf(false, '()', (x) => x.append('stuff'), { multiline: true });
+            expect(sb.toString()).toBe(`stuff`);
+        });
+        it('should parenthesize when condition function returns true (multiline)', () => {
+            sb.parenthesizeIf(() => true, '()', (x) => x.append('stuff'), { multiline: true });
+            expect(sb.toString()).toBe(`(${EOL}  stuff${EOL})`);
+        });
+        it('should not parenthesize when condition function returns false (multiline)', () => {
+            sb.parenthesizeIf(() => false, '()', (x) => x.append('stuff'), { multiline: true });
+            expect(sb.toString()).toBe(`stuff`);
+        });
+    });
+    describe('forEach', () => {
+        it('should add the content for each item', () => {
+            sb.forEach(['a', 'b', 'c'], (x, item) => x.append(`(${item})`));
+            expect(sb.toString()).toBe(`(a)(b)(c)`);
+        });
+        it('should add the content for items that match the condition', () => {
+            sb.forEach(['a', 'b', 'c'], (x, item) => x.append(`(${item})`), { condition: (item) => item === 'b' });
+            expect(sb.toString()).toBe(`(b)`);
+        });
+        it('should add the content for each item with the given string separator', () => {
+            sb.forEach(['a', 'b', 'c'], (x, item) => x.append(`item: ${item}`), { separator: ', ' });
+            expect(sb.toString()).toBe(`item: a, item: b, item: c`);
+        });
+        it('should add the content for each item with the given separator builder', () => {
+            sb.forEach(['a', 'b', 'c'], (x, item) => x.append(`item: ${item}`), {
+                separator: (x, p, n, pi, ni) => x.append(`(${p}:${pi}), (${n}:${ni})`),
+            });
+            expect(sb.toString()).toBe(`item: a(a:0), (b:1)item: b(b:1), (c:2)item: c`);
+        });
+        it('should add the content for items that match the condition with the given string separator', () => {
+            sb.forEach(['a', 'b', 'c'], (x, item) => x.append(`item: ${item}`), {
+                condition: (item) => item === 'a' || item === 'c',
+                separator: ', ',
+            });
+            expect(sb.toString()).toBe(`item: a, item: c`);
+        });
+        it('should add the content for items that match the condition with the given separator builder', () => {
+            sb.forEach(['a', 'b', 'c'], (x, item) => x.append(`item: ${item}`), {
+                condition: (item) => item === 'a' || item === 'c',
+                separator: (x, p, n, pi, ni) => x.append(`(${p}:${pi}), (${n}:${ni})`),
+            });
+            expect(sb.toString()).toBe(`item: a(a:0), (c:2)item: c`);
+        });
+    });
+    describe('forEachIf', () => {
+        it('should add the content for each item when condition is true', () => {
+            sb.forEachIf(true, ['a', 'b', 'c'], (x, item) => x.append(`(${item})`));
+            expect(sb.toString()).toBe(`(a)(b)(c)`);
+        });
+        it('should not add the content for each item when condition is false', () => {
+            sb.forEachIf(false, ['a', 'b', 'c'], (x, item) => x.append(`(${item})`));
+            expect(sb.toString()).toBe(``);
+        });
+    });
+    describe('appendSeparated', () => {
+        it('should add the content for each item with the given string separator', () => {
+            sb.appendSeparated(['a', 'b', 'c'], ', ');
+            expect(sb.toString()).toBe(`a, b, c`);
+        });
+    });
+    describe('appendSeparatedIf', () => {
+        it('should add the content for each item with the given string separator when condition is true', () => {
+            sb.appendSeparatedIf(true, ['a', 'b', 'c'], ', ');
+            expect(sb.toString()).toBe(`a, b, c`);
+        });
+        it('should not add the content for each item with the given string separator when condition is false', () => {
+            sb.appendSeparatedIf(false, ['a', 'b', 'c'], ', ');
+            expect(sb.toString()).toBe(``);
+        });
+    });
+});
+describe('builderTemplate', () => {
+    it('should resolve append values in a template string', () => {
+        const sb = new SourceBuilder();
+        sb.append(builderTemplate `abc${'def'}ghi${123}jkl${(b) => b.append('mno')}pqr${appendValueGroup(['stu', 'vxw'])}yz`);
+        expect(sb.toString()).toEqual('abcdefghi123jklmnopqrstuvxwyz');
+    });
+    it('should remove indentation based on last line', () => {
+        const sb = new SourceBuilder();
+        sb.append(builderTemplate `${'abc'}
+        ${123}
+         ghi`);
+        expect(sb.toString()).toEqual(`abc${EOL}123${EOL}ghi`);
+    });
+    describe('indent', () => {
+        it('should indent the content', () => {
+            const sb = new SourceBuilder();
+            sb.append(builderTemplate.indent `${'abc'}
+          ${123}
+          ghi`);
+            expect(sb.toString()).toEqual(`  abc${EOL}  123${EOL}  ghi`);
+        });
+    });
+});

package/esm/src/utils/string-builder/options.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"options.d.ts","sourceRoot":"","sources":["../../../../src/src/utils/string-builder/options.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC;;;OAGG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;CAC1B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,2BAA2B,EAAE,oBAEzC,CAAC"}

package/esm/src/utils/string-builder/string-builder.d.ts

@@ -0,0 +1,73 @@
+import type { Nullable, SingleOrMultiple } from '../type.utils.js';
+import { type StringBuilderOptions } from './options.js';
+export type BuilderFn<TBuilder extends StringBuilder> = (builder: TBuilder) => void;
+export type Primitive = string | number | boolean;
+export type AppendParam<TBuilder extends StringBuilder, TAdditionalAppends> = SingleOrMultiple<Primitive | null | undefined | BuilderFn<TBuilder> | TAdditionalAppends | {
+    __type: 'append-value-group';
+    values: AppendParam<TBuilder, TAdditionalAppends>[];
+    separator: string | null;
+}>;
+export declare const AdditionalAppendsSymbol: unique symbol;
+/**
+ * Represents a mutable string of characters.
+ */
+export declare class StringBuilder<TAdditionalAppends = never> {
+    private readonly _options;
+    protected str: string;
+    [AdditionalAppendsSymbol](_: TAdditionalAppends): void;
+    get options(): StringBuilderOptions;
+    /**
+     * Initializes a new instance of the StringBuilder class.
+     * @param options The options.
+     */
+    constructor(options?: Partial<StringBuilderOptions>);
+    /**
+     * Creates a new StringBuilder instance and appends the specified string to it.
+     * @param str The string to append.
+     * @param options The options.
+     * @returns A new StringBuilder instance.
+     */
+    static fromString(str: string, options?: Partial<StringBuilderOptions>): StringBuilder;
+    /**
+     * Builds a string using a StringBuilder build action.
+     * @param buildAction The build action to perform on the StringBuilder instance.
+     * @param options The options for the StringBuilder instance.
+     * @returns The built string.
+     */
+    static build(buildAction: AppendParam<StringBuilder, never>, options?: Partial<StringBuilderOptions>): string;
+    protected appendSingle(value: AppendParam<this, TAdditionalAppends>): void;
+    /**
+     * Appends one or more strings to the end of the current StringBuilder.
+     * @param value The string(s) to append.
+     * @returns The current StringBuilder.
+     */
+    append(...value: AppendParam<this, TAdditionalAppends>[]): this;
+    /**
+     * Appends one or more strings to the end of the current StringBuilder, followed by a line terminator.
+     * @param value
+     * @returns
+     */
+    appendLine(...value: Nullable<AppendParam<this, TAdditionalAppends>>[]): this;
+    /**
+     * Prepends one or more strings to the beginning of the current StringBuilder.
+     * @param value The string(s) to prepend.
+     * @returns The current StringBuilder.
+     */
+    prepend(...value: AppendParam<StringBuilder, never>[]): this;
+    /**
+     * Prepends one or more strings to the beginning of the current StringBuilder, followed by a line terminator.
+     * @param value The string(s) to prepend.
+     * @returns The current StringBuilder.
+     */
+    prependLine(...value: AppendParam<StringBuilder, never>[]): this;
+    /**
+     * Converts the value of this instance to a string.
+     * @returns A string whose value is the same as this instance.
+     */
+    toString(): string;
+    /**
+     * Removes all characters from the current StringBuilder.
+     */
+    clear(): void;
+}
+//# sourceMappingURL=string-builder.d.ts.map

package/esm/src/utils/string-builder/string-builder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"string-builder.d.ts","sourceRoot":"","sources":["../../../../src/src/utils/string-builder/string-builder.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,QAAQ,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AACnE,OAAO,EAA+B,KAAK,oBAAoB,EAAE,MAAM,cAAc,CAAC;AAEtF,MAAM,MAAM,SAAS,CAAC,QAAQ,SAAS,aAAa,IAAI,CAAC,OAAO,EAAE,QAAQ,KAAK,IAAI,CAAC;AACpF,MAAM,MAAM,SAAS,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;AAElD,MAAM,MAAM,WAAW,CAAC,QAAQ,SAAS,aAAa,EAAE,kBAAkB,IAAI,gBAAgB,CAC1F,SAAS,GACT,IAAI,GACJ,SAAS,GACT,SAAS,CAAC,QAAQ,CAAC,GAEnB,kBAAkB,GAClB;IACA,MAAM,EAAE,oBAAoB,CAAC;IAC7B,MAAM,EAAE,WAAW,CAAC,QAAQ,EAAE,kBAAkB,CAAC,EAAE,CAAC;IACpD,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B,CACF,CAAC;AAEF,eAAO,MAAM,uBAAuB,eAA8B,CAAC;AAEnE;;GAEG;AACH,qBAAa,aAAa,CAAC,kBAAkB,GAAG,KAAK;IACnD,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAuB;IAChD,SAAS,CAAC,GAAG,EAAE,MAAM,CAAM;IAE3B,CAAC,uBAAuB,CAAC,CAAC,CAAC,EAAE,kBAAkB,GAAG,IAAI;IAItD,IAAW,OAAO,IAAI,oBAAoB,CAEzC;IAED;;;OAGG;gBACS,OAAO,CAAC,EAAE,OAAO,CAAC,oBAAoB,CAAC;IAInD;;;;;OAKG;WACW,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,oBAAoB,CAAC,GAAG,aAAa;IAM7F;;;;;OAKG;WACW,KAAK,CAAC,WAAW,EAAE,WAAW,CAAC,aAAa,EAAE,KAAK,CAAC,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,oBAAoB,CAAC,GAAG,MAAM;IAMpH,SAAS,CAAC,YAAY,CAAC,KAAK,EAAE,WAAW,CAAC,IAAI,EAAE,kBAAkB,CAAC;IA6BnE;;;;OAIG;IACI,MAAM,CAAC,GAAG,KAAK,EAAE,WAAW,CAAC,IAAI,EAAE,kBAAkB,CAAC,EAAE,GAAG,IAAI;IAOtE;;;;OAIG;IACI,UAAU,CAAC,GAAG,KAAK,EAAE,QAAQ,CAAC,WAAW,CAAC,IAAI,EAAE,kBAAkB,CAAC,CAAC,EAAE,GAAG,IAAI;IAIpF;;;;OAIG;IACI,OAAO,CAAC,GAAG,KAAK,EAAE,WAAW,CAAC,aAAa,EAAE,KAAK,CAAC,EAAE,GAAG,IAAI;IAgBnE;;;;OAIG;IACI,WAAW,CAAC,GAAG,KAAK,EAAE,WAAW,CAAC,aAAa,EAAE,KAAK,CAAC,EAAE,GAAG,IAAI;IAIvE;;;OAGG;IACI,QAAQ,IAAI,MAAM;IAIzB;;OAEG;IACI,KAAK,IAAI,IAAI;CAGrB"}