@goast/typescript 0.4.0-beta4 → 0.4.0

package/esm/src/ast/nodes/constructor.test.js

@@ -0,0 +1,102 @@
+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, it } from '../../../deps/jsr.io/@std/testing/1.0.3/bdd.js';
+import { normalizeEOL } from '@goast/test-utils';
+import { TypeScriptFileBuilder } from '../../file-builder.js';
+import { tsConstructorParameter } from './constructor-parameter.js';
+import { tsConstructor } from './constructor.js';
+import { tsDecorator } from './decorator.js';
+import { tsDocTag } from './doc-tag.js';
+import { tsDoc } from './doc.js';
+let builder;
+beforeEach(() => {
+    builder = new TypeScriptFileBuilder();
+});
+it('should write empty constructor', () => {
+    builder.append(tsConstructor());
+    expect(builder.toString(false)).toBe(`constructor() {}${EOL}`);
+});
+it('should write documentation if it exists', () => {
+    builder.append(tsConstructor({ doc: tsDoc({ description: 'description' }) }));
+    expect(builder.toString(false)).toBe(`/**${EOL} * description${EOL} */${EOL}constructor() {}${EOL}`);
+});
+it('should write decorators if they exist', () => {
+    builder.append(tsConstructor({ decorators: [tsDecorator('decorator')] }));
+    expect(builder.toString(false)).toBe(`@decorator${EOL}constructor() {}${EOL}`);
+});
+it('should write the parameters', () => {
+    builder.append(tsConstructor({
+        parameters: ['x', 'y'],
+    }));
+    expect(builder.toString(false)).toBe(`constructor(x, y) {}${EOL}`);
+});
+it('should write the description of the parameters when no documentation is provided', () => {
+    builder.append(tsConstructor({
+        parameters: [tsConstructorParameter('x', { description: 'description' }), 'y'],
+    }));
+    expect(builder.toString(false)).toBe(`/**${EOL} * @param x description${EOL} */${EOL}constructor(x, y) {}${EOL}`);
+});
+it('should write the body', () => {
+    builder.append(tsConstructor({ body: 'this.x = x;' }));
+    expect(builder.toString(false)).toBe(`constructor() {${EOL}  this.x = x;${EOL}}${EOL}`);
+});
+it('should write the description of the parameter when documentation is provided', () => {
+    builder.append(tsConstructor({
+        doc: tsDoc({
+            description: 'description',
+            tags: [tsDocTag('param', 'y', 'y-description'), tsDocTag('returns', 'r-description')],
+        }),
+        decorators: [tsDecorator('decorator')],
+        parameters: [tsConstructorParameter('x', { description: 'x-description' }), 'y'],
+        body: 'this.x = x;',
+    }));
+    expect(builder.toString(false)).toBe(normalizeEOL(6)(`/**
+       * description
+       *
+       * @param x x-description
+       * @param y y-description
+       * @returns r-description
+       */
+      @decorator
+      constructor(x, y) {
+        this.x = x;
+      }
+      `));
+});
+it('should render injections', () => {
+    builder.append(tsConstructor({
+        doc: tsDoc({
+            description: 'description',
+            tags: [tsDocTag('param', 'y', 'y-description'), tsDocTag('returns', 'r-description')],
+        }),
+        decorators: [tsDecorator('decorator')],
+        parameters: [tsConstructorParameter('x', { description: 'x-description' }), 'y'],
+        body: 'this.x = x;',
+        inject: {
+            before: '║b║',
+            after: '║a║',
+            beforeParams: '║bp║',
+            afterParams: '║ap║',
+            beforeDoc: '║bd║',
+            afterDoc: '║ad║',
+            beforeDecorators: '║bds║',
+            afterDecorators: '║ads║',
+            beforeBody: '║bb║',
+            afterBody: '║ab║',
+        },
+    }));
+    expect(builder.toString(false)).toBe(normalizeEOL(6)(`║b║║bd║
+      /**
+       * description
+       *
+       * @param x x-description
+       * @param y y-description
+       * @returns r-description
+       */
+      ║ad║║bds║@decorator
+      ║ads║constructor║bp║(x, y)║ap║ ║bb║{
+        this.x = x;
+      }║ab║
+      ║a║`));
+});

package/esm/src/ast/nodes/decorator.d.ts

@@ -0,0 +1,25 @@
+import { type AppendValue, type AstNodeOptions, type BasicAppendValue, type Nullable, type Prettify, type SingleOrMultiple, type SourceBuilder } from '@goast/core';
+import { TsNode } from '../node.js';
+import { type TsArgument } from './argument.js';
+import type { TsReference } from './reference.js';
+import type { TsValue } from './types.js';
+type Injects = 'function' | 'arguments';
+type Options<TBuilder extends SourceBuilder, TInjects extends string = never> = AstNodeOptions<typeof TsNode<TBuilder, TInjects | Injects>, {
+    function: TsReference<TBuilder> | BasicAppendValue<TBuilder>;
+    arguments?: Nullable<Nullable<TsArgument<TBuilder> | TsValue<TBuilder>>[]>;
+}>;
+export declare class TsDecorator<TBuilder extends SourceBuilder, TInjects extends string = never> extends TsNode<TBuilder, TInjects | Injects> {
+    function: TsReference<TBuilder> | BasicAppendValue<TBuilder>;
+    arguments: (TsArgument<TBuilder> | TsValue<TBuilder>)[] | null;
+    constructor(options: Options<TBuilder, TInjects>);
+    protected onWrite(builder: TBuilder): void;
+}
+declare const createDecorator: <TBuilder extends SourceBuilder>(fn: Options<TBuilder>["function"], args?: Options<TBuilder>["arguments"], options?: Prettify<Omit<Options<TBuilder>, "function" | "arguments">>) => TsDecorator<TBuilder>;
+declare const writeDecorators: <TBuilder extends SourceBuilder>(builder: TBuilder, nodes: SingleOrMultiple<Nullable<TsDecorator<TBuilder> | AppendValue<TBuilder>>>, options?: {
+    multiline?: boolean;
+}) => void;
+export declare const tsDecorator: typeof createDecorator & {
+    write: typeof writeDecorators;
+};
+export {};
+//# sourceMappingURL=decorator.d.ts.map

package/esm/src/ast/nodes/decorator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"decorator.d.ts","sourceRoot":"","sources":["../../../../src/src/ast/nodes/decorator.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,WAAW,EAChB,KAAK,cAAc,EACnB,KAAK,gBAAgB,EAErB,KAAK,QAAQ,EACb,KAAK,QAAQ,EACb,KAAK,gBAAgB,EACrB,KAAK,aAAa,EAEnB,MAAM,aAAa,CAAC;AAErB,OAAO,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AAEpC,OAAO,EAAE,KAAK,UAAU,EAAc,MAAM,eAAe,CAAC;AAC5D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAClD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAE1C,KAAK,OAAO,GAAG,UAAU,GAAG,WAAW,CAAC;AAExC,KAAK,OAAO,CAAC,QAAQ,SAAS,aAAa,EAAE,QAAQ,SAAS,MAAM,GAAG,KAAK,IAAI,cAAc,CAC5F,OAAO,MAAM,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,EAC3C;IACE,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAAC,GAAG,gBAAgB,CAAC,QAAQ,CAAC,CAAC;IAC7D,SAAS,CAAC,EAAE,QAAQ,CAAC,QAAQ,CAAC,UAAU,CAAC,QAAQ,CAAC,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC;CAC5E,CACF,CAAC;AAEF,qBAAa,WAAW,CAAC,QAAQ,SAAS,aAAa,EAAE,QAAQ,SAAS,MAAM,GAAG,KAAK,CAAE,SAAQ,MAAM,CACtG,QAAQ,EACR,QAAQ,GAAG,OAAO,CACnB;IACQ,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAAC,GAAG,gBAAgB,CAAC,QAAQ,CAAC,CAAC;IAC7D,SAAS,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,IAAI,CAAC;gBAE1D,OAAO,EAAE,OAAO,CAAC,QAAQ,EAAE,QAAQ,CAAC;cAM7B,OAAO,CAAC,OAAO,EAAE,QAAQ,GAAG,IAAI;CAYpD;AAED,QAAA,MAAM,eAAe,GAAI,QAAQ,SAAS,aAAa,MACjD,OAAO,CAAC,QAAQ,CAAC,CAAC,UAAU,CAAC,SAC1B,OAAO,CAAC,QAAQ,CAAC,CAAC,WAAW,CAAC,YAC3B,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,UAAU,GAAG,WAAW,CAAC,CAAC,KACpE,WAAW,CAAC,QAAQ,CAA6E,CAAC;AAErG,QAAA,MAAM,eAAe,GAAI,QAAQ,SAAS,aAAa,WAC5C,QAAQ,SACV,gBAAgB,CAAC,QAAQ,CAAC,WAAW,CAAC,QAAQ,CAAC,GAAG,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC,YACtE;IAAE,SAAS,CAAC,EAAE,OAAO,CAAA;CAAE,KAChC,IAMF,CAAC;AAEF,eAAO,MAAM,WAAW,EAAE,OAAO,eAAe,GAAG;IAAE,KAAK,EAAE,OAAO,eAAe,CAAA;CAEhF,CAAC"}

package/esm/src/ast/nodes/decorator.js

@@ -0,0 +1,46 @@
+import { notNullish, toArray, } from '@goast/core';
+import { TsNode } from '../node.js';
+import { writeTsNode } from '../utils/write-ts-nodes.js';
+import { tsArgument } from './argument.js';
+export class TsDecorator extends TsNode {
+    constructor(options) {
+        var _a, _b;
+        super(options);
+        Object.defineProperty(this, "function", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "arguments", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.function = options.function;
+        this.arguments = (_b = (_a = options.arguments) === null || _a === void 0 ? void 0 : _a.filter(notNullish)) !== null && _b !== void 0 ? _b : null;
+    }
+    onWrite(builder) {
+        builder.append('@');
+        builder.append(this.inject.beforeFunction);
+        writeTsNode(builder, this.function);
+        builder.append(this.inject.afterFunction);
+        if (this.arguments) {
+            builder.append(this.inject.beforeArguments);
+            tsArgument.write(builder, this.arguments);
+            builder.append(this.inject.afterArguments);
+        }
+    }
+}
+const createDecorator = (fn, args, options) => new TsDecorator({ ...options, function: fn, arguments: args });
+const writeDecorators = (builder, nodes, options) => {
+    const filteredNodes = toArray(nodes).filter(notNullish);
+    builder.forEach(filteredNodes, (b, d) => {
+        writeTsNode(b, d);
+        b.append((options === null || options === void 0 ? void 0 : options.multiline) ? '\n' : ' ');
+    });
+};
+export const tsDecorator = Object.assign(createDecorator, {
+    write: writeDecorators,
+});

package/esm/src/ast/nodes/decorator.test.d.ts

@@ -0,0 +1,2 @@
+import "../../../_dnt.test_polyfills.js";
+//# sourceMappingURL=decorator.test.d.ts.map

package/esm/src/ast/nodes/decorator.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"decorator.test.d.ts","sourceRoot":"","sources":["../../../../src/src/ast/nodes/decorator.test.ts"],"names":[],"mappings":"AAAA,OAAO,iCAAiC,CAAC"}

package/esm/src/ast/nodes/decorator.test.js

@@ -0,0 +1,47 @@
+import "../../../_dnt.test_polyfills.js";
+import { EOL } from 'node:os';
+import { expect } from '../../../deps/jsr.io/@std/expect/1.0.5/expect.js';
+import { beforeEach, describe, it } from '../../../deps/jsr.io/@std/testing/1.0.3/bdd.js';
+import { TypeScriptFileBuilder } from '../../file-builder.js';
+import { tsDecorator } from './decorator.js';
+let builder;
+beforeEach(() => {
+    builder = new TypeScriptFileBuilder();
+});
+describe('single', () => {
+    it('should write a static decorator', () => {
+        builder.append(tsDecorator('decorator'));
+        expect(builder.toString(false)).toBe(`@decorator`);
+    });
+    it('should write a decorator without arguments', () => {
+        builder.append(tsDecorator('decorator', []));
+        expect(builder.toString(false)).toBe(`@decorator()`);
+    });
+    it('should write a decorator with arguments', () => {
+        builder.append(tsDecorator('decorator', ['arg1', 'arg2']));
+        expect(builder.toString(false)).toBe(`@decorator(arg1, arg2)`);
+    });
+    it('should render injections', () => {
+        builder.append(tsDecorator('decorator', ['arg1', 'arg2'], {
+            inject: {
+                before: '║b║',
+                after: '║a║',
+                beforeFunction: '║bf║',
+                afterFunction: '║af║',
+                beforeArguments: '║ba║',
+                afterArguments: '║aa║',
+            },
+        }));
+        expect(builder.toString(false)).toBe(`║b║@║bf║decorator║af║║ba║(arg1, arg2)║aa║║a║`);
+    });
+});
+describe('multiple', () => {
+    it('should write decorators across multiple lines', () => {
+        tsDecorator.write(builder, [tsDecorator('decorator1'), tsDecorator('decorator2')], { multiline: true });
+        expect(builder.toString(false)).toBe(`@decorator1${EOL}@decorator2${EOL}`);
+    });
+    it('should write decorators on the same line', () => {
+        tsDecorator.write(builder, [tsDecorator('decorator1'), tsDecorator('decorator2')], { multiline: false });
+        expect(builder.toString(false)).toBe(`@decorator1 @decorator2 `);
+    });
+});

package/esm/src/ast/nodes/doc-tag.d.ts

@@ -0,0 +1,74 @@
+import { type AstNodeOptions, type BasicAppendValue, type Nullable, type ParametersWithOverloads, type Prettify, type SourceBuilder, type StringSuggestions } from '@goast/core';
+import { TsNode } from '../node.js';
+import { writeTsNodes } from '../utils/write-ts-nodes.js';
+import type { TsType } from './types.js';
+type Injects = never;
+type Options<TBuilder extends SourceBuilder, TInjects extends string = never> = AstNodeOptions<typeof TsNode<TBuilder, TInjects | Injects>, {
+    tag: string;
+    type?: Nullable<TsType<TBuilder>>;
+    text?: Nullable<BasicAppendValue<TBuilder>>;
+}>;
+export declare class TsDocTag<TBuilder extends SourceBuilder, TInjects extends string = never> extends TsNode<TBuilder, TInjects | Injects> {
+    tag: string;
+    type: TsType<TBuilder> | null;
+    text: BasicAppendValue<TBuilder> | null;
+    constructor(options: Options<TBuilder, TInjects>);
+    protected onWrite(builder: TBuilder): void;
+}
+type _TsDocTagOpt<TBuilder extends SourceBuilder> = Prettify<Omit<Options<TBuilder>, 'tag'>>;
+type _TsDocTagArgsMap<TBuilder extends SourceBuilder> = {
+    access(access: StringSuggestions<'package' | 'private' | 'protected' | 'public'>, options?: _TsDocTagOpt<TBuilder>): never;
+    author(authorName: BasicAppendValue<TBuilder>, options?: _TsDocTagOpt<TBuilder>): never;
+    author(authorName: BasicAppendValue<TBuilder>, emailAddress: BasicAppendValue<TBuilder>, options?: _TsDocTagOpt<TBuilder>): never;
+    borrows(thatNamepath: BasicAppendValue<TBuilder>, thisNamepath: BasicAppendValue<TBuilder>, options?: _TsDocTagOpt<TBuilder>): never;
+    params(paramName: BasicAppendValue<TBuilder>, paramDescription: BasicAppendValue<TBuilder>, options?: _TsDocTagOpt<TBuilder>): never;
+    example(caption: BasicAppendValue<TBuilder>, code: BasicAppendValue<TBuilder>, options?: _TsDocTagOpt<TBuilder>): never;
+    example(code: BasicAppendValue<TBuilder>, options?: _TsDocTagOpt<TBuilder>): never;
+    exports(moduleName: BasicAppendValue<TBuilder>, exportName: BasicAppendValue<TBuilder>, options?: _TsDocTagOpt<TBuilder>): never;
+    kind(kindName: StringSuggestions<'class' | 'constant' | 'event' | 'external' | 'file' | 'function' | 'member' | 'mixin' | 'module' | 'namespace' | 'typedef'>, options?: _TsDocTagOpt<TBuilder>): never;
+    license(identifier: BasicAppendValue<TBuilder>, options?: _TsDocTagOpt<TBuilder>): never;
+    listens(eventName: BasicAppendValue<TBuilder>, options?: _TsDocTagOpt<TBuilder>): never;
+    mixes(otherObjectPath: BasicAppendValue<TBuilder>, options?: _TsDocTagOpt<TBuilder>): never;
+    mixin(mixinName: BasicAppendValue<TBuilder>, options?: _TsDocTagOpt<TBuilder>): never;
+    requires(moduleName: BasicAppendValue<TBuilder>, options?: _TsDocTagOpt<TBuilder>): never;
+    variation(variationNumber: BasicAppendValue<TBuilder>, options?: _TsDocTagOpt<TBuilder>): never;
+} & {
+    [K in 'virtual' | 'abstract']: (options?: _TsDocTagOpt<TBuilder>) => never;
+} & {
+    [K in 'alias' | 'augments' | 'callback' | 'extends' | 'lends' | 'name' | 'see' | 'this']: (namePath: BasicAppendValue<TBuilder>, options?: _TsDocTagOpt<TBuilder>) => never;
+} & {
+    [K in 'async' | 'generator' | 'global' | 'hideconstructor' | 'ignore' | 'inheritdoc' | 'inner' | 'instance' | 'override' | 'static' | 'enum' | 'package' | 'private' | 'protected' | 'implements' | 'type']: (options?: _TsDocTagOpt<TBuilder>) => never;
+} & {
+    [K in 'class' | 'constructor' | 'const' | 'function' | 'func' | 'method' | 'constant' | 'member' | 'constructs' | 'interface' | 'var' | 'yield' | 'yields' | 'module' | 'namespace' | 'typedef']: {
+        (name: BasicAppendValue<TBuilder>, options?: _TsDocTagOpt<TBuilder>): never;
+        (options?: _TsDocTagOpt<TBuilder>): never;
+    };
+} & {
+    [K in 'return' | 'returns' | 'throws' | 'exception' | 'classdesc' | 'copyright' | 'deprecated' | 'desc' | 'description' | 'file' | 'fileoverview' | 'overview' | 'public' | 'readonly' | 'since' | 'summary' | 'todo' | 'tutorial' | 'version']: {
+        (description: BasicAppendValue<TBuilder>, options?: _TsDocTagOpt<TBuilder>): never;
+        (options?: _TsDocTagOpt<TBuilder>): never;
+    };
+} & {
+    [K in 'default' | 'defaultvalue']: {
+        (value: BasicAppendValue<TBuilder>, options?: _TsDocTagOpt<TBuilder>): never;
+        (options?: _TsDocTagOpt<TBuilder>): never;
+    };
+} & {
+    [K in 'event' | 'fires']: (className: BasicAppendValue<TBuilder>, eventName: BasicAppendValue<TBuilder>, options?: _TsDocTagOpt<TBuilder>) => never;
+} & {
+    [K in 'external' | 'host']: (nameOfExternal: BasicAppendValue<TBuilder>, options?: _TsDocTagOpt<TBuilder>) => never;
+} & {
+    [K in 'memberof' | 'memberof!']: (parentNamepath: BasicAppendValue<TBuilder>, options?: _TsDocTagOpt<TBuilder>) => never;
+} & {
+    [K in 'param' | 'arg' | 'argument' | 'prop' | 'property' | 'template']: {
+        (name: BasicAppendValue<TBuilder>, description: BasicAppendValue<TBuilder>, options?: _TsDocTagOpt<TBuilder>): never;
+        (name: BasicAppendValue<TBuilder>, options?: _TsDocTagOpt<TBuilder>): never;
+    };
+};
+type _TsDocTagArgs<TTagName extends StringSuggestions<keyof _TsDocTagArgsMap<TBuilder>>, TBuilder extends SourceBuilder> = TTagName extends keyof _TsDocTagArgsMap<TBuilder> ? _TsDocTagArgsMap<TBuilder>[TTagName] extends (...args: any[]) => any ? ParametersWithOverloads<_TsDocTagArgsMap<TBuilder>[TTagName]> : never : [options?: _TsDocTagOpt<TBuilder>];
+declare function createDocTag<TTagName extends StringSuggestions<keyof _TsDocTagArgsMap<TBuilder>>, TBuilder extends SourceBuilder>(tag: TTagName, ...args: _TsDocTagArgs<TTagName, TBuilder>): TsDocTag<TBuilder>;
+export declare const tsDocTag: typeof createDocTag & {
+    write: typeof writeTsNodes;
+};
+export {};
+//# sourceMappingURL=doc-tag.d.ts.map

