123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223 |
- # The personal, minimalist, super-fast, database free, bookmarking service.
- # Makefile for PHP code analysis & testing, documentation and release generation
- # Prerequisites:
- # - install Composer, either:
- # - from your distro's package manager;
- # - from the official website (https://getcomposer.org/download/);
- # - install/update test dependencies:
- # $ composer install # 1st setup
- # $ composer update
- # - install Xdebug for PHPUnit code coverage reports:
- # - see http://xdebug.org/docs/install
- # - enable in php.ini
- BIN = vendor/bin
- PHP_SOURCE = index.php application tests plugins
- PHP_COMMA_SOURCE = index.php,application,tests,plugins
- all: static_analysis_summary check_permissions test
- ##
- # Concise status of the project
- # These targets are non-blocking: || exit 0
- ##
- static_analysis_summary: code_sniffer_source copy_paste mess_detector_summary
- @echo
- ##
- # PHP_CodeSniffer
- # Detects PHP syntax errors
- # 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.reporting.php
- ##
- 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
- ### - all errors/warnings
- code_sniffer_full:
- @$(BIN)/phpcs $(PHP_SOURCE) --report-full --report-width=200
- ### - errors grouped by kind
- code_sniffer_source:
- @$(BIN)/phpcs $(PHP_SOURCE) --report-source || exit 0
- ##
- # PHP Copy/Paste Detector
- # Detects code redundancy
- # Documentation: https://github.com/sebastianbergmann/phpcpd
- ##
- copy_paste:
- @echo "-----------------------"
- @echo "PHP COPY/PASTE DETECTOR"
- @echo "-----------------------"
- @$(BIN)/phpcpd $(PHP_SOURCE) || exit 0
- @echo
- ##
- # PHP Mess Detector
- # Detects PHP syntax errors, sorted by category
- # Rules documentation: http://phpmd.org/rules/index.html
- ##
- MESS_DETECTOR_RULES = cleancode,codesize,controversial,design,naming,unusedcode
- mess_title:
- @echo "-----------------"
- @echo "PHP MESS DETECTOR"
- @echo "-----------------"
- ### - all warnings
- mess_detector: mess_title
- @$(BIN)/phpmd $(PHP_COMMA_SOURCE) text $(MESS_DETECTOR_RULES) | sed 's_.*\/__'
- ### - all warnings + HTML output contains links to PHPMD's documentation
- mess_detector_html:
- @$(BIN)/phpmd $(PHP_COMMA_SOURCE) html $(MESS_DETECTOR_RULES) \
- --reportfile phpmd.html || exit 0
- ### - warnings grouped by message, sorted by descending frequency order
- mess_detector_grouped: mess_title
- @$(BIN)/phpmd $(PHP_SOURCE) text $(MESS_DETECTOR_RULES) \
- | cut -f 2 | sort | uniq -c | sort -nr
- ### - summary: number of warnings by rule set
- mess_detector_summary: mess_title
- @for rule in $$(echo $(MESS_DETECTOR_RULES) | tr ',' ' '); do \
- warnings=$$($(BIN)/phpmd $(PHP_COMMA_SOURCE) text $$rule | wc -l); \
- 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
- # Generates an HTML coverage report if Xdebug is enabled
- #
- # See phpunit.xml for configuration
- # https://phpunit.de/manual/current/en/appendixes.configuration.html
- ##
- test:
- @echo "-------"
- @echo "PHPUNIT"
- @echo "-------"
- @mkdir -p sandbox
- @$(BIN)/phpunit tests
- ##
- # Custom release archive generation
- #
- # For each tagged revision, GitHub provides tar and zip archives that correspond
- # to the output of git-archive
- #
- # These targets produce similar archives, featuring 3rd-party dependencies
- # to ease deployment on shared hosting.
- ##
- ARCHIVE_VERSION := shaarli-$$(git describe)-full
- ARCHIVE_PREFIX=Shaarli/
- release_archive: release_tar release_zip
- ### download 3rd-party PHP libraries
- composer_dependencies: clean
- composer update --no-dev
- find vendor/ -name ".git" -type d -exec rm -rf {} +
- ### generate a release tarball and include 3rd-party dependencies
- release_tar: composer_dependencies
- git archive --prefix=$(ARCHIVE_PREFIX) -o $(ARCHIVE_VERSION).tar HEAD
- tar rvf $(ARCHIVE_VERSION).tar --transform "s|^vendor|$(ARCHIVE_PREFIX)vendor|" vendor/
- gzip $(ARCHIVE_VERSION).tar
- ### generate a release zip and include 3rd-party dependencies
- release_zip: composer_dependencies
- git archive --prefix=$(ARCHIVE_PREFIX) -o $(ARCHIVE_VERSION).zip -9 HEAD
- mkdir $(ARCHIVE_PREFIX)
- rsync -a vendor/ $(ARCHIVE_PREFIX)vendor/
- zip -r $(ARCHIVE_VERSION).zip $(ARCHIVE_PREFIX)vendor/
- rm -rf $(ARCHIVE_PREFIX)
- ##
- # Targets for repository and documentation maintenance
- ##
- ### remove all unversioned files
- clean:
- @git clean -df
- @rm -rf sandbox
- ### generate the AUTHORS file from Git commit information
- authors:
- @cp .github/mailmap .mailmap
- @git shortlog -sne > AUTHORS
- @rm .mailmap
- ### 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
- ### 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
- #
- # 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: authors doc htmlsidebar htmlpages
|