Knowledge Base

  • Using branch Badges

    CodeFactor is very excited to support branch badges that developers can integrate into their repositories on GitHub and Bitbucket. Make code quality visible!

    Here is How

    Go to any repository page and click badge icon to see available options:

    The dialog contains links that are related to currently selected branch:

    Feel free to choose from available styles by adding style=<name> parameter:

    - https://www.codefactor.io/repository/github/codefactor-io/default-configs/badge?style=plastic

    - https://www.codefactor.io/repository/github/codefactor-io/default-configs/badge?style=flat-square

    - https://www.codefactor.io/repository/github/codefactor-io/default-configs/badge?style=for-the-badge

    - https://www.codefactor.io/repository/github/codefactor-io/default-configs/badge?style=social

  • Using GitHub Checks

    By default, CodeFactor updates Pull Request's status during review. E.g.:

    To view any reported issues you must click Details link and visit CodeFactor page with review results.

    A more integrated approach would be to report issues as code comments inside pull request and this is what GitHub Checks feature is for. To enable it go to repository Settings page and click Enable under GitHub App panel:

    If you'd like to revert back to status-only reviews, click Update under GitHub App panel or visit App install page on GitHub to perform uninstall.

  • I do not see any code coverage results

    CodeFactor.io aims to provide super fast code reviews and actionable feedback via Static Code Analysis. We do not support Code Coverage at this time and do not currently have plans to do so. But we hear that some of the Users that use CodeFactor for code analysis, use https://coveralls.io or https://about.codecov.io or similar services for test coverage.

  • Auto-Fix

    CodeFactor can fix certain reported issues. This can be done on-demand or automatically. We currently support:

    - Detekt

    - ESLint

    - PHP_CodeSniffer

    - Linter for Dart

    - Stylelint (please note of limitation when using unscoped disable comments, i.e. /* stylelint-disable */. For such files the entirety of source will not be auto-fixed.)

    - TSLint

    - RuboCop

    - SwiftLint

    On-demand fixes

    When visiting a page with fixable issues, you can create new PR or commit manually:

    If you do not see this button it means CodeFactor did not find any issues that can be fixed.

    We recommend using it to test this