@goast/typescript 0.4.0-beta3 → 0.4.0

package/script/src/ast/nodes/function.test.js

@@ -0,0 +1,110 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+require("../../../_dnt.test_polyfills.js");
+const node_os_1 = require("node:os");
+const expect_js_1 = require("../../../deps/jsr.io/@std/expect/1.0.5/expect.js");
+const bdd_js_1 = require("../../../deps/jsr.io/@std/testing/1.0.3/bdd.js");
+const test_utils_1 = require("@goast/test-utils");
+const file_builder_js_1 = require("../../file-builder.js");
+const decorator_js_1 = require("./decorator.js");
+const doc_js_1 = require("./doc.js");
+const function_js_1 = require("./function.js");
+const generic_parameter_js_1 = require("./generic-parameter.js");
+const parameter_js_1 = require("./parameter.js");
+let builder;
+(0, bdd_js_1.beforeEach)(() => {
+    builder = new file_builder_js_1.TypeScriptFileBuilder();
+});
+(0, bdd_js_1.describe)('tsFunction', () => {
+    (0, bdd_js_1.it)('should write the name of the function', () => {
+        builder.append((0, function_js_1.tsFunction)('X'));
+        (0, expect_js_1.expect)(builder.toString(false)).toBe('function X() {}' + node_os_1.EOL);
+    });
+    (0, bdd_js_1.it)('should write the generics if they exist', () => {
+        builder.append((0, function_js_1.tsFunction)('X', { generics: [(0, generic_parameter_js_1.tsGenericParameter)('T'), (0, generic_parameter_js_1.tsGenericParameter)('U')] }));
+        (0, expect_js_1.expect)(builder.toString(false)).toBe('function X<T, U>() {}' + node_os_1.EOL);
+    });
+    (0, bdd_js_1.it)('should write the parameters if they exist', () => {
+        builder.append((0, function_js_1.tsFunction)('X', { parameters: [(0, parameter_js_1.tsParameter)('y'), (0, parameter_js_1.tsParameter)('z')] }));
+        (0, expect_js_1.expect)(builder.toString(false)).toBe('function X(y, z) {}' + node_os_1.EOL);
+    });
+    (0, bdd_js_1.it)('should write the return type if it exists', () => {
+        builder.append((0, function_js_1.tsFunction)('X', { returnType: 'number' }));
+        (0, expect_js_1.expect)(builder.toString(false)).toBe('function X(): number {}' + node_os_1.EOL);
+    });
+    (0, bdd_js_1.it)('should write the body if it exists', () => {
+        builder.append((0, function_js_1.tsFunction)('X', { body: 'return 42;' }));
+        (0, expect_js_1.expect)(builder.toString(false)).toBe(`function X() {${node_os_1.EOL}  return 42;${node_os_1.EOL}}${node_os_1.EOL}`);
+    });
+    (0, bdd_js_1.it)('should write export keyword if configured', () => {
+        builder.append((0, function_js_1.tsFunction)('X', { export: true }));
+        (0, expect_js_1.expect)(builder.toString(false)).toBe('export function X() {}' + node_os_1.EOL);
+    });
+    (0, bdd_js_1.it)('should write documenation if it exists', () => {
+        builder.append((0, function_js_1.tsFunction)('X', { doc: (0, doc_js_1.tsDoc)({ description: 'description' }) }));
+        (0, expect_js_1.expect)(builder.toString(false)).toBe(`/**${node_os_1.EOL} * description${node_os_1.EOL} */${node_os_1.EOL}function X() {}${node_os_1.EOL}`);
+    });
+    (0, bdd_js_1.it)('should write decorators if they exist', () => {
+        builder.append((0, function_js_1.tsFunction)('X', { decorators: [(0, decorator_js_1.tsDecorator)('decorator')] }));
+        (0, expect_js_1.expect)(builder.toString(false)).toBe(`@decorator${node_os_1.EOL}function X() {}${node_os_1.EOL}`);
+    });
+    (0, bdd_js_1.it)('should write all the parts of the function', () => {
+        builder.append((0, function_js_1.tsFunction)('X', {
+            doc: (0, doc_js_1.tsDoc)({ description: 'description' }),
+            decorators: [(0, decorator_js_1.tsDecorator)('decorator')],
+            generics: [(0, generic_parameter_js_1.tsGenericParameter)('T'), (0, generic_parameter_js_1.tsGenericParameter)('U')],
+            parameters: [(0, parameter_js_1.tsParameter)('y'), (0, parameter_js_1.tsParameter)('z')],
+            returnType: 'number',
+            body: 'return 42;',
+            export: true,
+        }));
+        (0, expect_js_1.expect)(builder.toString(false)).toBe((0, test_utils_1.normalizeEOL)(8)(`/**
+         * description
+         */
+        @decorator
+        export function X<T, U>(y, z): number {
+          return 42;
+        }
+        `));
+    });
+    (0, bdd_js_1.it)('should render injections', () => {
+        builder.append((0, function_js_1.tsFunction)('X', {
+            doc: (0, doc_js_1.tsDoc)({ description: 'description' }),
+            decorators: [(0, decorator_js_1.tsDecorator)('decorator')],
+            generics: [(0, generic_parameter_js_1.tsGenericParameter)('T'), (0, generic_parameter_js_1.tsGenericParameter)('U')],
+            parameters: [(0, parameter_js_1.tsParameter)('y'), (0, parameter_js_1.tsParameter)('z')],
+            returnType: 'number',
+            body: 'return 42;',
+            export: true,
+            inject: {
+                before: '║b║',
+                after: '║a║',
+                beforeDoc: '║bd║',
+                afterDoc: '║ad║',
+                beforeDecorators: '║bds║',
+                afterDecorators: '║ads║',
+                beforeModifiers: '║bm║',
+                afterModifiers: '║am║',
+                beforeName: '║bn║',
+                afterName: '║an║',
+                beforeGenerics: '║bg║',
+                afterGenerics: '║ag║',
+                beforeParams: '║bp║',
+                afterParams: '║ap║',
+                beforeReturnType: '║brt║',
+                afterReturnType: '║art║',
+                beforeBody: '║bb║',
+                afterBody: '║ab║',
+            },
+        }));
+        (0, expect_js_1.expect)(builder.toString(false)).toBe((0, test_utils_1.normalizeEOL)(8)(`║b║║bd║
+        /**
+         * description
+         */
+        ║ad║║bds║@decorator
+        ║ads║║bm║export ║am║function ║bn║X║an║║bg║<T, U>║ag║║bp║(y, z)║ap║: ║brt║number║art║ ║bb║{
+          return 42;
+        }║ab║
+        ║a║`));
+    });
+});

