以下を実行すると、 $GOPATH/bin に lnstags がインストールされます。

go install -tags gopherlua github.com/ifritJP/lnstags@latest

$ git clone --depth 1 https://github.com/ifritJP/lnstags
$ cd lnstags
$ make build ONLY_GO=y

上記で lnstags/lnstags が生成されます。

lctags update は、 DB に登録されている lns のソースファルイリストを元に、 情報を更新する。

lctags build と異なり、解析するソースファイルを指定する必要がない。

解析対象の lns ファイルが増減した場合 は、 lctags update ではなく、 lctags build を使用しなければならない。

inq は、シンボル名を指定して問い合わせを行なう。

// @lnsFront: ok
class Foo {
   pub fn func() {
   }
}
class Bar {
   pub fn func() {
   }
}
let foo = new Foo();
foo.func();
let bar = new Bar();
bar.func();

たとえば、上記のような mini.lns ファイルがあった場合、 Foo クラスの func メソッドのシンボル名は次になる。

@mini.Foo.func

ここで、 @mini はモジュール名を示し、 mini は mini.lns を指す。 例えば abc/def/ghi.lns の場合、モジュール名は @abc.@def.@ghi となる。 Foo.func は、 Foo クラスの func メソッドを指す。

そして、次のコマンドを実行することで、 @mini.Foo.func の定義位置がリストされる。

$ lnstags inq def @mini.Foo.func
@mini.Foo.func      2 mini.lns            pub fn func() {

このコマンド lnstags inq def の def は、 定義場所 の問い合わせを指定する。

問い合わせの種類は次がある。

問い合わせしたいシンボルの完全限定名が判っている場合は inq コマンドが利用できるが、 完全限定名を調べるのが困難だったり面倒だったりする。

そこで、ソースの所定位置のシンボルについて問い合わせを行なうのが inq-at である。

以下のソースがある時に、 10 行目の 5 列目にある foo.func() の定義場所を問合せる場合、

// @lnsFront: ok
class Foo {
   pub fn func() {
   }
}
class Bar {
   pub fn func() {
   }
}
let foo = new Foo();
foo.func();
let bar = new Bar();
bar.func();

次のコマンドを実行する。

$ lnstags inq-at def mini.lns 10 5
@mini.Foo.func      2 mini.lns            pub fn func() {

これにより、指定した場所にあるシンボルについての問い合わせが行なわれる。

上記の場合、 mini.lns 10 5 にある foo.func の完全限定名が、 @mini.Foo.func であることを認識し、 それについての def 問い合わせを行なっている。

なお、inq-at を利用する場合、 指定の lns ファイルがエラー無くビルドできなければならない。

また、指定の lns ファイルの AST を解析するため、時間がかかる。

inq-at は lns ファイルの位置を指定して完全限定名を取得するが、 suffix はシンボル名の後方一致で完全限定名のリストを取得する。

例えば func に後方一致する完全限定名のリストを表示するには以下を実行する。

$ lnstags suffix func
@mini.Foo.func
@mini.Bar.func