Markdown文書で許可されたリンクや画像だけを残して管理する

こんにちは。Markdown文書で外部リンクや画像のうち、許可されたURIだけを残し、それ以外を自動で除外してくれるnpmライブラリ textlint-rule-allowed-uris を紹介します。

このプラグインには、次のような特徴があります。

• 許可・ブロックパターンを正規表現で指定: links、images それぞれについて、許可（ホワイトリスト）・ブロック（ブラックリスト）URIパターンを自由に設定できます。
• Markdown専用: .md、.mdx ファイルで、Markdown構文およびHTMLタグで記述されたリンク・画像をすべて検査します。
• ローカルパス、ハッシュ、クエリ文字列をサポート: 外部URLだけでなく、相対/絶対パス、ハッシュ、クエリ文字列を含むパスなども検査対象です。
• 柔軟な設定: オプションを指定しなければ何も検査せず、必要に応じて許可/ブロックルールを細かく調整できます。
• 未使用定義（Reference）検査オプション: 必要に応じて、使用されていない定義もチェックできます。

インストールと使い方は以下の通りです。

1. インストール

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

2. .textlintrc.js にパターンを指定

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

3. 実行

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

文書内のリンクや画像をポリシーに沿って管理したい方におすすめです。

より詳しい情報や例については、GitHubの README.md を参照してください。