文章中のサンプルコードが壊れていませんか？

ドキュメントにサンプルコードを書くことがありますが、しばしば壊れていることがあります。 読む方からすると、ちゃんとチェックして欲しいと思いますが、 書く方からすると、文章のどこにスクリプトがあるか探すのも大変だし、それをいちいち動かして確認するのも大変です。そんなジレンマを解決するいくつかのアプローチがあります。

RunDOC

https://github.com/rails/jsbundling-rails/issues/16#issuecomment-918446458 のコメント内である文章が紹介されています。 この文章で使われているのがRunDOCでした。

github.com

次のスクリプトを

Install by running:

:::>> $ gem install rails --no-document

実行して結果を展開してくれるようです。

Install by running:

$ gem install rails --no-document
Successfully installed rails-5.2.2
1 gem installed

Doctest

js-primerのDoctestを思い出しました。

github.com

こちらは

const a = 42;
console.log(a); // => 42

のようなスクリプトから、次のようなテストコードを生成して実行します。

const assert = requite("assert");
const a = 42;
assert.strictEqual(a, 42); // => 42

感想

似ていて微妙に違うアプローチが面白いです。