Bump version to v0.7.1

[github/shaarli/Shaarli.git] / Makefile

diff --git a/Makefile b/Makefile
index 80efcfaafd0e2973c4ea73aaf0c33e3ff77a0ca0..75c54f2875d012539e1ff3be563cabacdbf77041 100644 (file)
--- a/Makefile
+++ b/Makefile
@@ -13,10 +13,10 @@
 #   - enable in php.ini
 
 BIN = vendor/bin
-PHP_SOURCE = index.php application tests
-PHP_COMMA_SOURCE = index.php,application,tests
+PHP_SOURCE = index.php application tests plugins
+PHP_COMMA_SOURCE = index.php,application,tests,plugins
 
-all: static_analysis_summary test
+all: static_analysis_summary check_permissions test
 
 ##
 # Concise status of the project
@@ -36,6 +36,10 @@ static_analysis_summary: code_sniffer_source copy_paste mess_detector_summary
 
 code_sniffer: code_sniffer_full
 
+### - errors filtered by coding standard: PEAR, PSR1, PSR2, Zend...
+PHPCS_%:
+       @$(BIN)/phpcs $(PHP_SOURCE) --report-full --report-width=200 --standard=$*
+
 ### - errors by Git author
 code_sniffer_blame:
        @$(BIN)/phpcs $(PHP_SOURCE) --report-gitblame
@@ -94,6 +98,20 @@ mess_detector_summary: mess_title
                printf "$$warnings\t$$rule\n"; \
        done;
 
+##
+# Checks source file & script permissions
+##
+check_permissions:
+       @echo "----------------------"
+       @echo "Check file permissions"
+       @echo "----------------------"
+       @for file in `git ls-files`; do \
+               if [ -x $$file ]; then \
+                       errors=true; \
+                       echo "$${file} is executable"; \
+               fi \
+       done; [ -z $$errors ] || false
+
 ##
 # PHPUnit
 # Runs unitary and functional tests
@@ -102,10 +120,11 @@ mess_detector_summary: mess_title
 # See phpunit.xml for configuration
 # https://phpunit.de/manual/current/en/appendixes.configuration.html
 ##
-test: clean
+test:
        @echo "-------"
        @echo "PHPUNIT"
        @echo "-------"
+       @mkdir -p sandbox
        @$(BIN)/phpunit tests
 
 ##
@@ -114,16 +133,52 @@ test: clean
 
 ### remove all unversioned files
 clean:
-               @git clean -df
+       @git clean -df
+       @rm -rf sandbox
+
+### generate Doxygen documentation
+doxygen: clean
+       @rm -rf doxygen
+       @( cat Doxyfile ; echo "PROJECT_NUMBER=`git describe`" ) | doxygen -
 
 ### 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
+       @rm -rf doc
+       @git clone https://github.com/shaarli/Shaarli.wiki.git doc
+       @rm -rf doc/.git
+
+### Generate a custom sidebar
+#
+# Sidebar content:
+#  - convert GitHub-flavoured relative links to standard Markdown
+#  - trim HTML, only keep the list (<ul>[...]</ul>) part
+htmlsidebar:
+       @echo '<div id="local-sidebar">' > doc/sidebar.html
+       @awk 'BEGIN { FS = "[\\[\\]]{2}" }'\
+       'm = /\[/ { t=$$2; gsub(/ /, "-", $$2); print $$1"["t"]("$$2".html)"$$3 }'\
+       '!m { print $$0 }' doc/_Sidebar.md > doc/tmp.md
+       @pandoc -f markdown -t html5 -s doc/tmp.md | awk '/(ul>|li>)/' >> doc/sidebar.html
+       @echo '</div>' >> doc/sidebar.html
+       @rm doc/tmp.md
 
 ### 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"; \
+#
+# For all pages:
+#  - infer title from the file name
+#  - convert GitHub-flavoured relative links to standard Markdown
+#  - insert the sidebar menu
+htmlpages:
+       @for file in `find doc/ -maxdepth 1 -name "*.md"`; do \
+               base=`basename $$file .md`; \
+               sed -i "1i #$${base//-/ }" $$file; \
+               awk 'BEGIN { FS = "[\\[\\]]{2}" }'\
+       'm = /\[/ { t=$$2; gsub(/ /, "-", $$2); print $$1"["t"]("$$2".html)"$$3 }'\
+       '!m { print $$0 }' $$file > doc/tmp.md; \
+               mv doc/tmp.md $$file; \
+               pandoc -f markdown_github -t html5 -s \
+                       -c "github-markdown.css" \
+                       -T Shaarli -M pagetitle:"$${base//-/ }" -B doc/sidebar.html \
+                       -o doc/$$base.html $$file; \
        done;
+
+htmldoc: doc htmlsidebar htmlpages