{"id":22904594,"url":"https://github.com/itspriddle/vim-shellcheck","last_synced_at":"2025-06-23T05:39:47.640Z","repository":{"id":45011262,"uuid":"150680234","full_name":"itspriddle/vim-shellcheck","owner":"itspriddle","description":"Vim wrapper for ShellCheck, a static analysis tool for shell scripts.","archived":false,"fork":false,"pushed_at":"2024-09-12T22:22:56.000Z","size":32,"stargazers_count":92,"open_issues_count":0,"forks_count":4,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-03-29T22:17:04.783Z","etag":null,"topics":["bash","shellcheck","vim","vim-plugin"],"latest_commit_sha":null,"homepage":"https://www.vim.org/scripts/script.php?script_id=5788","language":"Vim Script","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/itspriddle.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-09-28T03:22:10.000Z","updated_at":"2025-02-16T03:35:01.000Z","dependencies_parsed_at":"2024-09-13T09:51:52.314Z","dependency_job_id":null,"html_url":"https://github.com/itspriddle/vim-shellcheck","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itspriddle%2Fvim-shellcheck","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itspriddle%2Fvim-shellcheck/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itspriddle%2Fvim-shellcheck/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itspriddle%2Fvim-shellcheck/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/itspriddle","download_url":"https://codeload.github.com/itspriddle/vim-shellcheck/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250372947,"owners_count":21419722,"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":["bash","shellcheck","vim","vim-plugin"],"created_at":"2024-12-14T02:46:36.603Z","updated_at":"2025-04-23T04:51:28.793Z","avatar_url":"https://github.com/itspriddle.png","language":"Vim Script","funding_links":[],"categories":["vim"],"sub_categories":[],"readme":"# vim-shellcheck\n\nVim wrapper for [ShellCheck][], a static analysis tool for shell scripts.\n\n[ShellCheck]: https://github.com/koalaman/shellcheck\n\n## Commands\n\nThese commands are available in buffers with `'filetype'` of `sh`.\n\n```\n:[range]ShellCheck[!] [args]\n```\n\nRun `shellcheck` for the current buffer using optional `[args]` and send any\nerrors to the quickfix-window. Specify a `[range]` or use a visual selection\nto check only those lines, otherwise the entire buffer is checked. Call with a\nbang to automatically open the quickfix-window when errors are found.\n\n```\n:[range]LShellCheck[!] [args]\n```\n\nRun `shellcheck` for the current buffer using optional `[args]` and send any\nerrors to a location-list-window. Specify a `[range]` or use a visual\nselection to check only those lines, otherwise the entire buffer is checked.\nCall with a bang to automatically open the location-list-window when errors\nare found.\n\n## QF Mappings\n\n**Open ShellCheck error definition on GitHub - gb**\n\nThe `gb` command can be used quickfix or location list windows to open the\nShellCheck error definition on GitHub. This command requires the Netrw plugin\nto be installed. If Netrw is not installed, the `gb` map prints the URL to the\nShellCheck error definition on GitHub instead. This functionality is enabled\nwhen the window's `w:quickfix_title` attribute starts with one of the\nfollowing:\n\n- `:shellcheck` -- created by `compiler shellcheck | :make %` or some other\n  program\n- `:ShellCheck` -- created by the `:ShellCheck` command\n- `:LShellCheck` -- created by the `:LShellCheck` command\n\nTo disable this mapping:\n\n```viml\nlet g:shellcheck_disable_mappings = 1\n```\n\nTo setup a different map:\n\n```viml\nlet g:shellcheck_disable_mappings = 1\nautocmd FileType qf nmap \u003cbuffer\u003e \u003csilent\u003e gB \u003cPlug\u003e(shellcheck-gb)\n```\n\nNote: The `gb` map will not be defined if one already exists.\n\n## Compiler\n\nA ShellCheck `:compiler` is provided by Vim 8.2.1769 and newer for use as a\n`'makeprg'`. To use it, run:\n\n```\n:compiler shellcheck\n:make! %\n:copen\n```\n\n## Configuration\n\n**`g:shellcheck_qf_open`**\n\nSpecifies how the quickfix-window is opened when `:ShellCheck!` is used. The\ndefault value is `\"botright copen 10\"`.\n\n**`g:shellcheck_ll_open`**\n\nSpecifies how the location-list-window is opened when `:LShellCheck!` is used.\nThe default value is `\"lopen 10\"`.\n\n## Installation\n\nUse your favorite plugin manager, or use Vim's built-in package support:\n\n```\nmkdir -p ~/.vim/pack/shellcheck/start\ncd ~/.vim/pack/shellcheck/start\ngit clone https://github.com/itspriddle/vim-shellcheck.git\nvim -u NONE -c \"helptags vim-shellcheck/doc\" -c q\n```\n\n## License\n\nMIT License - see [`LICENSE`](./LICENSE) in this repo.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fitspriddle%2Fvim-shellcheck","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fitspriddle%2Fvim-shellcheck","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fitspriddle%2Fvim-shellcheck/lists"}