HorlogeSkynet/Nftables
1
0
Fork 0
mirror of https://github.com/HorlogeSkynet/Nftables synced 2024-11-28 16:00:22 +01:00
Code Issues Releases Activity
v1.3.0
Nftables/README.md
Samuel FORESTIER 7bb2cd5411 Explicits Sublime Text 4 support
2021-06-04 23:36:27 +02:00

2.8 KiB
Raw Permalink Blame History

Nftables

A Sublime Text 3+ syntax definition for your nftables rules

Preview

Introduction

nftables should now be the regular way of handling Netfilter rules, and I was surprised not to find any syntax definition for Sublime Text.
This project aims to provide a "basic" one, as long as a building procedure for GNU/Linux users (when the nft binary is available for "dynamic" syntax checks).

This project has been inspired by the official nano syntax definition.
See the Scripting nftables Wiki page for external reference.

Installation

With Package Control

  1. Open your command palette and type in : Package Control: Install Package
  2. Browse the list or search for Nftables
  3. Press Enter and you're done !

Package Control dedicated page here.

Manually

  1. Move into Sublime Text packages folder (usually $HOME/.config/sublime-text-3/Packages/ or %AppData%\Sublime Text 3\Packages\)
  2. Clone this repository there : $ git clone https://github.com/HorlogeSkynet/Nftables.git
  3. Restart Sublime Text and... 🎉

Usage

Syntax

  • Open your command palette and type in : Set Syntax: Nftables

  • Click on the bottom-right corner : Nftables

  • View > Syntax > Nftables

Build

  • Open your command palette and type in : Build With: Nftables

  • Press CTRL + B

  • Tools > Build

Formats currently supported

  • nftables output
  • Scripted configuration

Frequently Asked Questions

Do you plan to support the whole nftables syntax ?

No, but feel free to contribute.

Why does this syntax coloration s*cks ?

Well, sorry to hear that. Grammar wasn't my favorite course at school.
I'd be pleased to review any issue or pull request.

Why didn't you convert the official Bison parser to Sublime's definition syntax ?

It looks like such a tool does not exist (yet ?).

Would this plugin help me building a secure fire-wall ?

No, but I would advise you this blog post as a well-explained starting point, written by @tasn.

I've noticed you got an extensive tests suite, can I run it ?

Of course, open the Nftables.sublime-syntax file, press CTRL + Shift + B and choose Build With: Syntax Tests.