From 170a56443782d9ae93bf453ccb63e9ce91e88c97 Mon Sep 17 00:00:00 2001 From: Bertrand Martin Date: Wed, 31 Jan 2024 23:01:35 +0100 Subject: [PATCH 1/2] Updated site to use Sentry Maven Skin --- README.md | 1 + pom.xml | 13 +++++-- src/site/markdown/index.md | 5 +++ .../resources/images/sentry-logo-white.png | Bin 0 -> 8987 bytes src/site/site.xml | 35 ++++++++++++++++++ 5 files changed, 51 insertions(+), 3 deletions(-) create mode 100644 src/site/markdown/index.md create mode 100644 src/site/resources/images/sentry-logo-white.png create mode 100644 src/site/site.xml diff --git a/README.md b/README.md index c953142..08c28ee 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,3 @@ # printf4j + A Java version of C's *printf() functions diff --git a/pom.xml b/pom.xml index af7578a..8676000 100644 --- a/pom.xml +++ b/pom.xml @@ -10,10 +10,10 @@ Sentry Software - https://sentrysoftware.com + https://sentrysoftware.org - https://github.com/sentrysoftware/printf4j + https://sentrysoftware.org/printf4j 2023 @@ -199,7 +199,14 @@ maven-site-plugin - 4.0.0-M13 + 3.12.1 + + + org.sentrysoftware.maven + maven-skin-tools + 1.3.00 + + diff --git a/src/site/markdown/index.md b/src/site/markdown/index.md new file mode 100644 index 0000000..a99cefa --- /dev/null +++ b/src/site/markdown/index.md @@ -0,0 +1,5 @@ +# Getting Started + +This is a Java library that implements C's `printf()` function and mimick its behavior. + +More information to come later. diff --git a/src/site/resources/images/sentry-logo-white.png b/src/site/resources/images/sentry-logo-white.png new file mode 100644 index 0000000000000000000000000000000000000000..a29a6ff77a33be706209b89e6116a4892aec88df GIT binary patch literal 8987 zcmd6N2UJtrwl;!*bg3fU07@qbHAsihJBSnkLx>Q8BqpI3MIb039R#H+Rf>Rsfb^mi z1u0UMB27dDDbnE&>hYa(#=UQx@!$8xco`YVUTe>?=G@=>*390yYht8LN6kS^LPA2P ztD|W~LUKZkc#J$nLHxXx!NWsBLN$rBu)e8ZVeV^W0rz!+uaR?Q}9*-{IIJ)JU*V51n~V3!MiE})Q%nUSs9w}X`rzPJ{buqaX1hJ;**t? z07=Wp%7VoBz(5dK5=eZ@ii4yTWMmbpU(SdlC4dVak5Q16 z^z!nO@RE{1W1S^I5D4Vh2pB9*ln}@HpzttnaTJdK*u+m8ng|>mi^SlOXcXVEO_(Fv z1Fr-C5YO}d5s5qIw{aBiSGI_Glk|pRBta5D$-fC38vggTWp zgF#4|A#i99EF3`;=l`=y93JXPT=K8*|A7IhCjy24iwWYT)BJaY@R~^Xf8w4fhCtzni6-X%SfA)rK?93`;n7$NG}`SCSeUq=@o1b28pEey zF2i>jiE=`F;eIO^5~1V-!^1RTc!Uywh!Pp`V~EIG5K$rxQ~*nh0>KJE;D5=Zosidj z{++bcU!@HV6?9QJJPZX#=xQnfhzpcJBApcEq@=avK~N2KX^;$51_V+ELe=G=Y9LuH zpqwT|UF{ENM0HIx+=Cb;{ttC0qPiv!qNXORCItioi6Dmp)#Nqg<+Y^b>AZj3~ zKdBpIk;IaNx&0?*Gz}FzkxmG-3DO(kriQ~H;CM3_5#LGx5b(!K^4Iqte*aKVbHlj6 z4AD-+yyEa!7}D7V|925BEX*B2v_=#GO8m6;qm=j*iMcusAAv=BBAm3aX!joo`GIW( zDXjrfm(qkv69EF!lvM+RG}JYKvJfo@ z^sg4YTo6RlMCeM310mud*<_Lv@r(5S!)PJ@6Vb~3FGhR3-yD;~KZ@G@m?4mV zzswleG1T!0EKUjFfpSHmy-<8VCE>@#gu?wJ+y4+ha^QbJFux)38$W-ezCV-MZ{h!g z`1wb4`a6Js7ww;k{A@Q<8+YzpE~6VN(P7Z5Rphghl1 zT)6Jo$|RU+

P?KGCFZ(L@;zIGH$M-?`)5drJqi^1XHc=ark1X7U%m@o@9!iqXnJ&RU9%S5QvOz8h-3>xpLkQs14!pM7FGGn=Q6YVi zHur$Z?Lt>T@S=4ZHFc<-6|C>UqFb&5&_lOcqHbG0*A>qp#F7)#61JIn6DB}wW$Tr@XaVj3Z(jFm=h((*Ji_yTLzb7;WsRVSnh?uJg(NJEhZ-{)hBWt zBvZw#UKRdgkx47`>84hc@qP6yAsm7HsGu=!#ys)-gyZK|6=N7Q$w2F@)rH{92a8T0 z03s}NZ%XOmzITx036spW)vYP^((fO`P%mk~PTo%R<%Uo^rtUqkp;^8z z>@leMiIdsp?7R-nXLv;~2*w(34a;QgS#QW9%ZQBz&;#=?fDL<3J-+SNQDg8T2I54; z+xgHSKA9&PSeD_q8&v0IWzmHTPMK%f79aCu8Su?z7Sk>F(}N_ol-hPWdg=x(>{1UD zJ!`8FxdPvG3Yu)Wyn1;yB+=)rWhn57Zf%8n@#&7)SNMsuJ@zGm1s-p5dv-7Q3V9o5z?s6XLils%NPb+ zawmawiAP8L(X%(6>hQETB|YNg;##YT1wh;w@d3~HV1v++C;;h4My#Xm%#gcpo>1?o zYQKjD_JQs-Ic~{7eIqSqNr}uUit-?XR~#j++@F{^xswE1)kotawi(GxA{*VRqr|oH z6nVdK6Yhc?C}spR7OI?U&6BmqlAAW*8Gf$Wy!+=5W7qs`@*f$}*T72CfWzDoZyODn zzC>jA5f&vD8~v@+ql~l9xFh=L*Cb|WhqD5!1((Q9ToK{b0GS$IyIIievvGc>T(&52 z%eQCYu-V{p+|22RY`(Fh&)t$L=G^=Ar!;ttqGFpwP19aUL({2f5)SHgazojgx{||( z)1dtv0t#srtAY>$YkY|Hg#(`o=du<*<>rd_P01p&DB;<46YKUKT5s<8VtK~ z<4D73Lrb{{>6=^^!I{@p@4uVJ2tG258@F-gkBw2DyP8Y4+5U=|P*sW8ZCTjjC#xGz zGQh13TECJOf_`{+QiD_3@$=OBo<>R%M|zF2s$FrivdpIyPra#no;L%pj63B+#Mi?J z<*4V`D*OHBU#W9T*t!~q-p+Hb?;q;qwiBE&#qe9Zp7*Q#z5&b=d!>pIJw7*{F8jo` zC7r%<#NZ@{zGNY`)fcu6xg$YsGH=6}v2J~Hves{Vkm>$*gqW zga)(;OG;$QDxKO&BzBg5!CyTijnA%^_mo}@cp;=gHavuJPr=+|j-oM{4|=389Ac{c zy6yXRirFN~+Sn0+Yf|3(NJT5>A%G)5(SFCAtm(`Wb4I)DDNE477^a>Eq6|Z+IxNXt zRYUvY%$O&t@b4fRWLp8(lc`88pUL?LMn`WKDb6*2#Cn{%29cfK3U(ZJvXC!m!pW4A zqJ^@ePlx-)M|7P`@d_u5TS&G<%5jAl3MXs57(89?-*EriS{mX3ET}u`^++ZR`UzE? zE}1|fN`_ao-wLVMR4Mhkvm2Jjhe&xZHl-FI$oi@s(8+Lm20V&kSiEgy!c#fwh+MON z$XlM;-2w6FqI+GSKR0=wJ$r{TWHjex=*%Y;1%%sF=C<~E!YJY046j9WI391V%|Ko0v5inOq=<% z@cxY;`Wttgd5)~BYI~(g2^KC~WrpjY;nSXLdL6z`I(4rtZa%&}-YRhY)8XnpV2wrl z%l!E7gOT(S*{PiQuoz*cZ=1dR2v64X<_=JGH?yzGCy^;#|9jCP5KH#4@s{dbZ7bw@ zR*Gvo9qBf0{pldsTrwMmV}N$-{YqX=(O0XG31J-Jo&Ii9{jH(yE!s*#=Q!8QAu^=) ze8k4*o>T8rUpEk#`G**}lJ@!Oi+g1Wdlh@%6F&1M-BuamJ~3Wyvp+zX|5ivf6UNH6 zl;R6rZMA6~{NT~ZJm99Wvz}a=^ChgZxOoeilUFZ$P}=e_LNS0TWEWgabNcy+$f6HQ zKTJk?Mzp_Oc{jB?r9mg_aKz-)hT@eUha9kB(rGFYU2EWuV2@i%OxFT6N5y zBDmp^pS-AJfNM_rb@0L@7#7sN6<{oIYCFD0+%ha~hVCX<5bo9?61=Oanp+ZVje_C@G!Ycd%j8;xS8QtP5E@=p!3_9AvI-QTPgO|&7op-rI5R6&}$kk zi?f;=+SYfM5R6tPZDr8vKI2Z^vKe|RvS);&p;5%kWK0r?Kdm9-na9jdZ%<9zELiWe znUL}<>!PT(gtLMO?QdtF1}8M@Ui4vmmVr%bQ<{BxrnDi=@+0pzY2KG7Cz}edysqS0 zO^p^ILs7^HT=9Yi9XUUM!DveT?$XJ=K01FBbmwh6bI}}q3+s?wzTn0n!Lhm(X*-B^(B!Fwr)rByLC&^`LvApVIGe* z`twKHgq3aiyg%C~zZH3Jk(}fHMJwvQT#ub%`t6*}pi6H!NhVTT{MMXVXK4GuENf>H z`Yw_>#4~Fz(%FYCQPa|26lxvgveVoC5c{l)#rahG_R)EZJoibyHrkKUd|qsQe8L6e zCK{Is9tkE**JCm1ZtL~y^^aaRz(N3asOkwjfyHZc8|637S}rgJdb!<1t)((S8V|8QT+YN#apSj-uat-L(>g2PM#6`5P2^iAJ@V$de~?^PfHV3jfp&b zk3oy=I8%#5+BRFSn^FW|Qi@va5f@33)6WNc9qp<%FT|8i`OPYwVxgp;;=8n+7Qoj} zL0=X+%DMB{6Rg9(rRAo9E8yL2RL^UgEtlbYJyV$Q@{HOL2C+lQx^*%yyUe7jIhw9LW7DG!+#u zJo@+m+*@jy*r)2?#QxeQmck9@uI}FGQ1uknt*t}jDAcH5mf?^bQWg)pm%u=29oE|1sr|9YkBgFpWIB*jnv*ulQPevTe6F^X&U_Y>wQ^3p$t=&r z*g0#%L+p(oM$)`v8;dC3uPT8)Gh=ILKarhPLMXc~66ekGoSWUMwpu`B-%fJI%z>KL z^=5cU(HlVK!pJzVb2WCwIm=(5$1j|P8roMCGMQ+4lkauM?31z<^-<#XA|Vl~9t&=@ zvCuk*?G8sWh0ZuKCf@Hc&JuzUF7c1&W1DRU-}VzMcx21P{M~fT%#VL`H7z0f&zQ^~ zjAFR;=DEcaj&hCULLY6@F3o`#BbHLqWv=k*cmgIeh8J^9+BB|+p1UQMxVki&6S8-r z%yO0OsZ<@OK!=iJQgo&T*HCPB5b691Je#M2)2C`0Cq1q{3Jm4dib`ZoF`q_}4D5!P zQL+{1`?Qs@H}Mvcrx?y)SiOU9FVJc4VWwVbMQ`j+?(mdd5olckG#*_}Z|6OTPKGv0 zE8Rh~W%24*bIX=6oP&1c?z)C&P@Ixbpsb$1XcSr!>y<3IOhdCx;>rK)g+Wfm*~#W2 z?>)YYlw9@>4iCKVEp{lb$aI-0Z3*}{&DtBR=aeX%yGk|y1$9pt?+R0L<<}T=^-PoJ z1^|*Kjp%n@hxMK7dLh(SoqDG9wf@`|!@`cCbMDjR?{C&0`emn@GVU&3@%b)9vp(0R z7+}_l=Ql@mfLDay4kt@Jf9d|BxEc`h^hylugGEm)I;Dv3X$3z=reBLVW0 zRTKQRvLSZwC5CY+XJhhDk3t{I7o`jIx}Q4;6{F$p2#?IXA)gz?L`AiToWk#24f$5U zw8(6Ie#qB?)iCEvrngzwm=K%>xq3Z?EXK%ECjizJij$@fkWWob(90!pOg#!ac~AR} zzBiKQapvd_2!amL26Mj8y?O|ZSt522q`a@buhkD1W{JJ{#FAv*x2 zi}LHC?&?@gy+k`%gx3ZkZ{{kcD4e_ksdDz6G&|sxa!<^}d!!CZy}_W_2e7#gnnKSr zxI`KD>zdHL%mws?>$hSyD-bp<8)wZUPVVO2ee9Pf`jf&1! z6{f7OhX$1fG;`>c~?p49V-pJ>3m2lO*+wdVbv9)!XEPe)J>ZAJSI$=Aw`)Aspx5jth-Xm8wb<*N65w@UEVn zZPun3wCmKJVL~jW&+T6~?zY5`nEUlA36**!xbs&%AXD11rG9J+2w#Idb^sl7oc(^ z1Q|myn;S~&l%11)8b(dRYhJ1$(b)x7Et&jd6VQttln!pHc~Xf5+>pDgb+kMY%=7`< zF&y)jlYL~mvwKaiKrX}2r0~7sU3r1sln$1HF|`5VMR(YwYV@u$mZ7QRGiI2 zlT{YkOOD*BfL;slmnb8x`M$z(K~AB5(kk!0yB6|>f$P;9emDEb)vzJ$Y(XoMp+zh5 zDS2N{(I%|l(XmpwTY$|^z+TmbriwCQ0R{X$q<21_jw)W-tEhSA(L=3x(UplUKYVd# z_vJmWWSblTyA-jidPI9s;`hi?)-OfZ-Z!7ixM+~>C!t}f{*a07lcUe8ED2ss9l^BO zBg5o*uoC~#3V&k;dwDu_tc7d4-bgUgE4EbYOsNh4u|raK}D^`goMPmh4?*I z!Ta>`OSkN&)J5!fU4#rK1z%-ctGIIUg40>vYL*>Xj1;Pl_eP~;s1#{#O*SvdP~(D2 zJlgV})!19FVx&3Sc$mfzE`(iK1Uh|Gwjt_CC0Cnp5cbOZev+e@n%}g(S7qp-@LAC; z&Qlv{s`r?gp+!c_cAfr!-r#b>Nysdl{KANLZZlw>Qt0)~`JMc3#*VRFFVni<0{j_7 zEvM9M>zlMIA>>oVF`KD#4~%t?{eg5XxS^9_q$;YY*`-V`ajjx}S}#f1jNC*+ZDEMjMSh=qiS-bs5c7&5H+=EVI^ zSuDC4rr#^?JR1r25}To-r8yO)`BXyv!}Gg23wRihSNI_&xq>S4GXrB+Xef;`WUG5} zOLI6D9$0!3kauK){WzNmhr~Y02{M|=7kW5%Q#1e+zK`2zwecT#*~*KVp|5omWmxK&Rr{#cTV5*&6u|Lx^Fyr>0DRpm$e)zSXtZV%g6+sT!&Wy$)@>bVLX&+QiY``i;`B_akEkzlbns^|c(Jn&V^$?B>X)S&?K z>^G%40=F9D>PcoCr_B3?>k7?vvUC{QF@qW=bLUzr^cYKXH_Wf)m`KwT$o)l`x`ag1 z9zV@|s;*@)yF9c`&Kj;&F1SIecO`^_wgaPbZj;tbwehjJR+h_q+NH+j(|4D!u&dT5 ziY{VuHRvC4q)AYRg2m*niV*Ivi~yu0fFju)YU+)13Wmpb+jmGLuV;sb^3s4^Wc9O* zbWB$D2zm0@-J-$8<6H975m$^{tM|4TuU(_TY`0FcoO-HScc$NKaIxaYt#Xto#Cc`; zLWtDh>6mf*s<==RQQozl%kl9$rzyo|jSerJ&mmgTXg|I?xiHPS3mzk2)s0hqL31poj5 literal 0 HcmV?d00001 diff --git a/src/site/site.xml b/src/site/site.xml new file mode 100644 index 0000000..d9ee95c --- /dev/null +++ b/src/site/site.xml @@ -0,0 +1,35 @@ + + + + + org.sentrysoftware.maven + sentry-maven-skin + 6.2.00 + + + + true + awk,printf,gawk,bwk,C + + + + images/sentry-logo-white.png + https://sentrysoftware.org + + + + + + + + + + +

+ + + + + + + \ No newline at end of file From 912ae44e78acb558cf4b977327901aae7620fc82 Mon Sep 17 00:00:00 2001 From: Bertrand Martin Date: Wed, 31 Jan 2024 23:02:25 +0100 Subject: [PATCH 2/2] Fixed or suppressed last checkstyle and pmd warnings Added checks during build so new errors will fail the build --- .../checkstyle.xml => checkstyle.xml | 21 +++-- pom.xml | 85 +++++++++++++++---- .../org/sentrysoftware/printf4j/Printf4J.java | 3 +- src/test/resources/pmd.xml | 75 ---------------- 4 files changed, 84 insertions(+), 100 deletions(-) rename src/test/resources/checkstyle.xml => checkstyle.xml (93%) delete mode 100644 src/test/resources/pmd.xml diff --git a/src/test/resources/checkstyle.xml b/checkstyle.xml similarity index 93% rename from src/test/resources/checkstyle.xml rename to checkstyle.xml index 2098fe6..9f73a03 100644 --- a/src/test/resources/checkstyle.xml +++ b/checkstyle.xml @@ -46,15 +46,16 @@ - + + - + - + @@ -65,12 +66,16 @@ - - - - + + + + + + + @@ -89,6 +94,8 @@ --> + + diff --git a/pom.xml b/pom.xml index 8676000..84b44d4 100644 --- a/pom.xml +++ b/pom.xml @@ -112,6 +112,36 @@ + + + maven-checkstyle-plugin + 3.3.1 + + ${project.build.sourceEncoding} + true + checkstyle.xml + + + + + + maven-pmd-plugin + 3.21.2 + + true + ${project.build.sourceEncoding} + 50 + ${maven.compiler.release} + + + + + + com.github.spotbugs + spotbugs-maven-plugin + 4.7.3.6 + + @@ -196,6 +226,44 @@ 3.2.5 + + + maven-checkstyle-plugin + 3.3.1 + + + + check + + + + + + + + maven-pmd-plugin + + + + check + + + + + + + + com.github.spotbugs + spotbugs-maven-plugin + + + + check + + + + + maven-site-plugin @@ -236,34 +304,17 @@ maven-checkstyle-plugin - 3.3.1 - - ${project.build.sourceEncoding} - true - src/test/resources/checkstyle.xml - maven-pmd-plugin - 3.21.2 - - true - ${project.build.sourceEncoding} - 50 - ${maven.compiler.release} - - src/test/resources/pmd.xml - - com.github.spotbugs spotbugs-maven-plugin - 4.7.3.6 diff --git a/src/main/java/org/sentrysoftware/printf4j/Printf4J.java b/src/main/java/org/sentrysoftware/printf4j/Printf4J.java index e02de8e..4984d73 100644 --- a/src/main/java/org/sentrysoftware/printf4j/Printf4J.java +++ b/src/main/java/org/sentrysoftware/printf4j/Printf4J.java @@ -199,6 +199,7 @@ public static char toChar(final Object o) { * @param arr Arguments to format. * @return The formatted string */ + @SuppressWarnings("checkstyle:methodlength") public static String sprintf(final Locale locale, final String format, final Object... arr) { // We're processing each format specifier (%d, %-12s, etc.) and will slightly @@ -456,7 +457,7 @@ public static String sprintf(final Locale locale, final String format, final Obj // Pass to the next argument (for the next format specifier we'll find) argumentIndex++; } - } catch (IllegalFormatException e) { /* do nothing */ } + } catch (IllegalFormatException e) { /* do nothing */ } // NOPMD // Now append the rest that didn't match our pattern percentMatcher.appendTail(formatResultBuilder); diff --git a/src/test/resources/pmd.xml b/src/test/resources/pmd.xml deleted file mode 100644 index b7b836a..0000000 --- a/src/test/resources/pmd.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - Our own rules - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -