README_ja.md

STC Filter

English

Robot-Inventor/spam-tweets-compressorの高度なスパム判定用のフィルターデータです。

Spam Tweets Compressorはこのリポジトリー内の必要なデータをCDN経由で取得します。

フィルターについて

フィルターに関する概要や、各フィルターの説明はFilter Descriptionを参照してください。

フィルターのフォーマット

フィルターのデータはJSON形式です。詳しいフォーマットはSpam Tweets Compressorのリポジトリー内の高度なスパム判定についてを参照してください。

フィルターの作成・編集方法

1. ディレクトリーを追加

新規でフィルターを作成する場合はsrc/filter/に新しいディレクトリーを作成してください。

既存のフィルターを編集する場合はステップ3に飛んでください。

2. filter_list.jsonに追記

src/filter/filter_list.jsonにディレクトリー名とフィルター名を追加します。filter_list.jsonは次のような形式になっています。

{
    "filter": [
        {
            "dir": "フィルターのディレクトリー名",
            "name": "フィルター名",
            "id": "一度設定したら変更しないID"
        }
    ]
}

3. JSONファイルを作成

作成または編集したいフィルターのディレクトリーに、高度なスパム判定についてを参考にして任意のファイル名でJSONファイルまたはJSONCファイルを作成するか既存のJSONファイルを編集します。

保守管理の観点から、内容ごとにJSONファイルを分割することをオススメします。作成するJSONファイルの個数やファイル名に指定はありません。

また、高度なスパム判定についてに書かれているフォーマットには記載されていませんが、各JSONファイルについての説明をdescriptionプロパティーに任意で記載できます。

4. ビルド

次のコマンドを実行するとdist/filter/内に、src/filter/の各ディレクトリー内のJSONファイルを統合した新しい1つのJSONファイルが作成されます。

npm run build

また、上記のコマンドを実行するとフィルターの名前とCDNのURLの情報が保存されているdist/advanced_filter.jsonが自動で更新されます。

フィルターのアップデートの配信

フィルターのデータは自動でCDN経由で配信されています。フィルターのアップデートを配信するために必要な特別な手順はありません。CDNのキャッシュは24時間ごとに更新されるため、フィルターの更新のマージ後、更新されたフィルターが配信されるまで最大で24時間かかります。