@goast/core 0.0.5 → 0.1.0

package/types/lib/utils/source-builder.d.ts

@@ -1,5 +1,5 @@
 import { Condition } from './condition';
-import { StringBuilder, StringBuilderOptions } from './string.utils';
+import { BuilderFn, StringBuilder, StringBuilderOptions, TextOrBuilderFn } from './string.utils';
 import { Nullable } from './type.utils';
 export type IndentOptions = {
     readonly type: 'tabs';
@@ -16,6 +16,36 @@ type KnownParatheses = '()' | '[]' | '{}' | '<>';
 export type Paratheses = KnownParatheses | Omit<string, KnownParatheses> | [open: Nullable<string>, close: Nullable<string>];
 export type SeparatorBuidlerFn<TBuilder extends SourceBuilder, TItem> = (builder: TBuilder, previousItem: TItem, nextItem: TItem, previousItemIndex: number, nextItemIndex: number) => void;
 export type Separator<TBuilder extends SourceBuilder, TItem> = string | SeparatorBuidlerFn<TBuilder, TItem>;
+/**
+ * Options for the `parenthesize` methods of the `SourceBuilder`.
+ * @see SourceBuilder.parenthesize
+ * @see SourceBuilder.parenthesizeIf
+ */
+export type ParenthesizeOptions = {
+    /**
+     * Whether to add line breaks after start and before end of the parentheses. Defaults to `false`.
+     */
+    readonly multiline?: boolean;
+    /**
+     * Whether to indent the content inside parentheses. Defaults to `true`.
+     */
+    readonly indent?: boolean;
+};
+/**
+ * Options for the `forEach` methods of the `SourceBuilder`.
+ * @see SourceBuilder.forEach
+ * @see SourceBuilder.forEachIf
+ */
+export type ForEachOptions<TBuilder extends SourceBuilder, TItem> = {
+    /**
+     * The condition to check before adding content for each item. Defaults to `true`.
+     */
+    readonly condition?: Condition<TItem>;
+    /**
+     * The seperator to add between items. Default to `undefined`.
+     */
+    readonly separator?: Separator<TBuilder, TItem>;
+};
 /**
  * Represents an in-memory source file.
  */
@@ -53,74 +83,61 @@ export declare class SourceBuilder extends StringBuilder {
      * @param options The options to use for the `SourceBuilder` instance.
      * @returns The string built by the `SourceBuilder` instance.
      */
-    static build(buildAction: (builder: SourceBuilder) => void, options?: Partial<SourceBuilderOptions>): string;
+    static build(buildAction: BuilderFn<SourceBuilder>, options?: Partial<SourceBuilderOptions>): string;
     /**
      * Appends one or more strings to the end of the current SourceBuilder.
      * @param value The string(s) to append.
      * @returns The current SourceBuilder.
      */
-    append(...value: Nullable<string>[]): this;
+    append(...value: Nullable<TextOrBuilderFn<this>>[]): this;
     /**
-     * Appends one or more strings to the end of the current SourceBuilder, followed by a line terminator.
+     * Appends one or more strings to the end of the current SourceBuilder if the specified condition is true.
+     * @param condition The condition to check before appending the specified value.
      * @param value The string(s) to append.
      * @returns The current SourceBuilder.
      */
-    appendLine(...value: Nullable<string>[]): this;
+    appendIf(condition: Condition, ...value: Nullable<TextOrBuilderFn<this>>[]): this;
     /**
-     * Appends one or more strings to the end of the current SourceBuilder if the specified condition is true.
-     * @param condition The condition to check before appending the specified value.
+     * Appends one or more strings to the end of the current SourceBuilder, followed by a line terminator.
      * @param value The string(s) to append.
      * @returns The current SourceBuilder.
      */
-    appendIf(condition: Condition, ...value: Nullable<string>[]): this;
+    appendLine(...value: Nullable<TextOrBuilderFn<this>>[]): this;
     /**
      * Appends one or more strings to the end of the current SourceBuilder, followed by a line terminator, if the specified condition is true.
      * @param condition The condition to check before appending the specified value.
      * @param value The string(s) to append.
      * @returns The current SourceBuilder.
      */
-    appendLineIf(condition: Condition, ...value: Nullable<string>[]): this;
+    appendLineIf(condition: Condition, ...value: Nullable<TextOrBuilderFn<this>>[]): this;
     /**
      * Appends the specified values to this source builder with the specified line prefix.
      * @param {string} prefix - The line prefix to use.
      * @param {...(string|null|undefined)} value - The values to append.
      * @returns {SourceBuilder} This source builder instance.
      */
-    appendWithLinePrefix(prefix: string, ...value: Nullable<string>[]): this;
+    appendWithLinePrefix(prefix: string, ...value: Nullable<TextOrBuilderFn<this>>[]): this;
     /**
      * Appends the specified values to this source builder as a new line with the specified line prefix.
      * @param {string} prefix - The line prefix to use.
      * @param {...(string|null|undefined)} value - The values to append.
      * @returns {SourceBuilder} This source builder instance.
      */
-    appendLineWithLinePrefix(prefix: string, ...value: Nullable<string>[]): this;
+    appendLineWithLinePrefix(prefix: string, ...value: Nullable<TextOrBuilderFn<this>>[]): this;
     /**
      * Prepends one or more strings to the beginning of the current SourceBuilder if the specified condition is true.
      * @param condition The condition to check before prepending the specified value.
      * @param value The string(s) to prepend.
      * @returns The current SourceBuilder.
      */
-    prependIf(condition: Condition, ...value: Nullable<string | ((builder: StringBuilder) => void)>[]): this;
+    prependIf(condition: Condition, ...value: Nullable<TextOrBuilderFn<StringBuilder>>[]): this;
     /**
      * Prepends one or more strings to the beginning of the current SourceBuilder, followed by a line terminator, if the specified condition is true.
      * @param condition The condition to check before appending the specified value.
      * @param value The string(s) to prepend.
      * @returns The current SourceBuilder.
      */
-    prependLineIf(condition: Condition, ...value: Nullable<string | ((builder: StringBuilder) => void)>[]): this;
-    /**
-     * Applies the provided builder function to this source builder.
-     * @param builderFn The builder function to apply.
-     * @returns This source builder instance.
-     */
-    apply(builderFn: (builder: this) => void): this;
-    /**
-     * Applies the provided builder function to this source builder with the specified line prefix.
-     * @param prefix The line prefix to use.
-     * @param builderFn The builder function to apply.
-     * @returns This source builder instance.
-     */
-    applyWithLinePrefix(prefix: string, builderFn: (builder: this) => void): this;
+    prependLineIf(condition: Condition, ...value: Nullable<TextOrBuilderFn<StringBuilder>>[]): this;
     /**
      * Ensures that the current line is empty or consists only of whitespace characters.
      * @returns A reference to this instance.
@@ -134,83 +151,53 @@ export declare class SourceBuilder extends StringBuilder {
     /**
      * Inserts specified content if the specified condition is true.
      * @param condition The condition to check before inserting content.
-     * @param builderFn The function to add content.
-     * @returns A reference to this instance.
-     */
-    applyIf(condition: Condition, builderFn: (builder: this) => void): this;
-    /**
-     * Inserts specified content depending on the specified condition.
-     * @param condition The condition to check before inserting content.
      * @param builderFn The function to add content if the condition is true.
      * @param elseBuilderFn The function to add content if the condition is false.
      * @returns A reference to this instance.
      */
-    applyIfElse(condition: Condition, builderFn: (builder: this) => void, elseBuilderFn: (builder: this) => void): this;
+    if(condition: Condition, builderFn: BuilderFn<this>, elseBuilderFn?: BuilderFn<this>): this;
     /**
      * Adds one indentation level. If the current line already contains characters, only subsequent lines are affected.
-     * @param builderFn The function to add indented content.
+     * @param builderFn The function to add indented content or the content itself.
      * @param condition The condition to check before adding indentation.
      * @returns A reference to this instance.
      */
-    indent(builderFn: (builder: this) => void, condition?: Condition): this;
+    indent(value: Nullable<TextOrBuilderFn<this>>): this;
     /**
-     * Adds parentheses around the specified content and adds one indentation level.
-     * @param brackets The brackets to use.
-     * @param builderFn The function to add content inside parentheses.
-     * @param indent Whether to indent the content inside parentheses. Defaults to `true`.
+     * Adds one indentation level if the specified condition is true. If the current line already contains characters, only subsequent lines are affected.
+     * @param builderFn The function to add indented content or the content itself.
+     * @param condition The condition to check before adding indentation.
      * @returns A reference to this instance.
      */
-    parenthesize(brackets: Paratheses, builderFn: (builder: this) => void, indent?: boolean): this;
+    indentIf(condition: Condition, value: Nullable<TextOrBuilderFn<this>>): this;
     /**
-     * Adds parentheses around the specified content if the specified condition is true.
-     * @param condition The condition to check before adding parentheses.
+     * Adds parentheses around the specified content.
      * @param brackets The brackets to use.
-     * @param builderFn The function to add content inside parentheses.
-     * @param indent Whether to indent the content inside parentheses. Defaults to `true`.
-     * @returns A reference to this instance.
-     */
-    parenthesizeIf(condition: Condition, brackets: Paratheses, builderFn: (builder: this) => void, indent?: boolean): this;
-    /**
-     * Adds content for each item in the specified array.
-     * @param items The items to add content for.
-     * @param builderFn The function to add content for each item.
-     * @returns A reference to this instance.
-     */
-    forEach<T>(items: Iterable<T>, builderFn: (builder: this, item: T, index: number) => void): this;
-    /**
-     * Adds content for each item in the specified array.
-     * @param items The items to add content for.
-     * @param condition The condition to check before adding content.
-     * @param builderFn The function to add content for each item.
-     * @returns A reference to this instance.
-     */
-    forEachIf<T>(items: Iterable<T>, condition: Condition, builderFn: (builder: this, item: T, index: number) => void): this;
-    /**
-     * Adds content for each item in the specified array.
-     * @param items The items to add content for.
-     * @param condition The condition to check before adding content for each item.
-     * @param builderFn The function to add content for each item.
+     * @param value The function to add content inside parentheses or one string that should be parenthesized.
+     * @param options Options for the parentheses.
      * @returns A reference to this instance.
      */
-    forEachMatching<T>(items: Iterable<T>, condition: Condition<T>, builderFn: (builder: this, item: T, index: number) => void): this;
+    parenthesize(brackets: Paratheses, value: Nullable<TextOrBuilderFn<this>>, options?: ParenthesizeOptions): this;
     /**
-     * Adds content for each item in the specified array.
-     * @param items The items to add content for.
-     * @param seperator The seperator to add between items.
-     * @param builderFn The function to add content for each item.
+     * Adds parentheses around the specified content if the specified condition is true.
+     * @param condition The condition to check before adding parentheses.
+     * @param brackets The brackets to use.
+     * @param value The function to add content inside parentheses or one string that should be parenthesized.
+     * @param options Options for the parentheses.
      * @returns A reference to this instance.
      */
-    forEachSeparated<T>(items: Iterable<T>, seperator: Separator<this, T>, builderFn: (builder: this, item: T, index: number) => void): this;
+    parenthesizeIf(condition: Condition, brackets: Paratheses, value: TextOrBuilderFn<this>, options?: ParenthesizeOptions): this;
     /**
      * Adds content for each item in the specified array.
      * @param items The items to add content for.
-     * @param condition The condition to check before adding content for each item.
-     * @param seperator The seperator to add between items.
      * @param builderFn The function to add content for each item.
+     * @param options The options for the loop.
      * @returns A reference to this instance.
      */
-    forEachMatchingSeparated<T>(items: Iterable<T>, condition: Condition<T>, seperator: Separator<this, T>, builderFn: (builder: this, item: T, index: number) => void): this;
-    private forEachImpl;
+    forEach<T>(items: Iterable<T>, builderFn: (builder: this, item: T, index: number) => void, options?: ForEachOptions<this, T>): this;
+    forEachIf<T>(condition: Condition, items: Iterable<T>, builderFn: (builder: this, item: T, index: number) => void, options?: ForEachOptions<this, T>): this;
+    appendSeparated(items: Iterable<Nullable<TextOrBuilderFn<this>>>, separator: string): this;
+    appendSeparatedIf(condition: Condition, items: Iterable<Nullable<TextOrBuilderFn<this>>>, separator: string): this;
     private appendIndent;
 }
 export {};

package/types/lib/utils/string.utils.d.ts

@@ -111,6 +111,8 @@ export type StringBuilderOptions = {
     readonly newLine: string;
 };
 export declare const defaultStringBuilderOptions: StringBuilderOptions;
+export type BuilderFn<TBuilder extends StringBuilder> = (builder: TBuilder) => void;
+export type TextOrBuilderFn<TBuilder extends StringBuilder> = string | BuilderFn<TBuilder>;
 /**
  * Represents a mutable string of characters.
  */
@@ -142,25 +144,25 @@ export declare class StringBuilder {
      * @param value The string(s) to append.
      * @returns The current StringBuilder.
      */
-    append(...value: Nullable<string>[]): this;
+    append(...value: Nullable<TextOrBuilderFn<this>>[]): this;
     /**
      * Appends one or more strings to the end of the current StringBuilder, followed by a line terminator.
      * @param value
      * @returns
      */
-    appendLine(...value: Nullable<string>[]): this;
+    appendLine(...value: Nullable<TextOrBuilderFn<this>>[]): 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: Nullable<string | ((builder: StringBuilder) => void)>[]): this;
+    prepend(...value: Nullable<TextOrBuilderFn<StringBuilder>>[]): 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: Nullable<string | ((builder: StringBuilder) => void)>[]): this;
+    prependLine(...value: Nullable<TextOrBuilderFn<StringBuilder>>[]): this;
     /**
      * Converts the value of this instance to a string.
      * @returns A string whose value is the same as this instance.

package/types/lib/utils/type.utils.d.ts

@@ -3,6 +3,7 @@ type MergeTwo<T, U> = {
 } & U;
 export type Merge<U extends unknown[]> = U extends [infer A, ...infer R] ? MergeTwo<A, Merge<R>> : {};
 export type OptionalProperties<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
+export type RequiredProperties<T, K extends keyof T> = Omit<T, K> & Required<Pick<T, K>>;
 export type ArrayItem<T> = T extends (infer U)[] ? U : never;
 export type Nullable<T> = T | null | undefined;
 export interface Constructor<T, TArgs extends any[]> extends Function {