feat: primitive TypeScript support

[buschtoens]

This PR enables primitive TypeScript support by:

• processing .js and .ts files
• adding esdoc-typescript-plugin

This solution is not perfect, but good enough to at least enable documenting TypeScript code, until ember-cli-addon-docs-typedoc is or ember-cli-addon-docs-tsdoc are a real thing.

[buschtoens]

It seems that for TypeScript files all @tags are ignored.

For instance, this yields:

class Foo {
  /**
   * this is method3.
   * @param n - this is the param desc.
   * @return this is the return desc.
   * @private
   */
  private method3(n: number): string {}
}

But that would be an upstream issue with esdoc-typescript-plugin, I assume. And I think that this crude documentation is still better than no documentation.

[buschtoens]

Aha! esdoc/esdoc-plugins#25

class Foo {
  /**
   * @desc this is method3.
   * @param n - this is the param desc.
   * @return this is the return desc.
   * @private
   */
  private method3(n: number): string {}
}

However, this the breaks the type information.

(The @private tag is also not automatically inferred.)

[buschtoens]

There also seems to be trouble with Generics<T> and <Type>casts: esdoc/esdoc-plugins#74

[tstormk]

Any updates on this? We really need Typescript support for our documentation and it would be great if this addon could support it. Currently there seems to be no work around either.

It would also be great if this addon could support custom ESDoc plugins.

[RobbieTheWagner]

@buschtoens @tstormk do either of you know if enabling the TS plugin effects normal JS output from ESDoc at all? This looks fine to me, but I would like to double check we are not messing anything up for JS users.

[nightire]

Suggested change

	{ name: 'esdoc-typescript-plugin', option: { enable: true } }
	{ name: 'esdoc-typescript-plugin' }

this enable option is true by default.

[nightire]

Can we cut a release with this improvement? I tested in a fairly large project which migrates some .js to .ts, and this PR works pretty well.

[RobbieTheWagner]

@nightire I mainly wanted to make sure it did not break plain JS. Does it work well for both vanilla JS and TS for you?

[nightire]

@rwwagner90 Yes, it works well for both vanilla JavaScript and TypeScript.