Makefile 7.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250
  1. # You can set these variables from the command line.
  2. BABEL ?= node_modules/.bin/babel
  3. BOOTSTRAP = ./node_modules/
  4. BUILDDIR = ./docs
  5. KARMA ?= ./node_modules/.bin/karma
  6. CLEANCSS ?= ./node_modules/clean-css-cli/bin/cleancss
  7. ESLINT ?= ./node_modules/.bin/eslint
  8. HTTPSERVE ?= ./node_modules/.bin/http-server
  9. HTTPSERVE_PORT ?= 8000
  10. INKSCAPE ?= inkscape
  11. INSTALL ?= install
  12. JSDOC ?= ./node_modules/.bin/jsdoc
  13. LERNA ?= ./node_modules/.bin/lerna
  14. OXIPNG ?= oxipng
  15. PAPER =
  16. RJS ?= ./node_modules/.bin/r.js
  17. NPX ?= ./node_modules/.bin/npx
  18. SASS ?= ./node_modules/.bin/sass
  19. SED ?= sed
  20. SPHINXBUILD ?= ./bin/sphinx-build
  21. SPHINXOPTS =
  22. XGETTEXT = xgettext
  23. # Internal variables.
  24. ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) ./docs/source
  25. VERSION_FORMAT = [0-9]+\.[0-9]+\.[0-9]+
  26. .PHONY: all
  27. all: node_modules dist
  28. .PHONY: help
  29. help:
  30. @echo "Please use \`make <target>' where <target> is one of the following:"
  31. @echo ""
  32. @echo " all Set up dev environment and create all builds"
  33. @echo " dist Create minified builds of converse.js and all its dependencies."
  34. @echo " clean Remove all NPM packages."
  35. @echo " check Run all tests."
  36. @echo " dev Set up the development environment and build unminified resources. To force a fresh start, run 'make clean' first."
  37. @echo " devserver Set up the development environment and start the webpack dev server."
  38. @echo " doc Make standalone HTML files of the documentation."
  39. @echo " po Generate gettext PO files for each i18n language."
  40. @echo " pot Generate a gettext POT file to be used for translations."
  41. @echo " release Prepare a new release of converse.js. E.g. make release VERSION=0.9.5"
  42. @echo " serve Serve this directory via a webserver on port 8000."
  43. @echo " serve_bg Same as \"serve\", but do it in the background"
  44. @echo " node_modules Install NPM dependencies"
  45. @echo " watch Watch for changes on JS and scss files and automatically update the generated files."
  46. @echo " logo Generate PNG logos of multiple sizes."
  47. ########################################################################
  48. ## Miscellaneous
  49. .PHONY: serve
  50. serve: node_modules dist
  51. $(HTTPSERVE) -p $(HTTPSERVE_PORT) -c-1
  52. .PHONY: serve_bg
  53. serve_bg: node_modules
  54. $(HTTPSERVE) -p $(HTTPSERVE_PORT) -c-1 -s &
  55. ########################################################################
  56. ## Translation machinery
  57. dist/converse-no-dependencies.js: src webpack/webpack.common.js webpack/webpack.nodeps.js @converse/headless node_modules
  58. npm run nodeps
  59. GETTEXT = $(XGETTEXT) --from-code=UTF-8 --language=JavaScript --keyword=__ --keyword=___ --keyword=i18n_ --force-po --output=src/i18n/converse.pot --package-name=Converse.js --copyright-holder="Jan-Carel Brand" --package-version=9.1.1 dist/converse-no-dependencies.js -c
  60. src/i18n/converse.pot: dist/converse-no-dependencies.js
  61. $(GETTEXT) 2>&1 > /dev/null; exit $$?;
  62. rm dist/converse-no-dependencies.js
  63. rm dist/tmp.css
  64. .PHONY: pot
  65. pot: src/i18n/converse.pot
  66. .PHONY: po
  67. po:
  68. find ./src/i18n -maxdepth 1 -mindepth 1 -type d -exec msgmerge {}/LC_MESSAGES/converse.po ./src/i18n/converse.pot -U \;
  69. ########################################################################
  70. ## Release management
  71. .PHONY: release
  72. release:
  73. $(SED) -i '/^_converse.VERSION_NAME =/s/=.*/= "v$(VERSION)";/' src/headless/core.js
  74. $(SED) -i '/Version:/s/:.*/: $(VERSION)/' COPYRIGHT
  75. $(SED) -i '/Project-Id-Version:/s/:.*/: Converse.js $(VERSION)\n"/' src/i18n/converse.pot
  76. $(SED) -i '/"version":/s/:.*/: "$(VERSION)",/' manifest.json
  77. $(SED) -i '/"version":/s/:.*/: "$(VERSION)",/' package.json
  78. $(SED) -i '/"version":/s/:.*/: "$(VERSION)",/' src/headless/package.json
  79. $(SED) -ri 's/--package-version=$(VERSION_FORMAT)/--package-version=$(VERSION)/' Makefile
  80. $(SED) -i -e "/version =/s/=.*/= '$(VERSION)'/" -e "/release =/s/=.*/= '$(VERSION)'/" docs/source/conf.py
  81. $(SED) -i "s/[Uu]nreleased/`date +%Y-%m-%d`/" CHANGES.md
  82. $(SED) -ri 's,cdn.conversejs.org/$(VERSION_FORMAT),cdn.conversejs.org/$(VERSION),' docs/source/quickstart.rst
  83. $(SED) -ri 's,cdn.conversejs.org/$(VERSION_FORMAT),cdn.conversejs.org/$(VERSION),' *.html
  84. $(SED) -ri 's,cdn.conversejs.org/$(VERSION_FORMAT),cdn.conversejs.org/$(VERSION),' demo/*.html
  85. make pot
  86. make po
  87. make dist
  88. npm pack
  89. cd src/headless && npm pack
  90. .PHONY: postrelease
  91. postrelease:
  92. $(SED) -i '/^_converse.VERSION_NAME =/s/=.*/= "v$(VERSION)dev";/' src/headless/core.js
  93. ########################################################################
  94. ## Install dependencies
  95. $(LERNA):
  96. npm install lerna
  97. ${NVM_DIR}/nvm.sh:
  98. wget -qO- https://raw.githubusercontent.com/nvm-sh/nvm/v0.38.0/install.sh | bash
  99. source ~/.bashrc
  100. .PHONY: nvm
  101. nvm: ${NVM_DIR}/nvm.sh
  102. .PHONY: node
  103. node: .nvmrc
  104. . $(HOME)/.nvm/nvm.sh && nvm install
  105. package-lock.json: package.json
  106. npm install
  107. node_modules: $(LERNA) package.json package-lock.json src/headless/package.json src/headless/package-lock.json
  108. npm run lerna
  109. .PHONY: clean
  110. clean:
  111. npm run clean
  112. rm -rf lib bin include parts
  113. .PHONY: dev
  114. dev: node_modules
  115. npm run dev
  116. .PHONY: devserver
  117. devserver: node_modules
  118. npm run serve
  119. ########################################################################
  120. ## Builds
  121. dist/converse.js:: node_modules
  122. npm run build
  123. dist/converse.css:: node_modules
  124. npm run build
  125. dist/website.css:: node_modules src/shared/styles/website.scss
  126. $(SASS) --load-path=$(BOOTSTRAP) src/shared/styles/website.scss $@
  127. dist/website.min.css:: node_modules dist/website.css
  128. $(CLEANCSS) dist/website.css > $@
  129. .PHONY: watch
  130. watch: node_modules
  131. npm run watch
  132. .PHONY: logo
  133. logo: logo/conversejs-transparent16.png \
  134. logo/conversejs-transparent19.png \
  135. logo/conversejs-transparent48.png \
  136. logo/conversejs-transparent128.png \
  137. logo/conversejs-transparent512.png \
  138. logo/conversejs-filled16.png \
  139. logo/conversejs-filled19.png \
  140. logo/conversejs-filled48.png \
  141. logo/conversejs-filled128.png \
  142. logo/conversejs-filled512.png \
  143. logo/conversejs-transparent%.png:: logo/conversejs-transparent.svg
  144. $(INKSCAPE) -e $@ -w $* $<
  145. $(OXIPNG) $@
  146. logo/conversejs-filled%.png:: logo/conversejs-filled.svg
  147. $(INKSCAPE) -e $@ -w $* $<
  148. $(OXIPNG) $@
  149. @converse/headless: src/headless
  150. src/headless/dist/converse-headless.js: src webpack/webpack.common.js node_modules @converse/headless
  151. npm run headless-dev
  152. src/headless/dist/converse-headless.min.js: src webpack/webpack.common.js node_modules @converse/headless
  153. npm run headless
  154. dist:: node_modules src/* | dist/website.css dist/website.min.css
  155. npm run headless
  156. npm run build
  157. .PHONY: install
  158. install:: dist
  159. .PHONY: cdn
  160. cdn:: node_modules
  161. npm run cdn
  162. ########################################################################
  163. ## Tests
  164. .PHONY: eslint
  165. eslint: node_modules
  166. $(ESLINT) src/*.js
  167. $(ESLINT) src/utils/*.js
  168. $(ESLINT) src/headless/*.js
  169. $(ESLINT) src/headless/utils/*.js
  170. .PHONY: check
  171. check: eslint | dist/converse.js dist/converse.css
  172. $(KARMA) start karma.conf.js $(ARGS)
  173. .PHONY: test
  174. test:
  175. $(KARMA) start karma.conf.js $(ARGS)
  176. ########################################################################
  177. ## Documentation
  178. ./bin/activate:
  179. python3 -m venv .
  180. .installed.cfg: requirements.txt buildout.cfg
  181. ./bin/pip install -r requirements.txt
  182. ./bin/pip install --upgrade pip==21.3.1
  183. ./bin/pip install --upgrade setuptools==51.3.3
  184. ./bin/buildout -v
  185. docsdev: ./bin/activate .installed.cfg
  186. .PHONY: html
  187. html: doc
  188. .PHONY: doc
  189. doc: node_modules docsdev apidoc
  190. rm -rf $(BUILDDIR)/html
  191. $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
  192. make apidoc
  193. @echo
  194. @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
  195. PHONY: apidoc
  196. apidoc:
  197. find ./src -type d -name node_modules -prune -false -o -name "*.js" | xargs $(JSDOC) --private --readme docs/source/jsdoc_intro.md -c docs/source/conf.json -d docs/html/api