Improved color bindings and support for all keywords of current i3 specifications.

README.md

@@ -1,141 +1,74 @@
-# i3config.vim - vim i3 config syntax highlighting
+# i3config.vim - vim i3/sway config syntax highlighting
 
-This file contains the syntax highlighting that I use for i3 config in Vim.
-Compared to the vim standard *conf* syntax highlighting, i3config
-adds highlighting of all keywords,
-types and options as defined in the i3 configuration manual.
+This file contains the syntax highlighting that I use for i3/sway config in NeoVim.
+It aims to guide you through configuration by distinctive and detailed highlights that
+make it clear if your configuration is valid. It also helps in navigating through.
 
-I built this based on the current specification
-provided (as of Sat 12 Mar 2016) in:
+### References
+- [i3 Guide](http://i3wm.org/docs/userguide.html#configuring)
+- [sway](https://github.com/swaywm/sway/blob/master/sway/sway.5.scd)
+- [sway-bar](https://github.com/swaywm/sway/blob/master/sway/sway-bar.5.scd)
+- [sway-input](https://github.com/swaywm/sway/blob/master/sway/sway-input.5.scd)
+- [sway-output](https://github.com/swaywm/sway/blob/master/sway/sway-output.5.scd)
 
-<http://i3wm.org/docs/userguide.html#configuring>
+Condensed showcase of `swayconfig` highlighting capabilities
+![screenshot](https://github.com/litoj/i3config.vim/assets/54900518/b4ddd978-2865-4ac4-95ca-fcffb3f0ab74)
 
-![](i3config.vim.gif)
-
-*using vim color scheme [dracula](https://github.com/dracula/vim)*
-
-*using Powerline font [ProFont for Powerline](https://github.com/powerline/fonts/blob/master/ProFont/README.rst)*
+used colourscheme: [NerdContrast](https://github.com/litoj/nerdcontrast.nvim)
 
 ## Features
 
-i3config does what a syntax highlighting would do and additionally
-provides some sort of syntax checking. If you end up with *Bold Red*
-lines in your i3 config file this would mean that your syntax is wrong
-or there is an issue in the plugin.
-If that is the case please report the issue and/or
-make a pull request to cover the case.
+- nice and clear syntax highlighting of i3 keywords and operators,
+- wrong syntax will be highlighted as an **error** or like the first word (keyword)
+- if something is not an error but wrong highlighting, please report it to this repo
 
 ### File type detection
 
-There is no specific extension for i3 config file.
-For auto detection, the recommended method is to rename your file to something like:
-
-+ .i3.config
-+ i3.config
-+ something.i3config
-+ something.i3.config
+Nowadays we usually use \*i3/config, therefore the filetype is used in
+connection with such path. But for convenience anything as `*i3config`/`*swayconfig` is recognized.
 
-> This way you can keep your file clean somewhere in a
-dotfile repository and have it symlinked to ~/.i3/config
-
-If you don't want to, then you can always do:
-
-```vim
-:set ft=i3config
-```
-
-or
-
-```vim
-:set filetype=i3config
-```
-
-or you can add this line your .vimrc file
-
-```vim
-aug i3config_ft_detection
-  au!
-  au BufNewFile,BufRead ~/.config/i3/config set filetype=i3config
-aug end
-```
-Additonally, you an add `# vim: filetype=i3config` anywhere in your config file, as suggested by the original plugin (see below).
+Additonally, you can add `# vim: filetype=i3config` or `swayconfig` to the bottom of your config file.
 
 ## Installation instructions
 
-Follow one of the steps below and reload vim afterwards.
+This plugin is a reference for syntax files included in `vim`, so it serves mainly for testing
+purposes. All changes should make its way to `vim` - in case of differences, please report an issue in this repo.
 
-### Vundle
+### [`vim-plug`](https://github.com/junegunn/vim-plug)
 
-Install using [Vundle](https://github.com/gmarik/Vundle.vim) by adding
-
-```vim
-Plugin 'mboughaba/i3config.vim'
-```
-
-to `.vimrc` and run `:PluginInstall`.
-
-### vim-plug
-
-Install using [vim-plug](https://github.com/junegunn/vim-plug). Similar than the installation for Vundle, just change `Plugin` to `Plug`:
+Similar to the installation for Vundle, just change `Plugin` to `Plug`:
 
 Add
 
 ```vim
-Plug 'mboughaba/i3config.vim'
+Plug 'litoj/i3config.vim'
 ```
 
 to `.vimrc` and run `:PlugInstall`.
 
-> I use Vundle myself, the two steps below may not be fully correct,
-you need to change them to fit your needs.
+### [`lazy.nvim`](https://github.com/folke/lazy.nvim)
 
-### Git submodule + Pathogen
-
-If you have [pathogen](https://github.com/tpope/vim-pathogen) installed,
-and you prefer to use git submodules, run
-
-```sh
-cd ~/.vim
-git submodule add https://github.com/mboughaba/i3config.vim.git bundle/syntax/
+```lua
+return {
+  'litoj/i3config.vim',
+  lazy = true,
+  ft = {"i3config", "swayconfig"}
+}
 ```
 
 ### Manual installation
 
-If you don't have either Vundle or Pathogen installed, copy both i3config.vim file
-to .vim/after/syntax and .vim/after/ftdetect respectively.
-
 ```sh
-git clone https://github.com/mboughaba/i3config.git /tmp/i3config.vim
-mkdir -p ~/.vim/after/syntax/
-mv /tmp/i3config.vim/after/syntax/i3config.vim ~/.vim/after/syntax/i3config.vim
+git clone https://github.com/litoj/i3config.vim.git /tmp/i3config.vim
+mkdir -p ~/.vim/syntax/
+mv /tmp/i3config.vim/syntax/i3config.vim ~/.vim/syntax/i3config.vim
 rm -rf /tmp/i3config.vim
 ```
 
-## Inspired by
-
-+ PotatoesMaster/i3-vim-syntax
-  <https://github.com/PotatoesMaster/i3-vim-syntax>
-+ vim-scripts/edifact.vim
-  <https://github.com/vim-scripts/edifact.vim> (For Error highlighting).
-
-### What about PotatoesMaster/i3-vim-syntax
-
-*PotatoesMaster/i3-vim-syntax* was the one I used in the past.
-But as the maintainer himself pointed out,
-there are some issues and a rewrite is needed.
-
 ## Contribution
 
 Feel free to make a pull request, I will integrate it when time permits.
-Make sure to add a line to cover your test in the *test.i3config*.
-
-## Background information
-
-### Author
-
-Mohamed Boughaba
-
-Development is done at: <https://github.com/mboughaba/i3config.vim>
+Make sure to add a line to cover your test in `test.swayconfig`.
 
 ## License
 

ftdetect/i3config.vim

@@ -1,4 +1,4 @@
-aug i3config#ft_detect
-    au!
-    au BufNewFile,BufRead .i3.config,i3.config,*.i3config,*.i3.config,*sway/config,*.swayconfig,*.sway.config,sway.config,*sway/config set filetype=i3config
+aug filetypedetect
+    au BufNewFile,BufRead *i3/*config,*i3/*conf*,*.i3conf* setf i3config
+    au BufNewFile,BufRead */sway/*conf*,*/sway/config.d/*,*.swayconf* setf swayconfig
 aug end