From fdacfcc2f515f2e2e6c9c47b6608563d2aa07b5a Mon Sep 17 00:00:00 2001 From: Shane O'Grady Date: Thu, 11 Nov 2021 09:02:42 -0800 Subject: [PATCH] feat: add support for semantic-release Support the `release` key for [`semantic-release`](https://semantic-release.gitbook.io/semantic-release/usage/configuration#configuration-file) configuration. --- README.md | 1 + defaultRules.md | 1 + index.js | 1 + tests/fields.js | 1 + tests/snapshots/cli.js.snap | Bin 1864 -> 1879 bytes tests/snapshots/main.js.md | 2 ++ tests/snapshots/main.js.snap | Bin 1250 -> 1260 bytes 7 files changed, 6 insertions(+) diff --git a/README.md b/README.md index b9c27dcd..7993c2ab 100644 --- a/README.md +++ b/README.md @@ -184,6 +184,7 @@ console.log(Object.keys(sorted)) - [npm-package-json-lint](https://npmpackagejsonlint.org/) - [Prettier](https://prettier.io/) - [remark](https://remark.js.org/) +- [semantic-release](https://github.com/semantic-release/semantic-release) - [stylelint](https://github.com/stylelint/stylelint) - [Tap](https://node-tap.org/) - [xojs](https://github.com/xojs/xo) diff --git a/defaultRules.md b/defaultRules.md index fd724db8..e638d8eb 100644 --- a/defaultRules.md +++ b/defaultRules.md @@ -68,6 +68,7 @@ _Note: when a specific key order is used, any other keys will be sorted in the e | eslintConfig | [ESLint sort](#eslint) | | eslintIgnore | | | npmpkgjsonlint | Key sort | +| release | Key sort | | remarkConfig | Key sort | | stylelint | | | ava | Key sort | diff --git a/index.js b/index.js index b332811d..c284f7ee 100755 --- a/index.js +++ b/index.js @@ -255,6 +255,7 @@ const fields = [ { key: 'eslintConfig', over: sortEslintConfig }, { key: 'eslintIgnore' }, { key: 'npmpkgjsonlint', over: sortObject }, + { key: 'release', over: sortObject }, { key: 'remarkConfig', over: sortObject }, { key: 'stylelint' }, { key: 'ava', over: sortObject }, diff --git a/tests/fields.js b/tests/fields.js index a73e2d39..b6b0f7c3 100644 --- a/tests/fields.js +++ b/tests/fields.js @@ -66,6 +66,7 @@ for (const field of [ 'galleryBanner', 'remarkConfig', 'npmpkgjsonlint', + 'release', ]) { test(field, macro.sortObjectAlphabetically, { path: field }) } diff --git a/tests/snapshots/cli.js.snap b/tests/snapshots/cli.js.snap index cf33c7f3c7ec18ac50f11a123409b85b932d3e07..658791cee9de6c497dbf3bb288724d8b470439b3 100644 GIT binary patch literal 1879 zcmV-d2dMZ#RzVZrS7+J(h3s#Z3wiw)S8mDOFk2yDu zF(Gp!(`~pdI^DvIiaONA%;{oGMvPIH88a2lqH`{D?z^|Qh2B0+Ew7T*n@;#s7O@d=(t;-Yj=%ORe!icKK^YO@vmM&NL#}%5!YvxPfxXsx~(|;V-e-8 z#d1Pg_e_mbm%O(*fAOJ7M~7zAQ{Fm4LCB2k`fCNJ3l3~k?Mu0u^2$NVTjxX)vUPs! z!mXQ{wx9dw_TE3D&+92~jZqUaytt_L&BV!nJ&DPVFRe`4M0sn(Kti^ky#FBcnX_|q z<6`Sitv-K@@>bOlLUOmH#17DYdv~qn&ce$dot#Q}>pSs;-1_?TCvzGbHhgpEX#1*D z%`a2lTKp^_@7G+=s4u=WOnPJRljAMb$&|N7B@puX!ldU@HY?^$9UF5Z<4}1P<*ld2 z5c2C_<Xy+Vig zMY*ZQR&6obue5f$5(Z;+r42W?-%CElV$rXr633BRt>zq)+{bVJb~q%Eq#}|`1~Djs zL|_ILc`tYMUP&k=bO5Dmc?AhiqsDI}4&Ne-7K_<3&1^987O6^fJ%ELMD{JOC|Av}K)Sd^ose z{5#yc2joJ+=8%lLS;k*@mGLFdGM37*76XLj?n}zjX&~eQg)BKQ0>J=m1RBM14s(;U zL@ej1#1z*R;4f3^F?36K%|}W2cZs7(IO25ekNhQFk$?UYy+NDi;;E7|>0C`p9k(xZ zF8ji&(OZn}JEIb=TYxjbL&nYky+BGx5zqv*Nqt9+zS&3v-Ct2pZKpncL|v~uV*g5f z2_TGRMG74VF9HjIRRJVEw@Bekg8O@?`-sQ#r}*qZuELQUKo&N%DJVOTXz?@jGXZ-~ zc|UtedC&+62S&3*JQ;)>mWT^LC=vwx0b9gfOLum4-|VFlZ@gF<{+D@i(E4z|3hWNb zGOxeu-h1HoqI-!$_dd%!M>CSi()|<=UIi+IQjbyQ`4znF)!bF;sOHpuS94v9<5}*N zO6N%Kp5)!)d^S9t4(tMcU>9#AQLv2xAP%yxn~JyYO$$L;y!F5%_Uq!!d+xj9CHJZL zol1y~5eMWmL6{4a0Oi0Ntawlh!g`_QJ1&j~if+z>GCn*cIorMxAyD9O3wLM_B+cBR zG}xNK41b!zn{d6Iizx^WR&juEk0)nAxxmE~86mI9e8&@RE)L2;Kq)6=qTF}v27MbS zJAroY^G=wE9v%$IJSd}8zil=9Dj*N4Fq;Eg#z6e&%V!K^9iQHhpzFBA69Ko5%TZMN z%rsnDDh6tR9RYM)(X$I?=al9w$Sa&*Sel!cpW{!@b*7hku0gZS_WWR~s<0;rAtOA5 z1CP1+E3!guPoB_f_q10L(z!=Pfo}IF7>TB7y!2zzJ%YuCyJNJW>hn9)>(x`a>({eLc@y_XwpUdoLKL{v3v zXp;;=h7jDjZ}sz8vAPrlqqlGM?n4{DhPd|G%)ibduC^mgzTPpLsrP#})7PWj@8D?* zFa)76haEK=KxqUX0b|)wa~&vkz-1tkJ&G}avJ7Ye?uqFEj$%TCz?xn&IpMU8qP(+$lhn||1k)k0tbL2tbD>vNzMW7LjBLE{bfN_`#VegJZFht z(~-OO`d#98En$uDov`@Vd26V_VdUi@`2IUwKiyV`~PDu@*Gy;!+aotqNhjL6P R0QYGC{tr>4gZ$?-006GZl@tH~ literal 1864 zcmV-O2ed+ojV zop;Xf-rj|jkZ_W_DLHze?(2JNEO!@O`RLR%1o2m`BIK7S^|EniTMwky6~{IjcORvE z^jH`nGqdZj7n~_LxFvjV^0nkChbSNIh#+L^srwHypFKA>HzvCN^y&-8DIdKbMab|4 zMYV4xO#bspWOi&xMdAj^NAJWCvUz^=qRktcwx0j{&Ys^RF6b#A-S-?Jt-GhiXo}z8 zn7`!kq+>%f>M0+!4JV|n;pYK2W|z%Kv5dMCdgS{e%15VY2^my4Cg%3%x*em!t9EWv zj(>;p(Q|Qx-2U>+C$Ba(tpDonvG(fI%`a0vx^pxkAJkmbYA(GrOnx)!$%&S#B+5r$ zizj46llj}RbraSZWEVnD8m@1peDo(BA&)Ok8lAi`bl$Z1$deg|%d#jReJ`C5ISJv% zkcLu4CjMsu^MDFqFjYlTRl(Bb#!?%l&cld^2tvaNl@mIM()CD;;*OP(RH3(&Tlwg| zF4533Q;n_4Vzghm+U1H0!Kw-y_vP|%%6%arX;k=Pr5b z9-`BgE;E*{;O|xtI*`&t89$~tD#j6|{NX04MPKm@-bCu0;n!i+U(51SxU(JQmTtn(Kt+`B_p{q2??=iZ zK&>QXqEeKua!cQWltGpcR^hVabi!L|tv0UOXtA2im2nfbaj8iu zNhxuOT(nZZ(#VClvCs))r{l&hPW`s%Qx)9kIZmE&e*mKNP_xBUZmQH*^t>7U*u}H} z>!RmRNtFER?z=d++-&ykG5XSu{_LYK&+)&vqnBLgGmoy*Cha=10q_G2%W+__Bm>9> z@__j)$0NEx-_%Lk`sNlcg3@k?;yoE+_^=Exf8Y?V@naS#fH-7KQ$CA?=Yq(&JR$wD>nPuLH;hjm-h6#bH4ji)lOz2_soF zegO%oz&v1;4>XpjEm{Jb%lFW{2f!@w*cRlnpSirtBbQqxx!gU4@8h1o2!p~3JWRE) zgg4VG3WKC;`ld=4+HHlfAB{M~wH`D~56BAPX{Ms@(>ihW>c&gQs!g}NTlY%p#j{4EfbV23DVZjv_0&Rwl}0{ zi!(xE1i~#A_5pTBVa3Nt_!Kw@9A#0NQ_1r{I}j#*+97UKR*0!AxvVP^=WcRjE;-Vx zck=F5I^_IIljr=|ucmWP$sS=(NpDv+Bf4Mg=ZE<++HwU*lM|w6Zxv}q%5flCK}ZgJ zt4IS<8i7Z^IL20y;Oc)bbuqXx!oPj&B>`^sD8M(R1y~ggX&ff(om&dj0lQfud>jd_ zzz;whON4(#!fio-6WAiG3@8z{Usp(0;&ydj>s042I@S5A*XrEELT7@+{tWvPNjiIp zB%IS~zyxe(>vjiH{s8hJ#IxEk00000000BE zSiz3uG!RW@nHd;qwKIaf4=aw$9gT#97FLJ@>_{td;DX$VJMHPj4z|;?EyRTn;1l=- z#Ak5W)84u91AGB?m7O?=)5(mMk$PP3y-Fu`yUJC$Op+u`KKT3j$G^Y5`0cNMfBfgy zn?JKOv41~2O_E2+DcI@z>G8E0zc8Oa&XVMf`Fw8l57U#2^yKC0mS#FlTl4(3d1~#P}S2ls-z*=Tu3Xhoh~cjl*-Cz)nDqM6_?c9d&n z9Y!2_Dn*@+7P5`r2nj4&$nM}yb^yF0D_U9x4aemLRY-z`EY+IISD9or-mFic596Si z!DAx#jyiq@3plxNJ%YRm@S zdE7l8`)8k7+5AUDG%bX57X=7aQB_QrjKi}B$fB{s4WCF8o;p(Hx7)*RPBm*6Zl(-5f39WDyJpe!GpB6 zQ@EM?bww}}g%I>D-QNkB!%bQnl#=kGF;DC_S`VWK%gmyp=uF3ReWkSV%~9(h=>B24 zr?8ebABuq+LZ`b6T7S9C#hoLajf%)N5Ts~0E^lzxISW|s=Ed9jaFNqW@Gb!Q1p3rf zy)AB);68T^81&j_AejNMfIL9T;TDeacm?VX)s)KNwIeR->2p?;$15bg!u$(<9rEg$ z%CAeYBBj$i>^-z*7zC~Dl^vsZP5{&K_RyxtqltX8GKbfuTmL>0`ncP*0JNVtOw|s6 zB`qnz{pn4|+db3WriYzJEfh0ZcaM6DoT^0G*k4Ye+(FP)R}-kP8c-~!FV<_5&QS}X z(``z;Dww|72(fie0}ee!BQuzovyk=4HOQ)9`mNdl&@`znYX`*p8ZL*iWt68>zP-G2Yn? zyR2cgFjrB>D#61!Cf>(Q<^3g{;#_aDy!(ySmdj6;!_~myu5GUFi+6QPs;-$%IM%bz zcE{~GF;m67i>_!{)%fsw<F=ldn`n1B Wszy&B&FldlJ^2r=rPEP*6#xL0TZB^p literal 1250 zcmV<81ReW9RzV%CV=$8J}-D%VMpq{(}KKmX{rzpj4y^WX3P`T6DV zS(@0tPd-eN$H^Jk>AUI4trOXAB&+euh6MUB4vHB( zCbD&uwUCwKUQu{7Z-zYEwt-|(sH&1F9q5SBqbcyg?C2Ptm-Gu-Q=U_vF*mCz8+hk& z_k8M~J+rd;kBDem2Vns>#?3IOnP0r#G7soqFi>!+0gf6#6k~LZ(}|5ISAeC27AQ6-B*= zpi^EjPG6asXRx*d9C)Z+ba$r8{sNzOYd^q&$5#axlJ*`BqsMDf)g_9~40)y7fr!|7 z)Iwq;dDHQla%Glryn1nAc+E?a?FYUwfcbVdDvjDhP@@4H%W&hsh)mV3h&O@1qZsipBBOFzvI9IwXFG+P zx!+a|kbj<<(4MIKG$n~gcVcK!MfiO|P=T?at>fx}eo09aDH zH~QNRu=A*eVkWz`sCUSzN|cTLg%rv?1YPxKzY0%%#d7*$yESPWwE#NZroNkk>6@Jp zd*?Lb&{H%rgN1SyvOb9h*%M5^C3^sxCbeblfVi#Uau_>Cc}fM`cP0e={D*}1F&WXT zU;^J%d6#lJ8x?MX1!ypUJK#Mn>rLQIGTN(}WcX+S0`;}9toeWb)2OUG!?03-&n`yl zsc7{2s&kqpmd@X~+05;JO`et3QU(03ybd-JlU ze|?j_c-r62z6)4hagPa&PO03SX1 M4