package/esm/src/ast/nodes/doc-tag.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"doc-tag.d.ts","sourceRoot":"","sources":["../../../../src/src/ast/nodes/doc-tag.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,cAAc,EACnB,KAAK,gBAAgB,EAGrB,KAAK,QAAQ,EACb,KAAK,uBAAuB,EAC5B,KAAK,QAAQ,EACb,KAAK,aAAa,EAClB,KAAK,iBAAiB,EACvB,MAAM,aAAa,CAAC;AAGrB,OAAO,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AACpC,OAAO,EAAe,YAAY,EAAE,MAAM,4BAA4B,CAAC;AACvE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AAEzC,KAAK,OAAO,GAAG,KAAK,CAAC;AAErB,KAAK,OAAO,CAAC,QAAQ,SAAS,aAAa,EAAE,QAAQ,SAAS,MAAM,GAAG,KAAK,IAAI,cAAc,CAC5F,OAAO,MAAM,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,EAC3C;IACE,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC;IAClC,IAAI,CAAC,EAAE,QAAQ,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC,CAAC;CAC7C,CACF,CAAC;AAEF,qBAAa,QAAQ,CAAC,QAAQ,SAAS,aAAa,EAAE,QAAQ,SAAS,MAAM,GAAG,KAAK,CAAE,SAAQ,MAAM,CACnG,QAAQ,EACR,QAAQ,GAAG,OAAO,CACnB;IACQ,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC;IAC9B,IAAI,EAAE,gBAAgB,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC;gBAEnC,OAAO,EAAE,OAAO,CAAC,QAAQ,EAAE,QAAQ,CAAC;cAO7B,OAAO,CAAC,OAAO,EAAE,QAAQ,GAAG,IAAI;CAYpD;AAED,KAAK,YAAY,CAAC,QAAQ,SAAS,aAAa,IAAI,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC;AAE7F,KAAK,gBAAgB,CAAC,QAAQ,SAAS,aAAa,IAChD;IACA,MAAM,CACJ,MAAM,EAAE,iBAAiB,CAAC,SAAS,GAAG,SAAS,GAAG,WAAW,GAAG,QAAQ,CAAC,EACzE,OAAO,CAAC,EAAE,YAAY,CAAC,QAAQ,CAAC,GAC/B,KAAK,CAAC;IACT,MAAM,CAAC,UAAU,EAAE,gBAAgB,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC,EAAE,YAAY,CAAC,QAAQ,CAAC,GAAG,KAAK,CAAC;IACxF,MAAM,CACJ,UAAU,EAAE,gBAAgB,CAAC,QAAQ,CAAC,EACtC,YAAY,EAAE,gBAAgB,CAAC,QAAQ,CAAC,EACxC,OAAO,CAAC,EAAE,YAAY,CAAC,QAAQ,CAAC,GAC/B,KAAK,CAAC;IACT,OAAO,CACL,YAAY,EAAE,gBAAgB,CAAC,QAAQ,CAAC,EACxC,YAAY,EAAE,gBAAgB,CAAC,QAAQ,CAAC,EACxC,OAAO,CAAC,EAAE,YAAY,CAAC,QAAQ,CAAC,GAC/B,KAAK,CAAC;IACT,MAAM,CACJ,SAAS,EAAE,gBAAgB,CAAC,QAAQ,CAAC,EACrC,gBAAgB,EAAE,gBAAgB,CAAC,QAAQ,CAAC,EAC5C,OAAO,CAAC,EAAE,YAAY,CAAC,QAAQ,CAAC,GAC/B,KAAK,CAAC;IACT,OAAO,CACL,OAAO,EAAE,gBAAgB,CAAC,QAAQ,CAAC,EACnC,IAAI,EAAE,gBAAgB,CAAC,QAAQ,CAAC,EAChC,OAAO,CAAC,EAAE,YAAY,CAAC,QAAQ,CAAC,GAC/B,KAAK,CAAC;IACT,OAAO,CAAC,IAAI,EAAE,gBAAgB,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC,EAAE,YAAY,CAAC,QAAQ,CAAC,GAAG,KAAK,CAAC;IACnF,OAAO,CACL,UAAU,EAAE,gBAAgB,CAAC,QAAQ,CAAC,EACtC,UAAU,EAAE,gBAAgB,CAAC,QAAQ,CAAC,EACtC,OAAO,CAAC,EAAE,YAAY,CAAC,QAAQ,CAAC,GAC/B,KAAK,CAAC;IACT,IAAI,CACF,QAAQ,EAAE,iBAAiB,CACvB,OAAO,GACP,UAAU,GACV,OAAO,GACP,UAAU,GACV,MAAM,GACN,UAAU,GACV,QAAQ,GACR,OAAO,GACP,QAAQ,GACR,WAAW,GACX,SAAS,CACZ,EACD,OAAO,CAAC,EAAE,YAAY,CAAC,QAAQ,CAAC,GAC/B,KAAK,CAAC;IACT,OAAO,CAAC,UAAU,EAAE,gBAAgB,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC,EAAE,YAAY,CAAC,QAAQ,CAAC,GAAG,KAAK,CAAC;IACzF,OAAO,CAAC,SAAS,EAAE,gBAAgB,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC,EAAE,YAAY,CAAC,QAAQ,CAAC,GAAG,KAAK,CAAC;IACxF,KAAK,CAAC,eAAe,EAAE,gBAAgB,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC,EAAE,YAAY,CAAC,QAAQ,CAAC,GAAG,KAAK,CAAC;IAC5F,KAAK,CAAC,SAAS,EAAE,gBAAgB,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC,EAAE,YAAY,CAAC,QAAQ,CAAC,GAAG,KAAK,CAAC;IACtF,QAAQ,CAAC,UAAU,EAAE,gBAAgB,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC,EAAE,YAAY,CAAC,QAAQ,CAAC,GAAG,KAAK,CAAC;IAC1F,SAAS,CAAC,eAAe,EAAE,gBAAgB,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC,EAAE,YAAY,CAAC,QAAQ,CAAC,GAAG,KAAK,CAAC;CACjG,GACC;KACC,CAAC,IAAI,SAAS,GAAG,UAAU,GAAG,CAAC,OAAO,CAAC,EAAE,YAAY,CAAC,QAAQ,CAAC,KAAK,KAAK;CAC3E,GACC;KACC,CAAC,IAAI,OAAO,GAAG,UAAU,GAAG,UAAU,GAAG,SAAS,GAAG,OAAO,GAAG,MAAM,GAAG,KAAK,GAAG,MAAM,GAAG,CACxF,QAAQ,EAAE,gBAAgB,CAAC,QAAQ,CAAC,EACpC,OAAO,CAAC,EAAE,YAAY,CAAC,QAAQ,CAAC,KAC7B,KAAK;CACX,GACC;KAEE,CAAC,IACG,OAAO,GACP,WAAW,GACX,QAAQ,GACR,iBAAiB,GACjB,QAAQ,GACR,YAAY,GACZ,OAAO,GACP,UAAU,GACV,UAAU,GACV,QAAQ,GACR,MAAM,GACN,SAAS,GACT,SAAS,GACT,WAAW,GACX,YAAY,GACZ,MAAM,GACT,CAAC,OAAO,CAAC,EAAE,YAAY,CAAC,QAAQ,CAAC,KAAK,KAAK;CAC/C,GACC;KAEE,CAAC,IACG,OAAO,GACP,aAAa,GACb,OAAO,GACP,UAAU,GACV,MAAM,GACN,QAAQ,GACR,UAAU,GACV,QAAQ,GACR,YAAY,GACZ,WAAW,GACX,KAAK,GACL,OAAO,GACP,QAAQ,GACR,QAAQ,GACR,WAAW,GACX,SAAS,GACZ;QACD,CAAC,IAAI,EAAE,gBAAgB,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC,EAAE,YAAY,CAAC,QAAQ,CAAC,GAAG,KAAK,CAAC;QAC5E,CAAC,OAAO,CAAC,EAAE,YAAY,CAAC,QAAQ,CAAC,GAAG,KAAK,CAAC;KAC3C;CACF,GACC;KAEE,CAAC,IACG,QAAQ,GACR,SAAS,GACT,QAAQ,GACR,WAAW,GACX,WAAW,GACX,WAAW,GACX,YAAY,GACZ,MAAM,GACN,aAAa,GACb,MAAM,GACN,cAAc,GACd,UAAU,GACV,QAAQ,GACR,UAAU,GACV,OAAO,GACP,SAAS,GACT,MAAM,GACN,UAAU,GACV,SAAS,GACZ;QACD,CAAC,WAAW,EAAE,gBAAgB,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC,EAAE,YAAY,CAAC,QAAQ,CAAC,GAAG,KAAK,CAAC;QACnF,CAAC,OAAO,CAAC,EAAE,YAAY,CAAC,QAAQ,CAAC,GAAG,KAAK,CAAC;KAC3C;CACF,GACC;KACC,CAAC,IAAI,SAAS,GAAG,cAAc,GAAG;QACjC,CAAC,KAAK,EAAE,gBAAgB,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC,EAAE,YAAY,CAAC,QAAQ,CAAC,GAAG,KAAK,CAAC;QAC7E,CAAC,OAAO,CAAC,EAAE,YAAY,CAAC,QAAQ,CAAC,GAAG,KAAK,CAAC;KAC3C;CACF,GACC;KACC,CAAC,IAAI,OAAO,GAAG,OAAO,GAAG,CACxB,SAAS,EAAE,gBAAgB,CAAC,QAAQ,CAAC,EACrC,SAAS,EAAE,gBAAgB,CAAC,QAAQ,CAAC,EACrC,OAAO,CAAC,EAAE,YAAY,CAAC,QAAQ,CAAC,KAC7B,KAAK;CACX,GACC;KACC,CAAC,IAAI,UAAU,GAAG,MAAM,GAAG,CAAC,cAAc,EAAE,gBAAgB,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC,EAAE,YAAY,CAAC,QAAQ,CAAC,KAAK,KAAK;CACpH,GACC;KACC,CAAC,IAAI,UAAU,GAAG,WAAW,GAAG,CAC/B,cAAc,EAAE,gBAAgB,CAAC,QAAQ,CAAC,EAC1C,OAAO,CAAC,EAAE,YAAY,CAAC,QAAQ,CAAC,KAC7B,KAAK;CACX,GACC;KACC,CAAC,IAAI,OAAO,GAAG,KAAK,GAAG,UAAU,GAAG,MAAM,GAAG,UAAU,GAAG,UAAU,GAAG;QACtE,CACE,IAAI,EAAE,gBAAgB,CAAC,QAAQ,CAAC,EAChC,WAAW,EAAE,gBAAgB,CAAC,QAAQ,CAAC,EACvC,OAAO,CAAC,EAAE,YAAY,CAAC,QAAQ,CAAC,GAC/B,KAAK,CAAC;QACT,CAAC,IAAI,EAAE,gBAAgB,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC,EAAE,YAAY,CAAC,QAAQ,CAAC,GAAG,KAAK,CAAC;KAC7E;CACF,CAAC;AAEJ,KAAK,aAAa,CAChB,QAAQ,SAAS,iBAAiB,CAAC,MAAM,gBAAgB,CAAC,QAAQ,CAAC,CAAC,EACpE,QAAQ,SAAS,aAAa,IAC5B,QAAQ,SAAS,MAAM,gBAAgB,CAAC,QAAQ,CAAC,GAEjD,gBAAgB,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,GAClE,uBAAuB,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,CAAC,GAC/D,KAAK,GACL,CAAC,OAAO,CAAC,EAAE,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC;AAEvC,iBAAS,YAAY,CACnB,QAAQ,SAAS,iBAAiB,CAAC,MAAM,gBAAgB,CAAC,QAAQ,CAAC,CAAC,EACpE,QAAQ,SAAS,aAAa,EAE9B,GAAG,EAAE,QAAQ,EACb,GAAG,IAAI,EAAE,aAAa,CAAC,QAAQ,EAAE,QAAQ,CAAC,GACzC,QAAQ,CAAC,QAAQ,CAAC,CAAC;AA2CtB,eAAO,MAAM,QAAQ,EAAE,OAAO,YAAY,GAAG;IAAE,KAAK,EAAE,OAAO,YAAY,CAAA;CAEvE,CAAC"}

package/esm/src/ast/nodes/doc-tag.js

@@ -0,0 +1,79 @@
+import { basicAppendValueGroup, notNullish, } from '@goast/core';
+import { isTypeScriptAppendValue } from '../../file-builder.js';
+import { TsNode } from '../node.js';
+import { writeTsNode, writeTsNodes } from '../utils/write-ts-nodes.js';
+export class TsDocTag extends TsNode {
+    constructor(options) {
+        var _a, _b;
+        super(options);
+        Object.defineProperty(this, "tag", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "type", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "text", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.tag = options.tag;
+        this.type = (_a = options.type) !== null && _a !== void 0 ? _a : null;
+        this.text = (_b = options.text) !== null && _b !== void 0 ? _b : null;
+    }
+    onWrite(builder) {
+        builder.append('@', this.tag);
+        if (this.type) {
+            builder.append(' ');
+            builder.parenthesize('{}', (b) => writeTsNode(b, this.type));
+        }
+        if (this.text) {
+            builder.append(' ', this.text);
+        }
+    }
+}
+// deno-lint-ignore no-explicit-any
+function createDocTag(tag, ...args) {
+    let opt = {};
+    if (args.length > 0) {
+        const lastArg = args[args.length - 1];
+        if (!isTypeScriptAppendValue(lastArg) && !!lastArg) {
+            opt = args.pop();
+        }
+    }
+    let params = args;
+    if (tag === 'author' && params.length === 2) {
+        params[1] = `<${params[1]}>`;
+    }
+    if (tag === 'borrows') {
+        params.splice(1, 0, 'as');
+    }
+    if (tag === 'example') {
+        if (typeof params[0] === 'string') {
+            params[0] = `<caption>${params[0]}</caption>`;
+        }
+        if (params[1] && isTypeScriptAppendValue(params[1])) {
+            params.splice(1, 0, '\n');
+        }
+    }
+    if ((tag === 'event' || tag === 'fires') && typeof params[0] === 'string' && typeof params[1] === 'string') {
+        params.splice(0, 2, `${params[0]}#${params[1]}`);
+    }
+    params = [...params, opt.text].filter(notNullish);
+    return new TsDocTag({
+        tag,
+        type: opt.type,
+        text: params.length > 0 ? basicAppendValueGroup(params, ' ') : null,
+        inject: opt.inject,
+    });
+}
+export const tsDocTag = Object.assign(createDocTag, {
+    write: writeTsNodes,
+});

package/esm/src/ast/nodes/doc-tag.test.d.ts

@@ -0,0 +1,2 @@
+import "../../../_dnt.test_polyfills.js";
+//# sourceMappingURL=doc-tag.test.d.ts.map

package/esm/src/ast/nodes/doc-tag.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"doc-tag.test.d.ts","sourceRoot":"","sources":["../../../../src/src/ast/nodes/doc-tag.test.ts"],"names":[],"mappings":"AAAA,OAAO,iCAAiC,CAAC"}

package/esm/src/ast/nodes/doc-tag.test.js

@@ -0,0 +1,30 @@
+import "../../../_dnt.test_polyfills.js";
+import { EOL } from 'node:os';
+import { expect } from '../../../deps/jsr.io/@std/expect/1.0.5/expect.js';
+import { beforeEach, it } from '../../../deps/jsr.io/@std/testing/1.0.3/bdd.js';
+import { TypeScriptFileBuilder } from '../../file-builder.js';
+import { tsDocTag } from './doc-tag.js';
+let builder;
+beforeEach(() => {
+    builder = new TypeScriptFileBuilder();
+});
+it('should write a custom tag', () => {
+    builder
+        .appendLine(tsDocTag('custom'))
+        .appendLine(tsDocTag('custom', { type: 'number' }))
+        .appendLine(tsDocTag('custom', { text: 'description' }))
+        .append(tsDocTag('custom', { type: 'number', text: 'description' }));
+    expect(builder.toString(false)).toBe(`@custom${EOL}@custom {number}${EOL}@custom description${EOL}@custom {number} description`);
+});
+it('should render injections', () => {
+    builder.append(tsDocTag('custom', { inject: { before: ['before'], after: ['after'] } }));
+    expect(builder.toString(false)).toBe(`before@customafter`);
+});
+it('should write author tag', () => {
+    builder.appendLine(tsDocTag('author', 'John Doe')).append(tsDocTag('author', 'John Doe', 'john.doe@gmail.com'));
+    expect(builder.toString(false)).toBe(`@author John Doe${EOL}@author John Doe <john.doe@gmail.com>`);
+});
+it('should write access tag', () => {
+    builder.append(tsDocTag('access', 'public'));
+    expect(builder.toString(false)).toBe('@access public');
+});

package/esm/src/ast/nodes/doc.d.ts

@@ -0,0 +1,30 @@
+import { type AstNodeOptions, type BasicAppendValue, type Nullable, type SourceBuilder } from '@goast/core';
+import { TsNode } from '../node.js';
+import { writeTsNodes } from '../utils/write-ts-nodes.js';
+import { type TsDocTag } from './doc-tag.js';
+import { TsGenericParameter } from './generic-parameter.js';
+import { TsParameter } from './parameter.js';
+type Injects = never;
+type Options<TBuilder extends SourceBuilder, TInjects extends string = never> = AstNodeOptions<typeof TsNode<TBuilder, TInjects | Injects>, {
+    description?: Nullable<BasicAppendValue<TBuilder>>;
+    tags?: Nullable<Nullable<TsDocTag<TBuilder>>[]>;
+}>;
+export declare class TsDoc<TBuilder extends SourceBuilder, TInjects extends string = never> extends TsNode<TBuilder, TInjects | Injects> {
+    description: BasicAppendValue<TBuilder> | null;
+    tags: TsDocTag<TBuilder>[];
+    constructor(options: Options<TBuilder, TInjects>);
+    protected onWrite(builder: TBuilder): void;
+}
+declare const createDoc: <TBuilder extends SourceBuilder>(options?: Options<TBuilder>) => TsDoc<TBuilder>;
+declare function getDoc<TBuilder extends SourceBuilder>(baseDoc: TsDoc<TBuilder> | null, options: {
+    parameters?: Nullable<Nullable<TsParameter<TBuilder> | BasicAppendValue<TBuilder>>[]>;
+    generics?: Nullable<Nullable<TsGenericParameter<TBuilder> | BasicAppendValue<TBuilder>>[]>;
+}): TsDoc<TBuilder> | null;
+declare function isDocEmpty(doc: Nullable<TsDoc<SourceBuilder>>): boolean;
+export declare const tsDoc: typeof createDoc & {
+    write: typeof writeTsNodes;
+    get: typeof getDoc;
+    isEmpty: typeof isDocEmpty;
+};
+export {};
+//# sourceMappingURL=doc.d.ts.map

package/esm/src/ast/nodes/doc.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"doc.d.ts","sourceRoot":"","sources":["../../../../src/src/ast/nodes/doc.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,cAAc,EACnB,KAAK,gBAAgB,EAIrB,KAAK,QAAQ,EACb,KAAK,aAAa,EACnB,MAAM,aAAa,CAAC;AAErB,OAAO,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AACpC,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAC1D,OAAO,EAAE,KAAK,QAAQ,EAAY,MAAM,cAAc,CAAC;AACvD,OAAO,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AAC5D,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,KAAK,OAAO,GAAG,KAAK,CAAC;AAErB,KAAK,OAAO,CAAC,QAAQ,SAAS,aAAa,EAAE,QAAQ,SAAS,MAAM,GAAG,KAAK,IAAI,cAAc,CAC5F,OAAO,MAAM,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,EAC3C;IACE,WAAW,CAAC,EAAE,QAAQ,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC,CAAC;IACnD,IAAI,CAAC,EAAE,QAAQ,CAAC,QAAQ,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC;CACjD,CACF,CAAC;AAEF,qBAAa,KAAK,CAAC,QAAQ,SAAS,aAAa,EAAE,QAAQ,SAAS,MAAM,GAAG,KAAK,CAChF,SAAQ,MAAM,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC;IACrC,WAAW,EAAE,gBAAgB,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC;IAC/C,IAAI,EAAE,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;gBAEtB,OAAO,EAAE,OAAO,CAAC,QAAQ,EAAE,QAAQ,CAAC;cAM7B,OAAO,CAAC,OAAO,EAAE,QAAQ,GAAG,IAAI;CAwBpD;AAED,QAAA,MAAM,SAAS,GAAI,QAAQ,SAAS,aAAa,YAAY,OAAO,CAAC,QAAQ,CAAC,KAAG,KAAK,CAAC,QAAQ,CAC3D,CAAC;AAErC,iBAAS,MAAM,CAAC,QAAQ,SAAS,aAAa,EAC5C,OAAO,EAAE,KAAK,CAAC,QAAQ,CAAC,GAAG,IAAI,EAC/B,OAAO,EAAE;IACP,UAAU,CAAC,EAAE,QAAQ,CAAC,QAAQ,CAAC,WAAW,CAAC,QAAQ,CAAC,GAAG,gBAAgB,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC;IACtF,QAAQ,CAAC,EAAE,QAAQ,CAAC,QAAQ,CAAC,kBAAkB,CAAC,QAAQ,CAAC,GAAG,gBAAgB,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC;CAC5F,GACA,KAAK,CAAC,QAAQ,CAAC,GAAG,IAAI,CAexB;AAED,iBAAS,UAAU,CAAC,GAAG,EAAE,QAAQ,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,GAAG,OAAO,CAEhE;AAED,eAAO,MAAM,KAAK,EAAE,OAAO,SAAS,GAAG;IACrC,KAAK,EAAE,OAAO,YAAY,CAAC;IAC3B,GAAG,EAAE,OAAO,MAAM,CAAC;IACnB,OAAO,EAAE,OAAO,UAAU,CAAC;CAK3B,CAAC"}

package/esm/src/ast/nodes/doc.js

@@ -0,0 +1,65 @@
+import { createOverwriteProxy, getIsInstanceOf, notNullish, } from '@goast/core';
+import { TsNode } from '../node.js';
+import { writeTsNodes } from '../utils/write-ts-nodes.js';
+import { tsDocTag } from './doc-tag.js';
+import { TsGenericParameter } from './generic-parameter.js';
+import { TsParameter } from './parameter.js';
+export class TsDoc extends TsNode {
+    constructor(options) {
+        var _a, _b, _c;
+        super(options);
+        Object.defineProperty(this, "description", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "tags", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.description = (_a = options.description) !== null && _a !== void 0 ? _a : null;
+        this.tags = (_c = (_b = options.tags) === null || _b === void 0 ? void 0 : _b.filter(notNullish)) !== null && _c !== void 0 ? _c : [];
+    }
+    onWrite(builder) {
+        if (!this.description && this.tags.length === 0) {
+            return;
+        }
+        builder
+            .ensureCurrentLineEmpty()
+            .parenthesize(['/**', ' */'], (b) => b.appendWithLinePrefix(' * ', (b) => {
+            if (this.description) {
+                b.append(this.description);
+            }
+            if (this.tags.length > 0) {
+                b.ensurePreviousLineEmpty();
+                tsDocTag.write(b, this.tags, { separator: '\n' });
+            }
+        }), { multiline: true, indent: false })
+            .appendLine();
+    }
+}
+const createDoc = (options) => new TsDoc(options !== null && options !== void 0 ? options : {});
+function getDoc(baseDoc, options) {
+    var _a, _b, _c, _d;
+    const paramsWithDesc = (_b = (_a = options.parameters) === null || _a === void 0 ? void 0 : _a.filter(getIsInstanceOf((TsParameter))).filter((x) => !!x.description)) !== null && _b !== void 0 ? _b : [];
+    const genericsWithDesc = (_d = (_c = options.generics) === null || _c === void 0 ? void 0 : _c.filter(getIsInstanceOf((TsGenericParameter))).filter((x) => !!x.description)) !== null && _d !== void 0 ? _d : [];
+    if (paramsWithDesc.length === 0 && genericsWithDesc.length === 0) {
+        return baseDoc;
+    }
+    const doc = baseDoc ? createOverwriteProxy(baseDoc) : createDoc();
+    const paramTags = paramsWithDesc.map((p) => tsDocTag('param', p.name, p.description));
+    const genericTags = genericsWithDesc.map((p) => tsDocTag('template', p.name, p.description));
+    doc.tags.splice(0, 0, ...genericTags, ...paramTags);
+    return doc;
+}
+function isDocEmpty(doc) {
+    return !doc || (!doc.description && doc.tags.length === 0);
+}
+export const tsDoc = Object.assign(createDoc, {
+    write: writeTsNodes,
+    get: getDoc,
+    isEmpty: isDocEmpty,
+});

package/esm/src/ast/nodes/doc.test.d.ts

@@ -0,0 +1,2 @@
+import "../../../_dnt.test_polyfills.js";
+//# sourceMappingURL=doc.test.d.ts.map

package/esm/src/ast/nodes/doc.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"doc.test.d.ts","sourceRoot":"","sources":["../../../../src/src/ast/nodes/doc.test.ts"],"names":[],"mappings":"AAAA,OAAO,iCAAiC,CAAC"}

package/esm/src/ast/nodes/doc.test.js

