scrapbox-userscript-stdのファイル構成

ここは、takker/scrapbox-userscript-stdのファイル構成を記述しているページ

一部は/villagepump/scrapbox-userscript-stdからの引用も含む

Mijinko_SD.iconが個人的に調べた範囲のものであって間違っているものもあるかもしれない

ここの情報を当てにしすぎず、製作者の/takker/takker.iconさんが公開している情報をちゃんと確認するようにしてほしい

これとか

ファイルが追加されたバージョンを書いていることもあるが、Mijinko_SD.iconが知っている範囲でしか書いていない

.test.tsはテスト時にのみ使用するファイル（deno testを参照）なので、ここでは取り上げない

更新を追いきれなかったが為に不足している情報もあるかもしれない

わざわざこれを読まなくても、mod.tsが提供している関数等の情報であればドキュメントを閲覧することで確認できる

このページはこんな人のためにある

takker/scrapbox-userscript-stdにどんな系統の関数があるかを確認したい人

mod.tsが提供していない関数も確認しておきたい人

デバッグのためにライブラリの内部まで確認する必要が出てきた人

ファイル

utilitesとかが雑においてある

mod.ts

スクリプトのbundleに使う

TypeScriptのソースコードを.jsにしてから最小化して保存する

このファイルをとりあえずインポートしておけば、殆どのライブラリ関数が使えるようになる

sleep.ts

sleep関数を使えるようにする

指定したミリ秒だけ処理を遅らせることができる

その他

未確認

./browser/

web browser上でないと使えないもの

dom/

websocketを使わない函数

元々↓(./browser/websocket/)とまとめてre exportしていたが、bundleでなぜかこちらでは使用していないscrapbox-parserのコードが混じってしまう現象が起きたので、websocketありとなしとでdirectoryを分けた

cache.ts

scrapbox.ioが管理しているcache storageから、最新のresponseを取得する

caret.ts

Scrapboxエディタのキャレットや選択範囲に関する関数が入っている

click.ts

マウスクリックを再現する

座標指定・押すボタンの指定・Shift, Ctrl, Altの同時押しに対応している

cursor.d.ts

カーソルの型定義

cursor.ts

カーソルを取得する

内部的にはstores.tsを呼び出して、その返値を抽出しているだけ

dom.ts

ScrapboxのDOMを取得するための関数が入っている

edit.ts

1. 編集時に使えるショートカットキーによるアクションを実行する

2. カーソル(キャレット)を移動したりスクロールしたりする

ensure.ts

値の型を判定する

引数は

value：判定したい値

name：値の名称

valueの型が正しくなかった場合はTypeError例外が発生する

mod.tsには含まれていない

extractCodeFiles.test.ts（v0.19.0 ～）

extractCodeFiles.ts（v0.19.0 ～）

scrapbox.Page.linesで取得できるような行データを渡して、中に含まれるコードブロックを抽出する

isHeightViewable.ts

/takker/要素が画面内にあるかどうかの判定

今は使っていない

まともに動いてなかった気がする/villagepump/takker.icon

mod.tsには含まれていない

mod.ts

./browser/直下にある*.tsファイルをほぼ全てbundleに含めるためのファイル

どれが含まれているかは当該ファイルを参照

motion.ts

モバイル用edit.tsのような感じ？

node.ts

行の取得や解析に関する関数が入っている

open.ts

別のページを開く

開くと同時にページ末尾にテキストを追記することもできる

position.ts

カーソル座標の型定義

press.ts

キーを押したときの処理をスクリプト内部から発火させる

pushPageTransition.ts（v0.18.0 ～）

Scrapboxのリンク先へスクロールする機能を、UserScript上から実行できるようにしたもの

参考：/takker/✅リンク先へスクロールする機能をscrapbox-userscript-stdに入れ

ページ遷移と同時にスクロールする仕込みをしたいのであれば、open()のoptionsのcontextに遷移先の情報を渡す方法がある

selection.d.ts

選択範囲の型定義

selection.ts

選択範囲を取得する

内部的にはstores.tsを呼び出して、その返値を抽出しているだけ

statusBar.ts

右下の通信ステータスに任意の文字を表示させる

stores.ts

カーソルと選択範囲を取得するためのものらしい

websocket/

websocketを使う函数

開いていないページを自由に書き換えられる

ページの削除やピン留めもできる

_fetch.ts

Scrapboxの編集のコミット関連で何かしらの処理をしているっぽい

applyCommit.ts

メタデータを含んだ行にcommitsを適用する

deletePage.ts

指定したページを削除する

diffToChanges.test.ts

diffToChanges.ts

差分データをwebsocketに渡す形式に変換する

id.ts

各種IDを取得できる

プロジェクトID

ユーザーID

行ID

IDをUnixTimeに変換することもできるっぽい？

listen.ts

Streamを購読する

makeChanges.ts

更新前のページデータから更新後のページデータに書き換えるのに必要なwebsocket送信用データを作っている

差分書き込みのコアプログラム

mod.ts

websocket/直下にあるファイルをbundleに含めるためのファイル

以下のファイルが対象

deletePage.ts

listen.ts

patch.ts

pin.ts

socket.ts

patch.ts

ページ全体を書き換える

serverには書き換え前後の差分だけを送信する

pin.ts

ページをピン留めしたり外したりする

既にピン留めされているかの確認はここではできない

getPage()で取得可能なデータにピン留めに関する情報が含まれている

pull.ts

ページ情報を取得し、オブジェクトとして返す

socket.ts

WebSocketの接続を開始したり終了したりできる

ここで作成した接続はpatch()などに渡すことで使用することができる

mod.ts

./browser/以下のスクリプトのbundleに使う

./deps/

外部ソースコードの依存関係がまとめられている

onp.ts

参照元：takker99/onp: TypeScript implementation of "An O(NP) Sequence Comparison Algorithm" from Sun Wu, Udi Manber and Gene Myers

/takker/takker99/onp

scrapbox-rest.ts

ScrapboxのREST APIに関する型定義をインポートしている

参照元：https://github.com/scrapbox-jp/types/blob/main/rest.ts

scrapbox.ts

Scrapboxの型定義ファイルをインポートしている

参照元：scrapbox-jp/types: scrapbox関連の型定義ファイル

socket.ts

ScrapboxのWebSocketを操作するためのライブラリと型定義ファイルをインポートしている

参照元：takker99/scrapbox-userscript-websocket: ScrapboxのWebSocketを操作できるUserScript

testing.ts

Denoのtestingをインポートしている

testingについて

./parser/（v0.15.0 ～）

Scrapbox-Parserの外部リンク記法解析結果をさらに細かく分ける函数を作ったにて追加されたもの