Knah-Tsaeb/MyShaarli
Knah-Tsaeb/MyShaarli
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

cleanup: makefile comments

Browse source
This commit is contained in:
nodiscc 2015-04-05 22:16:17 +02:00
parent 8438a2e5d0
commit f3e89f50ec
1 changed files with 18 additions and 21 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

39
Makefile
View file

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