Makefile

   1 # The personal, minimalist, super-fast, database free, bookmarking service.
   2 # Makefile for PHP code analysis & testing, documentation and release generation
   3
   4 BIN = vendor/bin
   5
   6 all: check_permissions test
   7
   8 ##
   9 # Docker test adapter
  10 #
  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.
  13 ##
  14 docker_%:
  15         rsync -az /shaarli/ ~/shaarli/
  16         cd ~/shaarli && make $*
  17
  18 ##
  19 # PHP_CodeSniffer
  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
  24 ##
  25 PHPCS := $(BIN)/phpcs
  26
  27 code_sniffer:
  28         @$(PHPCS)
  29
  30 ### - errors filtered by coding standard: PEAR, PSR1, PSR2, Zend...
  31 PHPCS_%:
  32         @$(PHPCS) --report-full --report-width=200 --standard=$*
  33
  34 ### - errors by Git author
  35 code_sniffer_blame:
  36         @$(PHPCS) --report-gitblame
  37
  38 ### - all errors/warnings
  39 code_sniffer_full:
  40         @$(PHPCS) --report-full --report-width=200
  41
  42 ### - errors grouped by kind
  43 code_sniffer_source:
  44         @$(PHPCS) --report-source || exit 0
  45
  46 ##
  47 # Checks source file & script permissions
  48 ##
  49 check_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 \
  55                         errors=true; \
  56                         echo "$${file} is executable"; \
  57                 fi \
  58         done; [ -z $$errors ] || false
  59
  60 ##
  61 # PHPUnit
  62 # Runs unitary and functional tests
  63 # Generates an HTML coverage report if Xdebug is enabled
  64 #
  65 # See phpunit.xml for configuration
  66 # https://phpunit.de/manual/current/en/appendixes.configuration.html
  67 ##
  68 test: translate
  69         @echo "-------"
  70         @echo "PHPUNIT"
  71         @echo "-------"
  72         @mkdir -p sandbox coverage
  73         @$(BIN)/phpunit --coverage-php coverage/main.cov --bootstrap tests/bootstrap.php --testsuite unit-tests
  74
  75 locale_test_%:
  76         @UT_LOCALE=$*.utf8 \
  77                 $(BIN)/phpunit \
  78                 --coverage-php coverage/$(firstword $(subst _, ,$*)).cov \
  79                 --bootstrap tests/languages/bootstrap.php \
  80                 --testsuite language-$(firstword $(subst _, ,$*))
  81
  82 all_tests: test locale_test_de_DE locale_test_en_US locale_test_fr_FR
  83         @# --The current version is not compatible with PHP 7.2
  84         @#$(BIN)/phpcov merge --html coverage coverage
  85         @# --text doesn't work with phpunit 4.* (v5 requires PHP 5.6)
  86         @#$(BIN)/phpcov merge --text coverage/txt coverage
  87
  88 ### download 3rd-party PHP libraries, including dev dependencies
  89 composer_dependencies_dev: clean
  90         composer install --prefer-dist
  91
  92 ##
  93 # Custom release archive generation
  94 #
  95 # For each tagged revision, GitHub provides tar and zip archives that correspond
  96 # to the output of git-archive
  97 #
  98 # These targets produce similar archives, featuring 3rd-party dependencies
  99 # to ease deployment on shared hosting.
 100 ##
 101 ARCHIVE_VERSION := shaarli-$$(git describe)-full
 102 ARCHIVE_PREFIX=Shaarli/
 103
 104 release_archive: release_tar release_zip
 105
 106 ### download 3rd-party PHP libraries
 107 composer_dependencies: clean
 108         composer install --no-dev --prefer-dist
 109         find vendor/ -name ".git" -type d -exec rm -rf {} +
 110
 111 ### download 3rd-party frontend libraries
 112 frontend_dependencies:
 113         yarn install
 114
 115 ### Build frontend dependencies
 116 build_frontend: frontend_dependencies
 117         yarn run build
 118
 119 ### generate a release tarball and include 3rd-party dependencies and translations
 120 release_tar: composer_dependencies htmldoc translate build_frontend
 121         git archive --prefix=$(ARCHIVE_PREFIX) -o $(ARCHIVE_VERSION).tar HEAD
 122         tar rvf $(ARCHIVE_VERSION).tar --transform "s|^vendor|$(ARCHIVE_PREFIX)vendor|" vendor/
 123         tar rvf $(ARCHIVE_VERSION).tar --transform "s|^doc/html|$(ARCHIVE_PREFIX)doc/html|" doc/html/
 124         tar rvf $(ARCHIVE_VERSION).tar --transform "s|^tpl|$(ARCHIVE_PREFIX)tpl|" tpl/
 125         gzip $(ARCHIVE_VERSION).tar
 126
 127 ### generate a release zip and include 3rd-party dependencies and translations
 128 release_zip: composer_dependencies htmldoc translate build_frontend
 129         git archive --prefix=$(ARCHIVE_PREFIX) -o $(ARCHIVE_VERSION).zip -9 HEAD
 130         mkdir -p $(ARCHIVE_PREFIX)/doc
 131         mkdir -p $(ARCHIVE_PREFIX)/vendor
 132         rsync -a doc/html/ $(ARCHIVE_PREFIX)doc/html/
 133         zip -r $(ARCHIVE_VERSION).zip $(ARCHIVE_PREFIX)doc/
 134         rsync -a vendor/ $(ARCHIVE_PREFIX)vendor/
 135         zip -r $(ARCHIVE_VERSION).zip $(ARCHIVE_PREFIX)vendor/
 136         rsync -a tpl/ $(ARCHIVE_PREFIX)tpl/
 137         zip -r $(ARCHIVE_VERSION).zip $(ARCHIVE_PREFIX)tpl/
 138         rm -rf $(ARCHIVE_PREFIX)
 139
 140 ##
 141 # Targets for repository and documentation maintenance
 142 ##
 143
 144 ### remove all unversioned files
 145 clean:
 146         @git clean -df
 147         @rm -rf sandbox
 148
 149 ### generate the AUTHORS file from Git commit information
 150 authors:
 151         @cp .github/mailmap .mailmap
 152         @git shortlog -sne > AUTHORS
 153         @rm .mailmap
 154
 155 ### generate phpDocumentor documentation
 156 phpdoc: clean
 157         @docker run --rm -v $(PWD):/data -u `id -u`:`id -g` phpdoc/phpdoc
 158
 159 ### generate HTML documentation from Markdown pages with MkDocs
 160 htmldoc:
 161         python3 -m venv venv/
 162         bash -c 'source venv/bin/activate; \
 163         pip install wheel; \
 164         pip install mkdocs; \
 165         mkdocs build --clean'
 166         find doc/html/ -type f -exec chmod a-x '{}' \;
 167         rm -r venv
 168
 169
 170 ### Generate Shaarli's translation compiled file (.mo)
 171 translate:
 172         @find inc/languages/ -name shaarli.po -execdir msgfmt shaarli.po -o shaarli.mo \;
 173
 174 ### Run ESLint check against Shaarli's JS files
 175 eslint:
 176         @yarn run eslint -c .dev/.eslintrc.js assets/vintage/js/
 177         @yarn run eslint -c .dev/.eslintrc.js assets/default/js/
 178         @yarn run eslint -c .dev/.eslintrc.js assets/common/js/
 179
 180 ### Run CSSLint check against Shaarli's SCSS files
 181 sasslint:
 182         @yarn run stylelint --config .dev/.stylelintrc.js 'assets/default/scss/*.scss'