From 46b5d9c9ea797a069281088f1b8cbd65f71bb862 Mon Sep 17 00:00:00 2001 From: Adam Kruszewski Date: Fri, 2 Jun 2023 16:49:13 +0200 Subject: [PATCH] Added readme file also fixed some minor issues and polished some comments. --- cape-jinx.el => cape-jinx-completion.el | 24 +++++++---- readme-images/cape-jinx.png | Bin 0 -> 10054 bytes readme.org | 53 ++++++++++++++++++++++++ 3 files changed, 68 insertions(+), 9 deletions(-) rename cape-jinx.el => cape-jinx-completion.el (84%) create mode 100755 readme-images/cape-jinx.png create mode 100644 readme.org diff --git a/cape-jinx.el b/cape-jinx-completion.el similarity index 84% rename from cape-jinx.el rename to cape-jinx-completion.el index f515062..b1cb6d3 100644 --- a/cape-jinx.el +++ b/cape-jinx-completion.el @@ -1,11 +1,11 @@ -;;; cape-jinx.el --- Completion At Point Extensions using Jinx spell checking -*- lexical-binding: t -*- +;;; cape-jinx-completion.el --- Completion At Point Extensions using Jinx spell checking -*- lexical-binding: t -*- ;; Copyright (C) 2023 Free Software Foundation, Inc. ;; Author: Adam Kruszewski ;; Maintainer: Adam Kruszewski ;; Created: 2023 -;; Version: 0.5 +;; Version: 1.0 ;; Package-Requires: ((emacs "27.1") (compat "29.1.4.0") (cape "0.15") (jinx "0.5")) ;; Homepage: https://code.bsdgeek.org/adam/cape-jinx-completion ;; Keywords: completion, spell-check @@ -27,20 +27,21 @@ ;;; Commentary: ;; Additional completion backend in the form of Capfs -;; (completion-at-point-functions), using underlying C module distributed -;; with Jinx just-in-time spell-checking package +;; (completion-at-point-functions), using underlying C module provided +;; by Jinx just-in-time spell-checking package ;; (see https://github.com/minad/jinx ). ;; ;; It doesn't need Jinx enabled, but it uses its configuration -;; and C module bride to enchant library. +;; and C module bridge to enchant library. ;; ;; Having jinx and cape configured you just need to add: ;; (add-to-list 'completion-at-point-functions #'cape-jinx) -;; cape-jinx completions to your completions-at-point-functions. +;; cape-jinx-completion to your completions-at-point-functions. (require 'cape) +(require 'jinx) -;; jinx.el version 0.5 required +;; jinx.el version 0.5 is required (defun jinx-suggest-for-word (word) (when (not jinx--dicts) (when (not (fboundp #'jinx--mod-dict)) @@ -53,7 +54,12 @@ (cl-pushnew el result)))) (delete-dups result))) -;; cape-jinx (based verbatim on cape-dict) +;; cape-jinx (based on cape-dict) +(defgroup cape-jinx nil + "Completion At Point extensions using Jinx spell checking." + :prefix "cape-jinx" + :group 'cape-jinx) + (defcustom cape-jinx-case-replace 'case-replace "Preserve case of input. See `dabbrev-case-replace' for details." @@ -97,4 +103,4 @@ :category 'cape-jinx) ,@cape--jinx-properties)))) -(provide 'cape-jinx) +(provide 'cape-jinx-completion) diff --git a/readme-images/cape-jinx.png b/readme-images/cape-jinx.png new file mode 100755 index 0000000000000000000000000000000000000000..666b6a3373924a03a043cc4f681a7ff0f0bbe63a GIT binary patch literal 10054 zcmc(FWl&sAyDfpB!Gi?%;1HZZa0tPJI|OHNcL@+AAwhzBu)!S$cS{I9z!2Phkl--D z*}UKV>YTdwoIkg2)%^i8U9)%Z?%q$YXRY=0=l81eI9TLZNJvOH3h!h!kdU6N0pC3^ z(18E?xjYKM#}juAd1<7|QOaGQ@zh32MG6V2CiWS^3>9c&y1dhOM?xa>c>H^^WKH9P zg!FP=K~_r3#{|BJX+(T}BXJx{drObOg8YTODbIF`JEeZAY_Zcgg+#L|Egih{H~GFS z!>hs6!1uSm%1EJxbM$RTh5^@S!;KDhwhy#FV^~BHTfWw4W3MUW!f1bt-JYkzGSm2M zGS57+eLI%7Z?o*Ku`uX9;pa)~f$V`#X)PqoK4}a(S=8^69FI-f|EY<5swHZV7P8YqGSNE$rXCS~sq9SFGYpk!1SA~857C^KG zK1D{ZC#Z=}JpQI7M;KN1DmXZJs$5@lo=_S?omjg>Qh8+1ajrfjBZFdLaq;>*6!lrX zx3+u?Wk^GVfJyM3r(^8i&P0B7ZEa7ndVamw3fOkfrZAktsHysc;j&FBBTRDVbSn53 z-ng8np8vMGu1*F%*TD0k3rSW^4kTYvY1AAVf`Z-ygOTFm;<|Wve9Fn8vDsy1Wt~$m zEz0&A+95BD)x)4Gg#gP3_bi0?o!jB+i20p$osLP2Nu8&d26Yd7qo}d`MTl$Ag8BUA z%5UyY*>~?SM7$2778Z=^otLQ_ofdnV-M8Q8zr_)c3B4#(O1V0>uWFC5$@WF-jlfxV zG`~vMbHgEGG;DPGc5vW;O~(6)Pxt1u_XS;9pA;7HU)sis#h@%5+Rik^kl43m)^Q*2Ae!3=Iv3v&9Vki_SRO(YU#};nQLsoc~NA z=xP;xs=|;oUp_V>G7?=#JNRa|s43{K#p^Lh<+Xv%r?zj3BS2s33nY8<*87r%+PXS|Y_Dx|+W)&UnR5PBtTWUNb=OD(%@0wmB3SeMhculL8 z&adFFi$T|yUp(}5?Z*#VN?{kIw6wH2YL{fC>G7lX%WQ}|F%{Lf#^oRiHHkZZ^jiHo zYqRB!z*HgUY%f`}sj7gJH95!MZwt`c z;<__Vhg%#?!nwAp#=r10jtTYw6RR%~^#Sf2+>5wA_06Tg+=~UTy^=}X-G7$5A?P@_0V~(%TOJ+dT3%k32;Q42nQLWZdT~;n4T6F}{#vj~<8?D> zAVf#UMnGH~z}Wio-yzrF z1E>?ii2n>&BjW$9S^Tqf_g2N}5jms2=SSYBYC6zXY8J&nv|ncq3k7|Tf4rA?DyCV_ zk~SF(0+2)(8(zNC)7L+7_Xm~A`$@{EGcu4o-awo}kfKj3?z;Ar zo}RwGVltN&G0ZncbbTfH57d_Cx#9JleWLYiAvifd-()6R#1jjk!*7@zmf8;c%Z#t4zlcPU7_V;sBPk5=~V8MFJbp)u$$-ji5 z&1Eq8E)X~n;Xt2|HK#g@9AIs+GEq%+fDg*F@Du8 z;96kihnonpBQ~RZTvqG(6P^Lt!R>Sb6Sr1DsM6m5YvDp$$iY{S*;&yaZ?jtFmcD2^ zg*15|E$zUnawaAVl}O=>Lymj%o$K2b!L)obj&4<0dsiZV&25}3-~`f9gKFloFUlPq z)O(AvA%m$(6(T-%ee<>w9+ai}+A&62yle7(%%|BKh5B)=5P4um+*1dcFIFH^DNWrSGrF@kuZVvq{W@K#KES>J~r#3vgO~hm8 z{hEY4O^3&p4?U#fo1~Eg+N4I^>XsQgjf8yLnE`{ze#i9~D&@66@?{|ZKBiWq`jIGv zEyuX?Oe8b2%wjI{!leup8CBMJ()m30AwAZ+~16K_ueH7$rW>u(@ z@%(NfVnEIAv!I%vo#7?rLJiq(n~|=OsQspdbYyN*3I5=<;8!>KWXES06EPZ|?o|<; z*fe1uXB=w~zsaJa?@>kt7RGC3m=SlU&Bx{IWmK%6@RQKbue0?|P5I#`q*I_jI`hwD zb6!U%bvgiP0RA9CGMe4cz^QGbihD@|bDG1#b)p{H4wAPvU@M(}-PLX)^VI98Hzf1@ z&YQo>e-P=s4#qQ!qQV`1Jh9kVK_FoVsx05&aAj9erCs^}g+y^3Ga=9ZI9$99PKO{0mEbpNyn$vzt)z>fhH{1DnnFY#gjD#qA zkc(Hts+`Ty2jl87mrf?wkNIkZNYEeZ@Tmfhjg2jLq@t~(Z;C6^oY{c{w_a~gn`>+T z0+9Z#)!VIU%nyzStCqiRqjQH@kH#;~^Z2@$ZjPx+K1?{9ADpGx!Wz(n^c#_#&kw)8 zsn}Z_ZyxW}Yh6)7`0l)G6R;2zIrG6qhd6b?G?!s909p(&@gT6O>}Q;Z?XwbWIQj21 zB}_8k*trTikblBN{kxFqz$h_nimgnC(gsLul0;GP+jd!m;gCv5NWd2-=Nqo^OwjqOLS9RF z^dN|hUtJEWVmPc0bnn9!g{}jo)3)}Vg*G|dZg1Y<+Afc@emXdK zmiKPw%L(0NS)<-!UmCjMv@B%4QO=pCex~Eu-IHWIo~y*U6wJ#X0%JTd$Ev#R(4cvi zwBBJbL-s7uB74N3`Dr(I2in6$)+)smwdcHe|83GvS*1Wj2I`3j*8ws!zfEK1 z+NmZ!#GCc{{es)GzL1cR@Ruh)RuDhV9O{%}MNrdzBt+wgcwcV8iej1m8pwCYr+c`& z|2^rKP;({O*Z)l&W-9c6r%sq`g0egF8(rKp>q`TYs#6-mX>mzpEN?MqJ2^&zJE!zp4er-8dcfp+IFG2U(h_w>`xY`<(= z8O|jGyqB7+Q8SK&=C@QmO9@XfEi)gAz}?8hy=E>c>PbYFpRKcJxA)_C@#8nrIaiZ%TPC4ds`cdV7n&2r(jOJkd{8 z4;2W890kEW8i=gh0%wzd30V`JkfZ7Mw3WRr->L>l-NgZtKP2MgG60xH^c}x4@#kj| z!H4o_v8vp)gC{k=y9n`6FDWM58|)+zxh7@QI#Nwr4&e)^EvqO>A{vx1_C)&}5-#r& z4QU}B(y@e4^LWrhMaS$Mab=>C+L)AGExBYdKj*#9sw600!zhf}Ct61T@35Sj+3>Ac~{kgIl*WV0QFKK^sy>i85AV6r#%(jP)bYM-Qq!_=x06AOhL<|?N(`RfOvGXo@pZqI{-u+nq} zqD92PYJcwVLT_XCL#efDt7qNMuW7YbhRilhspPS1xvTFJ%cuB3f5CZ`d>OhfHOUVN zYNw2JC%V%*>Pkrpv`!06JZiJKc*gXb0=bc~ge6d^b3~(+&{b zM~0NgNUB283pHNC4|8?ACuPo6#pJJ@ zk?Tp&c{da?(dtX#sAl##UQtrJmfiiXm*0W)dcZSC&6#y-Hx07NVWgGn>9lWG(BJ># z{9|r0tdgO;RCimyT`_;is&5SE{R3}LuhV)K4A<(-6^@}n z^9EaIkeRKF&#j1gpJB)w!OOW#Eou!*)m|jeA42UC7fC1xo3Fv=v_}ldMqx~$b0t&= zEl;tx*Y3-dgrPh`&5d?4RcCu3D&vHXoep*6=G}YJr5CZ-n@%ncV-MZ6`Z;FM@2IJF zhZ%apo5nt{ve=mRob7dhX7T2KR9LIb?46EVZ1Os`$<({0qK~CobC?~e67Q^vZudYF z8q3*WdW-peDnJ?4xSq;?*F?8O+~HUKcr>yQvCG6$IzO<=pOa>|y$_3KSx1-Ck1@n$n1py$cUpbw;z3FJ)1Jky2URf^T#7 zrqQ7(P9K$UyvvP+DNbLibWNBBNjG+In;piW$c;)e0EmrAtfVf-r&3Db`Bw;$%fWB- zvonyCe_yPNC8Kby>{N8dRe+C^|B~OTmekvM4Lu)V zLr1kciqN;lozq(NWTRFPekV=-Q(vVdKkEuH{|j0H0qyw~2|rnS0b?j%H0W)G<2-~; zt+{SzwuZrOn$2j!K1RF_09Fk3q{QFD28V~qBcRNLgs{8Y%k`-eO<}hU40JR0Ofmi46vuBd1Oz5<|TeJI7oWoUT$_*~ETvOe=}?UlecJTDKA4OoBf$shn}-Q7>b#lh@%VeJcsm~_;ptE;OEn+kGWTjQrkfK~K4S0?iB_@5!kpavR({Vjp@&0n;n zjwZm z{Jc#b!}?V5&2PEJM+JL}vmH~{#=bml{;Ndr$(}KGw#(;b?x7Qv%LwhHGxFl)WW;_u zny@Pu4&Bi98e!eau2Wc1jz{lo_mYd3R_Ch|g+Eu;R@gC_Z55e(k$i5X%=S|nql^0> zZ|r?jrRFfrvXRe0PBL{bg=AsO-<~a@;ZjBc9>?0>&EEjzPhXVYpTq{Q%sY2(Zc+9Q zYH*o$P@Zm&$y-`7>NdduKcqJjZ(CFWfby@!W8UX`(>s6am<=EfC2&;0xe3b&zSp1E zP=9-{yIbN|;^yYo^pF}s*4)~<4tPE9l$6%35B$#ea)DQciaJ0flER_iQ-u>udbHFY ztzD*ba8FE?n+)0@k)mD7p5TTAJ?(7=dW&So@YRaNSlplR$#oyLJ&ZK<6K%cc$3xRyym z0x8tzZs3QAaGMCmZ3;T;Hm-Dr^`6AmiMzK?1)sO$*85{qw$=I8&zN$m|iV4Veg8+~c(9oDVWaiq? zSz23@45fNbbt+4>0Vp;{O`Mf7RcV|76B()mEhn+-R@=k4R2|T;Uv!PkCHoYsK&^P} zb<7oUtBQtWSYC)K{noO|=s1L;>G5-mHDl74BM67?U%16YK;} z))&wAgiI0w3PbFeB=SqS7l+elvZI;7AKUHYY+abUWWKY+-#^u8_B8!0uP+9L8?c^j zfm;0YKibc6s1#p^-+TjrNY_@s#ys3B@lhR3l`B^SN1StkS@5B^Thtr{LQ4Bk&V3e8 zt~9&*lkA&MtQ0Sa+Di1>`2V5qctQ^2H|w+%wF7eSLXlW{uS8Y&+LRVWhQb zBI9^-=dg;y6~*?2+I9q%ka9?_xK?DEP<{E1*8o*ybrE)Vd`J4^ALd@xST@2?C?|CZ z*!-)lLUzeu4%mXS^;DyjcaRpHtrK88eR12HVl`^@QUQRmx}ZF%W$X(%h4P}?RKJc< z9Y3+|gs_E7eNKd28k#xVUY?HhPyy%+PlZrg-xZYjFV^jV=;^E7WrCk00yLm3%Bio( zUs^qWmDsuS*PM|n+Fe|#U%BW!?Jy<|D|hhZCGc;xJHF7$XyD_eaR?|?H4Pg-v<^cr{z65YLU?qeTR#!DPj3^47b#?0% z)ZS)dcT;nRZ;uklX|EIRf)}R_;>W8C)1s%FWd}R=qHj7bQbjtbV@JgNuVW_0>0~%j zrh<_CI-y;fJH-gHF-ITjA}&T&CC*f2=br`Fu1N$vzV|Gs74nOs(e~t zKS{c{@$e~QQLR`ZB6PPN1Z`3XN3MI#Z<2a*RT5Za&ry}7 z-RZ}RW8>oRofbvC4qlK8I_TM2;*La0p@Qq*#}#Z@u(jpEl~N8zD01-(c}M(MT{Mx3 zkSc8E5{KWfvg26o%{OwBI;j5uBdK+_@q6;m(6H9S-tL%3vv-0YTv{}LM6>>qW?GDZ zZ=aDWJj9=o+9;$6eS3B|K7d+t@@L2x^Za3}TOYIh+a3Jm!oI`DpzJO9>)(;sN_s&$ z3b=vrdRUF;>vtLu!}(q`|CoZ6ss2_YZMf!qQ{0#Ih!S2AxD&NaZp@GkqRsJS(tYn7 zVD&#?242d&Njq;PNePlZXQ5B636NLHW@ETXdD^ox7H$w_!j@*ROsF9{i~Us3<*$0W z?@b;~503J$Z?O3`4>A#da z2ge3Te_tdMK;zCY`kBA5-&`#M)e7n(`>UstcD!I(m687X_bS-^lz|z@RpN-9jb8~1 z4vYEnc=_(*9qWU!>z|pkSFYr8mYdy~AB!hBLTopAv})a1p|#DqEkr2MY#VIn!v_4X zpWa0#5#0@{3%+$cPMm>Kq24ulAI#Rg&uDuzvRPPD(i%9ZnB}}_ZZD6vV=frvV_fjT zTBiR=@RcnphLb*$MvBapyv`75!psVr^Z^{EHP>@Vyucr&26pU45T79zr7y@$RaMS4 z>+S#4f#h6Opm;=4;lM*&gNgs1F+IBf3pr2C|8e&fXdk_Cwz&V*Oaj%AjCe?o`4^Ze zCXWw3hkjb*%>?vAU;b9EmJ0MuANaYe;g`@?BOO+|SC)@G@UmY@W@cu74ZOWLu_vc- zI9&Y&wngxK6Z3L$`4}6EX9G=CfKm>2cX!XJ15c8j);;V^*|~;%+KP8t?huoBdlVFX zU(A|rTn5l9R6L8BF(4^Pzrh`1#D~gIMy+bH@9_BXCl#)mbN!rz@?(gFe9m^Fb5{e( z8$OwdhSMIlwk){RZ*1!`#r$>r8(*a#)@l~1B0gG~HA4c`j%yzpi5z2jgoK2YQ(sBV zvzerD8DIJI$^nKC>J(GUhi>HIbb;s`86&cv$4q>cpNiI_<BO;qChKnKBAS}SZbVI3 z`|3e)kl9*7?a9c{3(D8NhOcdKZ8o@6XNn6mTVc?{7c-s7ZsqBJLvw}#!*R*tfr`_2vRuo>(?sRYjW$2 z!^0S8k=m&T(An7=pRC<#hrS%hn~U#4w?M4Gt)lIPcoSDB ze&5n3UXoVmn5t3h#-gw^yKquDRZja(ycW?TKHyt${w1)p#ohWjX?{(3c58#p^aayL z&C|=!O`!&ckFnPB=5V!>fXc7s0m5^Js~1^DM!0H&3p9B(ivQU8I+*|u`qYxYAr#X&4iw7P?ya!)0R7!pYxTQ6AK0)6fynk6HPb>)UVy>-B){1^Mh=#>WTC;H8lw+ z$_9vTs1^a1&z#2Hb}TK0-;o2j(KzJ%EBA7}{bOTl{*7nJ&KhCrF7C_+*EPh_I*@^- z!isT7I3I7)N`sj$a;F*#H1j@2!Y2N~nDn=t9!)TD31v#8_}Gl>nCfL|2tbejUy=O& zTyVN^tCwrCsNEC`P(h~vP+=3K03dEIl~r1QG^zUv@H6MYSF*5)e0g^yaH~2N0>I(w z_s0ch)!>oQDbs~EUw7Qh#8r}MWZM@%Su+ZKd5Wjs(~RVg1?NKfjO>WPD@vU09zj?= z{EUqS0C7V{LnBG=3ky9Bo2(nT7ZZEN+fB|jJ<%A6-YM?0&@`DA${?@{cvlu@k!G3w zH&eC!xA}^}njdxr;z<4dN%-~WXZ3P3W&$X4e5$UOruD^Ohhe`m?;_+ZyTE<|9QPbZ zxfF9NrblGUoBE{yJr5rMUBc&6V2@SihQea$_>SVwpFcNw?(1|*pGM?J1e-j{mm%1H zGW-GtKEAs51LgTZRIHsDf}%#1>|m86_Ec7|`lF#F_RNj<)^C7=B~CMtJ{iY!u4w%_ zLQOXxF)J_G?pb{UFxx!iORfZ1!~kw(82B4y^Kz1tEtoy6GGPWVy5RnujGV{UBZ_HNp!B ztGAMpA17)-(3kf#kA^(j|4HeI{;w!~?HsydAxOO@9Ho#+(H+Ncg%g)pAFj7R$hTAx zD>deytNro$B;Vg^c1BE#qED{z`o27lZmg^~3w2}S(VqJ=#0JGI%8vuG(*dKSPi(xG z%av3<%J8p_TjFpOu}t8#Wvk~UT`5sZtu>SG&PeZ9%3nZs^*wRXj4pc_bH=yFV9eLZ znmlY9N@I<7d>a8CY3-KNJ`|V&FOQKdt%Mfm?eP2x5cA!w%w-I^5y141Wz5(9@q8(8 z5pOw|pliGE-l5j7b?%LZ!IYwz;@BspThzQD{1&AGJ8Ac5eCfnOAhe116!SkQ=(Br% zCKeD(Eln$#FK@C2u~kkQVtW23bx)S~|4!ZGA33U`psXpQwCT#^kB$ext~q_c5V89X zKI%zi)vO0Bw38LvcLz)D{;!3}Mf}cK(BHECWWx%Kh@eb+)_0~)9;6^=1g;4413L;2 zCu7w?oEC>ZV*|XMhg8fy#LikVf7bQ!P}nCH3csX=5_*)!6A^Snrb+vcrxoa^nFt@r oP!tw$t_!%RSn|Jbq9AAt9lh0WwEj#3XWx(%