What is this?
Flowery prettifies the result generated by Facebook Flow type check tool, making it easier to read.
Before: It's not easy to understand which part of the code went wrong.
After: Each error was listed with related file name and precise locations.
How to install
$ npm install -g flowery
How to use?
CLI
There are 3 ways to run flowery.
// runs flowery as a convenient wrapper// equals to $ flow --json | flowery$ flowery
// piping in content// useful
// pass in txt file generated by flow$ flowery log.txt
API
;var result = ;console// {arrErrors: [...], arrMessages: [...], joinedMessages: '....' }
By running one of those commands, flow
will check all js
files in the folder, pipe the results to flowery
, then you will see prettified results on screen, also a file named flow-results.txt
will be generated in the project folder too so your build tool could pick up from there and make further use of it.
As a side note, flowery can be invoked via both CLI
or API
, see example/api.js
for usage guide.
The core api
returns both arrErrors
and arrMessages
so you can further integrate with other toolchains, for example, build a better flow linter
for Sublime Text Editor.
How to build
npm run build
Flowery is written in ES2015
, hence it's required to run build to generate ES5
version before publish on NPM.
Roadmap
- A Sublime Text Editor package which mark errors in place and provide tooltips when mouse hovered it. (Total python noob here, any help would be highly appreciated)
See discussion here.