README.md

Code PushUp - Just Follow the Score <✓>

🔎🔬 Code quality integrations for any tool 📉🔍

🌟 Why Choose Code PushUp?

🔌 Code quality tools are like phone chargers. Everyone has a different plug.

• Incomplete or missing tracking due to a mix of portals and custom tools is costly and unreliable 💸
• No Standards in data and processes leads to flaky, unmaintained zombies 🧟
• Results are spread over multiple places and need manual steps 📂

🛠️ Standards for Code Quality that Integrates Any Tool

🚀 Automated CI Integration

• Seamless integration into any CI pipeline with full control. ⚙️
• Our tool works on all platforms like GitHub, Gitlab, etc. 🌐
• Even custom tooling can be created over the 📦 @code-pushup/core package
• Get updates on every PR! 🔄

---

⚡ Flexible Config Setup

• 📦 CLI for collecting audit results and uploading reports to the portal.
• 📦 Core Logic to craft your custom tooling.

Get started in no time! ⏱️

---

🔌 Officially Supported Plugins

	Eslint	Static analysis using ESLint rules
	Coverage	Test Coverage analysis
	JS Packages	Package audit on Security and Outdates
	Lighthouse	Web performance and best practices from Lighthouse

---

🔧 Custom Plugins

• 🛠️ Integrate your own metric with custom plugins 📚
• 📦 @code-pushup/models
  • Schemas and types for data models (useful for custom plugins or other integrations) 📊
• 📦 @code-pushup/utils
  • Various utilities (useful for custom plugins or other integrations) 🔨

---

📝 How It Works!

1. Configure
   Pick from a set of supported packages or include your own ideas. 🧩

2. Integrate
   Use our integration guide and packages to set up CI integration in minutes. ⏱️

3. Observe
   Guard regressions and track improvements with every code change. 🔍

4. Wing it!
   Watch improvements, share reports 📈

---

Just follow the score See regressions - Report scores - On every PR

💖 Want to support us?

• Read how to contribute to the codebase. See: CONTRIBUTING.md 🤝