@@ -0,0 +1,31 @@
+import "../../../_dnt.test_polyfills.js";
+import { EOL } from 'node:os';
+import { expect } from '../../../deps/jsr.io/@std/expect/1.0.5/expect.js';
+import { beforeEach, it } from '../../../deps/jsr.io/@std/testing/1.0.3/bdd.js';
+import { TypeScriptFileBuilder } from '../../file-builder.js';
+import { tsDocTag } from './doc-tag.js';
+import { tsDoc } from './doc.js';
+let builder;
+beforeEach(() => {
+    builder = new TypeScriptFileBuilder();
+});
+it('should not write anything if the node is empty', () => {
+    builder.append(tsDoc());
+    expect(builder.toString(false)).toBe('');
+});
+it('should write description', () => {
+    builder.append(tsDoc({ description: 'description' }));
+    expect(builder.toString(false)).toBe(`/**${EOL} * description${EOL} */${EOL}`);
+});
+it('should write tags', () => {
+    builder.append(tsDoc({ tags: [tsDocTag('tag1'), tsDocTag('tag2')] }));
+    expect(builder.toString(false)).toBe(`/**${EOL} * @tag1${EOL} * @tag2${EOL} */${EOL}`);
+});
+it('should write all the parts of the node', () => {
+    builder.append(tsDoc({ description: 'description', tags: [tsDocTag('tag1'), tsDocTag('tag2')] }));
+    expect(builder.toString(false)).toBe(`/**${EOL} * description${EOL} *${EOL} * @tag1${EOL} * @tag2${EOL} */${EOL}`);
+});
+it('should render injections', () => {
+    builder.append(tsDoc({ description: 'hello', inject: { before: ['before'], after: ['after'] } }));
+    expect(builder.toString(false)).toBe(`before${EOL}/**${EOL} * hello${EOL} */${EOL}after`);
+});

package/esm/src/ast/nodes/enum-value.d.ts

@@ -0,0 +1,24 @@
+import type { AppendValue, AstNodeOptions, BasicAppendValue, Nullable, Prettify, SingleOrMultiple, SourceBuilder } from '@goast/core';
+import { TsNode } from '../node.js';
+import type { TsDoc } from './doc.js';
+import type { TsString } from './string.js';
+type Injects = 'doc' | 'name' | 'value';
+type Options<TBuilder extends SourceBuilder, TInjects extends string = never> = AstNodeOptions<typeof TsNode<TBuilder, TInjects | Injects>, {
+    doc?: Nullable<TsDoc<TBuilder>>;
+    name: string;
+    value?: Nullable<TsString<TBuilder> | BasicAppendValue<TBuilder>>;
+}>;
+export declare class TsEnumValue<TBuilder extends SourceBuilder, TInjects extends string = never> extends TsNode<TBuilder, TInjects | Injects> {
+    doc: TsDoc<TBuilder> | null;
+    name: string;
+    value: TsString<TBuilder> | BasicAppendValue<TBuilder> | null;
+    constructor(options: Options<TBuilder, TInjects>);
+    protected onWrite(builder: TBuilder): void;
+}
+declare const createEnumValue: <TBuilder extends SourceBuilder>(name: Options<TBuilder>["name"], options?: Prettify<Omit<Options<TBuilder>, "name">>) => TsEnumValue<TBuilder>;
+declare const writeEnumValues: <TBuilder extends SourceBuilder>(builder: TBuilder, nodes: SingleOrMultiple<Nullable<TsEnumValue<TBuilder> | AppendValue<TBuilder>>>) => void;
+export declare const tsEnumValue: typeof createEnumValue & {
+    write: typeof writeEnumValues;
+};
+export {};
+//# sourceMappingURL=enum-value.d.ts.map

package/esm/src/ast/nodes/enum-value.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"enum-value.d.ts","sourceRoot":"","sources":["../../../../src/src/ast/nodes/enum-value.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,WAAW,EACX,cAAc,EACd,gBAAgB,EAChB,QAAQ,EACR,QAAQ,EACR,gBAAgB,EAChB,aAAa,EACd,MAAM,aAAa,CAAC;AAErB,OAAO,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AAEpC,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AACtC,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAE5C,KAAK,OAAO,GAAG,KAAK,GAAG,MAAM,GAAG,OAAO,CAAC;AAExC,KAAK,OAAO,CAAC,QAAQ,SAAS,aAAa,EAAE,QAAQ,SAAS,MAAM,GAAG,KAAK,IAAI,cAAc,CAC5F,OAAO,MAAM,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,EAC3C;IACE,GAAG,CAAC,EAAE,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,QAAQ,CAAC,QAAQ,CAAC,QAAQ,CAAC,GAAG,gBAAgB,CAAC,QAAQ,CAAC,CAAC,CAAC;CACnE,CACF,CAAC;AAEF,qBAAa,WAAW,CAAC,QAAQ,SAAS,aAAa,EAAE,QAAQ,SAAS,MAAM,GAAG,KAAK,CAAE,SAAQ,MAAM,CACtG,QAAQ,EACR,QAAQ,GAAG,OAAO,CACnB;IACQ,GAAG,EAAE,KAAK,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,QAAQ,CAAC,QAAQ,CAAC,GAAG,gBAAgB,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC;gBAEzD,OAAO,EAAE,OAAO,CAAC,QAAQ,EAAE,QAAQ,CAAC;cAO7B,OAAO,CAAC,OAAO,EAAE,QAAQ,GAAG,IAAI;CAcpD;AAED,QAAA,MAAM,eAAe,GAAI,QAAQ,SAAS,aAAa,QAC/C,OAAO,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,YACrB,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC,CAAC,KAClD,WAAW,CAAC,QAAQ,CAAoD,CAAC;AAE5E,QAAA,MAAM,eAAe,GAAI,QAAQ,SAAS,aAAa,WAC5C,QAAQ,SACV,gBAAgB,CAAC,QAAQ,CAAC,WAAW,CAAC,QAAQ,CAAC,GAAG,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC,KAC/E,IAEF,CAAC;AAEF,eAAO,MAAM,WAAW,EAAE,OAAO,eAAe,GAAG;IAAE,KAAK,EAAE,OAAO,eAAe,CAAA;CAEhF,CAAC"}

package/esm/src/ast/nodes/enum-value.test.d.ts

@@ -0,0 +1,2 @@
+import "../../../_dnt.test_polyfills.js";
+//# sourceMappingURL=enum-value.test.d.ts.map

package/esm/src/ast/nodes/enum-value.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"enum-value.test.d.ts","sourceRoot":"","sources":["../../../../src/src/ast/nodes/enum-value.test.ts"],"names":[],"mappings":"AAAA,OAAO,iCAAiC,CAAC"}