{ "content": [ { "type": "text", "text": "# Devel::Cover::Report::Vim (perldoc)\n\n## NAME\n\nDevel::Cover::Report::Vim - Backend for displaying coverage data in Vim\n\n## SYNOPSIS\n\ncover -report vim\n\n## DESCRIPTION\n\nThis module provides a reporting mechanism for displaying coverage data in Vim. It is designed\nto be called from the \"cover\" program.\n\n## Sections\n\n- **NAME**\n- **VERSION**\n- **SYNOPSIS**\n- **DESCRIPTION**\n- **SEE ALSO**\n- **BUGS**\n- **LICENCE**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n" } ], "structuredContent": { "command": "Devel::Cover::Report::Vim", "section": "", "mode": "perldoc", "summary": "Devel::Cover::Report::Vim - Backend for displaying coverage data in Vim", "synopsis": "cover -report vim", "tldr_summary": null, "tldr_examples": [], "tldr_source": null, "flags": [], "examples": [], "see_also": [], "section_outline": [ { "name": "NAME", "lines": 2, "subsections": [] }, { "name": "VERSION", "lines": 2, "subsections": [] }, { "name": "SYNOPSIS", "lines": 2, "subsections": [] }, { "name": "DESCRIPTION", "lines": 73, "subsections": [] }, { "name": "SEE ALSO", "lines": 3, "subsections": [] }, { "name": "BUGS", "lines": 2, "subsections": [] }, { "name": "LICENCE", "lines": 28, "subsections": [] } ], "sections": { "NAME": { "content": "Devel::Cover::Report::Vim - Backend for displaying coverage data in Vim\n", "subsections": [] }, "VERSION": { "content": "version 1.36\n", "subsections": [] }, "SYNOPSIS": { "content": "cover -report vim\n", "subsections": [] }, "DESCRIPTION": { "content": "This module provides a reporting mechanism for displaying coverage data in Vim. It is designed\nto be called from the \"cover\" program.\n\nBy default, the output of this report is a file named \"coverage.vim\" in the directory of the\ncoverage database. To use it, run\n\n:so coverdb/coverage.vim\n\nand you should see signs in the left column indicating the coverage status of that line.\n\nThe signs are as follows:\n\nP - Pod coverage\nS - Statement coverage\nR - Subroutine coverage\nB - Branch coverage\nC - Condition coverage\n\nThe last of the criteria, in the order given above, is the one which is displayed. Correctly\ncovered criteria are shown in green. Incorrectly covered criteria are shown in red. Any\nincorrectly covered criterion will override a correctly covered criterion.\n\nIf the coverage for the file being displayed is out of date the a function called CoverageOld()\nis called and passed the name of the file. Similarly, for current coverage data file\nCoverageValid is called.\n\nSigns may be overridden in a file named devel-cover.vim located somewhere underneath the ~/.vim\ndirectory.\n\nFor example, I use the solarized theme and keep the following commands in my local configuration\nfile ~/.vim/local/devel-cover.vim:\n\nlet s:fgcover = \"#859900\"\nlet s:fgerror = \"#dc322f\"\nlet s:bgvalid = \"#073642\"\nlet s:bgold = \"#342a2a\"\n\nlet s:types = [ \"pod\", \"subroutine\", \"statement\", \"branch\", \"condition\", ]\n\nfor s:type in s:types\nexe \"highlight cov\" . s:type . \" ctermbg=1 cterm=bold gui=NONE guifg=\" . s:fgcover\nexe \"highlight cov\" . s:type . \"error ctermbg=1 cterm=bold gui=NONE guifg=\" . s:fgerror\nendfor\nexe \"highlight SignColumn ctermbg=0 guibg=\" . s:bgvalid\n\n\" highlight cov ctermbg=8 guibg=#002b36\n\" highlight err ctermbg=0 guibg=#073642\n\nfunction! s:setbg(bg)\nfor s:type in s:types\nexe \"highlight cov\" . s:type . \" guibg=\" . a:bg\nexe \"highlight cov\" . s:type . \"error guibg=\" . a:bg\nendfor\nexe \"highlight SignColumn ctermbg=0 guibg=\" . a:bg\nendfunction\n\nfunction! CoverageValid(filename)\ncall s:setbg(s:bgvalid)\nendfunction\n\nfunction! CoverageOld(filename)\ncall s:setbg(s:bgold)\nendfunction\n\nThis configuration sets the background colour of the signs to a dark red when the coverage data\nis out of date.\n\ncoverage.vim adds two user commands: :Cov and :Uncov which can be used to toggle the state of\ncoverage signs.\n\nThe idea and the vim template is shamelessly stolen from Simplecov-Vim. See\nhttps://github.com/nyarly/Simplecov-Vim\n", "subsections": [] }, "SEE ALSO": { "content": "Devel::Cover\nSimplecov-Vim (https://github.com/nyarly/Simplecov-Vim)\n", "subsections": [] }, "BUGS": { "content": "Huh?\n", "subsections": [] }, "LICENCE": { "content": "Copyright 2012-2019, Paul Johnson (paul@pjcj.net)\n\nThis software is free. It is licensed under the same terms as Perl itself.\n\nThe latest version of this software should be available from my homepage: http://www.pjcj.net\n\nThe template is copied from Simplecov-Vim (https://github.com/nyarly/Simplecov-Vim) and is under\nthe MIT Licence.\n\nThe MIT License\n\nCopyright (c) 2011 Judson Lester\n\nPermission is hereby granted, free of charge, to any person obtaining a copy of this software\nand associated documentation files (the \"Software\"), to deal in the Software without\nrestriction, including without limitation the rights to use, copy, modify, merge, publish,\ndistribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the\nSoftware is furnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all copies or\nsubstantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING\nBUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND\nNONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,\nDAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n", "subsections": [] } } } }