feat: append sourceFileName on BaseType, used by TopRefNodeParser and ExposeNodeParser

[charlzyx]

for this idea #1018

And here is my custome example

utils/reformatRefDefName.ts

import {
  BaseType,
  DefinitionType,
  ReferenceType,
} from 'ts-json-schema-generator';

export const reformatDefName = (type: BaseType) => {
  let name = type.getName();
  /** myCustomeName Rule */
  if (!(type instanceof DefinitionType) || /def-\[REQ\]/.test(name)) {
    return name;
  }
  if (/__file:\/\/\//.test(name)) {
    return name;
  }
  const source = (type.sourceFileName || '').replace(process.cwd(), '');
  const ref = name + (source ? `__file:///${source}` : '');
  (type as any).name = ref;
  return ref;
};

export const reformatRefName = (type: any) => {
  let name = type.getName();
  if (!(type instanceof ReferenceType)) {
    return name;
  }
  const isDef = (type as any).type instanceof DefinitionType;
  if (!isDef) return name;
  const defName = (type as any)?.type?.name;
  const isDiff = defName !== name;
  if (isDiff) {
    (type as any).name = defName;
    return defName;
  } else {
    return name;
  }
};

custome DefinitionTypeFormatter

import {
  BaseType,
  Definition,
  DefinitionType,
  SubTypeFormatter,
  TypeFormatter,
  uniqueArray,
} from 'ts-json-schema-generator';
import { reformatDefName } from '../utils/reformatRefDefName';

export class DefinitionTypeFormatter implements SubTypeFormatter {
  public constructor(
    private childTypeFormatter: TypeFormatter,
    private encodeRefs: boolean,
  ) {}

  public supportsType(type: DefinitionType): boolean {
    return type instanceof DefinitionType;
  }
  public getDefinition(type: DefinitionType): Definition {
    const ref = reformatDefName(type);
    return {
      $ref: `#/definitions/${this.encodeRefs ? encodeURIComponent(ref) : ref}`,
    };
  }
  public getChildren(type: DefinitionType): BaseType[] {
    return uniqueArray([
      type,
      ...this.childTypeFormatter.getChildren(type.getType()),
    ]);
  }
}

custom ReferenceTypeFormatter

import {
  BaseType,
  Definition,
  DefinitionType,
  ReferenceType,
  SubTypeFormatter,
  TypeFormatter,
} from 'ts-json-schema-generator';
import { reformatRefName } from '../utils/reformatRefDefName';

export class ReferenceTypeFormatter implements SubTypeFormatter {
  public constructor(
    private childTypeFormatter: TypeFormatter,
    private encodeRefs: boolean,
  ) {}

  public supportsType(type: ReferenceType): boolean {
    return type instanceof ReferenceType;
  }
  public getDefinition(type: ReferenceType): Definition {
    const ref = reformatRefName(type);
    return {
      $ref: `#/definitions/${this.encodeRefs ? encodeURIComponent(ref) : ref}`,
    };
  }
  public getChildren(type: ReferenceType): BaseType[] {
    if (type.getType() instanceof DefinitionType) {
      return [];
    }

    // this means that the referred interface is private
    // so we have to expose it in the schema definitions
    return this.childTypeFormatter.getChildren(
      new DefinitionType(reformatRefName(type), type.getType()),
    );
  }
}

[domoritz]

Please use proper capitalization.

[domoritz]

Can this just be in the DefinitionType instead of the base type?

[domoritz]

This doesn't feel clean. Can we make sourceFileName an argument to the DefinitionType constructor?

[charlzyx]

Thank you for your correction. I think it is a very good suggestion. I will try to submit a version again tomorrow to correct these problems.

[domoritz]

Thank you for your pull request.

[domoritz]

Any updates @charlzyx?

[charlzyx]

Sorry i'm too late, too busy to submit; And sorry again, i don't know how to submit this or, so i have reopen another one #1056

[domoritz]

Can you push to the branch this pull request was made from?

[charlzyx]

sorry about #1056 this is my first time to use github pr，I'm not familiar with it.
just want submit a cleaning commit，i will try fix next free time.

[domoritz]

Okay. Please notify me when you want a review then.

[charlzyx]

i'm sorry but i have to say a bad info: this PR's fork in my personal repo is deleted, and not local repo. so link [charlzyx:next] override by #1056 's fork. and this PR cannot edit.

If possible, I suggest closing the current PR and reopening #1056

[domoritz]

Okay, please make sure my comment here are addressed. Ideally, copy them over.