Julia Syntax Highlighting

JuliaSyntaxHighlightingライブラリは、JuliaSyntaxとStyledStringsを使ってJuliaコードの構文をハイライトするための、小規模な便利パッケージです。

標準ライブラリ全体および、より広いエコシステムでの利用を想定しています。

Functions

JuliaSyntaxHighlighting.highlight — Function
highlight(content::Union{AbstractString, IO},
          ast::JuliaSyntax.GreenNode = <parsed content>;
          syntax_errors::Bool = false) -> AnnotatedString{String}

contentに、JuliaSyntaxを使って構文ハイライトを適用します。

デフォルトでは、ignore_errorsキーワード引数をtrueに設定して、JuliaSyntax.parseallを使い、astを生成します。代わりに、事前に生成したastを指定することもできます。

syntax_errorsが設定されている場合、検出された構文エラーにはjulia_errorフェイスが適用されます。

Warning

JuliaSyntaxで使われるフェイスや、その適用方法は変更される可能性があることに注意してください。

Examples

julia> JuliaSyntaxHighlighting.highlight("sum(1:8)")
"sum(1:8)"

julia> JuliaSyntaxHighlighting.highlight("sum(1:8)") |> Base.annotations
6-element Vector{@NamedTuple{region::UnitRange{Int64}, label::Symbol, value}}:
 @NamedTuple{region::UnitRange{Int64}, label::Symbol, value}((1:3, :face, :julia_funcall))
 @NamedTuple{region::UnitRange{Int64}, label::Symbol, value}((4:4, :face, :julia_rainbow_paren_1))
 @NamedTuple{region::UnitRange{Int64}, label::Symbol, value}((5:5, :face, :julia_number))
 @NamedTuple{region::UnitRange{Int64}, label::Symbol, value}((6:6, :face, :julia_operator))
 @NamedTuple{region::UnitRange{Int64}, label::Symbol, value}((7:7, :face, :julia_number))
 @NamedTuple{region::UnitRange{Int64}, label::Symbol, value}((8:8, :face, :julia_rainbow_paren_1))
source
JuliaSyntaxHighlighting.highlight! — Function
highlight!(content::Union{AnnotatedString, SubString{AnnotatedString}},
           ast::JuliaSyntax.GreenNode = <parsed content>;
           syntax_errors::Bool = false) -> content

content に JuliaSyntax を適用して、構文ハイライトを行います。

デフォルトでは、JuliaSyntax.parseall を使い、ignore_errors キーワード引数を true に設定して、ast を生成します。代わりに、事前に生成した ast を指定することもできます。

syntax_errors が設定されている場合、検出された構文エラーには julia_error フェイスが適用されます。

Warning

JuliaSyntax が使用するフェイスや、その適用方法は変更される可能性があることに注意してください。

Examples

julia> str = Base.AnnotatedString("sum(1:8)")
"sum(1:8)"

julia> JuliaSyntaxHighlighting.highlight!(str)
"sum(1:8)"

julia> Base.annotations(str)
6-element Vector{@NamedTuple{region::UnitRange{Int64}, label::Symbol, value}}:
 @NamedTuple{region::UnitRange{Int64}, label::Symbol, value}((1:3, :face, :julia_funcall))
 @NamedTuple{region::UnitRange{Int64}, label::Symbol, value}((4:4, :face, :julia_rainbow_paren_1))
 @NamedTuple{region::UnitRange{Int64}, label::Symbol, value}((5:5, :face, :julia_number))
 @NamedTuple{region::UnitRange{Int64}, label::Symbol, value}((6:6, :face, :julia_operator))
 @NamedTuple{region::UnitRange{Int64}, label::Symbol, value}((7:7, :face, :julia_number))
 @NamedTuple{region::UnitRange{Int64}, label::Symbol, value}((8:8, :face, :julia_rainbow_paren_1))
source

Faces

highlight/highlight!メソッドは、Juliaコードにカスタムフェイスを適用します。標準ライブラリの一部であるため、これらのフェイスにはjulia_*の形式の特権付きフェイス名が使われます。これらは他のパッケージでも再利用でき、faces.tomlの設定でカスタマイズできます。

不安定なフェイス

JuliaSyntaxHighlightingで使われる個々のフェイスは、ポイントリリースで予告なく変更される可能性があります。ただし、構文ハイライトのルールは時間とともに洗練されていくため、変更の頻度は次第に低くなるはずです。

現在のフェイスとそのデフォルト値は次のとおりです。

  • julia_macro: マゼンタ
  • julia_symbol: マゼンタ
  • julia_singleton_identifier: julia_symbolを継承
  • julia_type: 黄色
  • julia_typedec: 明るい青
  • julia_comment: グレー
  • julia_string: 緑
  • julia_regex: julia_stringを継承
  • julia_backslash_literal: マゼンタ。julia_stringを継承
  • julia_string_delim: 明るい緑
  • julia_cmdstring: julia_stringを継承
  • julia_char: julia_stringを継承
  • julia_char_delim: julia_string_delimを継承
  • julia_number: 明るいマゼンタ
  • julia_bool: julia_numberを継承
  • julia_funcall: シアン
  • julia_funcdef: シアン
  • julia_broadcast: 明るい青、太字
  • julia_builtin: 明るい青
  • julia_operator: 青
  • julia_comparator: julia_operatorを継承
  • julia_assignment: 明るい赤
  • julia_keyword: 赤
  • julia_parentheses: スタイルなし
  • julia_unpaired_parentheses: julia_errorとjulia_parenthesesを継承
  • julia_error: 赤い背景
  • julia_rainbow_paren_1: 明るい緑。julia_parenthesesを継承
  • julia_rainbow_paren_2: 明るい青。julia_parenthesesを継承
  • julia_rainbow_paren_3: 明るい赤。julia_parenthesesを継承
  • julia_rainbow_paren_4: julia_rainbow_paren_1を継承
  • julia_rainbow_paren_5: julia_rainbow_paren_2を継承
  • julia_rainbow_paren_6: julia_rainbow_paren_3を継承
  • julia_rainbow_bracket_1: 青。julia_parenthesesを継承
  • julia_rainbow_bracket_2: 明るいマゼンタ。`julia*parentheses`を継承
  • julia_rainbow_bracket_3: julia_rainbow_bracket_1を継承
  • julia_rainbow_bracket_4: julia_rainbow_bracket_2を継承
  • julia_rainbow_bracket_5: julia_rainbow_bracket_1を継承
  • julia_rainbow_bracket_6: julia_rainbow_bracket_2を継承
  • julia_rainbow_curly_1: 明るい黄色。julia_parenthesesを継承
  • julia_rainbow_curly_2: 黄色。julia_parenthesesを継承
  • julia_rainbow_curly_3: julia_rainbow_curly_1を継承
  • julia_rainbow_curly_4: julia_rainbow_curly_2を継承
  • julia_rainbow_curly_5: julia_rainbow_curly_1を継承
  • julia_rainbow_curly_6: julia_rainbow_curly_2を継承