From 86925d19766589d4c56ce315c0986845d4780929 Mon Sep 17 00:00:00 2001 From: fmdkdd Date: Fri, 25 May 2018 11:55:28 +0200 Subject: [PATCH] Add quick-peek customization to README --- README.md | 33 ++++++++++++++++++++++++++------- screenshots/quick-peek.png | Bin 0 -> 2038 bytes 2 files changed, 26 insertions(+), 7 deletions(-) create mode 100644 screenshots/quick-peek.png diff --git a/README.md b/README.md index 5fec67a..bd0c7b7 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,8 @@ [![License GPL 3](https://img.shields.io/github/license/flycheck/flycheck-inline.svg)][LICENCE] -This is an extension for [Flycheck](http://www.flycheck.org/). It implements a -minor-mode for displaying errors from Flycheck right below their reporting -location, using overlays. +This is an extension for [Flycheck][]. It implements a minor-mode for displaying +errors from Flycheck right below their reporting location, using overlays. ![flycheck-inline warning preview](screenshots/warning.gif) @@ -37,13 +36,31 @@ flycheck-inline RET`. If you wish to change the delay before errors are displayed, see `flycheck-display-errors-delay`. +You can change the way overlays are created by customizing +`flycheck-inline-display-function` and `flychjeck-inline-clear-function`. Here +is an example using [quick-peek][] to display the overlays which adds bars +around them: + +```emacs-lisp +(setq flycheck-inline-display-function + (lambda (msg pos) + (let* ((ov (quick-peek-overlay-ensure-at pos)) + (contents (quick-peek-overlay-contents ov))) + (setf (quick-peek-overlay-contents ov) + (concat contents (when contents "\n") msg)) + (quick-peek-update ov))) + flycheck-inline-clear-function #'quick-peek-hide) +``` + +The result: + +![flycheck-inline overlays with quick-peek](screenshots/quick-peek.png) + ## Contributing We welcome all kinds of contributions, whether you write patches, open pull -requests, write documentation, help others with Flycheck issues, or just tell -other people about your experiences with Flycheck. Please take a look at -our [Contributor’s Guide][contrib] for help and guidance about contributing to -Flycheck or to this extension. +requests, write documentation, help others with issues, or just tell other +people about your experiences with this extension. ## License @@ -62,3 +79,5 @@ this program. If not, see http://www.gnu.org/licenses/. [LICENCE]: https://github.com/flycheck/flycheck-licence/blob/master/LICENCE [contrib]: http://www.flycheck.org/en/latest/contributor/contributing.html [flycheck-rust]: https://github.com/flycheck/flycheck-rust +[Flycheck]: http://www.flycheck.org/ +[quick-peek]: https://github.com/cpitclaudel/quick-peek diff --git a/screenshots/quick-peek.png b/screenshots/quick-peek.png new file mode 100644 index 0000000000000000000000000000000000000000..5c3745268b49114a4a830bd19e8de5a589bbf386 GIT binary patch literal 2038 zcmV004R>004l5008;`004mK004C`008P>0026e000+ooVrmw0000d zP)t-sC@3f$AR#0qBtSqwCnzbps*{R)XKk?0-p@%@YcHPAjNWQV|Ns9!_5OYU0004E zOGiWufwNI#0000GV_{Bq000jF000EA000BP0000Byne7i000LiNklG_V~}h7G!1Y!Aa7t~_67l7AajV>_iQq|pmx06EJ%vfqt&f$wVby8f8*%E zhd!68_=sGeK2a1!Q4~c{6t%g2qc+v2-=ChIK7-my3Al20a9-t~uXxV?dVVFX)quOv z`3(FSz-vKI-4Qql{EooCI0u)!in12U0S<63QGO=ydsw)G0|2EI01E|JSOVV!xN;M~ zzme75fLmHPfq!_H;w&sIM=5s#4h{={5#XF@ZVj9w@DBuhw1h?77r08m`ztGx>nzF< z-KM}T_%f^mTsf;;8j%Cm!R4cYO2uL=a7Zt4~@RfkO4!CnI z@cyQdwR9s!=~z+GAkcQyl8&J|zMcPYw&z_*@h68Ofz z>BTn&P7(N{0iRvGq6fLlun;)4T-C)$MfA4;4+Op`@Njr*fY-&V;fkPzg;G}8JlTY^ z^fT80KfHy>nP#!+`hVaYoU+Px7On{VI+t?r4RBZ22m1!D;9L*5<0ix^7LEb%vLHJI zt~k|P!-tPuN@L*|0jEp3ZIse3UJZg~^5JmK7GL5Vfv-B#{EqLlMLlOjs{(&{d6_M# zwWb$ecP-_dfqUXx7dS=W1WsK8{EvUAtwi7iz60R&;S8DtP7(Mc0}mb=XP2r%?`V<6 z1;SJv!S4gO1{&af^tuw$YXbK`2tFb92p&3IQ}N>h$M(QIprHZnHFR1H+X?UxfB^Ua z1dothN6^sF2=$~!GDDP;K0s>^9TK?Y6Lh`?pRe@`6t_`;2f*(Rcy=iPUU%r=eLYGz zbhjw$)13icdtHu@3^pJ6?%JS0uHOS8Kx+++y#n{yL`T3wD8NH#`T68#JiOKo@a`nK zSHi>V5a0nFLTlkVkq!Ym>=O8th3nSBu?#pG3rD%u0QVXpyQ^JVxIPPf+QQ-egiFC> z0X+pMzB^{7~H$hW}flFyy7!L~p?e_!xJzDk)&Jy?v z+VxD6OB@7F;1q#BEO72=aub=rDel@cXi^0Jfq?(`@#9E-w*g=Dt^E-o@Ed_I`t+N? zuLT|nd{f}@>(2)G<=@&Lojvj^wkv>t{TUnJC;xEX=v(_E6oFsoQoc$9+@1QvdBab? zkIvDhtYP7pw(t?~f1wEcb{~HFPeTsBwf~nc<@QlZ?_2x9pN1TMYkzc(z*n7Vp83}P zC?N1Pfxo=G%;Nmdm?OWnU(>?X-&{-C6gWlT1WsKAoO_zwL?&>GyY>v46oC^sfzJUq zXD*oe$_)S`XKz_9xu6c2J{9L~xS~}Pr=BV<1}M}{tqCmPX znartHCXjx2bAiT+3veSa=3?Li0lM2O)_i2dAl7RWzEg5%jcJOflY;&=BV8>9`C3=J z--&EU(rYidl+sYGrIu@oi-_skhd@$~Bv)*Z9!x5#QDwEeO@Rv4BpVPB$P(Z{jHiL8 z=QJ=7sTLlqg-fx&3f#mFc)GIy2M}Y6s@&OYFIIz=UV9aIttFXn?&k^M>G@!~s=GUj zPcWwGM0c{rK!KPT)3e2)h3AIqdvp%CnX~XI;HK6prGqVSX)GKA;L`Z;N#jCm-_mQZ zweV{AeMS?&O>5y;1{{rrqdsd3JVH#&9`rJoav^YIFbUku0yiVzG7r3cjc0%_a4F`L zOQ~!jGT~A%S-=b}ydf|&sNu(X;NIgB5;bp9|Sn}G`WdP;1qZ588j&ZCvXCPdV2c&jUYC*@K=)9 z4tOB&O@W8Q8-Z^L{O}eCd|Q`t@OUP1S~z_;#Zk(`j>DP2dsEu_fMaFg zdrVq?G4ScU_A|NbLr6)|nY8{Umoms}e^KuG!JYd~TE7(dAg}$YRO%_qy@qDe`W1kW zEPNt&J*vGkY5k4B^$hUI-1Wmdcb&9;5%5u7`?=ipoueqf8YZoO-h($ literal 0 HcmV?d00001