1 # The personal, minimalist, super-fast, database free, bookmarking service.
2 # Makefile for PHP code analysis & testing, documentation and release generation
6 all: static_analysis_summary check_permissions test
11 # Shaarli sources and vendored libraries are copied from a shared volume
12 # to a user-owned directory to enable running tests as a non-root user.
15 rsync -az /shaarli/ ~/shaarli/
16 cd ~/shaarli && make $*
20 # Detects PHP syntax errors
21 # Documentation (usage, output formatting):
22 # - http://pear.php.net/manual/en/package.php.php-codesniffer.usage.php
23 # - http://pear.php.net/manual/en/package.php.php-codesniffer.reporting.php
30 ### - errors filtered by coding standard: PEAR, PSR1, PSR2, Zend...
32 @$(PHPCS) --report-full --report-width=200 --standard=$*
34 ### - errors by Git author
36 @$(PHPCS) --report-gitblame
38 ### - all errors/warnings
40 @$(PHPCS) --report-full --report-width=200
42 ### - errors grouped by kind
44 @$(PHPCS) --report-source || exit 0
47 # Checks source file & script permissions
50 @echo "----------------------"
51 @echo "Check file permissions"
52 @echo "----------------------"
53 @for file in `git ls-files | grep -v docker`; do \
54 if [ -x $$file ]; then \
56 echo "$${file} is executable"; \
58 done; [ -z $$errors ] || false
62 # Runs unitary and functional tests
63 # Generates an HTML coverage report if Xdebug is enabled
65 # See phpunit.xml for configuration
66 # https://phpunit.de/manual/current/en/appendixes.configuration.html
72 @mkdir -p sandbox coverage
73 @$(BIN)/phpunit --coverage-php coverage/main.cov --bootstrap tests/bootstrap.php --testsuite unit-tests
78 --coverage-php coverage/$(firstword $(subst _, ,$*)).cov \
79 --bootstrap tests/languages/bootstrap.php \
80 --testsuite language-$(firstword $(subst _, ,$*))
82 all_tests: test locale_test_de_DE locale_test_en_US locale_test_fr_FR
83 @$(BIN)/phpcov merge --html coverage coverage
84 @# --text doesn't work with phpunit 4.* (v5 requires PHP 5.6)
85 @#$(BIN)/phpcov merge --text coverage/txt coverage
88 # Custom release archive generation
90 # For each tagged revision, GitHub provides tar and zip archives that correspond
91 # to the output of git-archive
93 # These targets produce similar archives, featuring 3rd-party dependencies
94 # to ease deployment on shared hosting.
96 ARCHIVE_VERSION := shaarli-$$(git describe)-full
97 ARCHIVE_PREFIX=Shaarli/
99 release_archive: release_tar release_zip
101 ### download 3rd-party PHP libraries
102 composer_dependencies: clean
103 composer install --no-dev --prefer-dist
104 find vendor/ -name ".git" -type d -exec rm -rf {} +
106 ### download 3rd-party frontend libraries
107 frontend_dependencies:
110 ### Build frontend dependencies
111 build_frontend: frontend_dependencies
114 ### generate a release tarball and include 3rd-party dependencies and translations
115 release_tar: composer_dependencies htmldoc translate build_frontend
116 git archive --prefix=$(ARCHIVE_PREFIX) -o $(ARCHIVE_VERSION).tar HEAD
117 tar rvf $(ARCHIVE_VERSION).tar --transform "s|^vendor|$(ARCHIVE_PREFIX)vendor|" vendor/
118 tar rvf $(ARCHIVE_VERSION).tar --transform "s|^doc/html|$(ARCHIVE_PREFIX)doc/html|" doc/html/
119 tar rvf $(ARCHIVE_VERSION).tar --transform "s|^tpl|$(ARCHIVE_PREFIX)tpl|" tpl/
120 gzip $(ARCHIVE_VERSION).tar
122 ### generate a release zip and include 3rd-party dependencies and translations
123 release_zip: composer_dependencies htmldoc translate build_frontend
124 git archive --prefix=$(ARCHIVE_PREFIX) -o $(ARCHIVE_VERSION).zip -9 HEAD
125 mkdir -p $(ARCHIVE_PREFIX)/{doc,vendor}
126 rsync -a doc/html/ $(ARCHIVE_PREFIX)doc/html/
127 zip -r $(ARCHIVE_VERSION).zip $(ARCHIVE_PREFIX)doc/
128 rsync -a vendor/ $(ARCHIVE_PREFIX)vendor/
129 zip -r $(ARCHIVE_VERSION).zip $(ARCHIVE_PREFIX)vendor/
130 rsync -a tpl/ $(ARCHIVE_PREFIX)tpl/
131 zip -r $(ARCHIVE_VERSION).zip $(ARCHIVE_PREFIX)tpl/
132 rm -rf $(ARCHIVE_PREFIX)
135 # Targets for repository and documentation maintenance
138 ### remove all unversioned files
143 ### generate the AUTHORS file from Git commit information
145 @cp .github/mailmap .mailmap
146 @git shortlog -sne > AUTHORS
149 ### generate phpDocumentor documentation
151 @docker run --rm -v $(PWD):/data -u `id -u`:`id -g` phpdoc/phpdoc
153 ### generate HTML documentation from Markdown pages with MkDocs
155 python3 -m venv venv/
156 bash -c 'source venv/bin/activate; \
157 pip install mkdocs; \
158 mkdocs build --clean'
159 find doc/html/ -type f -exec chmod a-x '{}' \;
163 ### Generate Shaarli's translation compiled file (.mo)
165 @find inc/languages/ -name shaarli.po -execdir msgfmt shaarli.po -o shaarli.mo \;
167 ### Run ESLint check against Shaarli's JS files
169 @yarn run eslint -c .dev/.eslintrc.js assets/vintage/js/
170 @yarn run eslint -c .dev/.eslintrc.js assets/default/js/
172 ### Run CSSLint check against Shaarli's SCSS files
174 @yarn run sass-lint -c .dev/.sasslintrc 'assets/default/scss/*.scss' -v -q