123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110 |
- # Shaarli, the personal, minimalist, super-fast, no-database delicious clone.
- # Makefile for PHP code analysis & testing
- # Prerequisites:
- # - install Composer, either:
- # - from your distro's package manager;
- # - from the official website (https://getcomposer.org/download/);
- # - install/update test dependencies:
- # $ composer install # 1st setup
- # $ composer update
- BIN = vendor/bin
- PHP_SOURCE = index.php
- MESS_DETECTOR_RULES = cleancode,codesize,controversial,design,naming,unusedcode
- all: static_analysis_summary
- ##
- # Concise status of the project
- # These targets are non-blocking: || exit 0
- ##
- static_analysis_summary: code_sniffer_source copy_paste mess_detector_summary
- ##
- # PHP_CodeSniffer
- # Detects PHP syntax errors
- # Documentation (usage, output formatting):
- # - http://pear.php.net/manual/en/package.php.php-codesniffer.usage.php
- # - http://pear.php.net/manual/en/package.php.php-codesniffer.reporting.php
- ##
- code_sniffer: code_sniffer_full
- ### - errors by Git author
- code_sniffer_blame:
- @$(BIN)/phpcs $(PHP_SOURCE) --report-gitblame
- ### - all errors/warnings
- code_sniffer_full:
- @$(BIN)/phpcs $(PHP_SOURCE) --report-full --report-width=200
- ### - errors grouped by kind
- code_sniffer_source:
- @$(BIN)/phpcs $(PHP_SOURCE) --report-source || exit 0
- ##
- # PHP Copy/Paste Detector
- # Detects code redundancy
- # Documentation: https://github.com/sebastianbergmann/phpcpd
- ##
- copy_paste:
- @echo "-----------------------"
- @echo "PHP COPY/PASTE DETECTOR"
- @echo "-----------------------"
- @$(BIN)/phpcpd $(PHP_SOURCE) || exit 0
- @echo
- ##
- # PHP Mess Detector
- # Detects PHP syntax errors, sorted by category
- # Rules documentation: http://phpmd.org/rules/index.html
- ##
- mess_title:
- @echo "-----------------"
- @echo "PHP MESS DETECTOR"
- @echo "-----------------"
- ### - all warnings
- mess_detector: mess_title
- @$(BIN)/phpmd $(PHP_SOURCE) text $(MESS_DETECTOR_RULES) | sed 's_.*\/__'
- ### - all warnings + HTML output contains links to PHPMD's documentation
- mess_detector_html:
- @$(BIN)/phpmd $(PHP_SOURCE) html $(MESS_DETECTOR_RULES) \
- --reportfile phpmd.html || exit 0
- ### - warnings grouped by message, sorted by descending frequency order
- mess_detector_grouped: mess_title
- @$(BIN)/phpmd $(PHP_SOURCE) text $(MESS_DETECTOR_RULES) \
- | cut -f 2 | sort | uniq -c | sort -nr
- ### - summary: number of warnings by rule set
- mess_detector_summary: mess_title
- @for rule in $$(echo $(MESS_DETECTOR_RULES) | tr ',' ' '); do \
- warnings=$$($(BIN)/phpmd $(PHP_SOURCE) text $$rule | wc -l); \
- printf "$$warnings\t$$rule\n"; \
- done;
- ##
- # Targets for repository and documentation maintenance
- ##
- ### remove all unversioned files
- clean:
- @git clean -df
- ### update the local copy of the documentation
- doc: clean
- @rm -rf doc
- @git clone https://github.com/shaarli/Shaarli.wiki.git doc
- @rm -rf doc/.git
- ### Convert local markdown documentation to HTML
- htmldoc:
- for file in `find doc/ -maxdepth 1 -name "*.md"`; do \
- pandoc -f markdown_github -t html5 -s -c "github-markdown.css" -o doc/`basename $$file .md`.html "$$file"; \
- done;
|