crinch v0.1.0

Crinch

Every time I work on CSS, I just crinch.

Was sind die Ziele dieses Projekts?

Das Ziel ist es, einen Linter für CSS und SASS zu erstellen, welcher die Einhaltung der 5Minds CSS Guidelines überprüfen und als CI-Job garantieren kann.

Wir wollen dies erreichen, indem wir sass-lint wrappen.

Diese Vorgehensweise, im Gegensatz zur Erstellung einer Musterkonfiguration für SASS Lint, hat zwei Vorteile:

• Wir führen ein einheitliches Linting-Tool ein, dessen interne Funktionsweise wir später refaktorisieren können, ohne unsere CI-Jobs anpassen zu müssen.
• Wir sind in der LAge, die von diesem Linter geworfenen Issues um Zusatzinformationen, wie bspw. eine Kategorisierung der Issues oder Backlinks auf unsere CSS Guidelines, zu erweitern.

Relevante URLs

• https://github.com/sasstools/sass-lint - Sass Lint
• https://github.com/5minds/css-guidelines - CSS Guidelines (5Minds)

Wie kann ich das Projekt aufsetzen?

Voraussetzungen

• Node >= 0.6.0

Setup

$ git clone git@github.com:5minds/crinch.git
$ cd crinch
$ npm install

Benutzung

Crinch erwartet als ersten Parameter zwingend die zu prüfenden SCSS-Dateien. Optional können auch mehr Pfade/Globs angegeben werden.

$ crinch [PATH_WITH_GLOB]

# Beispiel:

$ crinch assets/stylesheets/**/*.css

$ crinch assets/stylesheets/**/*.css dist/css/**/*.css

Beispiel

Exit Codes

Sollte crinch in den angegebenen Dateien Issues finden, so wird ein Exit Code von 1 zurückgegeben (sonst 0).

Autoren

Marvin Junghenn, René Föhring (5Minds IT-Solutions)

Lizenz

Lizenzinformationen können der LICENSE-Datei entnommen werden.