This project adds color highlighting for nftables code in Vim and Neovim. It helps you see your code better and spot mistakes fast.
See it in action:
What does this do?
- Highlights important nftables words in color
- Shows mistakes or typos in red
- Works with files that end in
.nftand scripts that start with#!nft(this is called a "shebang", which tells your computer to use nft) - Works out-of-the-box in Vim and Neovim, with both light and dark color themes
make installGo to INSTALL.md to see step-by-step instructions on how to add this to Vim or Neovim.
After you install, you do not need to do anything extra. The colors will show up automatically when you open:
/etc/nftables.confor/etc/nftables*.conf- Any file that ends with
.nft - Scripts that start with
#!nftat the top
If the colors look wrong or if something does not work:
- Try to find the shortest line or lines of code that cause the problem.
- You do not need to share your whole file. Just the line(s) that cause the problem.
- Cover up any private info, like real IP addresses.
- Go to the issues page and open a new issue. Add:
- The line(s) that look wrong
- What you expect to see
- (Best) Add a screenshot
- If you need to share more, use a Gist link.
If you want to help make this better or fix things, see DEBUG.md for tips. (Even though it says "bind-named", the tricks work here too.)
Vim has a limit when matching patterns (only 9 matching groups allowed). To make IPv6 addresses work, the pattern is repeated in the files. This makes it faster and prevents problems. Also, since the code got long (over 12,000 lines), files are now split into smaller parts by what they do. This helps find mistakes faster.
You can find a picture that explains how nftables works here (PDF railroad diagram)