nlFilters の概要

nlFilters は NicoCache_nl を経由するレスポンスに対し、正規表現で HTML・JSON・JavaScript・CSS などを置換する機能である。ページの表示調整、キャッシュ状態の表示、独自スクリプトの注入などに利用できる。

標準フィルターは本体と同じ版で配布される。Windows パッケージ版ではアプリケーション側の標準フィルターを先に読み、利用者データ側のフィルターを後から適用する。自分で追加するフィルターは利用者データ側の nlFilters/ に置くこと。

基本的な使い方

1. 構文リファレンス を確認して .txt ファイルを作成する
2. nlFilters/ の直下に保存する
3. NicoCache_nl を再起動するか、設定された更新監視を待つ
4. 対象ページを開き、期待どおりに置換されることを確認する

標準外のフィルターは、ニコニコ動画側の変更で動かなくなることがある。まず標準フィルターのみで正常に動くことを確認し、追加フィルターは一つずつ有効にすること。

テストと切り分け

本体には nlFilters/tools/nlfilter-lab が含まれ、保存済みの fixture を使ってフィルターの構文・互換性を確認できる。実サイトの HTML 構造に依存する置換は、複数のページ・ログイン状態・画面幅で確認すること。

問題が起きたときは、追加した .txt をサブフォルダーへ退避して、標準フィルターだけで再現するかを確認する。フィルターの順序、URL 正規表現、MatchLocal、置換後の JavaScript 構文を確認すること。