html-id-generator v1.0.1

html-id-generator

Documentation

Dieser Generator kann genutzt werden um ab einem bestimmten StartPath alle unterliegenden Ordner nach Html-Dateien zu durchsuchen und für diese automatisiert id-tags zu setzen.

Quick Start

• npm install um nötige dependencies zu installieren
• Start des Programms (zwei Varianten)
  • Development
    • npm run dev um mittels nodemon einfach entwickeln zu können und einen automatischen neustart zu haben.
  • Wirkliches bauen
    • npm run build zum erstellen der Javascript Dateien
    • npm run start um die neu i dist Ordner erstellten Javascript Dateien (in diesem Fall die app.js) auszuführen

Configuration

• Die config.json dient für die Configuration dieses Tools. Hierüber ist es möglich folgende Einstellungen vorzunehmen:
  • tagnames definiert über die jeweiligen Tags welchen Html-Komponenten id's hinzugefügt werden soll
  • overwriteExistingIds bestimmt ob vorhandene ids überschrieben werden sollen
  • searchStartingRelativePath legt den relativen Pfad fest, von welchem aus die Unterordner nach .html Dateien durchsucht werden
  • blacklist legt fest, welche Dateien ignoriert werden sollen