Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/steelbrain/flow-ide
A full featured FlowType package for Atom Editor
https://github.com/steelbrain/flow-ide
Last synced: 11 days ago
JSON representation
A full featured FlowType package for Atom Editor
- Host: GitHub
- URL: https://github.com/steelbrain/flow-ide
- Owner: steelbrain
- License: mit
- Created: 2016-02-05T18:56:23.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2021-08-10T17:39:48.000Z (over 3 years ago)
- Last Synced: 2024-05-01T23:19:47.174Z (7 months ago)
- Language: JavaScript
- Size: 449 KB
- Stars: 202
- Watchers: 7
- Forks: 19
- Open Issues: 27
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
Flow-IDE
=======
Flow IDE is a lightweight package that provides IDE features for [FlowType][FlowType] for [Atom Editor][Atom]. It's pretty lightweight and robust.
#### Installation
```
apm install flow-ide
```
#### Setup
1) You will need to install flow-bin into your project!
```
npm install --save-dev flow-bin
```
or
```
yarn add --dev flow-bin
```
2) You will need ` // @flow ` at the top of all files you wish to lint
3) You will need a `.flowconfig` which can be initialized with `flow init` if you have flow installed, if not you can use [this flowconfig](https://github.com/steelbrain/flow-ide/blob/master/.flowconfig)
4) Window: Reload (Ctrl+Shift+F5) to apply changes
#### Features
- Linting
- Autocomplete
- Jump to declaration (using [facebook-atom/hyperclick][hyperclick] or [facebook-atom/atom-ide-ui][atom-ide-ui])
- Datatip on hover (using [facebook-atom/atom-ide-ui][atom-ide-ui])
- Outline of classes, functions, types and variables (using [facebook-atom/atom-ide-ui][atom-ide-ui])
#### Differences to other packages
Differences to [facebook/nuclide][nuclide]
- Nuclide is nice and all but it's mostly bloatware for lightweight flow programming
Differences to [AtomLinter/linter-flow][linter-flow]
- It tries to manage flow servers by itself, I find it annoying
Differences to [nmn/autocomplete-flow][autocomplete-flow]
- Never worked for me
Differences to [LukeHoban/ide-flow][ide-flow]
- Outdated and buggy
- No longer maintained
#### Screenshots
#### License
This project is licensed under the terms of MIT License. Check the LICENSE file for more info.
[FlowType]:http://flowtype.org/
[Atom]:https://atom.io/
[nuclide]:https://github.com/facebook/nuclide
[hyperclick]:https://github.com/facebook-atom/hyperclick
[atom-ide-ui]:https://github.com/facebook-atom/atom-ide-ui
[ide-flow]:https://github.com/lukehoban/atom-ide-flow
[linter-flow]:https://github.com/AtomLinter/linter-flow
[autocomplete-flow]:https://github.com/nmn/autocomplete-flow