Skip to content
This repository was archived by the owner on Feb 9, 2026. It is now read-only.

Commit 604149f

Browse files
authored
chore: Setup textlint (#51)
1 parent 0dc6e84 commit 604149f

File tree

8 files changed

+3210
-4956
lines changed

8 files changed

+3210
-4956
lines changed

.prh/suteravr-words.yaml

Lines changed: 121 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
1+
version: 1
2+
rules:
3+
4+
- expected: Clocking-Server
5+
pattern:
6+
- /clocking(-|\s)?(server)?/gi
7+
specs:
8+
- from: Clocking server
9+
to: Clocking-Server
10+
- from: clocking
11+
to: Clocking-Server
12+
13+
- expected: Clocker
14+
15+
- expected: Bloom
16+
pattern:
17+
- /bloom/gi
18+
- /broom/gi
19+
- /ブルーム/gi
20+
21+
- expected: SuteraVR
22+
23+
- expected: Sutera
24+
pattern:
25+
- /stella/gi
26+
- /sutera/gi
27+
- /ステラ/gi
28+
29+
- expected: Suteraネットワーク
30+
pattern:
31+
- /Sutera(-|\s)?(ネットワーク|network)/gi
32+
specs:
33+
- from: Sutera network
34+
to: Suteraネットワーク
35+
36+
- expected: Gatewayコンポーネント
37+
pattern:
38+
- /(?<!`)(gateway)(コンポーネント|component|サーバー|server|ブルーム|bloom)(?!`)/gi
39+
specs:
40+
- from: gatewayコンポーネント
41+
to: Gatewayコンポーネント
42+
43+
- expected: Gateway
44+
pattern:
45+
- /(?<!`)(gateway)(?!`)/gi
46+
specs:
47+
- from: "`gateway`"
48+
to: "`gateway`"
49+
50+
- expected: Object-Storageコンポーネント
51+
pattern:
52+
- /(?<!`)(Object(-|\s)?Storage)(コンポーネント|component|サーバー|server|ブルーム|bloom)(?!`)/gi
53+
54+
- expected: Object-Storage
55+
pattern:
56+
- /(?<!`)(Object(-|\s)?Storage)(?!`)/gi
57+
58+
- expected: Socialコンポーネント
59+
pattern:
60+
- /(?<!`)(Social|SuteraVR)(コンポーネント|component|サーバー|server|ブルーム|bloom)(?!`)/gi
61+
62+
- expected: Social
63+
pattern:
64+
- /(?<!`)(Social)(?!`)/gi
65+
66+
- expected: Social-VR
67+
pattern:
68+
- /Social(-|\s)?VR/gi
69+
specs:
70+
- from: social-vr
71+
to: Social-VR
72+
- from: Social VR
73+
to: Social-VR
74+
- from: SocialVR
75+
to: Social-VR
76+
77+
- expected: メタバース
78+
pattern:
79+
- /metaverse/gi
80+
specs:
81+
- from: MetaVerse
82+
to: メタバース
83+
84+
- expected: インスタンス
85+
pattern:
86+
- /instance/gi
87+
88+
- expected: 電子署名
89+
pattern:
90+
- /(?<!(電子))署名/g
91+
specs:
92+
- from: 署名
93+
to: 電子署名
94+
- from: 電子署名
95+
to: 電子署名
96+
97+
- expected: 公開鍵
98+
pattern:
99+
- /(署名)?(検証|公開)鍵/
100+
specs:
101+
- from: 検証鍵
102+
to: 公開鍵
103+
104+
- expected: 秘密鍵
105+
pattern:
106+
- 署名鍵
107+
108+
- expected: サーバー
109+
pattern: /サーバ(?!ー)/g
110+
specs:
111+
- from: サーバ
112+
to: サーバー
113+
114+
- expected: ユーザー
115+
pattern: /ユーザ(?!ー)/g
116+
117+
- expected: データ
118+
pattern: /データー/g
119+
specs:
120+
- from: データー
121+
to: データ

.textlintrc

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,18 @@
11
{
22
"rules": {
3-
"preset-smarthr": true,
4-
"preset-ja-technical-writing": true
5-
}
3+
"preset-ja-technical-writing": true,
4+
"period-in-list-item": true,
5+
"no-mixed-zenkaku-and-hankaku-alphabet": true,
6+
"ja-hiragana-hojodoushi": true,
7+
"ja-hiragana-fukushi": true,
8+
"ja-hiragana-keishikimeishi": true,
9+
"prh": {
10+
"rulePaths": [
11+
"./.prh/suteravr-words.yaml"
12+
]
13+
},
14+
},
15+
"filters": {
16+
"comments": true,
17+
},
618
}

clocking-server/clocking-server.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
# Clocking Server
2-
SuteraにはClocking Serverが存在します。
3-
Clocking Serverは各インスタンスにおける同期処理を担当します。
1+
# Clocking-Server
2+
SuteraにはClocking-Serverが存在します。
3+
Clocking-Serverは各インスタンスにおける同期処理を担当します。
44

5-
## SuteraにおけるClocking serverの具体的役割
5+
## SuteraにおけるClocking-Serverの具体的役割
66
- インスタンス内のエンティティ(※1)の状態の同期をとる
77
- ボイスチャットの処理を行う
88
- メッセージの送受信処理を行う
99

10-
※1: Clocking Serverは長いため、しばしばClockerと略されます。
10+
※1: Clocking-Serverは長いため、しばしばClockerと略されます。
1111

1212
※2: エンティティとは、SuteraVRにおける動的オブジェクトの総称です。アバターや、投げられたり、乗れたり、エフェクトを発生するようなオブジェクトを含みます。

gateway/README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
1. 全てのリクエストは羃等性があり、秘密鍵による署名を添付しなければならない。
2-
1. Gatewayサーバーが新設されるあるいは停止状態から復帰するとき、任意の他のGatewayサーバーを選択し全てのデータを受信することができる。
3-
1. Bloomの種類とエンドポイントと公開鍵を関連付けて保存できる
4-
1. Bloomの種類とエンドポイントと公開鍵の関連情報を検索、表示できる
5-
1. Bloomの種類を指定し、与えられた公開鍵のハッシュ値と差の小さいハッシュ値を持つBloomのエンドポイントを検索できる
6-
1. リクエストを受け取ったら、他のGatewayサーバーに配信する。
7-
1. 新しいBloomを追加し、関連付けられたBloomの種類と公開鍵とエンドポイントを登録できる
8-
1. 既存のBloomを編集し、関連付けられたBloomの種類と公開鍵とエンドポイントを変更できる
9-
1. 既存のBloomを削除し、関連付けられたBloomの種類と公開鍵とエンドポイントを削除できる
1+
1. 全てのリクエストは羃等性があり、秘密鍵による電子署名を添付しなければならない
2+
1. Gatewayコンポーネントが新設されるあるいは停止状態から復帰するとき、任意の他のGatewayコンポーネントを選択し全てのデータを受信できる
3+
1. Bloomの種類とエンドポイントと公開鍵を関連付けて保存できる
4+
1. Bloomの種類とエンドポイントと公開鍵の関連情報を検索、表示できる
5+
1. Bloomの種類を指定し、与えられた公開鍵のハッシュ値と差の小さいハッシュ値を持つBloomのエンドポイントを検索できる
6+
1. リクエストを受け取ったら、他のGatewayコンポーネントに配信する
7+
1. 新しいBloomを追加し、関連付けられたBloomの種類と公開鍵とエンドポイントを登録できる
8+
1. 既存のBloomを編集し、関連付けられたBloomの種類と公開鍵とエンドポイントを変更できる
9+
1. 既存のBloomを削除し、関連付けられたBloomの種類と公開鍵とエンドポイントを削除できる
Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
# Object Storage
1+
# Object-Storage
22

3-
SuteraにはObject Storageというコンポーネントが存在します。
4-
Object Storageは非ユーザー依存データを保存する役割を担当します。
3+
SuteraにはObject-Storageというコンポーネントが存在します。
4+
Object-Storageは非ユーザー依存データを保存する役割を担当します。
55

6-
## Object Storageの具体的な役割
6+
## Object-Storageの具体的な役割
77

88
非ユーザー依存データを保存します。
99

@@ -12,10 +12,12 @@ Object Storageは非ユーザー依存データを保存する役割を担当し
1212
非ユーザー依存データは、自動的に選択された複数箇所のObject-Storageコンポーネントへ保管されます。
1313
データを保管しているBloomが何かしらの理由で停止した場合、Suteraネットワークは同じデータを持っている他のBloomから別のBloomへデータをコピーします。
1414

15-
Suteraネットワークではデータが常に一定数の複製を保つように運用されています。
16-
ただし、まれに同じデータの複製を持っている全てのBloomが同時に停止するとデータがロストする可能性があります
15+
このように、Suteraネットワークではデータが常に一定数の複製を保つように運用されています。
16+
しかし、同じデータの複製を持つ全てのBloomが同時に停止する場合など、わずかなデータロストの可能性は依然として考えられます
1717

1818
## 指定したレプリケーションへのバックアップ
1919

20+
<!-- textlint-disable -->
2021
自動的なレプリケーションでのデータロストのリスクに備え、非ユーザー依存のデータはBloomを指定してコピーすることもできます。
22+
<!-- text-lint-enable -->
2123
例えば、思い出深いワールドは自分でホストするBloomでも保管しておくことができます。

0 commit comments

Comments
 (0)