【Hugo】findRE・replaceRE の使い方

 

今回は、 Hugo 本ブログで使用している静的サイトジェネレータ
公式サイト
で記事のマークダウンファイルや HTML 内の特定の内容を探し出したり書き換えたりするのに便利な

findREreplaceREについてご紹介したいと思います。


正規表現を使って探索・置換するための関数

この2つの関数の語尾についている RE というのは Regular Expression(正規表現)のことです。

正規表現とは、特定のパターンを満たす文字列を表現する方法です。

例えば、特定のアルファベット一文字の後ろに2桁までの数字が続くようなパターン(h2, u11)とか、

特定の文字列で挟まれたパターン(<div>foo</div>)とかを探したいときに使用します。


findRE の使い方

指定された範囲の中で、指定された正規表現にマッチする部分のリストを返します。

次のように書きます。

findRE (正規表現のパターン) (入力) [(最初から何番目までを返すか)]

例えば、

{{ findRE `a(.*?)e` `abcde apple je m'appelle apfel` }}

-> [abcde,
    apple,
    appe,
    apfe]

となります。

また、$inputの中身が次のものだったとして、

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
<div>
    <h2 class="omidashi">大見出し1</h2>
    <p>いろはにほへと</p>
    <p>ちりぬるを</p>
    <h3 class="komidashi" id="#小見出し1">小見出し1</h3>
    <p>わかよたれそ</p>
    <p>つねならむ</p>
    <h2 class="omidashi">大見出し2</h2>
    <h3 class="komidashi" id="#小見出し2">小見出し2</h3>
    <p>ういのおくやま</p>
    <p>けふこえて</p>
    <h3 class="komidashi" id="#小見出し3">小見出し3</h3>
    <p>あさきゆめみし</p>
    <p>えひもせす</p>
</div>

この中からh3タグで挟まれている部分だけ取り出したいときは次のようになります。

{{ findRE `<h3.*?>(.|\n)*?</h3>` $input }}
 
-> [<h3 class="komidashi" id="#小見出し1">小見出し1</h3>,
    <h3 class="komidashi" id="#小見出し2">小見出し2</h3>,
    <h3 class="komidashi" id="#小見出し3">小見出し3</h3>]

h3タグ直後のpタグを取り出したい場合は次のようになります。

{{ findRE `</h3>( |\n)*?<p>(.|\n)*?</p>` $input }}
 
-> [</h3>
    <p>わかよたれそ</p>,
    </h3>
    <p>ういのおくやま</p>,
    </h3>
    <p>あさきゆめみし</p>]

また、第三引数を指定することで、その個数分だけ取り出します。

{{ findRE `</h3>( |\n)*?<p>(.|\n)*?</p>` $input 1 }}
 
-> [</h3>
    <p>わかよたれそ</p>]

注意点

返ってくる値はリストなので、ひとつひとつの要素を扱いたい場合にはindexrangeを使うことになります。

正規表現のマッチがひとつしかない場合も

index (findRE ...) 0とする必要があります。

ただし、存在するかしないかで条件分岐するだけなら、空のリストはfalseとなるため、

if findRE ...とそのまま書いても判定できます。

関連記事

【Hugo】print・printf の使い方

【Hugo】print・printf の使い方


replaceRE の使い方

指定された文字列の、指定された正規表現のパターンに該当する部分を、指定されたものに置き換えたあとのものを返します。

次のように書きます。

replaceRE (正規表現のパターン) (置換先) (入力)
または
(入力) | replaceRE (正規表現のパターン) (置換先)

置換先に$1のように書くと、正規表現でマッチしたグループを表現できます。

$1なら1グループ目、$2なら2グループ目、$0ならマッチした部分全体です。

例えば、

{{ replaceRE `a(.*?)e` `a-e` `abcde apple je m'appelle apfel` }}
 
-> a-e a-e je m'a-elle a-el
 
{{ replaceRE `a(.*?)e` `$1` `abcde apple je m'appelle apfel` }}
 
-> bcd ppl je m'pplle pfl

となります。

また、$inputの中身が次のものだったとすれば、

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
<div>
    <h2 class="omidashi">大見出し1</h2>
    <p>いろはにほへと</p>
    <p>ちりぬるを</p>
    <h3>小見出し1</h3>
    <p>わかよたれそ</p>
    <p>つねならむ</p>
    <h2 class="omidashi">大見出し2</h2>
    <h3>小見出し2</h3>
    <p>ういのおくやま</p>
    <p>けふこえて</p>
    <h3>小見出し3</h3>
    <p>あさきゆめみし</p>
    <p>えひもせす</p>
</div>
{{ replaceRE `<h3>(.*?)</h3>` `<h3 class="komidashi" id="#$1">$1</h3>` $input }}
 
->
<div>
    <h2 class="omidashi">大見出し1</h2>
    <p>いろはにほへと</p>
    <p>ちりぬるを</p>
    <h3 class="komidashi" id="#小見出し1">小見出し1</h3>
    <p>わかよたれそ</p>
    <p>つねならむ</p>
    <h2 class="omidashi">大見出し2</h2>
    <h3 class="komidashi" id="#小見出し2">小見出し2</h3>
    <p>ういのおくやま</p>
    <p>けふこえて</p>
    <h3 class="komidashi" id="#小見出し3">小見出し3</h3>
    <p>あさきゆめみし</p>
    <p>えひもせす</p>
</div>

となります。

注意点

正規表現のパターンに該当する部分が置き換わるだけであり、

入力文全体が置き換わるわけではありません。

例えばさきほどのfindRE$inputの例で、

h3タグ直後のpタグの内容を取得しようとして、

{{ $pattern := `</h3>(?: |\n)*?<p>((?:.|\n)*?)</p>` }}
{{ $find := findRE $pattern $input }}
{{ range $find }}
    {{ . | replaceRE $pattern `$1` }}
{{ end }}

とすれば

わかよたれそ
ういのおくやま
あさきゆめみし

と、うまく取得できます。

しかし、

{{ $pattern := `</h3>(?: |\n)*?<p>((?:.|\n)*?)</p>` }}
{{ $find := findRE $pattern $input }}
{{ range $find }}
    {{ . | replaceRE `<p>((?:.|\n)*?)</p>` `$1` }}
{{ end }}

とすれば

</h3>
わかよたれそ
</h3>
ういのおくやま
</h3>
あさきゆめみし

というふうに、</h3>を残してしまいます。

割とはまりがちな上に気づきにくいので気をつけたいところです…。

なお、正規表現を使う必要がないなら、replaceを使うこともできます。

関連記事

【Hugo】.Scratch とは?

【Hugo】.Scratch とは?


Hugo のテンプレートを使って書き換えを行う時には必ずと言っていいほど頻繁に使う関数なので、

ぜひ覚えておいてください。

この記事がお役に立てたならうれしいです。

それでは👋