chore: Setup textlint (#51)

.prh/suteravr-words.yaml

@@ -0,0 +1,121 @@
+version: 1
+rules:
+
+  - expected: Clocking-Server
+    pattern:
+      - /clocking(-|\s)?(server)?/gi
+    specs:
+      - from: Clocking server
+        to: Clocking-Server
+      - from: clocking
+        to: Clocking-Server
+
+  - expected: Clocker
+
+  - expected: Bloom
+    pattern:
+      - /bloom/gi
+      - /broom/gi
+      - /ブルーム/gi
+
+  - expected: SuteraVR
+
+  - expected: Sutera
+    pattern:
+      - /stella/gi
+      - /sutera/gi
+      - /ステラ/gi
+
+  - expected: Suteraネットワーク
+    pattern:
+      - /Sutera(-|\s)?(ネットワーク|network)/gi
+    specs:
+      - from: Sutera network
+        to: Suteraネットワーク
+
+  - expected: Gatewayコンポーネント
+    pattern: 
+      - /(?<!`)(gateway)(コンポーネント|component|サーバー|server|ブルーム|bloom)(?!`)/gi
+    specs:
+      - from: gatewayコンポーネント
+        to: Gatewayコンポーネント
+
+  - expected: Gateway
+    pattern:
+      - /(?<!`)(gateway)(?!`)/gi
+    specs:
+      - from: "`gateway`"
+        to: "`gateway`"
+
+  - expected: Object-Storageコンポーネント
+    pattern: 
+      - /(?<!`)(Object(-|\s)?Storage)(コンポーネント|component|サーバー|server|ブルーム|bloom)(?!`)/gi
+
+  - expected: Object-Storage
+    pattern:
+      - /(?<!`)(Object(-|\s)?Storage)(?!`)/gi
+
+  - expected: Socialコンポーネント
+    pattern: 
+      - /(?<!`)(Social|SuteraVR)(コンポーネント|component|サーバー|server|ブルーム|bloom)(?!`)/gi
+
+  - expected: Social
+    pattern:
+      - /(?<!`)(Social)(?!`)/gi
+
+  - expected: Social-VR
+    pattern:
+      - /Social(-|\s)?VR/gi
+    specs:
+      - from: social-vr
+        to: Social-VR
+      - from: Social VR
+        to: Social-VR
+      - from: SocialVR
+        to: Social-VR
+
+  - expected: メタバース
+    pattern:
+      - /metaverse/gi
+    specs:
+      - from: MetaVerse
+        to: メタバース
+
+  - expected: インスタンス
+    pattern:
+      - /instance/gi
+
+  - expected: 電子署名
+    pattern:
+      - /(?<!(電子))署名/g
+    specs:
+      - from: 署名
+        to: 電子署名
+      - from: 電子署名
+        to: 電子署名
+
+  - expected: 公開鍵
+    pattern:
+      - /(署名)?(検証|公開)鍵/
+    specs:
+      - from: 検証鍵
+        to: 公開鍵
+
+  - expected: 秘密鍵
+    pattern:
+      - 署名鍵 
+
+  - expected: サーバー
+    pattern:  /サーバ(?!ー)/g
+    specs:
+      - from: サーバ
+        to:   サーバー
+
+  - expected: ユーザー
+    pattern:  /ユーザ(?!ー)/g
+
+  - expected: データ
+    pattern:  /データー/g
+    specs:
+      - from: データー
+        to:   データ

.textlintrc

@@ -1,6 +1,18 @@
 {
   "rules": {
-    "preset-smarthr": true,
-    "preset-ja-technical-writing": true
-  }
+    "preset-ja-technical-writing": true,
+    "period-in-list-item": true,
+    "no-mixed-zenkaku-and-hankaku-alphabet": true,
+    "ja-hiragana-hojodoushi": true,
+    "ja-hiragana-fukushi": true,
+    "ja-hiragana-keishikimeishi": true,
+    "prh": {
+      "rulePaths": [
+        "./.prh/suteravr-words.yaml"
+      ]
+    },
+  },
+  "filters": {
+    "comments": true,
+  },
 }

clocking-server/clocking-server.md

@@ -1,12 +1,12 @@
-# Clocking Server
-SuteraにはClocking Serverが存在します。
-Clocking Serverは各インスタンスにおける同期処理を担当します。
+# Clocking-Server
+SuteraにはClocking-Serverが存在します。
+Clocking-Serverは各インスタンスにおける同期処理を担当します。
 
-## SuteraにおけるClocking serverの具体的役割
+## SuteraにおけるClocking-Serverの具体的役割
 - インスタンス内のエンティティ(※1)の状態の同期をとる
 - ボイスチャットの処理を行う
 - メッセージの送受信処理を行う
 
-※1: Clocking Serverは長いため、しばしばClockerと略されます。
+※1: Clocking-Serverは長いため、しばしばClockerと略されます。
 
 ※2: エンティティとは、SuteraVRにおける動的オブジェクトの総称です。アバターや、投げられたり、乗れたり、エフェクトを発生するようなオブジェクトを含みます。

gateway/README.md

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

object-storage/01-what-is-object-storage.md

@@ -1,9 +1,9 @@
-# Object Storage
+# Object-Storage
 
-SuteraにはObject Storageというコンポーネントが存在します。  
-Object Storageは非ユーザー依存データを保存する役割を担当します。
+SuteraにはObject-Storageというコンポーネントが存在します。  
+Object-Storageは非ユーザー依存データを保存する役割を担当します。
 
-## Object Storageの具体的な役割
+## Object-Storageの具体的な役割
 
 非ユーザー依存データを保存します。
 
@@ -12,10 +12,12 @@ Object Storageは非ユーザー依存データを保存する役割を担当し
 非ユーザー依存データは、自動的に選択された複数箇所のObject-Storageコンポーネントへ保管されます。  
 データを保管しているBloomが何かしらの理由で停止した場合、Suteraネットワークは同じデータを持っている他のBloomから別のBloomへデータをコピーします。  
 
-Suteraネットワークではデータが常に一定数の複製を保つように運用されています。  
-ただし、まれに同じデータの複製を持っている全てのBloomが同時に停止するとデータがロストする可能性があります。
+このように、Suteraネットワークではデータが常に一定数の複製を保つように運用されています。  
+しかし、同じデータの複製を持つ全てのBloomが同時に停止する場合など、わずかなデータロストの可能性は依然として考えられます。
 
 ## 指定したレプリケーションへのバックアップ
 
+<!-- textlint-disable --> 
 自動的なレプリケーションでのデータロストのリスクに備え、非ユーザー依存のデータはBloomを指定してコピーすることもできます。  
+<!-- text-lint-enable -->
 例えば、思い出深いワールドは自分でホストするBloomでも保管しておくことができます。