package/script/src/ast/nodes/generic-parameter.d.ts

@@ -0,0 +1,27 @@
+import type { AstNodeOptions, BasicAppendValue, Nullable, Prettify, SourceBuilder } from '@goast/core';
+import { TsNode } from '../node.js';
+import { writeTsGenericParameters } from '../utils/write-ts-generic-parameters.js';
+import type { TsType } from './types.js';
+type Injects = 'modifiers' | 'name' | 'constraint' | 'default';
+type Options<TBuilder extends SourceBuilder, TInjects extends string = never> = AstNodeOptions<typeof TsNode<TBuilder, TInjects | Injects>, {
+    description?: Nullable<BasicAppendValue<TBuilder>>;
+    const?: Nullable<boolean>;
+    name: string;
+    constraint?: Nullable<TsType<TBuilder>>;
+    default?: Nullable<TsType<TBuilder>>;
+}>;
+export declare class TsGenericParameter<TBuilder extends SourceBuilder, TInjects extends string = never> extends TsNode<TBuilder, TInjects | Injects> {
+    description: BasicAppendValue<TBuilder> | null;
+    const: boolean;
+    name: string;
+    constraint: TsType<TBuilder> | null;
+    default: TsType<TBuilder> | null;
+    constructor(options: Options<TBuilder, TInjects>);
+    protected onWrite(builder: TBuilder): void;
+}
+declare const createGenericParameter: <TBuilder extends SourceBuilder>(name: Options<TBuilder>["name"], options?: Prettify<Omit<Options<TBuilder>, "name">>) => TsGenericParameter<TBuilder>;
+export declare const tsGenericParameter: typeof createGenericParameter & {
+    write: typeof writeTsGenericParameters;
+};
+export {};
+//# sourceMappingURL=generic-parameter.d.ts.map

package/script/src/ast/nodes/generic-parameter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"generic-parameter.d.ts","sourceRoot":"","sources":["../../../../src/src/ast/nodes/generic-parameter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,gBAAgB,EAAE,QAAQ,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAEvG,OAAO,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AACpC,OAAO,EAAE,wBAAwB,EAAE,MAAM,yCAAyC,CAAC;AAEnF,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AAEzC,KAAK,OAAO,GAAG,WAAW,GAAG,MAAM,GAAG,YAAY,GAAG,SAAS,CAAC;AAE/D,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,KAAK,CAAC,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC;IACxC,OAAO,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC;CACtC,CACF,CAAC;AAEF,qBAAa,kBAAkB,CAAC,QAAQ,SAAS,aAAa,EAAE,QAAQ,SAAS,MAAM,GAAG,KAAK,CAAE,SAAQ,MAAM,CAC7G,QAAQ,EACR,QAAQ,GAAG,OAAO,CACnB;IACQ,WAAW,EAAE,gBAAgB,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC;IAC/C,KAAK,EAAE,OAAO,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC;IACpC,OAAO,EAAE,MAAM,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC;gBAE5B,OAAO,EAAE,OAAO,CAAC,QAAQ,EAAE,QAAQ,CAAC;cAS7B,OAAO,CAAC,OAAO,EAAE,QAAQ,GAAG,IAAI;CAqBpD;AAED,QAAA,MAAM,sBAAsB,GAAI,QAAQ,SAAS,aAAa,QACtD,OAAO,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,YACrB,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC,CAAC,KAClD,kBAAkB,CAAC,QAAQ,CAA2D,CAAC;AAE1F,eAAO,MAAM,kBAAkB,EAAE,OAAO,sBAAsB,GAAG;IAAE,KAAK,EAAE,OAAO,wBAAwB,CAAA;CAGrG,CAAC"}

