@codechecks/client
TypeScript icon, indicating that this package has built-in type declarations

0.1.12 • Public • Published

codechecks.io

Code Checks

Open source platform for code review automation

Build Status Software License All Contributors codechecks.io

CodeChecks.io is a framework for code review automation. It allows writing plugins (codechecks) in JavaScript that:

  • execute directly on your CI (like CircleCI or TravisCI) and communicate with our backend
  • can inspect all Pull Request data (title, content, changed files etc.)
  • can attach feedback information back to GitHub as check (success/failure status, additional message)
  • can upload, retrieve and calculate difference between arbitrary artifacts (like JSON values describing build size or screenshots of views of a frontend app)
  • require only one GitHub AppCodechecks App installed in order to work
import { codechecks } from "@codechecks/client";

export default async () => {
  await codechecks.success({
    name: "Hello world!",
    shortDescription: "It's so easy!",
    longDescription: "# Hello! 👋",
  });
};

Particular codechecks can be distributed as npm packages and can be setup in a declarative way in codechecks.yml file.

Install

npm add --save-dev @codechecks/client

Docs 📚

Contributors

Thanks goes to these wonderful people (emoji key):

Chris Kaczor
Chris Kaczor

💻 🤔 📖 💼 🚇
cgewecke
cgewecke

🔌 🤔 💻
Evgeniy Timokhov
Evgeniy Timokhov

🔌
Michał Załęcki
Michał Załęcki

💻 🔌
Craig Thompson
Craig Thompson

💻
Jakub Ziółkowski
Jakub Ziółkowski

💻 🔌
Deric Cain
Deric Cain

💻

This project follows the all-contributors specification. Contributions of any kind welcome! Read more!

Package Sidebar

Install

npm i @codechecks/client

Weekly Downloads

4,318

Version

0.1.12

License

MIT

Unpacked Size

142 kB

Total Files

87

Last publish

Collaborators

  • krzkaczor