{"id":13898604,"url":"https://github.com/wincent/pinnacle","last_synced_at":"2025-03-21T03:30:51.388Z","repository":{"id":53012617,"uuid":"55044860","full_name":"wincent/pinnacle","owner":"wincent","description":"🏔 Highlight group manipulation for Vim","archived":false,"fork":false,"pushed_at":"2024-07-16T02:03:35.000Z","size":60,"stargazers_count":16,"open_issues_count":2,"forks_count":3,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-10-12T06:09:55.791Z","etag":null,"topics":["vim"],"latest_commit_sha":null,"homepage":"","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/wincent.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2016-03-30T08:11:46.000Z","updated_at":"2024-07-01T06:56:05.000Z","dependencies_parsed_at":"2022-09-08T10:15:04.616Z","dependency_job_id":"36ebb62f-dd60-480d-b176-fd9e53952fe1","html_url":"https://github.com/wincent/pinnacle","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wincent%2Fpinnacle","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wincent%2Fpinnacle/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wincent%2Fpinnacle/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wincent%2Fpinnacle/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wincent","download_url":"https://codeload.github.com/wincent/pinnacle/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":221811375,"owners_count":16884305,"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":["vim"],"created_at":"2024-08-06T18:04:22.377Z","updated_at":"2024-10-28T09:13:41.791Z","avatar_url":"https://github.com/wincent.png","language":"Vim Script","funding_links":[],"categories":["Vim Script"],"sub_categories":[],"readme":"# Pinnacle\u003ca name=\"pinnacle-pinnacle\" href=\"#user-content-pinnacle-pinnacle\"\u003e\u003c/a\u003e\n\n## Intro\u003ca name=\"pinnacle-intro\" href=\"#user-content-pinnacle-intro\"\u003e\u003c/a\u003e\n\nPinnacle provides functions for manipulating \u003cstrong\u003e`:highlight`\u003c/strong\u003e groups in Vimscript (eg. \u003cstrong\u003e`pinnacle#italicize`\u003c/strong\u003e) and Lua (eg. `require'wincent.pinnacle'.italicize()`).\n\n## Installation\u003ca name=\"pinnacle-installation\" href=\"#user-content-pinnacle-installation\"\u003e\u003c/a\u003e\n\nTo install Pinnacle, use your plug-in management system of choice.\n\nIf you don't have a \u0026quot;plug-in management system of choice\u0026quot;, I recommend Pathogen (https://github.com/tpope/vim-pathogen) due to its simplicity and robustness. Assuming that you have Pathogen installed and configured, and that you want to install Pinnacle into `~/.vim/bundle`, you can do so with:\n\n```\ngit clone https://github.com/wincent/pinnacle.git ~/.vim/bundle/pinnacle\n```\n\nAlternatively, if you use a Git submodule for each Vim plug-in, you could do the following after `cd`-ing into the top-level of your Git superproject:\n\n```\ngit submodule add https://github.com/wincent/pinnacle.git ~/vim/bundle/pinnacle\ngit submodule init\n```\n\nTo generate help tags under Pathogen, you can do so from inside Vim with:\n\n```\n:call pathogen#helptags()\n```\n\n## Functions\u003ca name=\"pinnacle-functions\" href=\"#user-content-pinnacle-functions\"\u003e\u003c/a\u003e\n\n\u003cp align=\"right\"\u003e\u003ca name=\"pinnaclesubnewlines\" href=\"#user-content-pinnaclesubnewlines\"\u003e\u003ccode\u003epinnacle#sub_newlines()\u003c/code\u003e\u003c/a\u003e\u003c/p\u003e\n\n### `pinnacle#sub_newlines()`\u003ca name=\"pinnacle-pinnaclesubnewlines\" href=\"#user-content-pinnacle-pinnaclesubnewlines\"\u003e\u003c/a\u003e\n\nReplaces newlines with spaces.\n\nNote that this function is not implemented in the Lua API, because it is required only for support on legacy Vim versions.\n\n\u003cp align=\"right\"\u003e\u003ca name=\"pinnaclecaptureline\" href=\"#user-content-pinnaclecaptureline\"\u003e\u003ccode\u003epinnacle#capture_line()\u003c/code\u003e\u003c/a\u003e\u003c/p\u003e\n\n### `pinnacle#capture_line()`\u003ca name=\"pinnacle-pinnaclecaptureline\" href=\"#user-content-pinnacle-pinnaclecaptureline\"\u003e\u003c/a\u003e\n\nRuns a command and returns the captured output as a single line.\n\nUseful when we don't want to let long lines on narrow windows produce unwanted embedded newlines.\n\nNote that this function is not implemented in the Lua API, because it is required only for support on legacy Vim versions.\n\n\u003cp align=\"right\"\u003e\u003ca name=\"pinnaclecapturehighlight\" href=\"#user-content-pinnaclecapturehighlight\"\u003e\u003ccode\u003epinnacle#capture_highlight()\u003c/code\u003e\u003c/a\u003e\u003c/p\u003e\n\n### `pinnacle#capture_highlight()`\u003ca name=\"pinnacle-pinnaclecapturehighlight\" href=\"#user-content-pinnacle-pinnaclecapturehighlight\"\u003e\u003c/a\u003e\n\nGets the current value of a highlight group.\n\n\u003cp align=\"right\"\u003e\u003ca name=\"pinnacleextracthighlight\" href=\"#user-content-pinnacleextracthighlight\"\u003e\u003ccode\u003epinnacle#extract_highlight()\u003c/code\u003e\u003c/a\u003e\u003c/p\u003e\n\n### `pinnacle#extract_highlight()`\u003ca name=\"pinnacle-pinnacleextracthighlight\" href=\"#user-content-pinnacle-pinnacleextracthighlight\"\u003e\u003c/a\u003e\n\nExtracts a highlight string from a group, recursively traversing linked groups, and returns a string suitable for passing to `:highlight`.\n\n\u003cp align=\"right\"\u003e\u003ca name=\"pinnacleextractbg\" href=\"#user-content-pinnacleextractbg\"\u003e\u003ccode\u003epinnacle#extract_bg()\u003c/code\u003e\u003c/a\u003e\u003c/p\u003e\n\n### `pinnacle#extract_bg()`\u003ca name=\"pinnacle-pinnacleextractbg\" href=\"#user-content-pinnacle-pinnacleextractbg\"\u003e\u003c/a\u003e\n\nExtracts just the bg portion of the specified highlight group.\n\n\u003cp align=\"right\"\u003e\u003ca name=\"pinnacleextractfg\" href=\"#user-content-pinnacleextractfg\"\u003e\u003ccode\u003epinnacle#extract_fg()\u003c/code\u003e\u003c/a\u003e\u003c/p\u003e\n\n### `pinnacle#extract_fg()`\u003ca name=\"pinnacle-pinnacleextractfg\" href=\"#user-content-pinnacle-pinnacleextractfg\"\u003e\u003c/a\u003e\n\nExtracts just the bg portion of the specified highlight group.\n\n\u003cp align=\"right\"\u003e\u003ca name=\"pinnacleextractcomponent\" href=\"#user-content-pinnacleextractcomponent\"\u003e\u003ccode\u003epinnacle#extract_component()\u003c/code\u003e\u003c/a\u003e\u003c/p\u003e\n\n### `pinnacle#extract_component()`\u003ca name=\"pinnacle-pinnacleextractcomponent\" href=\"#user-content-pinnacle-pinnacleextractcomponent\"\u003e\u003c/a\u003e\n\nExtracts a single component (eg. \u0026quot;bg\u0026quot;, \u0026quot;fg\u0026quot;, \u0026quot;italic\u0026quot; etc) from the specified highlight group.\n\n\u003cp align=\"right\"\u003e\u003ca name=\"pinnacledump\" href=\"#user-content-pinnacledump\"\u003e\u003ccode\u003epinnacle#dump()\u003c/code\u003e\u003c/a\u003e\u003c/p\u003e\n\n### `pinnacle#dump()`\u003ca name=\"pinnacle-pinnacledump\" href=\"#user-content-pinnacle-pinnacledump\"\u003e\u003c/a\u003e\n\nReturns a dictionary representation of the specified highlight group.\n\n\u003cp align=\"right\"\u003e\u003ca name=\"pinnaclehighlight\" href=\"#user-content-pinnaclehighlight\"\u003e\u003ccode\u003epinnacle#highlight()\u003c/code\u003e\u003c/a\u003e\u003c/p\u003e\n\n### `pinnacle#highlight()`\u003ca name=\"pinnacle-pinnaclehighlight\" href=\"#user-content-pinnacle-pinnaclehighlight\"\u003e\u003c/a\u003e\n\nReturns a string representation of a dictionary containing bg, fg, term, cterm and guiterm entries.\n\n\u003cp align=\"right\"\u003e\u003ca name=\"pinnacleitalicize\" href=\"#user-content-pinnacleitalicize\"\u003e\u003ccode\u003epinnacle#italicize()\u003c/code\u003e\u003c/a\u003e\u003c/p\u003e\n\n### `pinnacle#italicize()`\u003ca name=\"pinnacle-pinnacleitalicize\" href=\"#user-content-pinnacle-pinnacleitalicize\"\u003e\u003c/a\u003e\n\nReturns an italicized copy of `group` suitable for passing to `:highlight`.\n\n\u003cp align=\"right\"\u003e\u003ca name=\"pinnacleembolden\" href=\"#user-content-pinnacleembolden\"\u003e\u003ccode\u003epinnacle#embolden()\u003c/code\u003e\u003c/a\u003e\u003c/p\u003e\n\n### `pinnacle#embolden()`\u003ca name=\"pinnacle-pinnacleembolden\" href=\"#user-content-pinnacle-pinnacleembolden\"\u003e\u003c/a\u003e\n\nReturns a bold copy of `group` suitable for passing to `:highlight`.\n\n\u003cp align=\"right\"\u003e\u003ca name=\"pinnacleunderline\" href=\"#user-content-pinnacleunderline\"\u003e\u003ccode\u003epinnacle#underline()\u003c/code\u003e\u003c/a\u003e\u003c/p\u003e\n\n### `pinnacle#underline()`\u003ca name=\"pinnacle-pinnacleunderline\" href=\"#user-content-pinnacle-pinnacleunderline\"\u003e\u003c/a\u003e\n\nReturns an underlined copy of `group` suitable for passing to `:highlight`.\n\n\u003cp align=\"right\"\u003e\u003ca name=\"pinnacledecorate\" href=\"#user-content-pinnacledecorate\"\u003e\u003ccode\u003epinnacle#decorate()\u003c/code\u003e\u003c/a\u003e\u003c/p\u003e\n\n### `pinnacle#decorate()`\u003ca name=\"pinnacle-pinnacledecorate\" href=\"#user-content-pinnacle-pinnacledecorate\"\u003e\u003c/a\u003e\n\nReturns a copy of `group` decorated with `style` (eg. \u0026quot;bold\u0026quot;, \u0026quot;italic\u0026quot; etc) suitable for passing to `:highlight`.\n\nTo decorate with multiple styles, `style` should be a comma-separated list.\n\n## Website\u003ca name=\"pinnacle-website\" href=\"#user-content-pinnacle-website\"\u003e\u003c/a\u003e\n\nSource code:\n\n- https://github.com/wincent/pinnacle\n- https://gitlab.com/wincent/pinnacle\n- https://bitbucket.org/ghurrell/pinnacle\n\nOfficial releases are listed at:\n\nhttp://www.vim.org/scripts/script.php?script_id=5360\n\n## License\u003ca name=\"pinnacle-license\" href=\"#user-content-pinnacle-license\"\u003e\u003c/a\u003e\n\nCopyright (c) 2016-present Greg Hurrell\n\nPermission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \u0026quot;Software\u0026quot;), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software 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 substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \u0026quot;AS IS\u0026quot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n\n## Development\u003ca name=\"pinnacle-development\" href=\"#user-content-pinnacle-development\"\u003e\u003c/a\u003e\n\n### Contributing patches\u003ca name=\"pinnacle-contributing-patches\" href=\"#user-content-pinnacle-contributing-patches\"\u003e\u003c/a\u003e\n\nPatches can be sent via mail to greg@hurrell.net, or as GitHub pull requests at: https://github.com/wincent/pinnacle/pulls\n\n### Cutting a new release\u003ca name=\"pinnacle-cutting-a-new-release\" href=\"#user-content-pinnacle-cutting-a-new-release\"\u003e\u003c/a\u003e\n\nAt the moment the release process is manual:\n\n- Perform final sanity checks and manual testing\n- Update the \u003cstrong\u003e[`pinnacle-history`](#user-content-pinnacle-history)\u003c/strong\u003e section of the documentation\n- Verify clean work tree:\n\n```\ngit status\n```\n\n- Tag the release:\n\n```\ngit tag -s -m \"$VERSION release\" $VERSION\n```\n\n- Publish the code:\n\n```\ngit push origin main --follow-tags\ngit push github main --follow-tags\n```\n\n- Produce the release archive:\n\n```\ngit archive -o pinnacle-$VERSION.zip HEAD -- .\n```\n\n- Upload to http://www.vim.org/scripts/script.php?script_id=5360\n\n## Authors\u003ca name=\"pinnacle-authors\" href=\"#user-content-pinnacle-authors\"\u003e\u003c/a\u003e\n\nPinnacle is written and maintained by Greg Hurrell \u0026lt;greg@hurrell.net\u0026gt;.\n\nOther contributors that have submitted patches include (in alphabetical order):\n\n- Cody Buell\n- Khue Nguyen\n- Kyle Poole\n\n## History\u003ca name=\"pinnacle-history\" href=\"#user-content-pinnacle-history\"\u003e\u003c/a\u003e\n\n### main (not yet released)\u003ca name=\"pinnacle-main-not-yet-released\" href=\"#user-content-pinnacle-main-not-yet-released\"\u003e\u003c/a\u003e\n\n- Taught `pinnacle#decorate()` to accept a comma-separated list of styles.\n- Added alternative Lua-based API (eg. `require'wincent.pinnacle'.italicize()` is equivalent to `pinnacle#italicize()` etc); but note:\n- Removed functions that aren't needed in the Lua API: `pinnacle.extract_bg()`, `pinnacle.capture_highlight()`, `pinnacle.extract_component()`, `pinnacle.extract_fg()`, `pinnacle.extract_highlight()`, and `pinnacle.highlight()`. Equivalent functionality can be obtained by using the convenience functions listed below, along with `pinnacle.decorate()` and `pinnacle.dump()`.\n- Added convenience functions for common operations to the Lua API: `pinnacle.bg()`, `pinnacle.clear()`, `pinnacle.fg()`, `pinnacle.link()`, `pinnacle.merge()`, and `pinnacle.set()`.\n- Added utility functions to the Lua API: `pinnacle.adjust_lightness()`, `pinnacle.brighten()` and `pinnacle.darken()`.\n\n### 1.0 (6 March 2019)\u003ca name=\"pinnacle-10-6-march-2019\" href=\"#user-content-pinnacle-10-6-march-2019\"\u003e\u003c/a\u003e\n\n- Added `pinnacle#dump()`.\n\n### 0.3.1 (7 June 2017)\u003ca name=\"pinnacle-031-7-june-2017\" href=\"#user-content-pinnacle-031-7-june-2017\"\u003e\u003c/a\u003e\n\n- Fix another bug with augmentation of existing highlights.\n\n### 0.3 (6 June 2017)\u003ca name=\"pinnacle-03-6-june-2017\" href=\"#user-content-pinnacle-03-6-june-2017\"\u003e\u003c/a\u003e\n\n- Added `pinnacle#extract_bg` and `pinnacle#extract_fg`.\n- Fixed bug that could cause existing highlights to be incorrectly augmented.\n\n### 0.2 (9 January 2017)\u003ca name=\"pinnacle-02-9-january-2017\" href=\"#user-content-pinnacle-02-9-january-2017\"\u003e\u003c/a\u003e\n\n- Added `pinnacle#underline`.\n\n### 0.1 (30 March 2016)\u003ca name=\"pinnacle-01-30-march-2016\" href=\"#user-content-pinnacle-01-30-march-2016\"\u003e\u003c/a\u003e\n\n- Initial release.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwincent%2Fpinnacle","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwincent%2Fpinnacle","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwincent%2Fpinnacle/lists"}