1 # Shaarli, the personal, minimalist, super-fast, no-database delicious clone.
2 # Makefile for PHP code analysis & testing
5 # - install Composer, either:
6 # - from your distro's package manager;
7 # - from the official website (https://getcomposer.org/download/);
8 # - install/update test dependencies:
9 # $ composer install # 1st setup
11 # - install Xdebug for PHPUnit code coverage reports:
12 # - see http://xdebug.org/docs/install
16 PHP_SOURCE = index.php application tests plugins
17 PHP_COMMA_SOURCE = index.php,application,tests,plugins
19 all: static_analysis_summary test
22 # Concise status of the project
23 # These targets are non-blocking: || exit 0
26 static_analysis_summary: code_sniffer_source copy_paste mess_detector_summary
31 # Detects PHP syntax errors
32 # Documentation (usage, output formatting):
33 # - http://pear.php.net/manual/en/package.php.php-codesniffer.usage.php
34 # - http://pear.php.net/manual/en/package.php.php-codesniffer.reporting.php
37 code_sniffer: code_sniffer_full
39 ### - errors filtered by coding standard: PEAR, PSR1, PSR2, Zend...
41 @$(BIN)/phpcs $(PHP_SOURCE) --report-full --report-width=200 --standard=$*
43 ### - errors by Git author
45 @$(BIN)/phpcs $(PHP_SOURCE) --report-gitblame
47 ### - all errors/warnings
49 @$(BIN)/phpcs $(PHP_SOURCE) --report-full --report-width=200
51 ### - errors grouped by kind
53 @$(BIN)/phpcs $(PHP_SOURCE) --report-source || exit 0
56 # PHP Copy/Paste Detector
57 # Detects code redundancy
58 # Documentation: https://github.com/sebastianbergmann/phpcpd
62 @echo "-----------------------"
63 @echo "PHP COPY/PASTE DETECTOR"
64 @echo "-----------------------"
65 @$(BIN)/phpcpd $(PHP_SOURCE) || exit 0
70 # Detects PHP syntax errors, sorted by category
71 # Rules documentation: http://phpmd.org/rules/index.html
73 MESS_DETECTOR_RULES = cleancode,codesize,controversial,design,naming,unusedcode
76 @echo "-----------------"
77 @echo "PHP MESS DETECTOR"
78 @echo "-----------------"
81 mess_detector: mess_title
82 @$(BIN)/phpmd $(PHP_COMMA_SOURCE) text $(MESS_DETECTOR_RULES) | sed 's_.*\/__'
84 ### - all warnings + HTML output contains links to PHPMD's documentation
86 @$(BIN)/phpmd $(PHP_COMMA_SOURCE) html $(MESS_DETECTOR_RULES) \
87 --reportfile phpmd.html || exit 0
89 ### - warnings grouped by message, sorted by descending frequency order
90 mess_detector_grouped: mess_title
91 @$(BIN)/phpmd $(PHP_SOURCE) text $(MESS_DETECTOR_RULES) \
92 | cut -f 2 | sort | uniq -c | sort -nr
94 ### - summary: number of warnings by rule set
95 mess_detector_summary: mess_title
96 @for rule in $$(echo $(MESS_DETECTOR_RULES) | tr ',' ' '); do \
97 warnings=$$($(BIN)/phpmd $(PHP_COMMA_SOURCE) text $$rule | wc -l); \
98 printf "$$warnings\t$$rule\n"; \
103 # Runs unitary and functional tests
104 # Generates an HTML coverage report if Xdebug is enabled
106 # See phpunit.xml for configuration
107 # https://phpunit.de/manual/current/en/appendixes.configuration.html
113 @$(BIN)/phpunit tests
116 # Targets for repository and documentation maintenance
119 ### remove all unversioned files
123 ### update the local copy of the documentation
126 @git clone https://github.com/shaarli/Shaarli.wiki.git doc
129 ### Generate a custom sidebar
132 # - convert GitHub-flavoured relative links to standard Markdown
133 # - trim HTML, only keep the list (<ul>[...]</ul>) part
135 @echo '<div id="local-sidebar">' > doc/sidebar.html
136 @awk 'BEGIN { FS = "[\\[\\]]{2}" }'\
137 'm = /\[/ { t=$$2; gsub(/ /, "-", $$2); print $$1"["t"]("$$2".html)"$$3 }'\
138 '!m { print $$0 }' doc/_Sidebar.md > doc/tmp.md
139 @pandoc -f markdown -t html5 -s doc/tmp.md | awk '/(ul>|li>)/' >> doc/sidebar.html
140 @echo '</div>' >> doc/sidebar.html
143 ### Convert local markdown documentation to HTML
146 # - infer title from the file name
147 # - convert GitHub-flavoured relative links to standard Markdown
148 # - insert the sidebar menu
150 @for file in `find doc/ -maxdepth 1 -name "*.md"`; do \
151 base=`basename $$file .md`; \
152 sed -i "1i #$${base//-/ }" $$file; \
153 awk 'BEGIN { FS = "[\\[\\]]{2}" }'\
154 'm = /\[/ { t=$$2; gsub(/ /, "-", $$2); print $$1"["t"]("$$2".html)"$$3 }'\
155 '!m { print $$0 }' $$file > doc/tmp.md; \
156 mv doc/tmp.md $$file; \
157 pandoc -f markdown_github -t html5 -s \
158 -c "github-markdown.css" \
159 -T Shaarli -M pagetitle:"$${base//-/ }" -B doc/sidebar.html \
160 -o doc/$$base.html $$file; \
163 htmldoc: doc htmlsidebar htmlpages