class Prism::MagicComment (Ruby 4.0 リファレンスマニュアル)

要約

Prism::ParseResult#magic_comments で得られる、マジックコメント (# frozen_string_literal: true のような、Ruby の動作に影響を与える特別な形式のコメント)を表すクラスです。

キーも値も文字列として取得されます。"true" を真偽値に変換するような意味の解釈は行われないことに注意してください。

例

require "prism"

result = Prism.parse(<<~RUBY)
  # frozen_string_literal: true
  puts "hi"
RUBY
magic = result.magic_comments.first
p magic.key   # => "frozen_string_literal"
p magic.value # => "true"

[SEE_ALSO] Prism::ParseResult#magic_comments

インスタンスメソッド

key -> StringRuby 3.3 から[permalink][rdoc][edit]

マジックコメントのキー(: の左側)を文字列で返します。 key_loc.slice と同じ内容です。

key_loc -> Prism::LocationRuby 3.3 から[permalink][rdoc][edit]

キーのソースコード上の位置を表す Prism::Location を返します。

value -> StringRuby 3.3 から[permalink][rdoc][edit]

マジックコメントの値(: の右側)を文字列で返します。 value_loc.slice と同じ内容です。

value_loc -> Prism::LocationRuby 3.3 から[permalink][rdoc][edit]

値のソースコード上の位置を表す Prism::Location を返します。

例

require "prism"

magic = Prism.parse("# coding: utf-8\np 1\n").magic_comments.first
p magic.key_loc.slice   # => "coding"
p magic.value_loc.slice # => "utf-8"

要約

目次

インスタンスメソッド