]> git.immae.eu Git - github/shaarli/Shaarli.git/blame - Makefile
Doc: sync from Wiki, generate HTML
[github/shaarli/Shaarli.git] / Makefile
CommitLineData
00f98bda 1# Shaarli, the personal, minimalist, super-fast, no-database delicious clone.
00f98bda 2# Makefile for PHP code analysis & testing
f3e89f50 3
00f98bda
V
4# Prerequisites:
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
10# $ composer update
ca74886f
V
11# - install Xdebug for PHPUnit code coverage reports:
12# - see http://xdebug.org/docs/install
13# - enable in php.ini
f3e89f50 14
00f98bda 15BIN = vendor/bin
ca74886f
V
16PHP_SOURCE = index.php application tests
17PHP_COMMA_SOURCE = index.php,application,tests
00f98bda 18
ca74886f 19all: static_analysis_summary test
00f98bda
V
20
21##
22# Concise status of the project
00f98bda
V
23# These targets are non-blocking: || exit 0
24##
f3e89f50 25
00f98bda 26static_analysis_summary: code_sniffer_source copy_paste mess_detector_summary
ca74886f 27 @echo
00f98bda
V
28
29##
30# PHP_CodeSniffer
00f98bda 31# Detects PHP syntax errors
00f98bda
V
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
35##
f3e89f50 36
00f98bda
V
37code_sniffer: code_sniffer_full
38
3e25f245
V
39### - errors filtered by coding standard: PEAR, PSR1, PSR2, Zend...
40PHPCS_%:
41 @$(BIN)/phpcs $(PHP_SOURCE) --report-full --report-width=200 --standard=$*
42
f3e89f50 43### - errors by Git author
00f98bda
V
44code_sniffer_blame:
45 @$(BIN)/phpcs $(PHP_SOURCE) --report-gitblame
46
f3e89f50 47### - all errors/warnings
00f98bda
V
48code_sniffer_full:
49 @$(BIN)/phpcs $(PHP_SOURCE) --report-full --report-width=200
50
f3e89f50 51### - errors grouped by kind
00f98bda
V
52code_sniffer_source:
53 @$(BIN)/phpcs $(PHP_SOURCE) --report-source || exit 0
54
55##
56# PHP Copy/Paste Detector
00f98bda 57# Detects code redundancy
00f98bda
V
58# Documentation: https://github.com/sebastianbergmann/phpcpd
59##
f3e89f50 60
00f98bda
V
61copy_paste:
62 @echo "-----------------------"
63 @echo "PHP COPY/PASTE DETECTOR"
64 @echo "-----------------------"
65 @$(BIN)/phpcpd $(PHP_SOURCE) || exit 0
66 @echo
67
68##
69# PHP Mess Detector
00f98bda 70# Detects PHP syntax errors, sorted by category
00f98bda 71# Rules documentation: http://phpmd.org/rules/index.html
f3e89f50 72##
ca74886f 73MESS_DETECTOR_RULES = cleancode,codesize,controversial,design,naming,unusedcode
f3e89f50 74
00f98bda
V
75mess_title:
76 @echo "-----------------"
77 @echo "PHP MESS DETECTOR"
78 @echo "-----------------"
79
f3e89f50 80### - all warnings
00f98bda 81mess_detector: mess_title
ca74886f 82 @$(BIN)/phpmd $(PHP_COMMA_SOURCE) text $(MESS_DETECTOR_RULES) | sed 's_.*\/__'
00f98bda 83
f3e89f50 84### - all warnings + HTML output contains links to PHPMD's documentation
00f98bda 85mess_detector_html:
ca74886f 86 @$(BIN)/phpmd $(PHP_COMMA_SOURCE) html $(MESS_DETECTOR_RULES) \
00f98bda
V
87 --reportfile phpmd.html || exit 0
88
f3e89f50 89### - warnings grouped by message, sorted by descending frequency order
00f98bda
V
90mess_detector_grouped: mess_title
91 @$(BIN)/phpmd $(PHP_SOURCE) text $(MESS_DETECTOR_RULES) \
92 | cut -f 2 | sort | uniq -c | sort -nr
93
f3e89f50 94### - summary: number of warnings by rule set
00f98bda
V
95mess_detector_summary: mess_title
96 @for rule in $$(echo $(MESS_DETECTOR_RULES) | tr ',' ' '); do \
ca74886f 97 warnings=$$($(BIN)/phpmd $(PHP_COMMA_SOURCE) text $$rule | wc -l); \
00f98bda
V
98 printf "$$warnings\t$$rule\n"; \
99 done;
1acc87ee 100
ca74886f
V
101##
102# PHPUnit
103# Runs unitary and functional tests
104# Generates an HTML coverage report if Xdebug is enabled
105#
106# See phpunit.xml for configuration
107# https://phpunit.de/manual/current/en/appendixes.configuration.html
108##
d0ce99e5 109test:
ca74886f
V
110 @echo "-------"
111 @echo "PHPUNIT"
112 @echo "-------"
113 @$(BIN)/phpunit tests
114
1acc87ee 115##
116# Targets for repository and documentation maintenance
f3e89f50 117##
118
119### remove all unversioned files
1acc87ee 120clean:
d0ce99e5 121 @git clean -df
1acc87ee 122
f3e89f50 123### update the local copy of the documentation
1acc87ee 124doc: clean
d0ce99e5
V
125 @rm -rf doc
126 @git clone https://github.com/shaarli/Shaarli.wiki.git doc
127 @rm -rf doc/.git
82af78b2 128
992af0b9
V
129### Generate a custom sidebar
130#
131# Sidebar content:
132# - convert GitHub-flavoured relative links to standard Markdown
133# - trim HTML, only keep the list (<ul>[...]</ul>) part
134htmlsidebar:
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
141 @rm doc/tmp.md
142
82af78b2 143### Convert local markdown documentation to HTML
992af0b9
V
144#
145# For all pages:
146# - infer title from the file name
147# - convert GitHub-flavoured relative links to standard Markdown
148# - insert the sidebar menu
149htmlpages:
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; \
ca74886f 161 done;
992af0b9
V
162
163htmldoc: doc htmlsidebar htmlpages