Gérer dans des documents Markdown uniquement les liens ou images autorisés
(github.com/lumirlumir)Bonjour, je voudrais vous présenter textlint-rule-allowed-uris, une bibliothèque npm qui, dans des documents Markdown, ne conserve que les URI externes autorisées pour les liens ou les images et filtre automatiquement le reste.
Ce plugin présente les caractéristiques suivantes.
- Définition des motifs d’autorisation et de blocage par expressions régulières : vous pouvez configurer librement des motifs d’URI autorisés (whitelist) et bloqués (blacklist) séparément pour
linksetimages. - Spécifique à Markdown : il vérifie tous les liens et images écrits en syntaxe Markdown ou via des balises HTML dans les fichiers
.mdet.mdx. - Prise en charge des chemins locaux, hash et query strings : en plus des URL externes, il vérifie aussi les chemins relatifs/absolus, les ancres et les chemins contenant des query strings.
- Configuration flexible : si aucune option n’est définie, rien n’est vérifié, et vous pouvez ajuster finement les règles d’autorisation/blocage selon vos besoins.
- Option de vérification des définitions inutilisées (Reference) : si nécessaire, il est aussi possible de vérifier les définitions non utilisées.
L’installation et l’utilisation sont les suivantes.
- Installation
npm install --save-dev textlint-rule-allowed-uris - Définir les motifs dans
.textlintrc.jsmodule.exports = { rules: { "allowed-uris": { allowed: { links: [/mycompany\.com/], images: [/imgur\.com/], }, disallowed: { links: [/forbidden\.com/], }, checkUnusedDefinitions: true, } } } - Exécution
npx textlint --rule allowed-uris -f pretty-error file.md
Je le recommande à celles et ceux qui souhaitent gérer les liens et images de leurs documents selon une politique définie.
Pour plus d’informations et d’exemples, consultez le README.md sur GitHub.
Aucun commentaire pour le moment.