{"id":13768267,"url":"https://github.com/flow/vim-flow","last_synced_at":"2025-05-10T23:31:06.506Z","repository":{"id":22634721,"uuid":"25977452","full_name":"flow/vim-flow","owner":"flow","description":"A vim plugin for Flow","archived":true,"fork":false,"pushed_at":"2019-08-13T02:20:10.000Z","size":69,"stargazers_count":524,"open_issues_count":27,"forks_count":52,"subscribers_count":24,"default_branch":"master","last_synced_at":"2025-05-07T19:02:38.396Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Vim script","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/flow.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-10-30T15:34:43.000Z","updated_at":"2025-01-05T20:40:05.000Z","dependencies_parsed_at":"2022-08-21T09:00:42.373Z","dependency_job_id":null,"html_url":"https://github.com/flow/vim-flow","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flow%2Fvim-flow","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flow%2Fvim-flow/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flow%2Fvim-flow/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flow%2Fvim-flow/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/flow","download_url":"https://codeload.github.com/flow/vim-flow/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253497296,"owners_count":21917683,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-03T16:01:18.944Z","updated_at":"2025-05-10T23:31:06.026Z","avatar_url":"https://github.com/flow.png","language":"Vim script","funding_links":[],"categories":["Integrations"],"sub_categories":[],"readme":"# vim-flow\n\nA vim plugin for [Flow][flow].\n\n - Adds completions to `omnifunc`\n - Checks JavaScript files for type errors on save\n\n## Requirements\n\n - Requires [Flow][flow] to be installed and available on your path\n - Requires the project to be initialised with `flow init`\n - Requires JavaScript files to be marked with `/* @flow */` or `/* @flow weak */` at the top\n\n## Installation\n\n### [Pathogen][pathogen]\n\n    cd ~/.vim/bundle\n    git clone git://github.com/flowtype/vim-flow.git\n\n### [NeoBundle][neobundle]\n\nAdd this to your `~/.vimrc`\n\n```VimL\n  NeoBundleLazy 'flowtype/vim-flow', {\n            \\ 'autoload': {\n            \\     'filetypes': 'javascript'\n            \\ }}\n```\n\n#### With [Flow][flow] build step, using [flow-bin][flowbin]\n\n```VimL\n  NeoBundleLazy 'flowtype/vim-flow', {\n            \\ 'autoload': {\n            \\     'filetypes': 'javascript'\n            \\ },\n            \\ 'build': {\n            \\     'mac': 'npm install -g flow-bin',\n            \\     'unix': 'npm install -g flow-bin'\n            \\ }}\n```\n## Usage\n\nUnless [disabled manually][gflowenable], vim-flow will check JavaScript and JSX files on save.\n\n## Commands\n\n#### `FlowMake`\n\nTriggers a type check for the current file.\n\n#### `FlowToggle`\n\nTurns automatic checks on save on or off.\n\n#### `FlowType` \n\nDisplay the type of the variable under the cursor.\n\n#### `FlowJumpToDef` \n\nJump to the definition of the variable under the cursor.\n\n## Configuration\n\n#### `g:flow#autoclose`\n\nIf this is set to `1`, the quickfix window will not be opened when there are\nno errors, and will be automatically closed when previous errors are cleared.\n\nDefault is `0`.\n\n#### `g:flow#enable`\n\nTypechecking is done automatically on `:w` if set to `1`.\n\nTo disable this, set to `0` in your ~/.vimrc, like so:\n\n```VimL\nlet g:flow#enable = 0\n```\n\nDefault is `1`.\n\n#### `g:flow#errjmp`\n\nJump to errors after typechecking if set to `1`.\n\nDefault is `0`.\n\n#### `g:flow#flowpath`\n\nLeave this as default to use the flow executable defined on your path. To use\na custom flow executable, set this like so:\n\n```VimL\nlet g:flow#flowpath = /your/flow-path/flow\n```\n\n#### `g:flow#omnifunc`\n\nBy default `omnifunc` will be set to provide omni completion. To disable it\n(prevent overwriting an existed omnifunc), set this value to 0:\n\n```VimL\nlet g:flow#omnifunc = 0\n```\n\n#### `g:flow#timeout`\n\nBy default `timeout` will be set to 2 seconds. If you are working on a larger\ncodebase, you may want to increase this to avoid errors when Flow initializes.\n\n```VimL\nlet g:flow#timeout = 4\n```\n\n#### `g:flow#qfsize`\n\nLeave this as default to let the plugin decide on the quickfix window size.\n\n#### `g:flow#showquickfix`\n\nBy default, results are shown in a quickfix window. Setting this to 0 will\nstop the window from being shown. This is useful if you want to use\nvim-flow for the omnicomplete functionality, but are already using\nsomething like [ale](https://github.com/w0rp/ale).\n\n```VimL\nlet g:flow#showquickfix = 0\n```\n\n[gflowenable]: https://github.com/flowtype/vim-flow#gflowenable\n[flow]: https://github.com/facebook/flow\n[flowbin]: https://github.com/sindresorhus/flow-bin\n[pathogen]: https://github.com/tpope/vim-pathogen\n[neobundle]: https://github.com/Shougo/neobundle.vim\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fflow%2Fvim-flow","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fflow%2Fvim-flow","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fflow%2Fvim-flow/lists"}