chore: textlint-rule-prhを追加 (#296)

Author: 3w36zj6

.textlintrc.js

@@ -5,11 +5,29 @@ module.exports = {
   plugins: ["html"],
   filters: {
     comments: true,
+    allowlist: {
+      allow: ["/<(code|pre)[^>]*>[\\s\\S]*?</(code|pre)>/"],
+    },
   },
   rules: {
     "preset-jtf-style": {
+      // デフォルトで無効のため
+      "2.1.5.カタカナ": true,
+      // デフォルトで無効のため
+      "2.1.6.カタカナの長音": true,
+      // デフォルトで無効のため
+      "2.2.1.ひらがなと漢字の使い分け": true,
       // 階層構造を表現する記号としての>の使用例があるため
       "4.3.7.山かっこ<>": false,
     },
+    prh: {
+      rulePaths: ["./prh.yaml"],
+      checkLink: false,
+      checkBlockQuote: false,
+      checkEmphasis: true,
+      checkHeader: true,
+      checkParagraph: true,
+      checkCodeComment: [],
+    },
   },
 };

bun.lock

@@ -13,7 +13,7 @@ use crate::foundations::{
 ///
 /// # 引数シンク
 /// 組み込み関数と同様に、カスタム関数も可変長引数を受け取れます。
-/// 余分にある引数をすべてまとめて受け取る _引数シンク_（キッチンシンクのようにさまざまなものが流れ込む先）は、`..sink`の形で指定できます。このとき生成される`sink`の値は`arguments`型になります。この型は、位置引数と名前付き引数の両方にアクセスするためのメソッドを提供しています。
+/// 余分にある引数を全てまとめて受け取る _引数シンク_（キッチンシンクのようにさまざまなものが流れ込む先）は、`..sink`の形で指定できます。このとき生成される`sink`の値は`arguments`型になります。この型は、位置引数と名前付き引数の両方にアクセスするためのメソッドを提供しています。
 ///
 /// ```example
 /// #let format(title, ..authors) = {
@@ -109,7 +109,7 @@ impl Args {
         Ok(None)
     }
 
-    /// 可能ならn個の位置引数を取り出します。 
+    /// 可能ならn個の位置引数を取り出します。
     pub fn consume(&mut self, n: usize) -> SourceResult<Vec<Arg>> {
         let mut list = vec![];
 

crates/typst-library/src/foundations/args.rs

@@ -26,7 +26,7 @@ use crate::text::UnderlineElem;
 
 /// 文書のコンテンツ。
 ///
-/// この型は、Typstの中心となるものです。Typstのすべてのマークアップやほとんどの[関数]($function)はコンテンツを生成します。コンテンツ値は角括弧でマークアップを囲むことで作成できます。これは、コンテンツを関数に渡す際にも使われる方法です。
+/// この型は、Typstの中心となるものです。Typstの全てのマークアップやほとんどの[関数]($function)はコンテンツを生成します。コンテンツ値は角括弧でマークアップを囲むことで作成できます。これは、コンテンツを関数に渡す際にも使われる方法です。
 ///
 /// # 例
 /// ```example
@@ -35,14 +35,14 @@ use crate::text::UnderlineElem;
 /// ```
 ///
 /// コンテンツは`+`演算子で追加したり、[結合]($scripting/#blocks)したり、整数と乗算したりすることができます。コンテンツが期待される場所であれば、[文字列]($str)や`{none}`を渡すことも可能です。
-/// 
+///
 /// # 表現
 /// コンテンツはフィールドを持つ要素で構成されます。 _要素関数_ で要素を構築する際は、フィールドを引数として提供します。コンテンツ値がある場合は、[フィールドアクセス構文]($scripting/#field-access)でそのフィールドにアクセスできます。
 ///
 /// フィールドの中には必須のものがあります。それらは要素を構築する際に提供する必要があるため、その型のコンテンツでは常にフィールドアクセスを通じて利用可能です。
 /// 必須フィールドはドキュメント内でそのようにマークされています。
 ///
-/// ほとんどのフィールドはオプションで、必須フィールドと同様に、単一要素を設定するために要素関数に渡すことができます。しかし、[setルール]($styling/#set-rules)で設定して、スコープ内のすべての要素に適用することも可能です。
+/// ほとんどのフィールドはオプションで、必須フィールドと同様に、単一要素を設定するために要素関数に渡すことができます。しかし、[setルール]($styling/#set-rules)で設定して、スコープ内の全ての要素に適用することも可能です。
 /// オプションのフィールドは、要素関数に明示的に渡された場合にのみフィールドアクセス構文で利用でき、setルールから適用された場合は利用できません。
 ///
 /// 各要素にはデフォルトの外観があります。しかし、[showルール]($styling/#show-rules)を使用して、その外観を完全にカスタマイズすることもできます。showルールには要素が渡されます。showルールは要素のフィールドにアクセスし、そこから任意のコンテンツを生成することができます。

crates/typst-library/src/foundations/content.rs

@@ -66,10 +66,10 @@ use crate::World;
 ///
 /// # フォーマット
 /// [`display`]($datetime.display)メソッドを使うことで、日時をカスタマイズして表示するフォーマットを指定できます。日時のフォーマットは、_コンポーネント_ に _修飾子_ を組み合わせることで指定します。
-/// コンポーネントは、日時の中の特定の部分（たとえば年や月など）を表します。そして修飾子を使うことで、そのコンポーネントをどのように表示するかを細かく設定できます。
+/// コンポーネントは、日時の中の特定の部分（例えば年や月など）を表します。そして修飾子を使うことで、そのコンポーネントをどのように表示するかを細かく設定できます。
 /// コンポーネントを表示するには、コンポーネントの名前を角かっこで囲みます（例：`[[year]]`は年を表示します）。修飾子を追加するには、コンポーネント名の後に半角スペースを入れ、修飾子名、コロン（:）、修飾子の値を記述します（例：`[[month repr:short]]`は月名を短縮形で表示します）。
 ///
-/// 使用可能なコンポーネントと修飾子の組み合わせは以下のとおりです。
+/// 使用可能なコンポーネントと修飾子の組み合わせは以下の通りです。
 ///
 /// - `year`: `datetime`の年を表示します。
 ///   - `padding`: 年表示のパディングは`zero`（ゼロ）、`space`（空白）、`none`（なし）が指定できます。
@@ -100,7 +100,7 @@ use crate::World;
 /// - `second`: `date`の秒を表示します。
 ///   - `padding`: 秒表示のパディングは`zero`（ゼロ）、`space`（空白）、`none`（なし）が指定できます。
 ///
-/// すべてのコンポーネントが常に使用できるとは限らない点には注意してください。たとえば、`{datetime(year: 2023, month: 10, day: 13)}`のようにして新しい`datetime`を作成すると、内部的には日付のみが保持されるため、`hour`や`minute`のようなコンポーネントは使用できません。それらは特定の時刻が指定された`datetime`でのみ動作します。
+/// 全てのコンポーネントが常に使用できるとは限らない点には注意してください。例えば、`{datetime(year: 2023, month: 10, day: 13)}`のようにして新しい`datetime`を作成すると、内部的には日付のみが保持されるため、`hour`や`minute`のようなコンポーネントは使用できません。それらは特定の時刻が指定された`datetime`でのみ動作します。
 #[ty(scope, cast)]
 #[derive(Debug, Clone, Copy, PartialEq, Hash)]
 pub enum Datetime {
@@ -208,7 +208,7 @@ impl Datetime {
     /// _注_：指定する`datetime`の要素によって、Typstが保持する形式は次の3通りのいずれかになります。
     /// * 年、月、日だけを指定した場合、Typstは日付のみを保持します。
     /// * 時、分、秒だけを指定した場合、Typstは時刻のみを保持します。
-    /// * 年、月、日、時、分、秒すべてを指定した場合、Typstは完全な日時を保持します。
+    /// * 年、月、日、時、分、秒の全てを指定した場合、Typstは完全な日時を保持します。
     ///
     /// 保持形式に応じて、[`display`]($datetime.display)メソッドはデフォルトで異なるフォーマットを選択します。
     ///

crates/typst-library/src/foundations/datetime.rs

@@ -41,9 +41,9 @@ use crate::foundations::{
 /// ```
 ///
 /// 関数はTypstにおいて基礎となる構成要素です。
-/// Typstは様々な組版タスクに応じた関数を提供しています。
-/// さらには、作成されるマークアップの裏側では関数が用いられており、すべてのスタイル設定は関数を介して行われます。
-/// このリファレンスでは利用可能なすべての関数とその使い方を示します。
+/// Typstはさまざまな組版タスクに応じた関数を提供しています。
+/// さらには、作成されるマークアップの裏側では関数が用いられており、全てのスタイル設定は関数を介して行われます。
+/// このリファレンスでは利用可能な全ての関数とその使い方を示します。
 /// Typstで関数をさらに活用する方法については、[setルール]($styling/#set-rules)および[showルール]($styling/#show-rules)のドキュメントも参照して下さい。
 ///
 /// # 要素関数
@@ -61,10 +61,10 @@ use crate::foundations::{
 ///
 /// 関数バインディングの右辺は関数本体で、ブロックか任意の式です。
 /// 関数の戻り値を定義し、引数に依存させることができます。
-/// 関数本体が[コードブロック]($scripting/#blocks)の場合、戻り値はブロック内のすべての式を連結させた結果になります。
+/// 関数本体が[コードブロック]($scripting/#blocks)の場合、戻り値はブロック内の全ての式を連結させた結果になります。
 ///
 /// 関数本体内では、`return`キーワードを用いて処理を途中で抜け出したり、必要に応じて戻り値を指定して返したりできます。
-/// 戻り値が明示的に与えられない場合、本体は`return`の前の式すべてを連結した結果として評価されます。
+/// 戻り値が明示的に与えられない場合、本体は`return`の前の式全てを連結した結果として評価されます。
 ///
 /// 意味のある値を何も返さない関数は、代わりに[`none`]を返します。
 /// このような関数の戻り値の型はドキュメント中では明示的に指定されていません
@@ -107,7 +107,7 @@ use crate::foundations::{
 /// ```
 ///
 /// # 関数の純粋性に関する注意
-/// Typstにおいて関数はすべて _純粋_ です。
+/// Typstにおいて関数は全て _純粋_ です。
 /// これは同じ引数からは常に同じ結果が返ってくることを意味します。
 /// 純粋関数は2回目の呼び出し時に別の値を生成するために何かを「記憶」することはできません。
 ///

crates/typst-library/src/foundations/func.rs

@@ -28,7 +28,7 @@ pub fn module() -> Module {
 /// タグとその属性は、構文的に有効なHTMLを構成していなければなりません。
 /// `meta`のようないくつかのタグはコンテンツを受け付けません。
 /// したがって、それらに対して本文を提供してはいけません。
-/// 将来的に、この機能に対して更に多くのチェックを追加する可能性があるため、この関数を使用する際は有効なHTMLを生成していることを確認してください。
+/// 将来的に、この機能に対してさらに多くのチェックを追加する可能性があるため、この関数を使用する際は有効なHTMLを生成していることを確認してください。
 ///
 /// 通常、Typstは`html`、`head`、および`body`タグを生成します。
 /// 代わりにこの関数でそれらを作成した場合、Typstは自身の生成するタグを省略します。

crates/typst-library/src/html/mod.rs

@@ -99,7 +99,7 @@ use crate::World;
 ///
 /// # ページカウンター
 /// ページカウンターは特別です。
-/// 改ページ毎に値がインクリメントされます。
+/// 改ページごとに値がインクリメントされます。
 /// しかし、他のカウンターと同様に手動でインクリメントもできます。
 /// 例えば、前書きではローマ数字のページ番号を使い、メインのコンテンツではアラビア数字のページ番号に変更し、ページカウンターを1にリセットできます。
 ///
@@ -397,7 +397,7 @@ impl Counter {
         /// このcounterを識別するキー。
         ///
         /// - 文字列の場合、手動更新の場合にのみ影響を受けるカスタムカウンターを作成します
-        /// - [`page`]関数の場合、改ページに合わせてカウントされます
+        /// - [`page`]関数の場合、改ページにあわせてカウントされます
         /// - [セレクター]($selector)の場合、セレクターにマッチする要素が現れるたびにカウントされます。
         /// 例えば
         ///   - 要素関数が与えられた場合、その型を持つ要素がカウントされます

crates/typst-library/src/introspection/counter.rs

@@ -50,7 +50,7 @@ use crate::text::TextElem;
 /// ```
 ///
 /// # 配置のネスト
-/// レイアウトコンテナおよびその内部の要素に様々な配置設定を適用できます。
+/// レイアウトコンテナおよびその内部の要素にさまざまな配置設定を適用できます。
 /// このようにすることで複雑なレイアウトを作成できます。
 ///
 /// ```example

crates/typst-library/src/layout/align.rs

@@ -97,7 +97,7 @@ impl Length {
     /// このlengthをポイントに変換します。
     ///
     /// このlengthの`em`単位の値が（単に`2pt`ではなく`5em + 2pt`のように）非ゼロの場合にエラーが発生して失敗します。
-    /// 長さの`em`成分を無視するために（`(5em + 2pt).abs.pt()`のように）`abs`フィールドを使用してください（したがって数値部分のみが変換されます）。
+    /// 長さの`em`成分を無視するために（`(5em + 2pt).abs.pt()`のように）`abs`フィールドを使用してください（したがって、数値部分のみが変換されます）。
     #[func(name = "pt", title = "Points")]
     pub fn to_pt(&self, span: Span) -> SourceResult<f64> {
         self.ensure_that_em_is_zero(span, "pt")?;