fix(cli): fix stack overflow in Deno doc when namespace exports itself

[MujahedSafaa]

This PR fixes: denoland/deno#23711

When executing deno doc on a TypeScript file that contains a namespace exporting itself, like in this file example:
https://gist.github.com/crowlKats/1f6ed084bbab0a10267df9ed31564599

export namespace test {
    export { test };
}

The program exits with the following error:
thread 'main' has overflowed its stack
error: process didn't exit successfully: target\debug\examples\ddoc.exe test3.d.ts (exit code: 0xc00000fd, STATUS_STACK_OVERFLOW)

Solution:
I added a check to see if the export is the same as the namespace and, if so, it ignores generating the DocNode for it.

[CLAassistant]

All committers have signed the CLA.

[dsherret]

Thanks for the PR, but see the comments. Also, would you be able to sign the CLA?

[dsherret]

What happens for the following code?

export declare namespace test {
    const test: string;
    export { test };
}

Or the following:

export declare namespace test {
    export class test {}
}

I think it can't be based on strings, but probably needs to be based on the symbol id or swc id.

[MujahedSafaa]

I previously attempted to use the symbol ID, but the output varied for certain inputs. For instance:

export function describe(name?: string, options?: TestOptions, fn?: SuiteFn): Promise<void>;
export function describe(name?: string, fn?: SuiteFn): Promise<void>;
export function describe(options?: TestOptions, fn?: SuiteFn): Promise<void>;
export function describe(fn?: SuiteFn): Promise<void>;

export namespace describe {
    /**
     * Shorthand for skipping a suite, equivalent to `describe([name], { skip: true }[, fn])`.
     */
    export function skip(name?: string, options?: TestOptions, fn?: SuiteFn): Promise<void>;
    export function skip(name?: string, fn?: SuiteFn): Promise<void>;
    export function skip(options?: TestOptions, fn?: SuiteFn): Promise<void>;
    export function skip(fn?: SuiteFn): Promise<void>;

    /**
     * Shorthand for marking a suite as `TODO`, equivalent to `describe([name], { todo: true }[, fn])`.
     */
    export function todo(name?: string, options?: TestOptions, fn?: SuiteFn): Promise<void>;
    export function todo(name?: string, fn?: SuiteFn): Promise<void>;
    export function todo(options?: TestOptions, fn?: SuiteFn): Promise<void>;
    export function todo(fn?: SuiteFn): Promise<void>;

    /**
     * Shorthand for marking a suite as `only`, equivalent to `describe([name], { only: true }[, fn])`.
     * @since v18.15.0
     */
    export function only(name?: string, options?: TestOptions, fn?: SuiteFn): Promise<void>;
    export function only(name?: string, fn?: SuiteFn): Promise<void>;
    export function only(options?: TestOptions, fn?: SuiteFn): Promise<void>;
    export function only(fn?: SuiteFn): Promise<void>;
}

The documentation is only generated for the first line: export function describe(name?: string, options?: TestOptions, fn?: SuiteFn): Promise<void>; The rest are skipped because they share the same symbol ID. I guess the symbol ID is same since they all have the same symbol and module id

[MujahedSafaa]

Hello @dsherret
I wanted to follow up on my previous comment. Could you please check my comment above when you get a chance?

[dsherret]

We should add a test for this in tests/specs (copy and paste another .txt file, modify it, then run cargo test to see if it works. You can use UPDATE=1 env var to update the expected output with the actual output)

[MujahedSafaa]

Thanks for the PR, but see the comments. Also, would you be able to sign the CLA?

I signed the CLA document