From e07b51792431bf221d4624e959609a6bec15f420 Mon Sep 17 00:00:00 2001 From: hanna-skryl Date: Tue, 30 Dec 2025 19:15:34 -0500 Subject: [PATCH] docs: add category labels teaser and fix README links --- README.md | 27 +++++++++++++++----------- docs/images/plugin-axe.icon.png | Bin 0 -> 3905 bytes docs/images/plugin-jsdocs.icon.png | Bin 297 -> 1603 bytes packages/nx-plugin/README.md | 4 ++++ packages/plugin-js-packages/README.md | 2 +- packages/plugin-jsdocs/README.md | 3 ++- 6 files changed, 23 insertions(+), 13 deletions(-) create mode 100644 docs/images/plugin-axe.icon.png diff --git a/README.md b/README.md index e899bfa18..7135826d3 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,10 @@ --- +### 🏷️ Category labels + +See how your project measures up. With [portal integration](./packages/cli/README.md#portal-integration), category scores are embeddable and always reflect your latest report. + ![Type safety](https://api.staging.code-pushup.dev/badges/code-pushup/cli-workspace/type-safety?apiKey=cp_def67c4efe558a9149061d0c62de893e1689ad793071db332790238446173fef) ![Bug prevention](https://api.staging.code-pushup.dev/badges/code-pushup/cli-workspace/bug-prevention?apiKey=cp_def67c4efe558a9149061d0c62de893e1689ad793071db332790238446173fef) ![Code style](https://api.staging.code-pushup.dev/badges/code-pushup/cli-workspace/code-style?apiKey=cp_def67c4efe558a9149061d0c62de893e1689ad793071db332790238446173fef) @@ -23,6 +27,7 @@ ![Security](https://api.staging.code-pushup.dev/badges/code-pushup/cli-workspace/security?apiKey=cp_def67c4efe558a9149061d0c62de893e1689ad793071db332790238446173fef) ![Updates](https://api.staging.code-pushup.dev/badges/code-pushup/cli-workspace/updates?apiKey=cp_def67c4efe558a9149061d0c62de893e1689ad793071db332790238446173fef) ![Documentation](https://api.staging.code-pushup.dev/badges/code-pushup/cli-workspace/docs?apiKey=cp_def67c4efe558a9149061d0c62de893e1689ad793071db332790238446173fef) +![Axe Accessibility](https://api.staging.code-pushup.dev/badges/code-pushup/cli-workspace/axe-a11y?apiKey=cp_def67c4efe558a9149061d0c62de893e1689ad793071db332790238446173fef) --- @@ -31,8 +36,7 @@ _Common problems with keeping track of technical quality:_ - When **tech debt is invisible**, it's difficult to plan much-needed maintenance efforts 🔧 -- Individual tools measure different metrics, inability to combine them leads to - a **lack of comprehensive overview** 🧑‍🦯 +- Individual tools measure different metrics, the inability to combine them leads to a **lack of comprehensive overview** 🧑‍🦯 - Open-source tools typically used for failing checks in CI, which **can't measure incremental improvements** due to arbitrary pass/fail thresholds 🤖 - Off-the-shelf solutions tend to be opinionated and **hard to customize**, so may not fit your specific needs 🧱 @@ -42,15 +46,15 @@ _We want to change that!_ ## 🔎🔬 Code quality integrations for any tool 📉🔍 -| [🚀 Get started](./packages/cli/README.md#getting-started)️ | [🤖 CI automation](https://github.com/marketplace/actions/code-pushup) | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| Getting started cover image | CI Automation cover | -| | | +| [🚀 Get started](./packages/cli/README.md#getting-started)️ | [🤖 CI automation](https://github.com/marketplace/actions/code-pushup) | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Getting started cover image | CI Automation cover | +| | | -| 📈 [Portal](https://code-pushup.dev#portal)️ | 🔌 [Custom plugins](./packages/cli/docs/custom-plugins.md) | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| Portal integration cover image | Custom plugins | -| | | +| 📈 [Portal](https://code-pushup.dev/features)️ | 🔌 [Custom plugins](./packages/cli/docs/custom-plugins.md) | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Portal integration cover image | Custom plugins | +| | | --- @@ -64,6 +68,7 @@ _We want to change that!_ | | [Lighthouse](./packages/plugin-lighthouse#readme) | Measures web performance and best practices with **Lighthouse**. | | | [JSDocs](./packages/plugin-jsdocs#readme) | Analyzes how much source code is **documented** using JSDocs comments. | | | [TypeScript](./packages/plugin-typescript#readme) | Checks for **TypeScript** errors using strict compiler flags. | +| | [Axe](./packages/plugin-axe#readme) | Detects accessibility issues using **Axe**. | --- @@ -75,7 +80,7 @@ _We want to change that!_ 2. **[Integrate](https://github.com/marketplace/actions/code-pushup)** Use our integration guide and packages to set up CI integration in minutes. ⏱️ -3. **[Observe](https://code-pushup.dev#portal)** +3. **[Observe](https://code-pushup.dev/features)** Guard regressions and track improvements with every code change. 🔍 4. **Relax!** diff --git a/docs/images/plugin-axe.icon.png b/docs/images/plugin-axe.icon.png new file mode 100644 index 0000000000000000000000000000000000000000..dd90f55c5cd93cf0fe2e72871c9ad7003b408b14 GIT binary patch literal 3905 zcmb7HWmpt!vtH7L1r~5!Lck>!iB&;F1cap|mKLPDmRfuP2?@z11Y8;s>F!F$;k zmlq_YJ6wg2@0@?<-?^TcYi90wX6DDtb4{d{h7v6`D>VQBpjA;;czHvU|9gOxH}`WA z*OePWX{D;90J#3|%4#W0008LDR1{=&y+7}!JN*NhP3pTY^ld^biU3sty;(@*NI8XB zV<92zArGt!Bz1XYfZTW0K9^6sVDdeObRCZ`Vny?0B9L^$`?;*^xgC+W7=Tdg><-`mooQs+2h?AqEI5$k}Viix> zkJAx#*cufe3WM*XTA{CF51Z3ln4eE^vi=@iSLI_oiy`Z718A{V^{I?9MxVmjzY@mk zIbCE>1}){=t#lFQ&upWofDu3$0^jzgAMY$4B2j?#Xe@^-P_hHE#O*bo(!>7f3>>Fl zD+l)13uE6~;bAN%+|dErBmmjvdp8dDo?U;dgsv@ol1(=1cK2#ON!%4^7O_O=|_3Y@1#AbKI>hyyw%jEHdtw&$ag zMVh^n$Q{<6PAeO}MmAiU8*gnDGe3ke#%?h6)LNKdi&R$TF46f1a|3nvs$osPA@HM1 z0UKzDE6)MwY#)wx@nOP6CrkG|C$<{~}Fx3Rdgnzw%*4|kY$YEqvoT2xM zR=`bZTmYmBeT6lv?Kd)g5oD%=u9SL94N_$+cO>b5?LR%ST^8fHN()Wq(JSm2(=JpG zH;Vdf9*M_d19-*YX`B8nrMy|`OW3~o#F;p z+VA&s2yI}%t6iuOF7d6kUOSsucf(fuiWQDjj@o;r?pIX}XYtMW>lbUi+5}--L~s_C zsWPP|0BUl~Yke?Ng=Q4imUNyBU0XDTmP>!Rr@Yu0hE1Y8ViIo(nPR$AaHCJ6Y{AnV zJYxbEKQN-v`gf_p&N9E_SFMz7C%OF{Y>GP;D@wVQ=vFkPhV@2=LQA}wan427>` z!({kHqez5D0Bk8!=V6RVM<*&MskYf(lL zQ36h20Bpve8~_UoqbIgaO`g`1N_@1lgv(aast_v}nI6FofA!o&_W2;x!m~RM9jdG1 zE#QBiNuZRg6Z$xF+*qJVR6Pg7#j$&m_be@ASF|W-M1qDQ|JI#0k_{*wfj>!ew87bbgg%IzR!r?g|&8y!BJ< zz&q>JENU_Kbyby%Txn70OA~}Xf1I+^8dcC-_1@3@-Yoh8dFYI~!6mj=BQr39rqJ)+ zZajhAXYV6zew|vAnRG{I6W!aEgJE+%(?<(ZXA%O31ARgduT>_QS4~8=YF*>d7oupZb zNgX1qbiaJ;l(=%wA2TwIs(wLcfD6QL@dH{a%-$_9kS;U}Oig6U9ci%w>L^6B^v#pc zmN&={2refk)`(@(GdOX#u@Ph%j?bc;sOb7|wn|=+NiF3rkOk2ku4mzAshrB*#wP7Y zjz6#6kmKhcsb`sm1;1X~!mhN(T{GNj%773x^G|rc8X4pfvkVVRZSR!o)RSH88&eQ! ze3MBHs3O`zp8g?N5e}&a2Ahlw7CMczK2@TAlKCvfe8Q6^sL0hPWQf@&!_ts6H3BS0pxWt)enopXC8yT$2zmrs{H&|^m>^|n&l@G z_QOpN)n)Tjizcg5SKG}mR%01=%_wg$;Ei`aak8aUL2q<2sp~4ou=RXKwKG4jZIy-$G*P> zmMz(flI)B15KReg`BlB8Q-_~KzI4w^?|qDE4?7!vyc2ujJ4+Q+=hVlu%E+}D^_gh% zUIIf&3dWE)uvD&9G-%x9zfkrlc(;2psF7-#e+`I7QXlzDF>$1k!#KQ_IO~!e#y9u7 z+H2ctmZ1Cbir)K14__(q3x=TA5#3|y)gyHIbu>Zh#=HG12w1ndj`amxpGq~=fOM=( zeDX9$O3C8nbirk;zvFz_)Dw3C%nOGu@*?sZm^;qOwRm}?QsY7n9ykJ#6b;V$_NVqd zcARx{G>QTDR_;bryf0lfy;+6jP55M{N4)nxA)XAe)p7pkVjgDJ~-e7GioX zhq1Fx{0;*TFc*G6{A;YlTa@Ci$wuKc^Y6nEun9L}tn86N(@Wbmu27n4>!rZRhRX?? zc(eE?>_IVU*&6k5+V!@V@=N#$uqih}b@T-%z2tgXm4Xek@NF@F#oSlJ32i1(PGaR` zU@5DqZ2a7Z-{S;c-&JZ$!xlUTlBmS&?@wp&M)21jFE1AOX{S0dC(HgX?^l=WozA2o z^ZPk@9e*n5ll4rU29Vb9;_y3Gg_<%nV3pb985Ol~1>ln}a;2XiEsgDB{uPA~7mJJe z*Vy)M9{)s1OIE#l~Q#ROAO?^VO_2xEzN`%&lg-G3};oF)+-Rch|C5pXu z4^}gd*z)I$9@ozON=R0Wv#~#3?+Umkv*v)mc)-(5G2F95)UOO`ZRmJO6iav(K&KyY z95u_w#-XNoOLeo(>L-_yBvi<=yM=dpD)ii}3f0^j9ZwKXaqF zJRM6122E+?G=xrrAa#zq#{%!#{7VxeiN~eBLO-E+RMriDyJ1&H1S$+q-?KxVj9Xpk z`@?@p5?ao?zMh;7RZLXKPdYUB^aG=>7QHHd^yVLwU)1Ot4+vG9ST8pgTGE&#mFOR! zv2k8!!Ee|z-lJmgj|eMw%KX_;ifBG`RP=WQIZlS1{MN4sV~&LRT(rla758mvS`Q>I z_RL5GPysOKlT)sm^O(geU@v1mjnzN&WNrQn@k9B`Sgbc&SLL<-Ow+NhF4uSsr~k>? zX*z2Tcf^lGW--sBn?8;++#^I6jlj4VXm&1Q{9G!xKc-XPPB!vl$q;vEu=kzwJApI2 z|0E_;I=u6JU-8=RMLH!zjDp>x$D3Q#S_Wc_S^)EsLOT zZ%8uxijjy%TNB-@%sbw6hqVD}hTUaQH7eC8xETp7b9vxJY=)s9Gg z!b5`et{9rb1;fnjclfru?}{>(K}S>vq^HwKz4ybPpNO?hBuw(CaJI zFRsP40W;p0Y%>%DWbhRg0XvjhDeDo(I6K9&mdLnke?img zXEL}H&z;|1srdXJ?cZ`63G}@vz%ASDCT#zruh7w6YxJUaVIud%LFTO1&r`03U)n_p zLn1D|KU@Ar?D%t=R-a?#)brWDzI(XXYI|M=D0=OG><`PQkogEJpc=nup>h;cxM}#F zHD+HFq~Cc%A~i>qDBrdHwW`7#>w5GKMjf*5i;-bp*?2ivlLiOf_X8 z^yQaa0)f~hvGMqENg;doK;Z-o4<`vDPD}oouh)0A_Rc}>&8X~ISQS;^JS2cp**W|7 z!Li1IEd^9BLpH`E9Uv8UlA=!@*mfg#HxyE3h3aw0(PpD%PH3Z9K=4*|T94~E(Oe!& z%Qb%8d%xkK-p_xj2JP#}U)(o*szQB(mXG;2Gw7g8TQfi|#sjHl#vNdRoOveG9ANVR qGC>}4rfr?hE*tWHM$2fOKS*52hAy24Vftn!2B^HyP^gfz2>uT$N=_O8 literal 0 HcmV?d00001 diff --git a/docs/images/plugin-jsdocs.icon.png b/docs/images/plugin-jsdocs.icon.png index 1c2ffaa378d47dd1a509125002dbec6f2bb17178..8b46926687d851040480242b0db644834bb4afb7 100644 GIT binary patch literal 1603 zcmaKtc~sI_6vuyVXb4%RC}^dQWsVCjWHu9w8R|&dq=^wxiK4VPnkj-?lKWO+dE8QS z!89c^#Z+91NO7sb%%sIF+8oym&0Poon=_{~@16JVJ)ir1_uljVcrW?r5ho}Z0R{j7 z>ij#_U1l>kmI_F=ACL=@$PCE)uoD(o-jaN*Agn}j~ggQ5dmIq#A+x9>^zOj1DpA= zgH=Y(h>~jV6Z?0uwkWY!8z0*?_!`9JZA?=Tip85xlQ(1bB1YHGLu?xafeqg_Cls`5 z&ZeggYr1zO6)5wM(0tnI+AHVXdIWHot8ZiP8hKVLOL2b^IXxMUo24=)rH(HZv|%~K zVvmQS5KDnUaPhJQS2)_gC&A$$m$B`h6es{Bk{NDjw(Kv*0t%_wZdByzrdkFE^~ zRzGeO;6%575$uv_$zhJwzz@uiL~3N#l~_)%iRd(mjZJj8ZkhS%)X#Cmv?-PMr54QQ zEPg*UfAqwwt*PZe;a&4ov+?8J$%=vi>?MezzaRR(TkNyqr2D~}Aa|gdJ25@Y9UAAp3tQ^_f3IQ%b24i zw=*!f=hc)55~MPrZNGT}{(}S|%f_^AZ>v@}*l0vC`4|aeLYAn@aG~u}8SbLV0H3s> z_zN#{l}Iw`ZZOuM?U{mw%Vas_5^sXBhb!rn^dvQxLnRpF&ympi+Yh_;TX8fh4b6{1 zOg{OyXjJn*oyW-D%&}yQL2?%&o80dGZ@B( zCfcwQ{OS&Hf`g}pX-y0{T@#YZ@gh)^1P1>J(f7sq`!~nU^qPr%JSgOo+wR2AevlQV zL|o5vm=Q{=gykLmWxqTqF4>hKl$5f5oJCe(Ko9yxdI2_)vpgM&c616+CEs)px@MP*vbJL4J#-#pEUibKK3rWb{O8tC!w2qzm zz>GJQ@1g3q_tjN87nM=04FZTd(wA~5CmQD1z#PPDy|J?|dPVQ?RKe!y_`Cfxwg0*d zK6}l_?9YXLUIcy~4b6-Qe@4+1fbFo+l5mhPa(I3|*OWq#WB3M|D3*~#@6$%}TcqEF zu9;RGV8?Bv4_)0HxoWk)!&~N*xy^5_g%N|ZKmg10?D};0o%=>v6z0X~#b5of0^sa$1Y2eA74r}BIOSFV literal 297 zcmeAS@N?(olHy`uVBq!ia0vp^3LwnE3?yBabR7dy-T^)#u0WchVLwCV9_I4B%;o!- z%Jwjp@7?_L4-hex?PDt63rC7w$JKgI+RVOWJLgjLx;qJ*?j>!$-*x8QhR45wivR!r zUpnPSGSD>Mk|4ie1{O6>@2)+E4nKPQK5^Z)<= diff --git a/packages/nx-plugin/README.md b/packages/nx-plugin/README.md index a1fc57551..8de5a58a0 100644 --- a/packages/nx-plugin/README.md +++ b/packages/nx-plugin/README.md @@ -1,5 +1,9 @@ # @code-pushup/nx-plugin +[![npm](https://img.shields.io/npm/v/%40code-pushup%2Fnx-plugin.svg)](https://www.npmjs.com/package/@code-pushup/nx-plugin) +[![downloads](https://img.shields.io/npm/dm/%40code-pushup%2Fnx-plugin)](https://npmtrends.com/@code-pushup/nx-plugin) +[![dependencies](https://img.shields.io/librariesio/release/npm/%40code-pushup/nx-plugin)](https://www.npmjs.com/package/@code-pushup/nx-plugin?activeTab=dependencies) + ### Plugin Register this plugin in your `nx.json` to leverage a set of generators and executors to integrate Code PushUp into a Nx workspace. diff --git a/packages/plugin-js-packages/README.md b/packages/plugin-js-packages/README.md index 41f78b27b..fc1c33974 100644 --- a/packages/plugin-js-packages/README.md +++ b/packages/plugin-js-packages/README.md @@ -15,7 +15,7 @@ It supports the following package managers: - In order to check outdated dependencies for Yarn v2+, you need to install [`yarn-plugin-outdated`](https://github.com/mskelton/yarn-plugin-outdated). - [PNPM](https://pnpm.io/pnpm-cli) -> ![NOTE] +> [!NOTE] > As of now, Yarn v2 does not support security audit of optional dependencies. Only production and dev dependencies audits will be included in the report. ## Getting started diff --git a/packages/plugin-jsdocs/README.md b/packages/plugin-jsdocs/README.md index 67617b4d7..ef2e6e0d2 100644 --- a/packages/plugin-jsdocs/README.md +++ b/packages/plugin-jsdocs/README.md @@ -140,7 +140,8 @@ jsDocsPlugin({ }), ``` -> ⚠️ **Warning:** You cannot use both `onlyAudits` and `skipAudits` in the same configuration. Choose the one that better suits your needs. +> [!WARNING] +> You cannot use both `onlyAudits` and `skipAudits` in the same configuration. Choose the one that better suits your needs. ### Audits and group