正規表現チャットボット

正規表現

正規表現（regex）とは、テキスト内で検索パターンを指定する文字の並びです。

正規表現の構文を覚えることは、このトピックの範囲を超えています。 ここでは、正規表現を利用するためにjqが提供している式に焦点を当てます。

正規表現の方言

ツールによって、実装されている正規表現のバージョンが異なります。 jqはOnigurumaという正規表現ライブラリを組み込んでおり、これはPerl v5.8の正規表現とほぼ互換性があります。

jqが使う具体的な構文は、OnigurumaのGitHubリポジトリーで確認できます。

正規表現の関数

jqの正規表現は、一連のフィルターに限られています。

単純なマッチング

文字列がパターンに一致するかどうかを知りたいときは、testフィルターを使います。

STRING | test(REGEX)
STRING | test(REGEX; FLAGS)
STRING | test([REGEX, FLAGS])

このフィルターは、_真偽値_を出力します。

"Hello World!" | test("W")    # => true
"Goodbye Mars" | test("W")    # => false

マッチに関する情報

実際にパターンに一致した部分文字列を取り出したいときは、matchフィルターを使います。

STRING | match(REGEX)
STRING | match(REGEX; FLAGS)
STRING | match([REGEX, FLAGS])

このフィルターは、次のいずれかを出力します。

• 一致しなかった場合は、何も出力しません。
• 一致した場合は、さまざまなプロパティを含むオブジェクトを出力します。

この例では、後方参照の構文\1を使って、連続する2つの同じ母音を探します。

"Hello World!" | match("([aeiou])\\1")
# => empty

"Goodbye Mars" | match("([aeiou])\\1")
# => {
#      "offset": 1,
#      "length": 2,
#      "string": "oo",
#      "captures": [
#        {
#          "offset": 1,
#          "length": 1,
#          "string": "o",
#          "name": null
#        }
#      ]
#    }

matchフィルターは、一致する_たびに_オブジェクトを返します。 次の例では、"g"フラグを使ってすべての母音を見つけています。

"Goodbye Mars" | match("[aeiou]"; "g")
# => { "offset": 1, "length": 1, "string": "o", "captures": [] }
#    { "offset": 2, "length": 1, "string": "o", "captures": [] }
#    { "offset": 6, "length": 1, "string": "e", "captures": [] }
#    { "offset": 9, "length": 1, "string": "a", "captures": [] }

キャプチャした部分文字列

matchフィルターと同様に、captureフィルターも一致した場合はオブジェクトを返します。

STRING | capture(REGEX)
STRING | capture(REGEX; FLAGS)
STRING | capture([REGEX, FLAGS])

返されるオブジェクトは、名前付きキャプチャのマッピングです。

"JIRAISSUE-1234" | capture("(?<project>\\w+)-(?<issue_num>\\d+)")
# => {
#      "project": "JIRAISSUE",
#      "issue_num": "1234"
#    }

部分文字列だけを取り出す

scanフィルターは、"g"フラグを付けたmatchに似ています。

STRING | scan(REGEX)
STRING | scan(REGEX; FLAGS)

scanは部分文字列の_ストリーム_を出力します。

"Goodbye Mars" | scan("[aeiou]")
# => "o"
#    "o"
#    "e"
#    "a"

部分文字列をまとめて取り出すには、[...]という配列コンストラクターを使います。

"Goodbye Mars" | [ scan("[aeiou]") ]
# => ["o", "o", "e", "a"]

文字列の分割

文字列のうち残したい部分がわかっているときは、matchまたはscanを使います。 捨てたい部分がわかっているときは、splitを使います。

STRING | split(REGEX; FLAGS)

任意の空白文字で文字列を分割する例です。

"first   second           third fourth" | split("\\s+"; "")
# => ["first", "second", "third", "fourth"]

置換

subとgsubフィルターは、入力文字列を変換し、一致した部分を置換文字列に置き換えることができます。

最初に一致した部分だけを置き換えるには、subを使います。 一致したすべての部分を置き換えるには、gsubを使います。

STRING | sub(REGEX; REPLACEMENT)
STRING | sub(REGEX; REPLACEMENT; FLAGS)
STRING | gsub(REGEX; REPLACEMENT)
STRING | gsub(REGEX; REPLACEMENT; FLAGS)

"Goodnight kittens. Goodnight mittens." | sub("night"; " morning")
# => "Good morning kittens. Goodnight mittens."

"Goodnight kittens. Goodnight mittens." | gsub("night"; " morning")
# => "Good morning kittens. Good morning mittens."

置換テキストでは、一致した部分文字列を参照できます。名前付きキャプチャと文字列補間を使います。

"Some 3-letter acronyms: gnu, csv, png"
| gsub( "\\b(?<tla>[[:alpha:]]{3})\\b";     # find words 3 letters long
        "\(.tla | ascii_upcase)" )          # upper-case the match
# => "Some 3-letter acronyms: GNU, CSV, PNG"

フラグ

上記のすべてのフィルターで、FLAGSは、対応しているフラグを0個以上並べた文字列です。

• g - グローバル検索（最初の1つだけでなく、すべての一致を探します）
• i - 大文字と小文字を区別しない検索
• m - 複数行モード（'.'が改行に一致します）
• n - 空の一致を無視します
• p - sモードとmモードの両方が有効になります
• s - 単一行モード（'^' -> '\A'、'$' -> '\Z'）
• l - 最も長い一致を探します
• x - 拡張正規表現フォーマット（空白とコメントを無視します）

たとえば

"JIRAISSUE-1234" | capture("(?<project>\\w+)-(?<issue_num>\\d+)")

# or with Extended formatting

"JIRAISSUE-1234" | capture("
                     (?<project>   \\w+ )  # the Jira project
                     -                     # followed by a hyphen
                     (?<issue_num> \\d+ )  # followed by digits
                   "; "x")