Code Monkey home page Code Monkey logo

ast-metrics's Introduction

AST Metrics

PhpMetrics

CI GitHub Release

AST Metrics is a blazing-fast static code analyzer. It provides metrics about your code, and helps you to identify potential problems early on.

Documentation | Twitter | Contributing





Preview

HTML report

Quick start

Open your terminal and run the following command:

ast-metrics analyze --report-html=<directory> /path/to/your/code

Installation

AST Metrics is a standalone package. It does not require any other software to be installed.

curl -s https://raw.githubusercontent.com/Halleck45/ast-metrics/main/scripts/download.sh|bash

or follow the detailled installation instructions.

Important

Please always read any script found on the internet before running it, and never use privileged access to run it.

Features

  • Designed for CI/CD. You can integrate it into your pipeline to check that your code meets your quality standards.
  • Fast and efficient.
  • Provides simple and detailed reports.
  • Code analysis: cyclomatic complexity, maintainability, size...
  • Coupling analysis: instability, afferent coupling...
  • Activity analysis: number of commits, bus factor...

Read more in the documentation

Contributing

AST Metrics is experimental and actively developed. We welcome contributions.

Feel free to open a discussion. We love suggestions, ideas, bug reports, and other contributions.

If you want to contribute code, please read the contributing guidelines to get started.

We are looking for help to support new programming languages, stabilize the tool, and enrich it. Here is the list of supported languages:

  • โœ… PHP (full)
  • ๐Ÿ‘ท Python (partial)
  • ๐Ÿ‘ท Golang (partial)
  • ๐Ÿ•› Dart
  • ๐Ÿ•› Flutter
  • ๐Ÿ•› TypeScript
  • ๐Ÿ•› Java

License

AST Metrics is open-source software licensed under the MIT license

ast-metrics's People

Contributors

halleck45 avatar dependabot[bot] avatar

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.