シェルのコマンドにプロンプトを付けたり付けなかったりしている

shell-prompt-mix既定で動く（情報）日本語 / 英語

シェルのブロックで、「$」のプロンプトを付けたコマンドと付けないコマンドが混ざっている所

例

指摘される文

# 使い方 ```bash npm install chaffjs ``` ```bash npx chaffjs init ``` ```bash $ npx chaffjs README.md ```

chaff の出力

11:1 このブロックだけ、コマンドへのプロンプト（$）の付け方がほかと違います（ほかの 2 ブロック）

直した文

# 使い方 ```bash npm install chaffjs ``` ```bash npx chaffjs init ``` ```bash npx chaffjs README.md ```

chaff の出力

指摘なし

この例で使った chaff.yaml

genre: docs/manual

直し方

多いほうに揃えてください。コピーして使うコマンドなら、プロンプトを付けないほうが打ち間違えません。

なぜ指摘するのか

「$ npm install」と「npm install」が一つの文書に混ざっていると、読み手は「$」まで打つのか迷い、コピーしたコマンドが動かないこともあります。シェルのブロック（```bash、```console）のうち、全部の行にプロンプト（$）を付けたブロックと、一つも付けないブロックを比べ、少ないほうを指します。出力と一緒に書いたブロック（プロンプトのある行と無い行が混ざる）は見ません。どちらに揃えるかは決めません。

指摘しないもの

シェル以外の言語のブロック、言語名の無いブロック、コマンドと出力を一緒に書いたブロック、コメント（#）の行は見ません。少ないほうが {limit} ブロックを超えるときは使い分けとみなします。

止める・ゆるめる

この一か所だけ黙らせる（文書に書く）

チームでゆるめる（理由は chaff.yaml にコメントで残ります）

npx chaffjs relax shell-prompt-mix --why "理由"

チームで止める（chaff.yaml）

rules: shell-prompt-mix: off

技術的な情報

層: L1
状態: 安定
重さ: 情報
対象の言語: 日本語と英語
向いている文章: technical, docs, blog, legal, academic, literature, speech
文書から読み取るもの: markdown

強さ（段階）

chaff.yaml の rules にこの名前と段階を書くと変わります。書かなければ、ジャンルが決めた段階で動きます（どのジャンルで動くかは下の「ジャンルごとの動き」にあります）。

strict	少ないほうの書き方が 3 ブロック以下のとき指摘
normal	少ないほうの書き方が 2 ブロック以下のとき指摘
relaxed	少ないほうの書き方が 1 ブロック以下のとき指摘

ジャンルごとの動き

既定で動くジャンル: technical/spec, technical/readme, blog/tech, blog/essay, blog/owned-media, docs/manual, docs/faq, docs/glossary
このルールを止めるジャンル: legal/contract, legal/statute, legal/judgment, legal/patent, academic/paper, literature/fiction, literature/essay, literature/poetry, literature/play, speech/address, speech/transcript
このルールが向かず、見ないジャンル: business/proposal, business/report, business/email, business/press-release, business/meeting-notes

ジャンル

指摘の文

このブロックだけ、コマンドへのプロンプト（$）の付け方がほかと違います（ほかの {majority} ブロック）

書き直しの深さ（chaff fix-plan --depth）: light — 語と文を直す。構成と文体は残す

このページはルールの定義ファイルから作られています:packages/chaff/rules/shell-prompt-mix.yaml