Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Status & ember-cli-typescript compatibility #1

Open
buschtoens opened this issue Nov 21, 2018 · 3 comments
Open

Status & ember-cli-typescript compatibility #1

buschtoens opened this issue Nov 21, 2018 · 3 comments

Comments

@buschtoens
Copy link

buschtoens commented Nov 21, 2018

The initial-implementation branch is not compatible with the latest ember-cli-typescript@beta any more.

I would like to know your opinion regarding the best way forward. Do you think it is worthwhile to fix this docs generator, when ember-cli-typscript@2 is released?

I've also submitted ember-learn/ember-cli-addon-docs-esdoc#7 to enable crude TS support via ember-cli-addon-docs-esdoc.

I guess that in the end we'll want build ember-cli-addon-docs-tsdoc or some docs generator that is built on tsdoc, as tsdoc itself seems to be very minimal in scope.

@josemarluedke
Copy link

Is there any new updates going on in this? Looking forward to use generate Docs for TS.

@dfreeman
Copy link
Collaborator

The initial-implementation branch is compatible with ember-cli-typescript@2 and works well enough with the one project I've been playing with it with. You're welcome to try your luck with that branch, but I don't think we're going to want to commit to supporting this project in the long term. In fact, now that it's not so tightly bound to the implementation of ember-cli-typescript itself, it may make sense to transfer this repo out of the typed-ember org.

Longer term I suspect tsdoc or perhaps code-to-json will prove to be a better fit for a TypeScript-oriented AddonDocs plugin.

@dfreeman
Copy link
Collaborator

Update: I did go ahead and transfer this to my personal org, and I'll update the README with a big "you probably don't want to use this" disclaimer.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants