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 000000000..dd90f55c5 Binary files /dev/null and b/docs/images/plugin-axe.icon.png differ diff --git a/docs/images/plugin-jsdocs.icon.png b/docs/images/plugin-jsdocs.icon.png index 1c2ffaa37..8b4692668 100644 Binary files a/docs/images/plugin-jsdocs.icon.png and b/docs/images/plugin-jsdocs.icon.png differ 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