Merge pull request #393 from ArthurHoaro/tools-js-indent

[github/shaarli/Shaarli.git] / Makefile

diff --git a/Makefile b/Makefile
index 28353587c238dfdd91809d00d7debc751c2178e7..a86f9aa8bbe8bdb0b160db7cea331ba605a3eeb0 100644 (file)
--- a/Makefile
+++ b/Makefile
@@ -13,8 +13,8 @@
 #   - 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
 
@@ -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
@@ -106,6 +110,7 @@ test:
        @echo "-------"
        @echo "PHPUNIT"
        @echo "-------"
+       @mkdir -p sandbox
        @$(BIN)/phpunit tests
 
 ##
@@ -115,6 +120,12 @@ test:
 ### remove all unversioned files
 clean:
        @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
@@ -122,8 +133,38 @@ doc: clean
        @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