vvakame / docker-review

Re:VIEW build container by docker
MIT License
148 stars 38 forks source link

textlintを入れる #14

Closed doublemarket closed 6 years ago

doublemarket commented 6 years ago

こんにちは、Re:VIEWでPDF/ePubを生成するのに、こちらのDockerイメージ使わせていただいております。ありがとうございます!

単にPDF/ePubを生成するだけでなく、テストも回したいと考えています。せっかくなら同じコンテナに関連するチェックツール(textlint)も入っていると嬉しいなと思ったのですが、いかがでしょうか。

Re:VIEWのソースが入っているディレクトリに、以下のような内容の.textlintrcを入れておき、

{
  "plugins": {
    "review"
  },
  "rules": {
    "preset-jtf-style": true,
    "prh": {
      "rulePaths": [
        "/work/prh-rules/review.yml"
      ]
    }
  }
}

以下のコマンドのようにdockerコンテナを起動すると、textlintでチェックできます。

docker run --rm -v $(pwd):/work review-test /bin/bash -c "cd /work && textlint -f pretty-error *.re"

(マージしていただけるようなら、READMEにこのコマンドなど使い方も追加します)

vvakame commented 6 years ago

返事が遅くてすみません。 各種ツール類(redpen, prh, textlint など)は自分で入れてほしいなーという気持ちです。 これらはプロジェクトローカルにバージョンや設定などを持つべきで、Dockerイメージ側で管理するべきではないと思っています。 (ほんとはNode.jsを入れるのもどうなんだそれは という話があったり…)

vvakame commented 6 years ago

https://github.com/TechBooster/C89-FirstStepReVIEW-v2/blob/master/build-in-docker.sh https://github.com/TechBooster/C89-FirstStepReVIEW-v2/blob/master/package.json#L38-L39 我々が利用例として案内しているサンプル本のリポジトリも校正ツールであるprhは後乗せです。

doublemarket commented 6 years ago

@vvakame なるほど、承知しました。コンテナになっていることで依存性などを考えずにRe:VIEWを使えるので、周辺ツールも一緒にコンテナにと思いましたが、あくまでRe:VIEWのみという方針なのですね。サンプル本の情報もありがとうございます!