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

「#@warnタグ」 プリプロセッサで警告メッセージがでない #1258

Closed
Yuki-book opened this issue Jan 19, 2019 · 7 comments
Closed

Comments

@Yuki-book
Copy link

「#@warnタグ」の用途?

フォーマットガイドより

#@warn(〜) : 警告メッセージ。プリプロセス時にメッセージが出力されます。

原稿を書くとき、未完成の部分に#@warnタグでTBD.を書いています。

[testwarm.re]

#@# コメント

#@warn{TBD. 後で確認}

プリプロセッサで警告とならない

プリプロセッサを実行しても、警告メッセージは表示されません。

コメントと#@warnは、同じ結果となります。

$ review-preproc testwarn.re
#@# コメント

#@warn{TBD. 後で確認}
$

EPUBビルドもPDFビルドでも警告は出ません。

改善(案)

プリプロセッサで警告メッセージを表示してくれれば、まだ原稿が完成していないことがわかります。

コードをみると#@warnタグをチェックしていますが、警告メッセージを表示していません。
異常なプリプロセッサタグは、警告メッセージを表示しています。
これでは、コメントと#@warnタグは同じだと思います。

[lib/review/preprocessor.rb]

        when /\A\#@/
          op = line.slice(/@(\w+)/, 1)
          warn "unknown directive: #{line.strip}" unless known_directive?(op)
          @f.print line

修正(案)

        when /\A\#@/
          op = line.slice(/@(\w+)/, 1)
          warnmsg = known_directive?(op) ? "preproc:" : "unknown directive:"
          warn warnmsg+" #{line.strip}" 
          @f.print line

プリプロセッサを --replaceオプションで使用すると、警告メッセージのみが表示されるので便利です。

@kmuto
Copy link
Owner

kmuto commented Jan 19, 2019

たしかに。
これも初期からあることになってるディレクティブで、gitログをおっかけてみたのですが、一度も実装されていた気配がないですね…。

@kmuto
Copy link
Owner

kmuto commented Jan 21, 2019

どう出力させるのが妥当そうに思います?> @takahashim

@takahashim
Copy link
Collaborator

確かにSVNから移行した(最古の)バージョンでも、format.txtで、

#@warn(...)
    警告メッセージ。プリプロセス時にメッセージが出力される。

という記載がありましたが、使われている気配がないですね…。

とりあえずreview-preprocでメッセージを出させるようにするのは悪くなさそうですが、それで十分かと言われるとあまり自信ないです(review-preprocはたまにしか使わないので)。

@kmuto
Copy link
Owner

kmuto commented Jan 23, 2019

require/provideも実は実装はないですね(たぶん青木さんの手元ツールのほうで何かやってたのだと思われる…)。こちらは今のpreprocのやり方では無理な気がしますし、単純にマニュアルから削除かな…。

kmuto added a commit that referenced this issue Jan 23, 2019
@takahashim
Copy link
Collaborator

require/provideの方はreview-checkdepで使っているかと。

@kmuto
Copy link
Owner

kmuto commented Jan 23, 2019

む、そっちか。では削除のは戻しておきます

@Yuki-book
Copy link
Author

対応ありがとうございます。これで安心して使えます。
未完成の部分に#@warnタグでTBD.を書いて、原稿書きを進められます。

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants