scan — 記法の検査

.qmd の callout・チャンクオプション・相互参照・Div を検査する

概要

quarto-dsh scan.qmd 本文の記法を検査します。callout 型・チャンクオプション・相互参照・Div の開閉・コードブロックの閉じ忘れを検出します。

使い方

quarto-dsh scan <file.qmd> [dir]

検出できる問題

未知の callout 型

::: {.callout-bogus}
text
:::
[error] index.qmd:line 1 — 未知の callout 型: 'callout-bogus' (有効: note, warning, important, tip, caution)

実在する callout は note / warning / important / tip / caution の 5 種類です。

未知のチャンクオプション

{r} チャンク内に未知の #| オプションが含まれる場合:

#| bogus-option: true
[warning] index.qmd:line 2 — 未知のチャンクオプション: '#| bogus'

未定義の相互参照

@fig-dist に分布を示します。

#| label: fig-dist が無い場合に警告します。

Div の開閉

::: {.callout-note}
text
:::

::: が閉じられていない場合、エラーとして検出します。

出力

問題がなければ次のように表示されます。

OK: 問題はありません。
Tipエディタ連携

quarto-dsh-lsp をエディタに登録すると、保存時に自動で診断が表示されます。詳しくは LSP を参照してください。

関連