package/script/src/ast/nodes/generic-parameter.js

@@ -0,0 +1,71 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.tsGenericParameter = exports.TsGenericParameter = void 0;
+const node_js_1 = require("../node.js");
+const write_ts_generic_parameters_js_1 = require("../utils/write-ts-generic-parameters.js");
+const write_ts_nodes_js_1 = require("../utils/write-ts-nodes.js");
+class TsGenericParameter extends node_js_1.TsNode {
+    constructor(options) {
+        var _a, _b, _c, _d;
+        super(options);
+        Object.defineProperty(this, "description", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "const", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "name", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "constraint", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "default", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.description = (_a = options.description) !== null && _a !== void 0 ? _a : null;
+        this.const = (_b = options.const) !== null && _b !== void 0 ? _b : false;
+        this.name = options.name;
+        this.constraint = (_c = options.constraint) !== null && _c !== void 0 ? _c : null;
+        this.default = (_d = options.default) !== null && _d !== void 0 ? _d : null;
+    }
+    onWrite(builder) {
+        builder.append(this.inject.beforeModifiers);
+        builder.appendIf(this.const, 'const ');
+        builder.append(this.inject.afterModifiers);
+        builder.append(this.inject.beforeName, this.name, this.inject.afterName);
+        if (this.constraint !== null) {
+            builder.append(' extends ');
+            builder.append(this.inject.beforeConstraint);
+            (0, write_ts_nodes_js_1.writeTsNode)(builder, this.constraint);
+            builder.append(this.inject.afterConstraint);
+        }
+        if (this.default !== null) {
+            builder.append(' = ');
+            builder.append(this.inject.beforeDefault);
+            (0, write_ts_nodes_js_1.writeTsNode)(builder, this.default);
+            builder.append(this.inject.afterDefault);
+        }
+    }
+}
+exports.TsGenericParameter = TsGenericParameter;
+const createGenericParameter = (name, options) => new TsGenericParameter({ ...options, name });
+exports.tsGenericParameter = Object
+    .assign(createGenericParameter, {
+    write: write_ts_generic_parameters_js_1.writeTsGenericParameters,
+});

package/script/src/ast/nodes/generic-parameter.test.d.ts

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

package/script/src/ast/nodes/generic-parameter.test.d.ts.map

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

package/script/src/ast/nodes/generic-parameter.test.js

@@ -0,0 +1,72 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+require("../../../_dnt.test_polyfills.js");
+const node_os_1 = require("node:os");
+const expect_js_1 = require("../../../deps/jsr.io/@std/expect/1.0.5/expect.js");
+const bdd_js_1 = require("../../../deps/jsr.io/@std/testing/1.0.3/bdd.js");
+const file_builder_js_1 = require("../../file-builder.js");
+const generic_parameter_js_1 = require("./generic-parameter.js");
+let builder;
+(0, bdd_js_1.beforeEach)(() => {
+    builder = new file_builder_js_1.TypeScriptFileBuilder();
+});
+(0, bdd_js_1.describe)('tsGenericParameter', () => {
+    (0, bdd_js_1.it)('should write the name of the parameter', () => {
+        builder.append((0, generic_parameter_js_1.tsGenericParameter)('T'));
+        (0, expect_js_1.expect)(builder.toString(false)).toBe('T');
+    });
+    (0, bdd_js_1.it)('should write the constraint if it exists', () => {
+        builder.append((0, generic_parameter_js_1.tsGenericParameter)('T', { constraint: 'number' }));
+        (0, expect_js_1.expect)(builder.toString(false)).toBe('T extends number');
+    });
+    (0, bdd_js_1.it)('should write the default if it exists', () => {
+        builder.append((0, generic_parameter_js_1.tsGenericParameter)('T', { default: 'string' }));
+        (0, expect_js_1.expect)(builder.toString(false)).toBe('T = string');
+    });
+    (0, bdd_js_1.it)('should write the const keyword if the parameter is const', () => {
+        builder.append((0, generic_parameter_js_1.tsGenericParameter)('T', { const: true }));
+        (0, expect_js_1.expect)(builder.toString(false)).toBe('const T');
+    });
+    (0, bdd_js_1.it)('should write all the parts of the parameter', () => {
+        builder.append((0, generic_parameter_js_1.tsGenericParameter)('T', { constraint: 'number', default: '4711', const: true }));
+        (0, expect_js_1.expect)(builder.toString(false)).toBe('const T extends number = 4711');
+    });
+    (0, bdd_js_1.it)('should render injections', () => {
+        builder.append((0, generic_parameter_js_1.tsGenericParameter)('T', {
+            constraint: 'number',
+            default: '4711',
+            const: true,
+            inject: {
+                before: '║b║',
+                after: '║a║',
+                beforeModifiers: '║bm║',
+                afterModifiers: '║am║',
+                beforeName: '║bn║',
+                afterName: '║an║',
+                beforeConstraint: '║bc║',
+                afterConstraint: '║ac║',
+                beforeDefault: '║bd║',
+                afterDefault: '║ad║',
+            },
+        }));
+        (0, expect_js_1.expect)(builder.toString(false)).toBe('║b║║bm║const ║am║║bn║T║an║ extends ║bc║number║ac║ = ║bd║4711║ad║║a║');
+    });
+    (0, bdd_js_1.describe)('write', () => {
+        (0, bdd_js_1.it)('should not write anything if the node is empty', () => {
+            generic_parameter_js_1.tsGenericParameter.write(builder, []);
+            (0, expect_js_1.expect)(builder.toString(false)).toBe('');
+        });
+        (0, bdd_js_1.it)('should write a single parameter', () => {
+            generic_parameter_js_1.tsGenericParameter.write(builder, [(0, generic_parameter_js_1.tsGenericParameter)('T')]);
+            (0, expect_js_1.expect)(builder.toString(false)).toBe('<T>');
+        });
+        (0, bdd_js_1.it)('should write all the parameters', () => {
+            generic_parameter_js_1.tsGenericParameter.write(builder, [(0, generic_parameter_js_1.tsGenericParameter)('T'), (0, generic_parameter_js_1.tsGenericParameter)('U')]);
+            (0, expect_js_1.expect)(builder.toString(false)).toBe('<T, U>');
+        });
+        (0, bdd_js_1.it)('should write multiline if more than 2 parameters', () => {
+            generic_parameter_js_1.tsGenericParameter.write(builder, [(0, generic_parameter_js_1.tsGenericParameter)('T'), (0, generic_parameter_js_1.tsGenericParameter)('U'), (0, generic_parameter_js_1.tsGenericParameter)('V')]);
+            (0, expect_js_1.expect)(builder.toString(false)).toBe(`<${node_os_1.EOL}  T,${node_os_1.EOL}  U,${node_os_1.EOL}  V${node_os_1.EOL}>`);
+        });
+    });
+});

package/script/src/ast/nodes/indexer.d.ts

@@ -0,0 +1,25 @@
+import type { AstNodeOptions, Nullable, Prettify, SourceBuilder } 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>, {
+    keyName?: Nullable<string>;
+    keyType: TsType<TBuilder>;
+    valueType: TsType<TBuilder>;
+    readonly?: Nullable<boolean>;
+}>;
+export declare class TsIndexer<TBuilder extends SourceBuilder, TInjects extends string = never> extends TsNode<TBuilder, TInjects | Injects> {
+    keyName: string;
+    keyType: TsType<TBuilder>;
+    valueType: TsType<TBuilder>;
+    readonly: boolean;
+    constructor(options: Options<TBuilder, TInjects>);
+    protected onWrite(builder: TBuilder): void;
+}
+declare const createIndexer: <TBuilder extends SourceBuilder>(keyType: Options<TBuilder>["keyType"], valueType: Options<TBuilder>["valueType"], options?: Prettify<Omit<Options<TBuilder>, "keyType" | "valueType">>) => TsIndexer<TBuilder>;
+export declare const tsIndexer: typeof createIndexer & {
+    write: typeof writeTsNodes;
+};
+export {};
+//# sourceMappingURL=indexer.d.ts.map

package/script/src/ast/nodes/indexer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"indexer.d.ts","sourceRoot":"","sources":["../../../../src/src/ast/nodes/indexer.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,QAAQ,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAErF,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,OAAO,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;IAC3B,OAAO,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC;IAC1B,SAAS,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC;IAC5B,QAAQ,CAAC,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC;CAC9B,CACF,CAAC;AAEF,qBAAa,SAAS,CAAC,QAAQ,SAAS,aAAa,EAAE,QAAQ,SAAS,MAAM,GAAG,KAAK,CAAE,SAAQ,MAAM,CACpG,QAAQ,EACR,QAAQ,GAAG,OAAO,CACnB;IACQ,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC;IAC1B,SAAS,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC;IAC5B,QAAQ,EAAE,OAAO,CAAC;gBAEb,OAAO,EAAE,OAAO,CAAC,QAAQ,EAAE,QAAQ,CAAC;cAQ7B,OAAO,CAAC,OAAO,EAAE,QAAQ,GAAG,IAAI;CAcpD;AAED,QAAA,MAAM,aAAa,GAAI,QAAQ,SAAS,aAAa,WAC1C,OAAO,CAAC,QAAQ,CAAC,CAAC,SAAS,CAAC,aAC1B,OAAO,CAAC,QAAQ,CAAC,CAAC,WAAW,CAAC,YAC/B,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,SAAS,GAAG,WAAW,CAAC,CAAC,KACnE,SAAS,CAAC,QAAQ,CAAgE,CAAC;AAEtF,eAAO,MAAM,SAAS,EAAE,OAAO,aAAa,GAAG;IAAE,KAAK,EAAE,OAAO,YAAY,CAAA;CAEzE,CAAC"}

package/script/src/ast/nodes/indexer.test.d.ts

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

package/script/src/ast/nodes/indexer.test.d.ts.map

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

package/script/src/ast/nodes/indexer.test.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+require("../../../_dnt.test_polyfills.js");
+const node_os_1 = require("node:os");
+const expect_js_1 = require("../../../deps/jsr.io/@std/expect/1.0.5/expect.js");
+const bdd_js_1 = require("../../../deps/jsr.io/@std/testing/1.0.3/bdd.js");
+const file_builder_js_1 = require("../../file-builder.js");
+const indexer_js_1 = require("./indexer.js");
+let builder;
+(0, bdd_js_1.beforeEach)(() => {
+    builder = new file_builder_js_1.TypeScriptFileBuilder();
+});
+(0, bdd_js_1.describe)('tsIndexer', () => {
+    (0, bdd_js_1.it)('should write the key and value types', () => {
+        builder.append((0, indexer_js_1.tsIndexer)('string', 'number'));
+        (0, expect_js_1.expect)(builder.toString(false)).toBe(`[key: string]: number;${node_os_1.EOL}`);
+    });
+    (0, bdd_js_1.it)('should write the readonly keyword if the indexer is readonly', () => {
+        builder.append((0, indexer_js_1.tsIndexer)('string', 'number', { readonly: true }));
+        (0, expect_js_1.expect)(builder.toString(false)).toBe(`readonly [key: string]: number;${node_os_1.EOL}`);
+    });
+    (0, bdd_js_1.it)('should write the key name if it exists', () => {
+        builder.append((0, indexer_js_1.tsIndexer)('string', 'number', { keyName: 'id' }));
+        (0, expect_js_1.expect)(builder.toString(false)).toBe(`[id: string]: number;${node_os_1.EOL}`);
+    });
+    (0, bdd_js_1.it)('should render injections', () => {
+        builder.append((0, indexer_js_1.tsIndexer)('string', 'number', {
+            keyName: 'id',
+            readonly: true,
+            inject: { before: '║b║', after: '║a║' },
+        }));
+        (0, expect_js_1.expect)(builder.toString(false)).toBe(`║b║readonly [id: string]: number;${node_os_1.EOL}║a║`);
+    });
+});

package/script/src/ast/nodes/interface.d.ts

@@ -0,0 +1,38 @@
+import { type AstNodeOptions, type BasicAppendValue, type Nullable, type Prettify, type SourceBuilder } from '@goast/core';
+import { TsNode } from '../node.js';
+import { writeTsNodes } from '../utils/write-ts-nodes.js';
+import { type TsDecorator } from './decorator.js';
+import { type TsDoc } from './doc.js';
+import { type TsGenericParameter } from './generic-parameter.js';
+import type { TsIndexer } from './indexer.js';
+import type { TsMethod } from './method.js';
+import type { TsProperty } from './property.js';
+import type { TsReference } from './reference.js';
+type Injects = 'doc' | 'decorators' | 'modifiers' | 'name' | 'generics' | 'extends' | 'body' | 'members';
+type Options<TBuilder extends SourceBuilder, TInjects extends string = never> = AstNodeOptions<typeof TsNode<TBuilder, TInjects | Injects>, {
+    doc?: Nullable<TsDoc<TBuilder>>;
+    decorators?: Nullable<Nullable<TsDecorator<TBuilder>>[]>;
+    export?: Nullable<boolean>;
+    name: string;
+    generics?: Nullable<Nullable<TsGenericParameter<TBuilder> | BasicAppendValue<TBuilder>>[]>;
+    extends?: Nullable<Nullable<TsReference<TBuilder> | BasicAppendValue<TBuilder>>[]>;
+    members?: Nullable<Nullable<Member<TBuilder>>[]>;
+}>;
+type Member<TBuilder extends SourceBuilder> = TsIndexer<TBuilder> | TsProperty<TBuilder> | TsMethod<TBuilder> | BasicAppendValue<TBuilder>;
+export declare class TsInterface<TBuilder extends SourceBuilder, TInjects extends string = never> extends TsNode<TBuilder, TInjects | Injects> {
+    doc: TsDoc<TBuilder> | null;
+    decorators: TsDecorator<TBuilder>[];
+    export: boolean;
+    name: string;
+    generics: (TsGenericParameter<TBuilder> | BasicAppendValue<TBuilder>)[];
+    extends: (TsReference<TBuilder> | BasicAppendValue<TBuilder>)[];
+    members: Member<TBuilder>[];
+    constructor(options: Options<TBuilder, TInjects>);
+    protected onWrite(builder: TBuilder): void;
+}
+declare const createInterface: <TBuilder extends SourceBuilder>(name: Options<TBuilder>["name"], options?: Prettify<Omit<Options<TBuilder>, "name">>) => TsInterface<TBuilder>;
+export declare const tsInterface: typeof createInterface & {
+    write: typeof writeTsNodes;
+};
+export {};
+//# sourceMappingURL=interface.d.ts.map

package/script/src/ast/nodes/interface.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"interface.d.ts","sourceRoot":"","sources":["../../../../src/src/ast/nodes/interface.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,cAAc,EACnB,KAAK,gBAAgB,EAErB,KAAK,QAAQ,EACb,KAAK,QAAQ,EACb,KAAK,aAAa,EACnB,MAAM,aAAa,CAAC;AAErB,OAAO,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AAEpC,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAC1D,OAAO,EAAE,KAAK,WAAW,EAAe,MAAM,gBAAgB,CAAC;AAC/D,OAAO,EAAE,KAAK,KAAK,EAAS,MAAM,UAAU,CAAC;AAC7C,OAAO,EAAE,KAAK,kBAAkB,EAAsB,MAAM,wBAAwB,CAAC;AACrF,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAC9C,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAChD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAElD,KAAK,OAAO,GAAG,KAAK,GAAG,YAAY,GAAG,WAAW,GAAG,MAAM,GAAG,UAAU,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,CAAC;AAEzG,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,UAAU,CAAC,EAAE,QAAQ,CAAC,QAAQ,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC;IACzD,MAAM,CAAC,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,QAAQ,CAAC,QAAQ,CAAC,kBAAkB,CAAC,QAAQ,CAAC,GAAG,gBAAgB,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC;IAC3F,OAAO,CAAC,EAAE,QAAQ,CAAC,QAAQ,CAAC,WAAW,CAAC,QAAQ,CAAC,GAAG,gBAAgB,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC;IACnF,OAAO,CAAC,EAAE,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC;CAClD,CACF,CAAC;AAEF,KAAK,MAAM,CAAC,QAAQ,SAAS,aAAa,IACtC,SAAS,CAAC,QAAQ,CAAC,GACnB,UAAU,CAAC,QAAQ,CAAC,GACpB,QAAQ,CAAC,QAAQ,CAAC,GAClB,gBAAgB,CAAC,QAAQ,CAAC,CAAC;AAE/B,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,UAAU,EAAE,WAAW,CAAC,QAAQ,CAAC,EAAE,CAAC;IACpC,MAAM,EAAE,OAAO,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,CAAC,kBAAkB,CAAC,QAAQ,CAAC,GAAG,gBAAgB,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC;IACxE,OAAO,EAAE,CAAC,WAAW,CAAC,QAAQ,CAAC,GAAG,gBAAgB,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC;IAChE,OAAO,EAAE,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;gBAEvB,OAAO,EAAE,OAAO,CAAC,QAAQ,EAAE,QAAQ,CAAC;cAW7B,OAAO,CAAC,OAAO,EAAE,QAAQ,GAAG,IAAI;CA2CpD;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,eAAO,MAAM,WAAW,EAAE,OAAO,eAAe,GAAG;IAAE,KAAK,EAAE,OAAO,YAAY,CAAA;CAE7E,CAAC"}

package/script/src/ast/nodes/interface.js

@@ -0,0 +1,102 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.tsInterface = exports.TsInterface = void 0;
+const core_1 = require("@goast/core");
+const node_js_1 = require("../node.js");
+const write_ts_members_js_1 = require("../utils/write-ts-members.js");
+const write_ts_nodes_js_1 = require("../utils/write-ts-nodes.js");
+const decorator_js_1 = require("./decorator.js");
+const doc_js_1 = require("./doc.js");
+const generic_parameter_js_1 = require("./generic-parameter.js");
+class TsInterface extends node_js_1.TsNode {
+    constructor(options) {
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
+        super(options);
+        Object.defineProperty(this, "doc", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "decorators", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "export", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "name", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "generics", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "extends", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "members", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.doc = (_a = options.doc) !== null && _a !== void 0 ? _a : null;
+        this.decorators = (_c = (_b = options.decorators) === null || _b === void 0 ? void 0 : _b.filter(core_1.notNullish)) !== null && _c !== void 0 ? _c : [];
+        this.export = (_d = options.export) !== null && _d !== void 0 ? _d : false;
+        this.name = options.name;
+        this.generics = (_f = (_e = options.generics) === null || _e === void 0 ? void 0 : _e.filter(core_1.notNullish)) !== null && _f !== void 0 ? _f : [];
+        this.extends = (_h = (_g = options.extends) === null || _g === void 0 ? void 0 : _g.filter(core_1.notNullish)) !== null && _h !== void 0 ? _h : [];
+        this.members = (_k = (_j = options.members) === null || _j === void 0 ? void 0 : _j.filter(core_1.notNullish)) !== null && _k !== void 0 ? _k : [];
+    }
+    onWrite(builder) {
+        builder.append(this.inject.beforeDoc);
+        doc_js_1.tsDoc.write(builder, doc_js_1.tsDoc.get(this.doc, { generics: this.generics }));
+        builder.append(this.inject.afterDoc);
+        builder.append(this.inject.beforeDecorators);
+        decorator_js_1.tsDecorator.write(builder, this.decorators, { multiline: true });
+        builder.append(this.inject.afterDecorators);
+        builder.append(this.inject.beforeModifiers);
+        if (this.export)
+            builder.append('export ');
+        builder.append(this.inject.afterModifiers);
+        builder.append('interface ');
+        builder.append(this.inject.beforeName, this.name, this.inject.afterName);
+        builder.append(this.inject.beforeGenerics);
+        generic_parameter_js_1.tsGenericParameter.write(builder, this.generics);
+        builder.append(this.inject.afterGenerics);
+        if (this.extends.length > 0) {
+            builder.append(' extends ');
+            builder.append(this.inject.beforeExtends);
+            (0, write_ts_nodes_js_1.writeTsNodes)(builder, this.extends, { separator: ', ' });
+            builder.append(this.inject.afterExtends);
+        }
+        builder.append(' ');
+        builder.append(this.inject.beforeBody);
+        builder.parenthesize('{}', (b) => {
+            b.append(this.inject.beforeMembers);
+            (0, write_ts_members_js_1.writeTsMembers)(b, this.members);
+            b.append(this.inject.afterMembers);
+        }, { multiline: this.members.length > 0 });
+        builder.append(this.inject.afterBody);
+        builder.appendLine();
+    }
+}
+exports.TsInterface = TsInterface;
+const createInterface = (name, options) => new TsInterface({ ...options, name });
+exports.tsInterface = Object.assign(createInterface, {
+    write: write_ts_nodes_js_1.writeTsNodes,
+});

package/script/src/ast/nodes/interface.test.d.ts

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

package/script/src/ast/nodes/interface.test.d.ts.map

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

package/script/src/ast/nodes/interface.test.js

@@ -0,0 +1,117 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+require("../../../_dnt.test_polyfills.js");
+const node_os_1 = require("node:os");
+const expect_js_1 = require("../../../deps/jsr.io/@std/expect/1.0.5/expect.js");
+const bdd_js_1 = require("../../../deps/jsr.io/@std/testing/1.0.3/bdd.js");
+const test_utils_1 = require("@goast/test-utils");
+const file_builder_js_1 = require("../../file-builder.js");
+const decorator_js_1 = require("./decorator.js");
+const doc_js_1 = require("./doc.js");
+const generic_parameter_js_1 = require("./generic-parameter.js");
+const interface_js_1 = require("./interface.js");
+const method_js_1 = require("./method.js");
+const property_js_1 = require("./property.js");
+const reference_js_1 = require("./reference.js");
+let builder;
+(0, bdd_js_1.beforeEach)(() => {
+    builder = new file_builder_js_1.TypeScriptFileBuilder();
+});
+(0, bdd_js_1.describe)('tsInterface', () => {
+    (0, bdd_js_1.it)('should write the name of the interface', () => {
+        builder.append((0, interface_js_1.tsInterface)('X'));
+        (0, expect_js_1.expect)(builder.toString(false)).toBe(`interface X {}${node_os_1.EOL}`);
+    });
+    (0, bdd_js_1.it)('should write the generics if they exist', () => {
+        builder.append((0, interface_js_1.tsInterface)('X', { generics: [(0, generic_parameter_js_1.tsGenericParameter)('T'), (0, generic_parameter_js_1.tsGenericParameter)('U')] }));
+        (0, expect_js_1.expect)(builder.toString(false)).toBe(`interface X<T, U> {}${node_os_1.EOL}`);
+    });
+    (0, bdd_js_1.it)('should write the extends if it exists', () => {
+        builder.append((0, interface_js_1.tsInterface)('X', { extends: [(0, reference_js_1.tsReference)('Y'), (0, reference_js_1.tsReference)('Z')] }));
+        (0, expect_js_1.expect)(builder.toString(false)).toBe(`interface X extends Y, Z {}${node_os_1.EOL}`);
+    });
+    (0, bdd_js_1.it)('should write the properties if they exist', () => {
+        builder.append((0, interface_js_1.tsInterface)('X', { members: [(0, property_js_1.tsProperty)('x'), (0, property_js_1.tsProperty)('y')] }));
+        (0, expect_js_1.expect)(builder.toString(false)).toBe(`interface X {${node_os_1.EOL}  x;${node_os_1.EOL}  y;${node_os_1.EOL}}${node_os_1.EOL}`);
+    });
+    (0, bdd_js_1.it)('should write the methods if they exist', () => {
+        builder.append((0, interface_js_1.tsInterface)('X', { members: [(0, method_js_1.tsMethod)('x'), (0, method_js_1.tsMethod)('y')] }));
+        (0, expect_js_1.expect)(builder.toString(false)).toBe(`interface X {${node_os_1.EOL}  x();${node_os_1.EOL}  y();${node_os_1.EOL}}${node_os_1.EOL}`);
+    });
+    (0, bdd_js_1.it)('should write export keyword if configured', () => {
+        builder.append((0, interface_js_1.tsInterface)('X', { export: true }));
+        (0, expect_js_1.expect)(builder.toString(false)).toBe(`export interface X {}${node_os_1.EOL}`);
+    });
+    (0, bdd_js_1.it)('should write the doc if it exists', () => {
+        builder.append((0, interface_js_1.tsInterface)('X', { doc: (0, doc_js_1.tsDoc)({ description: 'description' }) }));
+        (0, expect_js_1.expect)(builder.toString(false)).toBe(`/**${node_os_1.EOL} * description${node_os_1.EOL} */${node_os_1.EOL}interface X {}${node_os_1.EOL}`);
+    });
+    (0, bdd_js_1.it)('should write the decorators if they exist', () => {
+        builder.append((0, interface_js_1.tsInterface)('X', { decorators: [(0, decorator_js_1.tsDecorator)('decorator')] }));
+        (0, expect_js_1.expect)(builder.toString(false)).toBe(`@decorator${node_os_1.EOL}interface X {}${node_os_1.EOL}`);
+    });
+    (0, bdd_js_1.it)('should write all the parts of the interface', () => {
+        builder.append((0, interface_js_1.tsInterface)('X', {
+            doc: (0, doc_js_1.tsDoc)({ description: 'description' }),
+            decorators: [(0, decorator_js_1.tsDecorator)('decorator')],
+            generics: [(0, generic_parameter_js_1.tsGenericParameter)('T'), (0, generic_parameter_js_1.tsGenericParameter)('U')],
+            extends: [(0, reference_js_1.tsReference)('Y'), (0, reference_js_1.tsReference)('Z')],
+            members: [(0, property_js_1.tsProperty)('x'), (0, property_js_1.tsProperty)('y'), (0, method_js_1.tsMethod)('x'), (0, method_js_1.tsMethod)('y')],
+            export: true,
+        }));
+        (0, expect_js_1.expect)(builder.toString(false)).toBe((0, test_utils_1.normalizeEOL)(8)(`/**
+         * description
+         */
+        @decorator
+        export interface X<T, U> extends Y, Z {
+          x;
+          y;
+          x();
+          y();
+        }
+        `));
+    });
+    (0, bdd_js_1.it)('should render injections', () => {
+        builder.append((0, interface_js_1.tsInterface)('X', {
+            doc: (0, doc_js_1.tsDoc)({ description: 'description' }),
+            decorators: [(0, decorator_js_1.tsDecorator)('decorator')],
+            generics: [(0, generic_parameter_js_1.tsGenericParameter)('T'), (0, generic_parameter_js_1.tsGenericParameter)('U')],
+            extends: [(0, reference_js_1.tsReference)('Y'), (0, reference_js_1.tsReference)('Z')],
+            members: [(0, property_js_1.tsProperty)('x'), (0, property_js_1.tsProperty)('y'), (0, method_js_1.tsMethod)('x'), (0, method_js_1.tsMethod)('y')],
+            export: true,
+            inject: {
+                before: '║b║',
+                after: '║a║',
+                beforeDoc: '║bd║',
+                afterDoc: '║ad║',
+                beforeDecorators: '║bds║',
+                afterDecorators: '║ads║',
+                beforeModifiers: '║bm║',
+                afterModifiers: '║am║',
+                beforeName: '║bn║',
+                afterName: '║an║',
+                beforeGenerics: '║bg║',
+                afterGenerics: '║ag║',
+                beforeExtends: '║be║',
+                afterExtends: '║ae║',
+                beforeBody: '║bb║',
+                afterBody: '║ab║',
+                beforeMembers: '║bm║',
+                afterMembers: '║am║',
+            },
+        }));
+        (0, expect_js_1.expect)(builder.toString(false)).toBe((0, test_utils_1.normalizeEOL)(8)(`║b║║bd║
+        /**
+         * description
+         */
+        ║ad║║bds║@decorator
+        ║ads║║bm║export ║am║interface ║bn║X║an║║bg║<T, U>║ag║ extends ║be║Y, Z║ae║ ║bb║{
+          ║bm║x;
+          y;
+          x();
+          y();
+          ║am║
+        }║ab║
+        ║a║`));
+    });
+});