ast metrics

AST метрики

Metrics AST-это вспыхивающий статический кодовый анализатор. Он предоставляет метрики о вашем коде и помогает вам на раннем этапе выявлять потенциальные проблемы.

Документация | Вклад | Twitter

Предварительный просмотр

Быстрый старт

Откройте свой терминал и запустите следующую команду:

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

Установка

Metrics AST - это отдельный пакет. Это не требует установки какого -либо другого программного обеспечения.

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

или следуйте инструкциям по установке.

Важный

Пожалуйста, всегда читайте любой сценарий, найденной в Интернете, прежде чем запустить его, и никогда не используйте привилегированный доступ для его запуска.

Почему?

Анализ статического кода-это изменение игры для улучшения качества кода. Это помогает вам достать потенциальные проблемы на раннем этапе, обеспечить соблюдение стандартов кодирования и получить более глубокое представление о вашей кодовой базе.

С метриками AST вы можете:

• Получите обзор птичьего полета о своем проекте : быстро идентифицируйте чрезмерно сложный код или тесно связанные классы, которые могут замедлить вашу разработку или представить ошибки.
• Обеспечение архитектурной когерентности : убедитесь, что ваша структура кода соответствует лучшей практике - например, убедиться, что ваш уровень обслуживания не зависит от вашего уровня доступа к данным.

Независимо от того, поддерживаете ли вы существующую кодовую базу или создаете новую, метрики AST дают вам возможность писать лучше, более поддерживаемый код.

Функции

• Разработано для CI/CD . Вы можете интегрировать его в свой трубопровод, чтобы проверить, что ваш код соответствует вашим стандартам качества, вы можете интегрировать его в свои конвейеры CI, независимо от того, используете ли вы действия GitHub или Gitlab CI.
• Быстро и эффективно .
• Предоставляет простые и подробные отчеты.
• Анализ кода : Цикломатическая сложность, обслуживаемость, размер ...
• Анализ связи : нестабильность, афферентная связь ...
• Анализ деятельности : количество коммитов, автобусный фактор ...
• Легко установить : нет зависимостей, конфигурация не требуется .

Узнайте больше в документации

Внося

Метрики AST экспериментальны и активно развиваются. Мы приветствуем взносы.

Не стесняйтесь открывать дискуссию. Мы любим предложения, идеи, отчеты об ошибках и другие вклады.

Если вы хотите внести свой вклад в кодовую базу, ознакомьтесь с руководством для начала.

Мы ищем помощь в поддержке новых языков программирования, стабилизировали инструмент и обогащаем его. Вот список поддерживаемых языков:

• ✅ PHP (PHP 5, PHP 7, = <php 8.1)
• ✅ Голанг
• ? Python (частично)
• ? Дрэк
• ? Разветвление
• ? Машинопись
• ? Ява

Лицензия

AST Metrics-это программное обеспечение с открытым исходным кодом, лицензированное по лицензии MIT