Giter Site home page Giter Site logo

checkupjs / checkup Goto Github PK

View Code? Open in Web Editor NEW
76.0 5.0 23.0 9.77 MB

A health checkup for your project.

Home Page: https://checkupjs.github.io/

License: MIT License

JavaScript 1.75% TypeScript 96.51% Handlebars 0.05% EJS 1.68% CSS 0.01%
checkup health-checkup insights static-analysis

checkup's Introduction

checkup

Checkup is the easiest way to gather static analysis insights for your projects.


CI Build License Dependabot Volta Managed TypeScript Code Style: prettier

Checkup is a framework that uses static analysis and gain insights to help drive maintenance decisions. It provides a framework to run tasks to gather information about the craftsmanship and quality of your codebase. Task results are output as SARIF, which provides a consistent schema for data processing, and can be integrated into your development workflow through IDE integrations.

Checkup summary output

Checkup allows you to determine the important information you care about, and provides the infrastructure to gather and output that data.

Tasks can gather insights on things like

  • Code structure - to give shape to your project, which can help you understand the codebase and identify areas of improvement
  • Dependency health - such as which dependency versions are out of date, or outside supported ranges
  • Test health - to identify types of tests used, which tests are being skipped, and what the shape of the test infrastructure is
  • API compatability - to identify which APIs are being used, and which are not
  • Migration status - to give practical insight into how your codebase is being migrated
  • Anything else you can dream up... ๐Ÿ’ก

Features

  • Task Runner CLI - A CLI that runs tasks that can be loaded via plugins.
  • Code Generators - A collection of generators allowing you to generate a checkup config file, plugin project structure, and task files and tests.
  • Plugins - Existing plugins for JavaScript and Ember.

Installation and Usage

See the documentation for information on installation and usage.

Contributing

To contribute, please read the CONTRIBUTING guidelines.

Contributors โœจ

Thanks goes to these wonderful people (emoji key):


Steve Calvert

๐Ÿ’ป ๐Ÿ’ฌ ๐Ÿ‘€ ๐Ÿš‡

carakessler

๐Ÿ’ป ๐Ÿ’ฌ ๐Ÿ‘€ ๐Ÿš‡

Zhan Wang

๐Ÿ’ป ๐Ÿ‘€

Mahir Shah

๐Ÿ’ป

Tyler Becks

๐Ÿ’ป

Gabriel Csapo

๐Ÿ’ป

Lisa Li

๐Ÿ’ป

Evan Solomon

๐Ÿ’ป

Omayeli Arenyeka

๐Ÿ’ป

Chad Hietala

๐Ÿ’ป

Robert Jackson

๐Ÿ’ป ๐Ÿ’ฌ ๐Ÿ‘€ ๐Ÿš‡

Brenden Palmer

๐Ÿ’ป

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

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.