Links oder Bilder in Markdown-Dokumenten verwalten, indem nur erlaubte Links bzw. Bilder beibehalten werden

Hallo, ich möchte die npm-Bibliothek textlint-rule-allowed-uris vorstellen, die in Markdown-Dokumenten nur externe Links oder Bilder mit erlaubten URIs stehen lässt und den Rest automatisch herausfiltert.

Dieses Plugin hat die folgenden Eigenschaften.

• Erlaubte/gesperrte Muster per regulären Ausdrücken festlegen: Für Links und Bilder können URI-Muster für erlaubte (Whitelist) und gesperrte (Blacklist) Einträge frei konfiguriert werden.
• Speziell für Markdown: In .md- und .mdx-Dateien werden sowohl mit Markdown-Syntax als auch mit HTML-Tags geschriebene Links und Bilder geprüft.
• Unterstützung für lokale Pfade, Hashes und Query-Strings: Nicht nur externe URLs, sondern auch relative/absolute Pfade, Pfade mit Hashes oder Query-Strings usw. werden geprüft.
• Flexible Konfiguration: Wenn keine Optionen angegeben werden, wird nichts geprüft; bei Bedarf lassen sich die Regeln für Erlauben/Sperren fein abstimmen.
• Option zur Prüfung ungenutzter Definitionen (Reference): Falls nötig, können auch ungenutzte Definitionen geprüft werden.

Installation und Verwendung sind wie folgt.

1. Installation

   npm install --save-dev textlint-rule-allowed-uris  
   

2. Muster in .textlintrc.js festlegen

   module.exports = {  
     rules: {  
       "allowed-uris": {  
         allowed: {  
           links: [/mycompany\.com/],  
           images: [/imgur\.com/],  
         },  
         disallowed: {  
           links: [/forbidden\.com/],  
         },  
         checkUnusedDefinitions: true,  
       }  
     }  
   }  
   

3. Ausführen

   npx textlint --rule allowed-uris -f pretty-error file.md  
   

Empfehlenswert für alle, die Links und Bilder in Dokumenten anhand von Richtlinien verwalten möchten!

Für weitere Informationen und Beispiele siehe bitte die README.md auf GitHub.