@goast/core 0.4.0-beta4 → 0.4.1

package/script/src/utils/source-builder.d.ts

@@ -0,0 +1,234 @@
+import { type Condition } from './condition.js';
+import { type StringBuilderOptions } from './string-builder/options.js';
+import { type AppendParam, type BuilderFn, StringBuilder } from './string-builder/string-builder.js';
+import type { AppendValue } from './string-builder/utils.js';
+import type { Nullable } from './type.utils.js';
+export type IndentOptions = {
+    readonly type: 'tabs';
+} | {
+    readonly type: 'spaces';
+    readonly count: number;
+};
+/**
+ * Options for the `SourceBuilder` class.
+ */
+export type SourceBuilderOptions = StringBuilderOptions & {
+    /**
+     * The type of indentation to use.
+     * @default { type: 'spaces', count: 2 }
+     */
+    indent: IndentOptions;
+};
+/**
+ * Default options for the `SourceBuilder` class.
+ */
+export declare const defaultSourceBuilderOptions: SourceBuilderOptions;
+type KnownParatheses = '()' | '[]' | '{}' | '<>';
+export type Paratheses<TBuilder extends StringBuilder> = KnownParatheses | Omit<string, KnownParatheses> | [open: Nullable<AppendValue<TBuilder>>, close: Nullable<AppendValue<TBuilder>>];
+export type SeparatorBuidlerFn<TBuilder, TItem> = (builder: TBuilder, previousItem: TItem, nextItem: TItem, previousItemIndex: number, nextItemIndex: number) => void;
+export type Separator<TBuilder, 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.
+     * @default false
+     */
+    readonly multiline?: boolean;
+    /**
+     * Whether to indent the content inside parentheses.
+     * @default true
+     */
+    readonly indent?: boolean;
+    /**
+     * Whether to pretend that the current line and the one before is empty or consists only of whitespace characters.
+     * This is useful when the parentheses are used as a block and `ensurePreviousLineEmpty` is used.
+     * @default true
+     */
+    readonly pretendEmpty?: boolean;
+};
+/**
+ * Options for the `forEach` methods of the `SourceBuilder`.
+ * @see SourceBuilder.forEach
+ * @see SourceBuilder.forEachIf
+ */
+export type ForEachOptions<TBuilder, 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>;
+};
+type SwitchCase<TValue, TBuilder extends StringBuilder> = {
+    case: TValue;
+    value: AppendValue<TBuilder>;
+};
+/**
+ * Represents an in-memory source file.
+ */
+export declare class SourceBuilder<TAdditionalAppends = never> extends StringBuilder<TAdditionalAppends> {
+    private readonly __options;
+    private readonly _indentString;
+    private _isLineIndented;
+    private _isLastLineEmpty;
+    private _isCurrentLineEmpty;
+    private _linePrefixNodes;
+    /**
+     * Gets the options used by this instance.
+     */
+    get options(): SourceBuilderOptions;
+    /**
+     * Initializes a new instance of the SourceBuilder class.
+     * @param options The options to use for this instance.
+     */
+    constructor(options?: Partial<SourceBuilderOptions>);
+    /**
+     * Creates a new instance of the SourceBuilder class from a string.
+     * @param str The string to use as the initial content of the builder.
+     * @param options The options to use for this instance.
+     * @returns A new instance of the SourceBuilder class.
+     */
+    static fromString(str: string, options?: Partial<SourceBuilderOptions>): SourceBuilder;
+    /**
+     * Builds a string using a callback function that receives a `SourceBuilder` instance.
+     * @param buildAction The callback function that receives a `SourceBuilder` instance to build the string.
+     * @param options The options to use for the `SourceBuilder` instance.
+     * @returns The string built by the `SourceBuilder` instance.
+     */
+    static build(buildAction: AppendParam<SourceBuilder, never>, options?: Partial<SourceBuilderOptions>): string;
+    protected appendSingle(value: AppendParam<this, TAdditionalAppends>): void;
+    /**
+     * 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.
+     */
+    appendIf(condition: Condition, ...value: AppendParam<this, TAdditionalAppends>[]): this;
+    /**
+     * 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.
+     */
+    appendLine(...value: AppendParam<this, TAdditionalAppends>[]): 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: AppendParam<this, TAdditionalAppends>[]): 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: AppendParam<this, TAdditionalAppends>[]): 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: AppendParam<this, TAdditionalAppends>[]): 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: AppendParam<StringBuilder, never>[]): 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: AppendParam<StringBuilder, never>[]): this;
+    /**
+     * Ensures that the current line and the one before is empty or consists only of whitespace characters.
+     * @returns A reference to this instance.
+     */
+    ensurePreviousLineEmpty(): this;
+    /**
+     * Ensures that the current line is empty or consists only of whitespace characters.
+     * @returns A reference to this instance.
+     */
+    ensureCurrentLineEmpty(): this;
+    /**
+     * Pretends that the current line and the one before is empty or consists only of whitespace characters.
+     * @returns A reference to this instance.
+     */
+    pretendPreviousLineEmpty(): this;
+    /**
+     * Pretends that the current line is empty or consists only of whitespace characters.
+     * @returns A reference to this instance.
+     */
+    pretendCurrentLineEmpty(): this;
+    /**
+     * 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 if the condition is true.
+     * @param elseBuilderFn The function to add content if the condition is false.
+     * @returns A reference to this instance.
+     */
+    if(condition: Condition, builderFn: AppendParam<this, TAdditionalAppends>, elseBuilderFn?: AppendParam<this, TAdditionalAppends>): this;
+    switch<T extends string | number>(value: T, cases: Record<T, AppendParam<this, TAdditionalAppends>>, defaultBuilderFn?: AppendParam<this, TAdditionalAppends>): this;
+    switch<T>(value: T, cases: SwitchCase<T, this>[], defaultBuilderFn?: AppendParam<this, TAdditionalAppends>, equals?: (a: T, b: T) => boolean): 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 or the content itself.
+     * @param condition The condition to check before adding indentation.
+     * @returns A reference to this instance.
+     */
+    indent(value: AppendParam<this, TAdditionalAppends>): this;
+    /**
+     * 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.
+     */
+    indentIf(condition: Condition, value: AppendParam<this, TAdditionalAppends>): this;
+    /**
+     * Adds parentheses around the specified content.
+     * @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.
+     */
+    parenthesize(brackets: Paratheses<this>, value: AppendParam<this, TAdditionalAppends>, options?: ParenthesizeOptions): this;
+    /**
+     * 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.
+     */
+    parenthesizeIf(condition: Condition, brackets: Paratheses<this>, value: AppendParam<this, TAdditionalAppends>, options?: ParenthesizeOptions): 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.
+     * @param options The options for the loop.
+     * @returns A reference to this instance.
+     */
+    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<AppendParam<this, TAdditionalAppends>>, separator: string): this;
+    appendSeparatedIf(condition: Condition, items: Iterable<AppendParam<this, TAdditionalAppends>>, separator: string): this;
+    private appendIndent;
+}
+declare function _builderTemplate<T extends SourceBuilder>(template: readonly string[] | ArrayLike<string>, ...substitutions: AppendValue<T>[]): BuilderFn<T>;
+declare const _builderTemplateExtensions: {
+    readonly indent: <T extends SourceBuilder>(template: readonly string[] | ArrayLike<string>, ...substitutions: AppendValue<T>[]) => BuilderFn<T>;
+};
+export declare const builderTemplate: typeof _builderTemplate & typeof _builderTemplateExtensions;
+export {};
+//# sourceMappingURL=source-builder.d.ts.map

package/script/src/utils/source-builder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"source-builder.d.ts","sourceRoot":"","sources":["../../../src/src/utils/source-builder.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,SAAS,EAAiB,MAAM,gBAAgB,CAAC;AAC/D,OAAO,EAA+B,KAAK,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AACrG,OAAO,EAAE,KAAK,WAAW,EAAE,KAAK,SAAS,EAAE,aAAa,EAAE,MAAM,oCAAoC,CAAC;AACrG,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;AAE7D,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAEhD,MAAM,MAAM,aAAa,GAAG;IAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GAAG;IAAE,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CAAC;AAE5G;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,oBAAoB,GAAG;IACxD;;;OAGG;IACH,MAAM,EAAE,aAAa,CAAC;CACvB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,2BAA2B,EAAE,oBAIzC,CAAC;AAEF,KAAK,eAAe,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC;AACjD,MAAM,MAAM,UAAU,CAAC,QAAQ,SAAS,aAAa,IACjD,eAAe,GACf,IAAI,CAAC,MAAM,EAAE,eAAe,CAAC,GAC7B,CAAC,IAAI,EAAE,QAAQ,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,QAAQ,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;AAEpF,MAAM,MAAM,kBAAkB,CAAC,QAAQ,EAAE,KAAK,IAAI,CAChD,OAAO,EAAE,QAAQ,EACjB,YAAY,EAAE,KAAK,EACnB,QAAQ,EAAE,KAAK,EACf,iBAAiB,EAAE,MAAM,EACzB,aAAa,EAAE,MAAM,KAClB,IAAI,CAAC;AACV,MAAM,MAAM,SAAS,CAAC,QAAQ,EAAE,KAAK,IAAI,MAAM,GAAG,kBAAkB,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;AAEtF;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC;;;OAGG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC;IAC7B;;;OAGG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC;IAC1B;;;;OAIG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,OAAO,CAAC;CACjC,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,cAAc,CAAC,QAAQ,EAAE,KAAK,IAAI;IAC5C;;OAEG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,CAAC,KAAK,CAAC,CAAC;IACtC;;OAEG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;CACjD,CAAC;AAEF,KAAK,UAAU,CAAC,MAAM,EAAE,QAAQ,SAAS,aAAa,IAAI;IACxD,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,WAAW,CAAC,QAAQ,CAAC,CAAC;CAC9B,CAAC;AAOF;;GAEG;AACH,qBAAa,aAAa,CAAC,kBAAkB,GAAG,KAAK,CAAE,SAAQ,aAAa,CAAC,kBAAkB,CAAC;IAC9F,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAuB;IACjD,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAS;IAEvC,OAAO,CAAC,eAAe,CAAkB;IACzC,OAAO,CAAC,gBAAgB,CAAiB;IACzC,OAAO,CAAC,mBAAmB,CAAiB;IAC5C,OAAO,CAAC,gBAAgB,CAAwB;IAEhD;;OAEG;IACH,IAAoB,OAAO,IAAI,oBAAoB,CAElD;IAED;;;OAGG;gBACS,OAAO,CAAC,EAAE,OAAO,CAAC,oBAAoB,CAAC;IAMnD;;;;;OAKG;WACoB,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,oBAAoB,CAAC,GAAG,aAAa;IAMtG;;;;;OAKG;WACoB,KAAK,CAC1B,WAAW,EAAE,WAAW,CAAC,aAAa,EAAE,KAAK,CAAC,EAC9C,OAAO,CAAC,EAAE,OAAO,CAAC,oBAAoB,CAAC,GACtC,MAAM;cAMU,YAAY,CAAC,KAAK,EAAE,WAAW,CAAC,IAAI,EAAE,kBAAkB,CAAC;IAgE5E;;;;;OAKG;IACI,QAAQ,CAAC,SAAS,EAAE,SAAS,EAAE,GAAG,KAAK,EAAE,WAAW,CAAC,IAAI,EAAE,kBAAkB,CAAC,EAAE,GAAG,IAAI;IAO9F;;;;OAIG;IACa,UAAU,CAAC,GAAG,KAAK,EAAE,WAAW,CAAC,IAAI,EAAE,kBAAkB,CAAC,EAAE,GAAG,IAAI;IAInF;;;;;OAKG;IACI,YAAY,CAAC,SAAS,EAAE,SAAS,EAAE,GAAG,KAAK,EAAE,WAAW,CAAC,IAAI,EAAE,kBAAkB,CAAC,EAAE,GAAG,IAAI;IAOlG;;;;;OAKG;IACI,oBAAoB,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,KAAK,EAAE,WAAW,CAAC,IAAI,EAAE,kBAAkB,CAAC,EAAE,GAAG,IAAI;IAWpG;;;;;OAKG;IACI,wBAAwB,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,KAAK,EAAE,WAAW,CAAC,IAAI,EAAE,kBAAkB,CAAC,EAAE,GAAG,IAAI;IAIxG;;;;;OAKG;IACI,SAAS,CAAC,SAAS,EAAE,SAAS,EAAE,GAAG,KAAK,EAAE,WAAW,CAAC,aAAa,EAAE,KAAK,CAAC,EAAE,GAAG,IAAI;IAO3F;;;;;OAKG;IACI,aAAa,CAAC,SAAS,EAAE,SAAS,EAAE,GAAG,KAAK,EAAE,WAAW,CAAC,aAAa,EAAE,KAAK,CAAC,EAAE,GAAG,IAAI;IAO/F;;;OAGG;IACI,uBAAuB,IAAI,IAAI;IAWtC;;;OAGG;IACI,sBAAsB,IAAI,IAAI;IAQrC;;;OAGG;IACI,wBAAwB,IAAI,IAAI;IAMvC;;;OAGG;IACI,uBAAuB,IAAI,IAAI;IAKtC;;;;;;OAMG;IACI,EAAE,CACP,SAAS,EAAE,SAAS,EACpB,SAAS,EAAE,WAAW,CAAC,IAAI,EAAE,kBAAkB,CAAC,EAChD,aAAa,CAAC,EAAE,WAAW,CAAC,IAAI,EAAE,kBAAkB,CAAC,GACpD,IAAI;IAIA,MAAM,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,EACrC,KAAK,EAAE,CAAC,EACR,KAAK,EAAE,MAAM,CAAC,CAAC,EAAE,WAAW,CAAC,IAAI,EAAE,kBAAkB,CAAC,CAAC,EACvD,gBAAgB,CAAC,EAAE,WAAW,CAAC,IAAI,EAAE,kBAAkB,CAAC,GACvD,IAAI;IACA,MAAM,CAAC,CAAC,EACb,KAAK,EAAE,CAAC,EACR,KAAK,EAAE,UAAU,CAAC,CAAC,EAAE,IAAI,CAAC,EAAE,EAC5B,gBAAgB,CAAC,EAAE,WAAW,CAAC,IAAI,EAAE,kBAAkB,CAAC,EACxD,MAAM,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,OAAO,GAC/B,IAAI;IAqBP;;;;;OAKG;IACI,MAAM,CAAC,KAAK,EAAE,WAAW,CAAC,IAAI,EAAE,kBAAkB,CAAC,GAAG,IAAI;IAWjE;;;;;OAKG;IACI,QAAQ,CAAC,SAAS,EAAE,SAAS,EAAE,KAAK,EAAE,WAAW,CAAC,IAAI,EAAE,kBAAkB,CAAC,GAAG,IAAI;IAIzF;;;;;;OAMG;IACI,YAAY,CACjB,QAAQ,EAAE,UAAU,CAAC,IAAI,CAAC,EAC1B,KAAK,EAAE,WAAW,CAAC,IAAI,EAAE,kBAAkB,CAAC,EAC5C,OAAO,CAAC,EAAE,mBAAmB,GAC5B,IAAI;IAyBP;;;;;;;OAOG;IACI,cAAc,CACnB,SAAS,EAAE,SAAS,EACpB,QAAQ,EAAE,UAAU,CAAC,IAAI,CAAC,EAC1B,KAAK,EAAE,WAAW,CAAC,IAAI,EAAE,kBAAkB,CAAC,EAC5C,OAAO,CAAC,EAAE,mBAAmB,GAC5B,IAAI;IAUP;;;;;;OAMG;IACI,OAAO,CAAC,CAAC,EACd,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC,EAClB,SAAS,EAAE,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,MAAM,KAAK,IAAI,EAC1D,OAAO,CAAC,EAAE,cAAc,CAAC,IAAI,EAAE,CAAC,CAAC,GAChC,IAAI;IA8BA,SAAS,CAAC,CAAC,EAChB,SAAS,EAAE,SAAS,EACpB,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC,EAClB,SAAS,EAAE,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,MAAM,KAAK,IAAI,EAC1D,OAAO,CAAC,EAAE,cAAc,CAAC,IAAI,EAAE,CAAC,CAAC,GAChC,IAAI;IAOA,eAAe,CAAC,KAAK,EAAE,QAAQ,CAAC,WAAW,CAAC,IAAI,EAAE,kBAAkB,CAAC,CAAC,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;IAIhG,iBAAiB,CACtB,SAAS,EAAE,SAAS,EACpB,KAAK,EAAE,QAAQ,CAAC,WAAW,CAAC,IAAI,EAAE,kBAAkB,CAAC,CAAC,EACtD,SAAS,EAAE,MAAM,GAChB,IAAI;IAOP,OAAO,CAAC,YAAY;CAGrB;AAED,iBAAS,gBAAgB,CAAC,CAAC,SAAS,aAAa,EAC/C,QAAQ,EAAE,SAAS,MAAM,EAAE,GAAG,SAAS,CAAC,MAAM,CAAC,EAC/C,GAAG,aAAa,EAAE,WAAW,CAAC,CAAC,CAAC,EAAE,GACjC,SAAS,CAAC,CAAC,CAAC,CAiBd;AAED,QAAA,MAAM,0BAA0B;sBACrB,CAAC,SAAS,aAAa,YACpB,SAAS,MAAM,EAAE,GAAG,SAAS,CAAC,MAAM,CAAC,oBAC7B,WAAW,CAAC,CAAC,CAAC,EAAE,KACjC,SAAS,CAAC,CAAC,CAAC;CAGP,CAAC;AAEX,eAAO,MAAM,eAAe,EAAE,OAAO,gBAAgB,GAAG,OAAO,0BAG9D,CAAC"}