{"id":13753114,"url":"https://github.com/MicahElliott/Rocannon","last_synced_at":"2025-05-09T20:34:53.720Z","repository":{"id":26893881,"uuid":"30355177","full_name":"MicahElliott/Rocannon","owner":"MicahElliott","description":"Vim for Ansible playbooks: omni-completion, abbreviations, syntax, folding, K-docs, and colorscheme","archived":false,"fork":false,"pushed_at":"2020-08-04T12:58:13.000Z","size":877,"stargazers_count":84,"open_issues_count":4,"forks_count":13,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-05-06T23:42:49.703Z","etag":null,"topics":["ansible","color-scheme","completion","documentation","folding","highlighting","vim"],"latest_commit_sha":null,"homepage":null,"language":"VimL","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/MicahElliott.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-02-05T12:50:29.000Z","updated_at":"2024-12-20T16:14:53.000Z","dependencies_parsed_at":"2022-07-30T06:07:45.730Z","dependency_job_id":null,"html_url":"https://github.com/MicahElliott/Rocannon","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/MicahElliott%2FRocannon","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MicahElliott%2FRocannon/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MicahElliott%2FRocannon/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MicahElliott%2FRocannon/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MicahElliott","download_url":"https://codeload.github.com/MicahElliott/Rocannon/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253321825,"owners_count":21890473,"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":["ansible","color-scheme","completion","documentation","folding","highlighting","vim"],"created_at":"2024-08-03T09:01:16.435Z","updated_at":"2025-05-09T20:34:48.653Z","avatar_url":"https://github.com/MicahElliott.png","language":"VimL","funding_links":[],"categories":["vim"],"sub_categories":[],"readme":"# Rocannon: Operator of the Ansible\n\nCommand the Ansible, Relish the Rainbow. Never visit the Ansible docs again.\n\n![Rocannon!](https://raw.githubusercontent.com/MicahElliott/Rocannon/master/img/rainbow.jpg)\n\nAnsible is a unique DSL with semantics way beyond an editor’s simple\nbuilt-in YAML treatment. Thus, Ansible files need a totally different type of\nsyntax highlighting — and of course completion of actions and their args.\n\n## Features\n* Completion system that’s aware of all ansible modules/actions and their\n  args, and even the unique `state=` values\n* Syntax for semantics of Ansible, way beyond vanilla YAML\n* A 256-color scheme to make use of the extended syntax\n* Local, comprehensive documentation system that mirrors online docs (use `K`)\n* Folding regions to collapse task blocks into simple, readable lists\n* Simple skeleton for new `.ans`/`.yaml` files\n* “Bouncing” between related roles files\n* Execution of individual plays (via implicit tags and `:make`)\n\n(This is a somewhat simplistic Vim implementation, but mostly works if you\nstick to Ansible best practices\n[http://docs.ansible.com/playbooks_best_practices.html]().)\n\n## Demo\n- Vanilla YAML file with default highlighting\n- Change the filetype to ansible (can be done in other ways)\n- Reopen file to reflect filetype\n- Notice the folding\n- Create a new \"stat\" play to not install pbzip2 otherwise\n- Notice the completion of action and arg (other args also completable)\n- Pull up documentation for `stat` with `K`\n\n![Rocannon Demo!](https://raw.githubusercontent.com/MicahElliott/Rocannon/master/examples/demo4.gif)\n\n## Installation\nHere I’m using [Vundle](https://github.com/VundleVim/Vundle.vim) (but\n[Pathogen](https://github.com/tpope/vim-pathogen) should also work):\n\n    % vim ~/.vimrc \" add line inside vundle block\n    Plugin 'MicahElliott/Rocannon'\n\nThen install it with Vundle.\n\n    % vim +PluginInstall +qa\n\nI recommend the above, but — just for fun — you could even use Ansible to get\nit! (This also assumes Vundle is managing your `~/.vim/bundle` area, and that\nyou’ve added the _Plugin_ line above to your `~/.vimrc`.)\n\n    % ansible localhost -m git -a 'repo=https://github.com/MicahElliott/Rocannon dest=~/.vim/bundle/Rocannon'\n\nRocannon should automatically detect a file with extension `.yaml` (but not\n`.yml`) as an Ansible file type. If you want to be explicit, though, you could\nadd to the top (or bottom) of each Ansible YAML file:\n\n    # vim:ft=ansible:\n\nNow open an Ansible file and your should notice that the filetype is\n“ansible”, and you’ll see some fancy colors, completions, etc:\n\n    % vim foo.yaml\n\n_(It would be really nice if Ansible supported a `*.ans` file extension.)_\n\n## Comprehensive Help\nThis README is just to get you started. Use the extensive [vim\nhelp](https://github.com/MicahElliott/Rocannon/blob/master/doc/rocannon.txt)\nto learn the important details:\n\n    :help rocannon\n\nEvery Ansible module’s online documentation is also available via vim’s `K`.\n\n## Completions\nAll known Ansible **actions** are omni-completed, and a short description is\nshown. Actions also have abbreviations, so that when you type `yum: ` it will\ncomplete to `yum: name=`. There are also completions for each arg, so if you\ntype `yum: name=zsh \u003cC-x\u003e\u003cC-o\u003e` you will see a list of all possible args. Even\n`state` values are completed.\n\n## Syntax/Highlighting (colorscheme)\nYes, it’s very colorful. Although initially jarring, I find this quite\nhelpful. The scheme is called _rocannon_. I recommend that you embrace this\nrainbow (though it can be turned off).\n\n## Folding\nPlays can be folded into a single line containing just the `name:`\ndescription.\n\n## Jumping between files (like vim-rails)\nSeveral files in a role often need to be bounced around between. Vim-Rails\nsupports this nicely, bouncing between controllers, views, models, tests, etc.\nRocannon should do the same between tasks, handlers, templates, files, and\nvars.\n\n## To its fullest\nIt’s helpful to have a terminal and font that fully support 256 colors, bold,\nunderline, italic, etc. If you don't already have that covered, I recommend\n[Urxvt](https://wiki.archlinux.org/index.php/rxvt-unicode) and\n[Orp-Font](https://github.com/MicahElliott/Orp-Font) (if you like bitmapped).\n\n## License\nCopyright © Micah Elliott. Distributed under the same terms as Vim itself. See\n`:help license`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FMicahElliott%2FRocannon","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FMicahElliott%2FRocannon","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FMicahElliott%2FRocannon/lists"}