Gestionar documentos Markdown dejando solo enlaces o imágenes permitidos
(github.com/lumirlumir)Hola, hoy les presento textlint-rule-allowed-uris, una librería de npm que filtra automáticamente en documentos Markdown los enlaces externos o imágenes y deja solo los URI permitidos.
Este plugin tiene las siguientes características.
- Patrones de permitido/bloqueado con expresiones regulares: puedes configurar libremente patrones de URI permitidos (whitelist) y bloqueados (blacklist) por separado para
linkseimages. - Exclusivo para Markdown: revisa tanto enlaces como imágenes escritos con sintaxis Markdown y también con etiquetas HTML en archivos
.mdy.mdx. - Soporte para rutas locales, hash y query string: además de URLs externas, también revisa rutas relativas/absolutas, hashes y rutas con query string.
- Configuración flexible: si no se especifican opciones, no revisa nada, y según la necesidad se pueden ajustar con detalle las reglas de permitido/bloqueado.
- Opción para revisar definiciones no utilizadas (Reference): si hace falta, también puede verificar definiciones sin uso.
La instalación y el uso son los siguientes.
- Instalación
npm install --save-dev textlint-rule-allowed-uris - Definir patrones en
.textlintrc.jsmodule.exports = { rules: { "allowed-uris": { allowed: { links: [/mycompany\.com/], images: [/imgur\.com/], }, disallowed: { links: [/forbidden\.com/], }, checkUnusedDefinitions: true, } } } - Ejecutar
npx textlint --rule allowed-uris -f pretty-error file.md
Se lo recomiendo a quienes quieran gestionar de forma consistente los enlaces e imágenes de sus documentos.
Para más información y ejemplos, les agradeceré que consulten el README.md en GitHub.
Aún no hay comentarios.