rushstack icon indicating copy to clipboard operation
rushstack copied to clipboard

[api-extractor] How to remove redundant new lines of trimmed variables?

Open xiasun opened this issue 1 year ago • 0 comments

Summary

How to remove redundant newlines on trimmed members?

Repro steps

I want to trim internal members in my public release.

Let's say a sample .d.ts file is as follow

export class SampleClass {

    /** @internal */
    private _member1;

    /** @internal */
    private _member2;

    /** @internal */
    private _member3;

    /** @internal */
    private _member4;

    /** @internal */
    private _member5;

    /** @public */
    constructor();

    /** @public */
    public member1;

    /** @public */
    public member2;

}

My config file is an initially created one, and I just update dstRollup part as follow

"dtsRollup": {
    "enabled": true,
    "untrimmedFilePath": "<projectFolder>/dist/sdk/splat/sdk/index.d.ts",
    "publicTrimmedFilePath": "<projectFolder>/dist/sdk/splat/splat.d.ts",
    "omitTrimmingComments": true
},

The generated release has multiple newlines for the trimmed internal members

export class SampleClass {










    /** @public */
    constructor();

    /** @public */
    public member1;

    /** @public */
    public member2;

}

Expected result:

export class SampleClass {

    /** @public */
    constructor();

    /** @public */
    public member1;

    /** @public */
    public member2;

}

Actual result:

export class SampleClass {










    /** @public */
    constructor();

    /** @public */
    public member1;

    /** @public */
    public member2;

}

Details

Standard questions

Please answer these questions to help us investigate your issue more quickly:

Question Answer
@microsoft/api-extractor version? 7.43.0
Operating system? Windows
API Extractor scenario? config above
Would you consider contributing a PR? Yes
TypeScript compiler version? 5.0.4
Node.js version (node -v)? 19.4.0

xiasun avatar Jun 17 '24 03:06 xiasun