Skip to content

Build system: switch out of Flow comment syntax #729

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

Closed
tmcw opened this issue Apr 14, 2017 · 1 comment
Closed

Build system: switch out of Flow comment syntax #729

tmcw opened this issue Apr 14, 2017 · 1 comment
Labels

Comments

@tmcw
Copy link
Member

tmcw commented Apr 14, 2017

Flow comment syntax is a continuing bother with prettier's formatting ( #709 ) and it sounds like its problems are very deep rooted, according to Christopher. Plus our continuing lack of Flow comments support because of a lack of upstream implementation mean that it just isn't... well, a good train to get on.

This'd mean switching to real Flow annotations, which would then mean switching to using a tool to strip them out, and then potentially going all the way and producing a single bundle to save on startup time

What do folks think here: are Flow comments something we should dig into or something that would be wise to cut from scope?

@arv
Copy link
Contributor

arv commented Apr 17, 2017

I don't have an answer here but the way that documentation.js can work without a compile step is a good feature.

If we ever commit to a compile step then normal Flow annotations are just incredible.

tmcw added a commit that referenced this issue May 2, 2017
We're switching to Flow annotations - not Flow comments. This
gives documentation.js the ability to self-document without
JSDoc types and improves our compatibility with tools like
prettier.

Fixes #729. Fixes #709
tmcw added a commit that referenced this issue May 9, 2017
We're switching to Flow annotations - not Flow comments. This
gives documentation.js the ability to self-document without
JSDoc types and improves our compatibility with tools like
prettier.

Fixes #729. Fixes #709
@tmcw tmcw closed this as completed in #767 May 9, 2017
tmcw added a commit that referenced this issue May 9, 2017
* build: Use Flow syntax without comments.

We're switching to Flow annotations - not Flow comments. This
gives documentation.js the ability to self-document without
JSDoc types and improves our compatibility with tools like
prettier.

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

No branches or pull requests

2 participants