]> git.immae.eu Git - github/shaarli/Shaarli.git/blobdiff - Makefile
Upgrade composer - web-thumbnailer v1.3.0
[github/shaarli/Shaarli.git] / Makefile
index 2064303afa379e5b4f40ed6fd04aea878f0afa08..56cf09b2e0abdbcad70e1553bf17db4a763011a3 100644 (file)
--- a/Makefile
+++ b/Makefile
@@ -1,23 +1,22 @@
 # 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
 
+##
+# Docker test adapter
+#
+# Shaarli sources and vendored libraries are copied from a shared volume
+# to a user-owned directory to enable running tests as a non-root user.
+##
+docker_%:
+       rsync -az /shaarli/ ~/shaarli/
+       cd ~/shaarli && make $*
+
 ##
 # Concise status of the project
 # These targets are non-blocking: || exit 0
@@ -105,7 +104,7 @@ check_permissions:
        @echo "----------------------"
        @echo "Check file permissions"
        @echo "----------------------"
-       @for file in `git ls-files`; do \
+       @for file in `git ls-files | grep -v docker`; do \
                if [ -x $$file ]; then \
                        errors=true; \
                        echo "$${file} is executable"; \
@@ -120,12 +119,12 @@ check_permissions:
 # See phpunit.xml for configuration
 # https://phpunit.de/manual/current/en/appendixes.configuration.html
 ##
-test:
+test: translate
        @echo "-------"
        @echo "PHPUNIT"
        @echo "-------"
        @mkdir -p sandbox coverage
-       @$(BIN)/phpunit --coverage-php coverage/main.cov --testsuite unit-tests
+       @$(BIN)/phpunit --coverage-php coverage/main.cov --bootstrap tests/bootstrap.php --testsuite unit-tests
 
 locale_test_%:
        @UT_LOCALE=$*.utf8 \
@@ -155,21 +154,35 @@ release_archive: release_tar release_zip
 
 ### download 3rd-party PHP libraries
 composer_dependencies: clean
-       composer update --no-dev
+       composer install --no-dev --prefer-dist
        find vendor/ -name ".git" -type d -exec rm -rf {} +
 
-### generate a release tarball and include 3rd-party dependencies
-release_tar: composer_dependencies
+### download 3rd-party frontend libraries
+frontend_dependencies:
+       yarn install
+
+### Build frontend dependencies
+build_frontend: frontend_dependencies
+       yarn run build
+
+### generate a release tarball and include 3rd-party dependencies and translations
+release_tar: composer_dependencies htmldoc translate build_frontend
        git archive --prefix=$(ARCHIVE_PREFIX) -o $(ARCHIVE_VERSION).tar HEAD
        tar rvf $(ARCHIVE_VERSION).tar --transform "s|^vendor|$(ARCHIVE_PREFIX)vendor|" vendor/
+       tar rvf $(ARCHIVE_VERSION).tar --transform "s|^doc/html|$(ARCHIVE_PREFIX)doc/html|" doc/html/
+       tar rvf $(ARCHIVE_VERSION).tar --transform "s|^tpl|$(ARCHIVE_PREFIX)tpl|" tpl/
        gzip $(ARCHIVE_VERSION).tar
 
-### generate a release zip and include 3rd-party dependencies
-release_zip: composer_dependencies
+### generate a release zip and include 3rd-party dependencies and translations
+release_zip: composer_dependencies htmldoc translate build_frontend
        git archive --prefix=$(ARCHIVE_PREFIX) -o $(ARCHIVE_VERSION).zip -9 HEAD
-       mkdir $(ARCHIVE_PREFIX)
+       mkdir -p $(ARCHIVE_PREFIX)/{doc,vendor}
+       rsync -a doc/html/ $(ARCHIVE_PREFIX)doc/html/
+       zip -r $(ARCHIVE_VERSION).zip $(ARCHIVE_PREFIX)doc/
        rsync -a vendor/ $(ARCHIVE_PREFIX)vendor/
        zip -r $(ARCHIVE_VERSION).zip $(ARCHIVE_PREFIX)vendor/
+       rsync -a tpl/ $(ARCHIVE_PREFIX)tpl/
+       zip -r $(ARCHIVE_VERSION).zip $(ARCHIVE_PREFIX)tpl/
        rm -rf $(ARCHIVE_PREFIX)
 
 ##
@@ -190,26 +203,27 @@ authors:
 ### generate Doxygen documentation
 doxygen: clean
        @rm -rf doxygen
-       @( cat Doxyfile ; echo "PROJECT_NUMBER=`git describe`" ) | doxygen -
-
-### Convert local markdown documentation to HTML
-#
-# For all pages:
-#  - convert GitHub-flavoured relative links to standard Markdown
-#  - generate html documentation with mkdocs
-htmlpages:
-       # Rename local [[links]] to regular links.
-       @for file in `find doc/md/ -maxdepth 1 -name "*.md"`; do \
-               sed -e "s/\[\[\(.*\)\]\]/[\1](\1)/g" "$$file" > doc/md/tmp.md; \
-               mv doc/md/tmp.md $$file; \
-       done
+       @doxygen Doxyfile
 
+### generate HTML documentation from Markdown pages with MkDocs
+htmldoc:
        python3 -m venv venv/
        bash -c 'source venv/bin/activate; \
        pip install mkdocs; \
-       mkdocs build'
+       mkdocs build --clean'
        find doc/html/ -type f -exec chmod a-x '{}' \;
        rm -r venv
 
-doc_html: authors htmlpages
 
+### Generate Shaarli's translation compiled file (.mo)
+translate:
+       @find inc/languages/ -name shaarli.po -execdir msgfmt shaarli.po -o shaarli.mo \;
+
+### Run ESLint check against Shaarli's JS files
+eslint:
+       @yarn run eslint -c .dev/.eslintrc.js assets/vintage/js/
+       @yarn run eslint -c .dev/.eslintrc.js assets/default/js/
+
+### Run CSSLint check against Shaarli's SCSS files
+sasslint:
+       @yarn run sass-lint -c .dev/.sasslintrc 'assets/default/scss/*.scss' -v -q