Site config `site.conf` richtig formatieren


#1

Viele kämpfen ja damit, wie man die Einrückungen in der site.conf richtig formatiert.

Dies liegt daran, dass die site.conf nicht auf .lua endet. Wenn man in seinem Editor auf syntax-highlighting auf lua einstellt, dann sieht man Formatierungsfehler gleich.

z.B. bei dem Editor Atom geht das so:

(Auf englisch hierher: https://stackoverflow.com/a/51320605/1069083)


You can add a key mapping in Atom:

  • Cmd + Shift + p, search for “Settings View: Show Keybindings”

  • click on “your keymap file”

  • Add a section there like this one:

      'atom-text-editor':
         'ctrl-alt-i': 'editor:auto-indent'
    

Add the highlighting for site.conf as lua sourcecode:

  • open the ~/.atom/config.cson file (by CTRL+SHIFT+p: type "open config’’)

  • add/edit a customFileTypes section under core for example like the following:

      core:
        customFileTypes:
          "source.lua": [
            "conf"
          ]
    

(You find the languages scope names (“source.lua”, “text.html.php”…) in the language package settings see here)


So eingestellt, ist die site.conf gleich im richtigen syntax highlighting im Editor und man kann mit STRG+SHIFT+i markierten kode richtig stellen.


#2

Rein interessehalber, Lua ist ja nicht Python (zum Glück), insofern ›braucht‹ man das nur für den eigenen Seelenfrieden/zwecks Übersichtlichkeit, oder?


#3

Klar, funktionieren tut der Kompilierprozess auch mit falsch eingerückten configurationen.

Es ist auch essentiell, wenn man verschiedene branches in verschiedenen site konfigurationen vergleichen will. Wenn diese nach dem gleichen chema eingerückt sind, dann kann man mit diff und co arbeiten um z.B. unterschiede zu entdecken.

Außerdem erkennt das Auge syntax fehler durch fehlende Klammern nur, wenn die Einrückung stimmt.

Die site.conf ist ja auch für externe das aushängeschild, was die Firmware einer Community ausmacht. (siehe auch Code Review auf Sicherheit )


#4

Nutze hierzu (windows) notepad++ => der Editor zeigt die (farblich) zugehörigen Klammen an - auf meine Augen allen verlasse ich mich schon lange nicht mehr :wink:

image


#5

diff --ignore-space-change?

Gewagte These; mir kommt es mehr auf die Funktionen in der Firmware an denn auf die Formattierung der site.conf an …