From 0fb3cfaa67ee39f164785b486fd9e41eca762c43 Mon Sep 17 00:00:00 2001 From: Varun Gandhi Date: Wed, 31 Aug 2022 13:19:43 +0800 Subject: [PATCH] fix: Escape special characters in SCIP symbols. --- scip_indexer/BUILD | 1 + scip_indexer/SCIPUtils.cc | 63 ++++++++++++--- test/scip/testdata/classes.snapshot.rb | 10 +-- test/scip/testdata/def_delegator.snapshot.rb | 76 +++++++++---------- .../testdata/fields_and_attrs.snapshot.rb | 50 ++++++------ test/scip/testdata/hoverdocs.snapshot.rb | 48 ++++++------ .../testdata/implicit_super_arg.snapshot.rb | 2 +- test/scip/testdata/inheritance.snapshot.rb | 36 ++++----- .../loops_and_conditionals.snapshot.rb | 2 +- .../multifile/basic/def_class1.snapshot.rb | 2 +- test/scip/testdata/type_change.snapshot.rb | 40 +++++----- test/scip/testdata/type_docs.snapshot.rb | 2 +- test/scip/testdata/types.snapshot.rb | 6 +- 13 files changed, 192 insertions(+), 146 deletions(-) diff --git a/scip_indexer/BUILD b/scip_indexer/BUILD index 9fd9429011..28fb99634a 100644 --- a/scip_indexer/BUILD +++ b/scip_indexer/BUILD @@ -21,6 +21,7 @@ cc_library( deps = [ "//proto", "@com_google_absl//absl/status", + "@com_google_absl//absl/strings", ], ) diff --git a/scip_indexer/SCIPUtils.cc b/scip_indexer/SCIPUtils.cc index c6a6d61c28..6704dce4d4 100644 --- a/scip_indexer/SCIPUtils.cc +++ b/scip_indexer/SCIPUtils.cc @@ -1,6 +1,8 @@ #include #include "absl/status/status.h" +#include "absl/strings/match.h" +#include "absl/strings/str_replace.h" #include "proto/SCIP.pb.h" @@ -8,28 +10,69 @@ namespace scip::utils { using namespace std; +void addEscaped(string &out, const string &in) { + bool needsEscape = false; + bool needsBacktickEscape = false; + for (auto &c : in) { + if (('a' <= c && c <= 'z') || ('A' <= c && c <= 'Z') || ('0' <= c && c <= '9') || c == '+' || c == '-' || + c == '$' || c == '_') { + continue; + } + needsBacktickEscape = c == '`'; + needsEscape = true; + } + if (needsEscape) { + if (needsBacktickEscape) { + absl::StrAppend(&out, "`", absl::StrReplaceAll(in, {{"`", "``"}}), "`"); + return; + } + absl::StrAppend(&out, "`", in, "`"); + return; + } + out.append(in); +} + +void addSpaceEscaped(string &out, const string &in) { + if (absl::StrContains(in, " ")) { + out.append(absl::StrReplaceAll(in, {{" ", " "}})); + return; + } + out.append(in); +} + absl::Status emitDescriptorString(const scip::Descriptor &descriptor, string &out) { switch (descriptor.suffix()) { case scip::Descriptor::Namespace: // module - absl::StrAppend(&out, descriptor.name(), "/"); + addEscaped(out, descriptor.name()); + out.push_back('/'); return absl::OkStatus(); case scip::Descriptor::Type: - absl::StrAppend(&out, descriptor.name(), "#"); + addEscaped(out, descriptor.name()); + out.push_back('#'); return absl::OkStatus(); case scip::Descriptor::Term: - absl::StrAppend(&out, descriptor.name(), "."); + addEscaped(out, descriptor.name()); + out.push_back('.'); return absl::OkStatus(); case scip::Descriptor::Meta: - absl::StrAppend(&out, descriptor.name(), ":"); + addEscaped(out, descriptor.name()); + out.push_back(':'); return absl::OkStatus(); case scip::Descriptor::Method: - absl::StrAppend(&out, descriptor.name(), "(", descriptor.disambiguator(), ")."); + addEscaped(out, descriptor.name()); + out.push_back('('); + addEscaped(out, descriptor.disambiguator()); + out.append(")."); return absl::OkStatus(); case scip::Descriptor::TypeParameter: - absl::StrAppend(&out, "[", descriptor.name(), "]"); + out.push_back('['); + addEscaped(out, descriptor.name()); + out.push_back(']'); return absl::OkStatus(); case scip::Descriptor::Parameter: - absl::StrAppend(&out, "(", descriptor.name(), ")"); + out.push_back('('); + addEscaped(out, descriptor.name()); + out.push_back(')'); return absl::OkStatus(); default: return absl::InvalidArgumentError( @@ -42,12 +85,14 @@ absl::Status emitSymbolString(const scip::Symbol &symbol, string &out) { if (symbol.has_package()) { auto &package = symbol.package(); if (!package.name().empty()) { - absl::StrAppend(&out, package.name(), " "); // FIXME(varun): handle escaping + addSpaceEscaped(out, package.name()); + out.push_back(' '); } else { out.append(". "); } if (!package.version().empty()) { - absl::StrAppend(&out, package.version(), " "); // FIXME(varun): handle escaping + addSpaceEscaped(out, package.version()); + out.push_back(' '); } else { out.append(". "); } diff --git a/test/scip/testdata/classes.snapshot.rb b/test/scip/testdata/classes.snapshot.rb index 94aa02e4f2..b55719d22b 100644 --- a/test/scip/testdata/classes.snapshot.rb +++ b/test/scip/testdata/classes.snapshot.rb @@ -73,15 +73,15 @@ module M5 module M6 # ^^ definition [..] M5#M6# def self.g() -# ^^^^^^^^^^^^ definition [..] M5##g(). +# ^^^^^^^^^^^^ definition [..] M5#``#g(). end end def self.h() -# ^^^^^^^^^^^^ definition [..] #h(). +# ^^^^^^^^^^^^ definition [..] ``#h(). M6.g() # ^^ reference [..] M5#M6# -# ^ reference [..] M5##g(). +# ^ reference [..] M5#``#g(). return end end @@ -91,7 +91,7 @@ class C7 module M8 # ^^ definition [..] C7#M8# def self.i() -# ^^^^^^^^^^^^ definition [..] C7##i(). +# ^^^^^^^^^^^^ definition [..] C7#``#i(). end end @@ -99,7 +99,7 @@ def j() # ^^^^^^^ definition [..] C7#j(). M8.i() # ^^ reference [..] C7#M8# -# ^ reference [..] C7##i(). +# ^ reference [..] C7#``#i(). return end end diff --git a/test/scip/testdata/def_delegator.snapshot.rb b/test/scip/testdata/def_delegator.snapshot.rb index 925bc24085..7ee110293c 100644 --- a/test/scip/testdata/def_delegator.snapshot.rb +++ b/test/scip/testdata/def_delegator.snapshot.rb @@ -6,20 +6,20 @@ class MyArray1 # ^^^^^^^^ definition [..] MyArray1# attr_accessor :inner_array # ^^^^^^^^^^^^^^^^^^^^^^^^^^ definition [..] MyArray1#inner_array(). -# ^^^^^^^^^^^^^^^^^^^^^^^^^^ definition [..] MyArray1#inner_array=(). +# ^^^^^^^^^^^^^^^^^^^^^^^^^^ definition [..] MyArray1#`inner_array=`(). extend Forwardable # ^^^^^^^^^^^ reference [..] Forwardable# def_delegator :@inner_array, :[], :get_at_index # ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ definition [..] MyArray1#get_at_index(). # ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] Sorbet#Private#Static# -# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] Sorbet#Private##sig(). +# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] Sorbet#Private#``#sig(). # ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] T# -# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] #untyped(). +# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] ``#untyped(). # ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] T# -# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] #nilable(). +# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] ``#nilable(). # ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] T#Private#Methods#DeclBuilder#params(). # ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] T# -# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] #untyped(). +# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] ``#untyped(). # ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] T#Private#Methods#DeclBuilder#returns(). # ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] Proc# end @@ -31,20 +31,20 @@ class MyArray2 # ^^^ reference [..] T#Sig# attr_accessor :inner_array # ^^^^^^^^^^^^^^^^^^^^^^^^^^ definition [..] MyArray2#inner_array(). -# ^^^^^^^^^^^^^^^^^^^^^^^^^^ definition [..] MyArray2#inner_array=(). +# ^^^^^^^^^^^^^^^^^^^^^^^^^^ definition [..] MyArray2#`inner_array=`(). extend Forwardable # ^^^^^^^^^^^ reference [..] Forwardable# def_delegator :@inner_array, :[], :get_at_index # ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ definition [..] MyArray2#get_at_index(). # ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] Sorbet#Private#Static# -# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] Sorbet#Private##sig(). +# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] Sorbet#Private#``#sig(). # ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] T# -# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] #untyped(). +# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] ``#untyped(). # ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] T# -# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] #nilable(). +# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] ``#nilable(). # ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] T#Private#Methods#DeclBuilder#params(). # ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] T# -# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] #untyped(). +# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] ``#untyped(). # ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] T#Private#Methods#DeclBuilder#returns(). # ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] Proc# end @@ -53,42 +53,42 @@ class MyArray3 # ^^^^^^^^ definition [..] MyArray3# attr_accessor :inner_array # ^^^^^^^^^^^^^^^^^^^^^^^^^^ definition [..] MyArray3#inner_array(). -# ^^^^^^^^^^^^^^^^^^^^^^^^^^ definition [..] MyArray3#inner_array=(). +# ^^^^^^^^^^^^^^^^^^^^^^^^^^ definition [..] MyArray3#`inner_array=`(). extend Forwardable # ^^^^^^^^^^^ reference [..] Forwardable# def_delegators :@inner_array, :size, :<<, :map -# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] #nilable(). +# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] ``#nilable(). # ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] Proc# # ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ definition [..] MyArray3#map(). # ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] Sorbet#Private#Static# -# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] Sorbet#Private##sig(). +# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] Sorbet#Private#``#sig(). # ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] T# -# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] #untyped(). +# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] ``#untyped(). # ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] T# -# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] #nilable(). -# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ definition [..] MyArray3#<<(). +# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] ``#nilable(). +# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ definition [..] MyArray3#`<<`(). # ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] T# -# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] #untyped(). +# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] ``#untyped(). # ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] T#Private#Methods#DeclBuilder#returns(). # ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] Sorbet#Private#Static# -# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] Sorbet#Private##sig(). +# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] Sorbet#Private#``#sig(). # ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] T# -# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] #untyped(). +# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] ``#untyped(). # ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] T# # ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ definition [..] MyArray3#size(). # ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] T#Private#Methods#DeclBuilder#params(). # ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] T# -# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] #untyped(). +# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] ``#untyped(). # ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] T#Private#Methods#DeclBuilder#returns(). # ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] Sorbet#Private#Static# -# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] Sorbet#Private##sig(). +# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] Sorbet#Private#``#sig(). # ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] T# -# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] #untyped(). +# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] ``#untyped(). # ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] T# -# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] #nilable(). +# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] ``#nilable(). # ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] T#Private#Methods#DeclBuilder#params(). # ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] T# -# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] #untyped(). +# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] ``#untyped(). # ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] T#Private#Methods#DeclBuilder#returns(). # ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] T#Private#Methods#DeclBuilder#params(). end @@ -99,7 +99,7 @@ class MyArray4 # ^ reference [..] T# # ^^^ reference [..] T#Sig# attr_accessor :inner_array -# ^^^^^^^^^^^^^^^^^^^^^^^^^^ definition [..] MyArray4#inner_array=(). +# ^^^^^^^^^^^^^^^^^^^^^^^^^^ definition [..] MyArray4#`inner_array=`(). # ^^^^^^^^^^^^^^^^^^^^^^^^^^ definition [..] MyArray4#inner_array(). extend Forwardable # ^^^^^^^^^^^ reference [..] Forwardable# @@ -107,35 +107,35 @@ class MyArray4 # ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ definition [..] MyArray4#size(). # ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] Proc# # ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] T# -# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] #untyped(). +# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] ``#untyped(). # ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] T# -# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] #nilable(). +# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] ``#nilable(). # ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] T#Private#Methods#DeclBuilder#params(). # ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] T# -# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] #untyped(). +# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] ``#untyped(). # ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] T#Private#Methods#DeclBuilder#returns(). # ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] Sorbet#Private#Static# -# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] Sorbet#Private##sig(). +# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] Sorbet#Private#``#sig(). # ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] T# -# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] #untyped(). +# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] ``#untyped(). # ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] T# -# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] #nilable(). +# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] ``#nilable(). # ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] T#Private#Methods#DeclBuilder#params(). # ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] T# -# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] #untyped(). +# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] ``#untyped(). # ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] T#Private#Methods#DeclBuilder#returns(). # ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] Sorbet#Private#Static# -# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] Sorbet#Private##sig(). +# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] Sorbet#Private#``#sig(). # ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] T# -# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] #untyped(). +# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] ``#untyped(). # ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] T# -# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] #nilable(). +# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] ``#nilable(). # ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] T#Private#Methods#DeclBuilder#params(). # ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] T# -# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] #untyped(). +# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] ``#untyped(). # ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] T#Private#Methods#DeclBuilder#returns(). # ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] Sorbet#Private#Static# # ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ definition [..] MyArray4#map(). -# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ definition [..] MyArray4#<<(). -# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] Sorbet#Private##sig(). +# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ definition [..] MyArray4#`<<`(). +# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] Sorbet#Private#``#sig(). end diff --git a/test/scip/testdata/fields_and_attrs.snapshot.rb b/test/scip/testdata/fields_and_attrs.snapshot.rb index 8ac31bb9fc..188cdec2f2 100644 --- a/test/scip/testdata/fields_and_attrs.snapshot.rb +++ b/test/scip/testdata/fields_and_attrs.snapshot.rb @@ -8,17 +8,17 @@ class K def m1 # ^^^^^^ definition [..] K#m1(). @f = 0 -# ^^ definition [..] K#@f. +# ^^ definition [..] K#`@f`. @g = @f -# ^^ definition [..] K#@g. -# ^^ reference [..] K#@f. +# ^^ definition [..] K#`@g`. +# ^^ reference [..] K#`@f`. return end def m2 # ^^^^^^ definition [..] K#m2(). @f = @g -# ^^ definition [..] K#@f. -# ^^ reference [..] K#@g. +# ^^ definition [..] K#`@f`. +# ^^ reference [..] K#`@g`. return end end @@ -29,8 +29,8 @@ class K def m3 # ^^^^^^ definition [..] K#m3(). @g = @f -# ^^ definition [..] K#@g. -# ^^ reference [..] K#@f. +# ^^ definition [..] K#`@g`. +# ^^ reference [..] K#`@f`. return end end @@ -39,14 +39,14 @@ def m3 class L # ^ definition [..] L# @x = 10 -# ^^ definition [..] #@x. +# ^^ definition [..] ``#`@x`. @y = 9 -# ^^ definition [..] #@y. +# ^^ definition [..] ``#`@y`. def self.m1 -# ^^^^^^^^^^^ definition [..] #m1(). +# ^^^^^^^^^^^ definition [..] ``#m1(). @y = @x -# ^^ definition [..] #@y. -# ^^ reference [..] #@x. +# ^^ definition [..] ``#`@y`. +# ^^ reference [..] ``#`@x`. return end @@ -62,22 +62,22 @@ def m2 class N # ^ definition [..] N# @@a = 0 -# ^^^ definition [..] #@@a. +# ^^^ definition [..] ``#`@@a`. @@b = 1 -# ^^^ definition [..] #@@b. +# ^^^ definition [..] ``#`@@b`. def self.m1 -# ^^^^^^^^^^^ definition [..] #m1(). +# ^^^^^^^^^^^ definition [..] ``#m1(). @@b = @@a -# ^^^ definition [..] #@@b. -# ^^^ reference [..] #@@a. +# ^^^ definition [..] ``#`@@b`. +# ^^^ reference [..] ``#`@@a`. return end def m2 # ^^^^^^ definition [..] N#m2(). @@b = @@a -# ^^^ definition [..] N#@@b. -# ^^^ reference [..] N#@@a. +# ^^^ definition [..] N#`@@b`. +# ^^^ reference [..] N#`@@a`. return end @@ -92,20 +92,20 @@ def m3 class P # ^ definition [..] P# attr_accessor :a -# ^^^^^^^^^^^^^^^^ definition [..] P#a=(). +# ^^^^^^^^^^^^^^^^ definition [..] P#`a=`(). # ^^^^^^^^^^^^^^^^ definition [..] P#a(). attr_reader :r # ^^^^^^^^^^^^^^ definition [..] P#r(). attr_writer :w -# ^^^^^^^^^^^^^^ definition [..] P#w=(). +# ^^^^^^^^^^^^^^ definition [..] P#`w=`(). def init # ^^^^^^^^ definition [..] P#init(). self.a = self.r -# ^^^ reference [..] P#a=(). +# ^^^ reference [..] P#`a=`(). # ^ reference [..] P#r(). self.w = self.a -# ^^^ reference [..] P#w=(). +# ^^^ reference [..] P#`w=`(). # ^ reference [..] P#a(). end @@ -129,12 +129,12 @@ def useP # ^ reference [..] P# p.a = p.r # ^ reference local 1~#2121829932 -# ^^^ reference [..] P#a=(). +# ^^^ reference [..] P#`a=`(). # ^ reference local 1~#2121829932 # ^ reference [..] P#r(). p.w = p.a # ^ reference local 1~#2121829932 -# ^^^ reference [..] P#w=(). +# ^^^ reference [..] P#`w=`(). # ^ reference local 1~#2121829932 # ^ reference [..] P#a(). end diff --git a/test/scip/testdata/hoverdocs.snapshot.rb b/test/scip/testdata/hoverdocs.snapshot.rb index c8b8b1d54f..06517de908 100644 --- a/test/scip/testdata/hoverdocs.snapshot.rb +++ b/test/scip/testdata/hoverdocs.snapshot.rb @@ -24,7 +24,7 @@ def m1 end sig { returns(T::Boolean) } -# ^^^ reference [..] Sorbet#Private##sig(). +# ^^^ reference [..] Sorbet#Private#``#sig(). # ^^^^^^^ reference [..] T#Private#Methods#DeclBuilder#returns(). # ^ reference [..] T# # ^^^^^^^ reference [..] T#Boolean. @@ -40,9 +40,9 @@ def m2 end sig { params(C, T::Boolean).returns(T::Boolean) } -# ^^^ reference [..] Sorbet#Private##sig(). +# ^^^ reference [..] Sorbet#Private#``#sig(). # ^^^^^^ reference [..] T#Private#Methods#DeclBuilder#params(). -# ^ reference [..] T.untyped# +# ^ reference [..] `T.untyped`# # ^ reference [..] T# # ^^^^^^^ reference [..] T#Boolean. # ^^^^^^^ reference [..] T#Private#Methods#DeclBuilder#returns(). @@ -95,7 +95,7 @@ def m4(xs) # Yet another.. # ...doc comment sig { returns(T::Boolean) } -# ^^^ reference [..] Sorbet#Private##sig(). +# ^^^ reference [..] Sorbet#Private#``#sig(). # ^^^^^^^ reference [..] T#Private#Methods#DeclBuilder#returns(). # ^ reference [..] T# # ^^^^^^^ reference [..] T#Boolean. @@ -116,9 +116,9 @@ def m5 # And... # ...one more doc comment sig { params(C, T::Boolean).returns(T::Boolean) } -# ^^^ reference [..] Sorbet#Private##sig(). +# ^^^ reference [..] Sorbet#Private#``#sig(). # ^^^^^^ reference [..] T#Private#Methods#DeclBuilder#params(). -# ^ reference [..] T.untyped# +# ^ reference [..] `T.untyped`# # ^ reference [..] T# # ^^^^^^^ reference [..] T#Boolean. # ^^^^^^^ reference [..] T#Private#Methods#DeclBuilder#returns(). @@ -198,7 +198,7 @@ module M2 # This method is inside M1::M2 sig { returns(T::Boolean) } -# ^^^ reference [..] Sorbet#Private##sig(). +# ^^^ reference [..] Sorbet#Private#``#sig(). # ^^^^^^^ reference [..] T#Private#Methods#DeclBuilder#returns(). # ^ reference [..] T# # ^^^^^^^ reference [..] T#Boolean. @@ -249,10 +249,10 @@ def f1 # Yet another global function sig { returns(T::Integer) } -#^^^ reference [..] Sorbet#Private##sig(). +#^^^ reference [..] Sorbet#Private#``#sig(). # ^^^^^^^ reference [..] T#Private#Methods#DeclBuilder#returns(). # ^ reference [..] T# -# ^^^^^^^ reference [..] T.untyped# +# ^^^^^^^ reference [..] `T.untyped`# # ^^^^^^^^^^ reference [..] Sorbet#Private#Static# def f2 #^^^^^^ definition [..] Object#f2(). @@ -280,10 +280,10 @@ def f3 # undocumented global function # ^^^ reference [..] T#Sig# sig { returns(T::Integer) } -#^^^ reference [..] Sorbet#Private##sig(). +#^^^ reference [..] Sorbet#Private#``#sig(). # ^^^^^^^ reference [..] T#Private#Methods#DeclBuilder#returns(). # ^ reference [..] T# -# ^^^^^^^ reference [..] T.untyped# +# ^^^^^^^ reference [..] `T.untyped`# # ^^^^^^^^^^ reference [..] Sorbet#Private#Static# def f4 # another undocumented global function #^^^^^^ definition [..] Object#f4(). @@ -315,18 +315,18 @@ def p1 # documentation # | sets @x and @@y @x = 10 -# ^^ definition [..] K1#@x. +# ^^ definition [..] K1#`@x`. # documentation # | ```ruby # | @x (T.untyped) # | ``` @@y = 10 -# ^^^ definition [..] K1#@@y. +# ^^^ definition [..] K1#`@@y`. # documentation # | ```ruby # | @@y (T.untyped) # | ``` -# ^^^^^^^^ reference [..] K1#@@y. +# ^^^^^^^^ reference [..] K1#`@@y`. # override_documentation # | ```ruby # | @@y (Integer(10)) @@ -335,7 +335,7 @@ def p1 # lorem ipsum, you get it def self.p2 -# ^^^^^^^^^^^ definition [..] #p2(). +# ^^^^^^^^^^^ definition [..] ``#p2(). # documentation # | ```ruby # | sig {returns(T.untyped)} @@ -344,12 +344,12 @@ def self.p2 # documentation # | lorem ipsum, you get it @z = 10 -# ^^ definition [..] #@z. +# ^^ definition [..] ``#`@z`. # documentation # | ```ruby # | @z (T.untyped) # | ``` -# ^^^^^^^ reference [..] #@z. +# ^^^^^^^ reference [..] ``#`@z`. # override_documentation # | ```ruby # | @z (Integer(10)) @@ -375,7 +375,7 @@ class K2 < K1 # | Parent class # doc comment on class var ooh @z = 9 -# ^^ definition [..] #@z. +# ^^ definition [..] ``#`@z`. # documentation # | ```ruby # | @z (T.untyped) @@ -394,22 +394,22 @@ def p1 # documentation # | overrides K1's p1 @x = 20 -# ^^ definition [..] K2#@x. +# ^^ definition [..] K2#`@x`. # documentation # | ```ruby # | @x (T.untyped) # | ``` @@y = 20 -# ^^^ definition [..] K2#@@y. +# ^^^ definition [..] K2#`@@y`. # documentation # | ```ruby # | @@y (T.untyped) # | ``` @z += @x -# ^^ reference [..] K2#@z. -# ^^ reference (write) [..] K2#@z. -# ^^^^^^^^ reference [..] K2#@z. -# ^^ reference [..] K2#@x. +# ^^ reference [..] K2#`@z`. +# ^^ reference (write) [..] K2#`@z`. +# ^^^^^^^^ reference [..] K2#`@z`. +# ^^ reference [..] K2#`@x`. # override_documentation # | ```ruby # | @x (Integer(20)) diff --git a/test/scip/testdata/implicit_super_arg.snapshot.rb b/test/scip/testdata/implicit_super_arg.snapshot.rb index 30744de45a..352c88b9da 100644 --- a/test/scip/testdata/implicit_super_arg.snapshot.rb +++ b/test/scip/testdata/implicit_super_arg.snapshot.rb @@ -25,6 +25,6 @@ def f(a, b) # ^ definition local 1~#3809224601 # ^ definition local 2~#3809224601 super -# ^^^^^ reference [..] >#(). +# ^^^^^ reference [..] `>`#``(). end end diff --git a/test/scip/testdata/inheritance.snapshot.rb b/test/scip/testdata/inheritance.snapshot.rb index 32b87f034b..9bbdc70d8b 100644 --- a/test/scip/testdata/inheritance.snapshot.rb +++ b/test/scip/testdata/inheritance.snapshot.rb @@ -7,7 +7,7 @@ class Z1 # ^^^ reference [..] T#Sig# sig { params(a: T::Boolean).void } -# ^^^ reference [..] Sorbet#Private##sig(). +# ^^^ reference [..] Sorbet#Private#``#sig(). # ^^^^^^ reference [..] T#Private#Methods#DeclBuilder#params(). # ^ reference [..] T# # ^^^^^^^ reference [..] T#Boolean. @@ -17,21 +17,21 @@ def write_f(a) # ^^^^^^^^^^^^^^ definition [..] Z1#write_f(). # ^ definition local 1~#1000661517 @f = a -# ^^ definition [..] Z1#@f. -# ^^^^^^ reference [..] Z1#@f. +# ^^ definition [..] Z1#`@f`. +# ^^^^^^ reference [..] Z1#`@f`. # ^ reference local 1~#1000661517 end sig { returns(T::Boolean) } -# ^^^ reference [..] Sorbet#Private##sig(). +# ^^^ reference [..] Sorbet#Private#``#sig(). # ^^^^^^^ reference [..] T#Private#Methods#DeclBuilder#returns(). # ^ reference [..] T# # ^^^^^^^ reference [..] T#Boolean. # ^^^^^^^^^^ reference [..] Sorbet#Private#Static# def read_f? -# ^^^^^^^^^^^ definition [..] Z1#read_f?(). +# ^^^^^^^^^^^ definition [..] Z1#`read_f?`(). @f -# ^^ reference [..] Z1#@f. +# ^^ reference [..] Z1#`@f`. end end @@ -42,19 +42,19 @@ class Z2 # ^^^ reference [..] T#Sig# sig { returns(T::Boolean) } -# ^^^ reference [..] Sorbet#Private##sig(). +# ^^^ reference [..] Sorbet#Private#``#sig(). # ^^^^^^^ reference [..] T#Private#Methods#DeclBuilder#returns(). # ^ reference [..] T# # ^^^^^^^ reference [..] T#Boolean. # ^^^^^^^^^^ reference [..] Sorbet#Private#Static# def read_f? -# ^^^^^^^^^^^ definition [..] Z2#read_f?(). +# ^^^^^^^^^^^ definition [..] Z2#`read_f?`(). @f -# ^^ reference [..] Z2#@f. +# ^^ reference [..] Z2#`@f`. end sig { params(a: T::Boolean).void } -# ^^^ reference [..] Sorbet#Private##sig(). +# ^^^ reference [..] Sorbet#Private#``#sig(). # ^^^^^^ reference [..] T#Private#Methods#DeclBuilder#params(). # ^ reference [..] T# # ^^^^^^^ reference [..] T#Boolean. @@ -64,8 +64,8 @@ def write_f(a) # ^^^^^^^^^^^^^^ definition [..] Z2#write_f(). # ^ definition local 1~#1000661517 @f = a -# ^^ definition [..] Z2#@f. -# ^^^^^^ reference [..] Z2#@f. +# ^^ definition [..] Z2#`@f`. +# ^^^^^^ reference [..] Z2#`@f`. # ^ reference local 1~#1000661517 end end @@ -78,15 +78,15 @@ class Z3 < Z1 # ^^^ reference [..] T#Sig# sig { returns(T::Boolean) } -# ^^^ reference [..] Sorbet#Private##sig(). +# ^^^ reference [..] Sorbet#Private#``#sig(). # ^^^^^^^ reference [..] T#Private#Methods#DeclBuilder#returns(). # ^ reference [..] T# # ^^^^^^^ reference [..] T#Boolean. # ^^^^^^^^^^ reference [..] Sorbet#Private#Static# def read_f_plus_1? -# ^^^^^^^^^^^^^^^^^^ definition [..] Z3#read_f_plus_1?(). +# ^^^^^^^^^^^^^^^^^^ definition [..] Z3#`read_f_plus_1?`(). @f + 1 -# ^^ reference [..] Z3#@f. +# ^^ reference [..] Z3#`@f`. end end @@ -98,7 +98,7 @@ class Z4 < Z3 # ^^^ reference [..] T#Sig# sig { params(a: T::Boolean).void } -# ^^^ reference [..] Sorbet#Private##sig(). +# ^^^ reference [..] Sorbet#Private#``#sig(). # ^^^^^^ reference [..] T#Private#Methods#DeclBuilder#params(). # ^ reference [..] T# # ^^^^^^^ reference [..] T#Boolean. @@ -110,8 +110,8 @@ def write_f_plus_1(a) write_f(a) # ^ reference local 1~#3337417690 @f = read_f_plus_1? -# ^^ definition [..] Z4#@f. -# ^^^^^^^^^^^^^^^^^^^ reference [..] Z4#@f. +# ^^ definition [..] Z4#`@f`. +# ^^^^^^^^^^^^^^^^^^^ reference [..] Z4#`@f`. end end diff --git a/test/scip/testdata/loops_and_conditionals.snapshot.rb b/test/scip/testdata/loops_and_conditionals.snapshot.rb index 7b3b09a34e..24cc13e110 100644 --- a/test/scip/testdata/loops_and_conditionals.snapshot.rb +++ b/test/scip/testdata/loops_and_conditionals.snapshot.rb @@ -28,7 +28,7 @@ def if_elsif_else() # ^ reference local 1~#2393773952 # ^ reference local 1~#2393773952 # ^ reference local 1~#2393773952 -# ^^ reference [..] Integer#==(). +# ^^ reference [..] Integer#`==`(). x # ^ reference local 1~#2393773952 else diff --git a/test/scip/testdata/multifile/basic/def_class1.snapshot.rb b/test/scip/testdata/multifile/basic/def_class1.snapshot.rb index 5442b969ed..84e94e3170 100644 --- a/test/scip/testdata/multifile/basic/def_class1.snapshot.rb +++ b/test/scip/testdata/multifile/basic/def_class1.snapshot.rb @@ -7,7 +7,7 @@ class C1 # ^^^ reference [..] T#Sig# sig { returns(T::Boolean) } -# ^^^ reference [..] Sorbet#Private##sig(). +# ^^^ reference [..] Sorbet#Private#``#sig(). # ^^^^^^^ reference [..] T#Private#Methods#DeclBuilder#returns(). # ^ reference [..] T# # ^^^^^^^ reference [..] T#Boolean. diff --git a/test/scip/testdata/type_change.snapshot.rb b/test/scip/testdata/type_change.snapshot.rb index b16ad8200a..b446852ed2 100644 --- a/test/scip/testdata/type_change.snapshot.rb +++ b/test/scip/testdata/type_change.snapshot.rb @@ -130,7 +130,7 @@ class C # | class C # | ``` @k = nil -# ^^ definition [..] #@k. +# ^^ definition [..] ``#`@k`. # documentation # | ```ruby # | @k (T.untyped) @@ -149,67 +149,67 @@ def change_type(b) # | b (T.untyped) # | ``` @f = nil -# ^^ definition [..] C#@f. +# ^^ definition [..] C#`@f`. # documentation # | ```ruby # | @f (T.untyped) # | ``` @@g = nil -# ^^^ definition [..] C#@@g. +# ^^^ definition [..] C#`@@g`. # documentation # | ```ruby # | @@g (T.untyped) # | ``` @k = nil -# ^^ definition [..] C#@k. +# ^^ definition [..] C#`@k`. # documentation # | ```ruby # | @k (T.untyped) # | ``` if b @f = 1 -# ^^ reference (write) [..] C#@f. +# ^^ reference (write) [..] C#`@f`. # override_documentation # | ```ruby # | @f (Integer(1)) # | ``` @@g = 1 -# ^^^ reference (write) [..] C#@@g. +# ^^^ reference (write) [..] C#`@@g`. # override_documentation # | ```ruby # | @@g (Integer(1)) # | ``` @k = 1 -# ^^ reference (write) [..] C#@k. +# ^^ reference (write) [..] C#`@k`. # override_documentation # | ```ruby # | @k (Integer(1)) # | ``` -# ^^^^^^ reference [..] C#@k. +# ^^^^^^ reference [..] C#`@k`. # override_documentation # | ```ruby # | @k (Integer(1)) # | ``` else @f = 'f' -# ^^ reference (write) [..] C#@f. +# ^^ reference (write) [..] C#`@f`. # override_documentation # | ```ruby # | @f (String("f")) # | ``` @@g = 'g' -# ^^^ reference (write) [..] C#@@g. +# ^^^ reference (write) [..] C#`@@g`. # override_documentation # | ```ruby # | @@g (String("g")) # | ``` @k = 'k' -# ^^ reference (write) [..] C#@k. +# ^^ reference (write) [..] C#`@k`. # override_documentation # | ```ruby # | @k (String("k")) # | ``` -# ^^^^^^^^ reference [..] C#@k. +# ^^^^^^^^ reference [..] C#`@k`. # override_documentation # | ```ruby # | @k (String("k")) @@ -244,48 +244,48 @@ def change_type(b) if !b # ^ reference local 1~#2066187318 @f = 1 -# ^^ definition [..] D#@f. +# ^^ definition [..] D#`@f`. # documentation # | ```ruby # | @f (T.untyped) # | ``` @@g = 1 -# ^^^ definition [..] D#@@g. +# ^^^ definition [..] D#`@@g`. # documentation # | ```ruby # | @@g (T.untyped) # | ``` @k = 1 -# ^^ definition [..] D#@k. +# ^^ definition [..] D#`@k`. # documentation # | ```ruby # | @k (T.untyped) # | ``` -# ^^^^^^ reference [..] D#@k. +# ^^^^^^ reference [..] D#`@k`. # override_documentation # | ```ruby # | @k (Integer(1)) # | ``` else @f = 'f' -# ^^ definition [..] D#@f. +# ^^ definition [..] D#`@f`. # documentation # | ```ruby # | @f (T.untyped) # | ``` @@g = 'g' -# ^^^ definition [..] D#@@g. +# ^^^ definition [..] D#`@@g`. # documentation # | ```ruby # | @@g (T.untyped) # | ``` @k = 'k' -# ^^ definition [..] D#@k. +# ^^ definition [..] D#`@k`. # documentation # | ```ruby # | @k (T.untyped) # | ``` -# ^^^^^^^^ reference [..] D#@k. +# ^^^^^^^^ reference [..] D#`@k`. # override_documentation # | ```ruby # | @k (String("k")) diff --git a/test/scip/testdata/type_docs.snapshot.rb b/test/scip/testdata/type_docs.snapshot.rb index 3b0334a320..0062e2e8bf 100644 --- a/test/scip/testdata/type_docs.snapshot.rb +++ b/test/scip/testdata/type_docs.snapshot.rb @@ -12,7 +12,7 @@ module M # ^^^ reference [..] T#Sig# sig { params(x: Integer, y: String).returns(String) } -# ^^^ reference [..] Sorbet#Private##sig(). +# ^^^ reference [..] Sorbet#Private#``#sig(). # ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] Sorbet#Private#Static# # ^^^^^^^ reference [..] Integer# # ^^^^^^ reference [..] String# diff --git a/test/scip/testdata/types.snapshot.rb b/test/scip/testdata/types.snapshot.rb index 8332d6aa44..ce065a8358 100644 --- a/test/scip/testdata/types.snapshot.rb +++ b/test/scip/testdata/types.snapshot.rb @@ -11,8 +11,8 @@ module M # ^ definition [..] M# module_function sig { returns(T::Boolean) } -# ^^^ reference [..] Sorbet#Private##sig(). -# ^^^ reference [..] Sorbet#Private##sig(). +# ^^^ reference [..] Sorbet#Private#``#sig(). +# ^^^ reference [..] Sorbet#Private#``#sig(). # ^ reference [..] T# # ^^^^^^^ reference [..] T#Boolean. # ^^^^^^^ reference [..] T#Boolean. @@ -20,7 +20,7 @@ module M # ^^^^^^^^^^ reference [..] Sorbet#Private#Static# def b # ^^^^^ definition [..] M#b(). -# ^^^^^ definition [..] #b(). +# ^^^^^ definition [..] ``#b(). true end end