Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Snippetの依存ライブラリが指定できない #10

Closed
pm-twice opened this issue Mar 10, 2020 · 5 comments
Closed

Snippetの依存ライブラリが指定できない #10

pm-twice opened this issue Mar 10, 2020 · 5 comments
Assignees
Labels
enhancement New feature or request

Comments

@pm-twice
Copy link

例えばlockを用いた高速なScannerをスニペットに登録する際に、structそのものの登録は行えても、
スニペット貼り付けのたびに依存するライブラリであるstd::io::Read, std::str::FromStrなどを記載する必要があり、少々手間がかかってしまいます。
アトリビュートにuse,libなどを追加してそのスニペットが依存しているライブラリ(もしくは単純に文字列でも)を登録可能にはできないでしょうか?

docアトリビュートとgrepの組み合わせで似たようなことができないか試しているのですが、rust-docのtest部分のuseと被って抽出が上手くいかないのです。

@hatoo hatoo added the enhancement New feature or request label Mar 10, 2020
@hatoo hatoo self-assigned this Mar 10, 2020
@hatoo hatoo mentioned this issue Mar 14, 2020
@hatoo
Copy link
Owner

hatoo commented Mar 14, 2020

#11 に実装してみました

cargo install --git=https://github.com/hatoo/cargo-snippet.git --branch="prefix" --features="binaries"

でインストールできるので試してもらって良さそうならマージします:+1:

@pm-twice
Copy link
Author

pm-twice commented Mar 18, 2020

対応ありがとうございます。早速試してみました。

#[snippet(prefix = "use std::io;")]が無事に出力されることも確認しました。

ただ、複数行のuseが存在する場合に、改行コードを入れるとエラーが出てしまうのは利用上の注意書きにあった方がいいかと思います。

初めに複数行出力を以下の2通りで試してERROR cargo_snippet::writer] rustfmt returns non-zero statusと表示されて戸惑ってしまったので。

#[snippet(prefix="use std::io::{self,Read};\nuse std::str::FromStr;")]
#[snippet(prefix=r"use std::io::{self,Read};
use std::str::FromStr;")]

;に対して自動で改行がなされることはReadmeあたりに書いておいた方がいいかもしれません。

#[snippet(prefix="use std::io::{self,Read};use std::str::FromStr;")]

あるいは、見た目上で2行に分けて利用しても問題ないとも。

#[snippet(prefix="use std::io::{self,Read};")]
#[snippet(prefix="use std::str::FromStr;")]

Rustをまだ学習中のため、的外れな指摘だったらすいません。

@hatoo
Copy link
Owner

hatoo commented Mar 18, 2020

ありがとうございます。

prefixに\nなどのエスケープされた文字列が入っててもいいように修正しました。 #11

;に対して自動で改行がなされることはReadmeあたりに書いておいた方がいいかもしれません。

これは出力の際にrustfmtがかかるのでuseが自動的に整形されているためです。
rustfmtがかかる理由は #2 (comment)

ドキュメントに後で書いておきます

@pm-twice
Copy link
Author

ご対応ありがとうございます。
こちらでも無事、エスケープ文字入りでも出力されることが確認できました。

@hatoo
Copy link
Owner

hatoo commented Mar 19, 2020

マージしました。
何か問題がありましたらこのissueを再オープンしてください

@hatoo hatoo closed this as completed Mar 19, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants