forked from Automattic/wp-calypso
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Remove "Makefile" functionality and update documentation (Automattic#…
…14631) * Updated documentation to change references from "make *" to their equivalent "npm" commands. * Simplify the Makefile to be just a list of aliases to the NPM commands * Remove unused scripts. * Added "@" to the Makefile aliases so they don't print the command before running it. Also, by popular demand, brought back the ASCII art. * Added "npm run distclean" before the Docker image is built * Make `npm run clean` and `npm run distclean` work without any `node_modules` installed. * Updated new documentation that was using `make run`. * Allow running `npm run dashboard` even with a cleaned-up `node_modules` folder. * Added deprecation notice to the Makefile * Fixed Docker build in Windows ("touch" command isn't available after nuking node_modules)
- Loading branch information
Showing
42 changed files
with
117 additions
and
483 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,252 +1,70 @@ | ||
| SINGLE_QUOTE := ' | ||
| # We need to escape single quote as '\'' | ||
| THIS_DIR := '$(subst $(SINGLE_QUOTE),$(SINGLE_QUOTE)\$(SINGLE_QUOTE)$(SINGLE_QUOTE),$(CURDIR))' | ||
|
|
||
| ifeq ($(OS),Windows_NT) | ||
| SEPARATOR := ; | ||
| else | ||
| SEPARATOR := : | ||
| endif | ||
|
|
||
| # BIN | ||
| BIN := $(THIS_DIR)/bin | ||
|
|
||
| # NODE BIN folder | ||
| NODE_BIN := $(THIS_DIR)/node_modules/.bin | ||
|
|
||
| # applications | ||
| NODE ?= node | ||
| NPM ?= npm | ||
| BUNDLER ?= $(BIN)/bundler | ||
| I18N_CALYPSO ?= $(NODE_BIN)/i18n-calypso | ||
| SASS ?= $(NODE_BIN)/node-sass --include-path 'client' | ||
| RTLCSS ?= $(NODE_BIN)/rtlcss | ||
| AUTOPREFIXER ?= $(NODE_BIN)/postcss -r --use autoprefixer --autoprefixer.browsers "last 2 versions, > 1%, Safari >= 8, iOS >= 8, Firefox ESR, Opera 12.1" | ||
| RECORD_ENV ?= $(BIN)/record-env | ||
| ALL_DEVDOCS_JS ?= server/devdocs/bin/generate-devdocs-index | ||
| COMPONENTS_USAGE_STATS_JS ?= server/devdocs/bin/generate-components-usage-stats.js | ||
| COMPONENTS_PROPTYPES_JS ?= server/devdocs/bin/generate-proptypes-index.js | ||
|
|
||
| # files used as prereqs | ||
| SASS_FILES := $(shell \ | ||
| find client assets \ | ||
| -type f \ | ||
| -name '*.scss' \ | ||
| ) | ||
| JS_FILES := $(shell \ | ||
| find . \ | ||
| -not \( -path './.git' -prune \) \ | ||
| -not \( -path './build' -prune \) \ | ||
| -not \( -path './node_modules' -prune \) \ | ||
| -not \( -path './public' -prune \) \ | ||
| -type f \ | ||
| \( -name '*.js' -or -name '*.jsx' \) \ | ||
| ) | ||
| # same as JS_FILES, but excludes extensions | ||
| JS_FILES_FOR_TRANSLATE := $(shell \ | ||
| find . \ | ||
| -not \( -path './.git' -prune \) \ | ||
| -not \( -path './build' -prune \) \ | ||
| -not \( -path './node_modules' -prune \) \ | ||
| -not \( -path './public' -prune \) \ | ||
| -not \( -path './client/extensions' -prune \) \ | ||
| -type f \ | ||
| \( -name '*.js' -or -name '*.jsx' \) \ | ||
| ) | ||
| MD_FILES := $(shell \ | ||
| find . \ | ||
| -not \( -path './.git' -prune \) \ | ||
| -not \( -path './build' -prune \) \ | ||
| -not \( -path './node_modules' -prune \) \ | ||
| -not \( -path './public' -prune \) \ | ||
| -type f \ | ||
| -name '*.md' \ | ||
| | sed 's/ /\\ /g' \ | ||
| ) | ||
| COMPONENTS_USAGE_STATS_FILES = $(shell \ | ||
| find client \ | ||
| -not \( -path '*/docs/*' -prune \) \ | ||
| -not \( -path '*/test/*' -prune \) \ | ||
| -not \( -path '*/docs-example/*' -prune \) \ | ||
| -type f \ | ||
| \( -name '*.js' -or -name '*.jsx' \) \ | ||
| ) | ||
| COMPONENTS_PROPTYPE_FILES = $(shell \ | ||
| find client \ | ||
| -name 'index.jsx' \ | ||
| -or -name 'index.js' \ | ||
| -or -name 'example.jsx' \ | ||
| -and -not -path '*/test/*' \ | ||
| ) | ||
|
|
||
| CONFIG_FILES = $(shell \ | ||
| find config \ | ||
| -name '*.json' \ | ||
| ) | ||
|
|
||
|
|
||
| # variables | ||
| NODE_ENV ?= development | ||
| CALYPSO_ENV ?= $(NODE_ENV) | ||
|
|
||
| export NODE_ENV := $(NODE_ENV) | ||
| export CALYPSO_ENV := $(CALYPSO_ENV) | ||
| export NODE_PATH := server$(SEPARATOR)client$(SEPARATOR). | ||
| ################################ | ||
| ## DEPRECATED ## | ||
| ################################ | ||
|
|
||
| .DEFAULT_GOAL := install | ||
|
|
||
| welcome: | ||
| @printf "\033[36m _ \n" | ||
| @printf "\033[36m ___ __ _| |_ _ _ __ ___ ___ \n" | ||
| @printf "\033[36m / __/ _\` | | | | | '_ \/ __|/ _ \\ \n" | ||
| @printf "\033[36m | (_| (_| | | |_| | |_) \__ \ (_) | \n" | ||
| @printf "\033[36m \___\__,_|_|\__, | .__/|___/\___/ \n" | ||
| @printf "\033[36m |___/|_| \n" | ||
| @printf "\033[m\n" | ||
|
|
||
| install: node_modules | ||
|
|
||
| # Simply running `make run` will spawn the Node.js server instance. | ||
| run: welcome githooks install build | ||
| @$(NODE) $(NODE_ARGS) build/bundle.js | ||
|
|
||
| dashboard: install | ||
| @$(NODE_BIN)/webpack-dashboard -- make run | ||
|
|
||
| # a helper rule to ensure that a specific module is installed, | ||
| # without relying on a generic `npm install` command | ||
| node_modules/%: | ||
| @$(NPM) install $(notdir $@) | ||
|
|
||
| node-version: node_modules/semver | ||
| @$(BIN)/check-node-version | ||
|
|
||
| # ensures that the `node_modules` directory is installed and up-to-date with | ||
| # the dependencies listed in the "package.json" file. | ||
| node_modules: package.json | node-version | ||
| @$(NPM) prune | ||
| @$(NPM) install | ||
| @touch node_modules | ||
| # This file is deprecated. Instead of running "make ___" commands, you should | ||
| # use the equivalent "npm run ___" commands instead. | ||
| # See the "scripts" property of package.json for more information. | ||
|
|
||
| test: build | ||
| @$(NPM) test | ||
|
|
||
| lint: node_modules/eslint node_modules/eslint-plugin-react node_modules/babel-eslint config-defaults-lint mixedindentlint | ||
| @$(NPM) run lint | ||
|
|
||
| eslint: lint | ||
| .DEFAULT_GOAL := install | ||
|
|
||
| eslint-branch: node_modules/eslint node_modules/eslint-plugin-react node_modules/babel-eslint | ||
| @git diff --name-only $$(git merge-base $$(git rev-parse --abbrev-ref HEAD) master)..HEAD | grep '\.jsx\?$$' | xargs $(NODE_BIN)/eslint --cache | ||
| install: | ||
| npm run install-if-needed | ||
|
|
||
| # Skip files that are auto-generated | ||
| mixedindentlint: node_modules/mixedindentlint | ||
| @echo "$(JS_FILES)\n$(SASS_FILES)" | xargs $(NODE_BIN)/mixedindentlint --ignore-comments --exclude="client/config/index.js" | ||
| run: | ||
| npm start | ||
|
|
||
| # Ensure that default config values exist in _shared.json | ||
| config-defaults-lint: $(CONFIG_FILES) | ||
| @$(NODE) bin/validate-config-keys.js || exit | ||
| dashboard: | ||
| @npm run dashboard | ||
|
|
||
| # keep track of the current CALYPSO_ENV so that it can be used as a | ||
| # prerequisite for other rules | ||
| .env: FORCE | ||
| @$(RECORD_ENV) $@ | ||
| test: | ||
| @npm test | ||
|
|
||
| public/style.css: node_modules $(SASS_FILES) | ||
| @$(SASS) assets/stylesheets/style.scss $@ | ||
| @$(AUTOPREFIXER) $@ | ||
| lint: | ||
| @npm run lint | ||
|
|
||
| public/style-debug.css: node_modules $(SASS_FILES) | ||
| @$(SASS) --source-map "$(@D)/style-debug.css.map" assets/stylesheets/style.scss $@ | ||
| @$(AUTOPREFIXER) $@ | ||
| eslint: | ||
| @npm run lint | ||
|
|
||
| public/style-rtl.css: public/style.css | ||
| @$(RTLCSS) $(THIS_DIR)/public/style.css $@ | ||
| eslint-branch: | ||
| @npm run eslint-branch | ||
|
|
||
| public/editor.css: node_modules $(SASS_FILES) | ||
| @$(SASS) assets/stylesheets/editor.scss $@ | ||
| @$(AUTOPREFIXER) $@ | ||
| mixedindentlint: | ||
| @npm run lint:mixedindent | ||
|
|
||
| public/directly.css: node_modules $(SASS_FILES) | ||
| @$(SASS) assets/stylesheets/directly.scss $@ | ||
| @$(AUTOPREFIXER) $@ | ||
| config-defaults-lint: | ||
| @npm run lint:config-defaults | ||
|
|
||
| server/devdocs/search-index.js: $(MD_FILES) $(ALL_DEVDOCS_JS) | ||
| @$(ALL_DEVDOCS_JS) $(MD_FILES) | ||
| build-server: | ||
| @npm run build-server | ||
|
|
||
| server/devdocs/components-usage-stats.json: $(COMPONENTS_USAGE_STATS_FILES) $(COMPONENTS_USAGE_STATS_JS) | ||
| @$(COMPONENTS_USAGE_STATS_JS) $(COMPONENTS_USAGE_STATS_FILES) | ||
| build: | ||
| @npm run build | ||
|
|
||
| server/devdocs/proptypes-index.json: $(COMPONENTS_PROPTYPE_FILES) $(COMPONENTS_PROPTYPES_JS) | ||
| @$(COMPONENTS_PROPTYPES_JS) $(COMPONENTS_PROPTYPE_FILES) | ||
| build-desktop: | ||
| @npm run build-desktop | ||
|
|
||
| build-server: install | ||
| @mkdir -p build | ||
| @CALYPSO_ENV=$(CALYPSO_ENV) $(NODE_BIN)/webpack --display-error-details --config webpack.config.node.js | ||
| clean: | ||
| @npm run clean | ||
|
|
||
| build: install build-server build-css server/devdocs/search-index.js server/devdocs/proptypes-index.json server/devdocs/components-usage-stats.json | ||
| @if [ $(CALYPSO_ENV) != development ]; then $(BUNDLER); fi | ||
| distclean: | ||
| @npm run distclean | ||
|
|
||
| build-css: public/style.css public/style-rtl.css public/style-debug.css public/editor.css public/directly.css | ||
| translate: | ||
| @npm run translate | ||
|
|
||
| build-desktop: build-server build-css | ||
| @$(BUNDLER) | ||
| shrinkwrap: | ||
| @npm run update-deps | ||
|
|
||
| # the `clean` rule deletes all the files created from `make build`, but not | ||
| # those created by `make install` | ||
| clean: | ||
| @rm -rf public/style*.css public/style-debug.css.map public/*.js public/*.js.map server/devdocs/search-index.js server/devdocs/proptypes-index.json server/devdocs/components-usage-stats.json public/directly.css public/editor.css build/* server/bundler/*.json .babel-cache | ||
|
|
||
| # the `distclean` rule deletes all the files created from `make install` | ||
| distclean: clean | ||
| @rm -rf node_modules | ||
|
|
||
| # create list of translations, saved as `./calypso-strings.pot` | ||
| translate: node_modules | ||
| $(I18N_CALYPSO) --format pot --output-file ./calypso-strings.pot $(JS_FILES_FOR_TRANSLATE) -e date | ||
|
|
||
| # install all git hooks | ||
| githooks: githooks-commit githooks-push | ||
|
|
||
| # install git pre-commit hook | ||
| githooks-commit: | ||
| @if [ ! -e .git/hooks/pre-commit ]; then ln -s ../../bin/pre-commit .git/hooks/pre-commit; fi | ||
|
|
||
| # install git pre-push hook | ||
| githooks-push: | ||
| @if [ ! -e .git/hooks/pre-push ]; then ln -s ../../bin/pre-push .git/hooks/pre-push; fi | ||
|
|
||
| # generate a new shrinkwrap | ||
| shrinkwrap: node-version | ||
| @! lsof -Pi :3000 -sTCP:LISTEN -t || ( echo "Please stop your Calypso instance running on port 3000 and try again." && exit 1 ) | ||
| @type shonkwrap || ( echo "Please install shonkwrap globally and try again: 'npm install -g shonkwrap'" && exit 1 ) | ||
| @rm -rf node_modules | ||
| @rm -f npm-shrinkwrap.json | ||
| @$(NPM) install --no-optional | ||
| @$(NPM) install --no-optional # remove this when this is fixed in npm 3 | ||
| @shonkwrap --dev | ||
|
|
||
| analyze-bundles: node_modules | ||
| @rm -f stats.json | ||
| @WEBPACK_OUTPUT_JSON=1 CALYPSO_ENV=production $(MAKE) build | ||
| @$(NODE_BIN)/webpack-bundle-analyzer stats.json public -p 9898 | ||
| analyze-bundles: | ||
| @npm run analyze-bundles | ||
|
|
||
| urn: | ||
| @printf "⚱\n\n"; | ||
| @$(MAKE) run; | ||
| @npm start; | ||
|
|
||
| docker-build: | ||
| docker build -t wp-calypso . | ||
| @npm run docker-build | ||
|
|
||
| docker-run: | ||
| @echo running wp-calypso docker image at localhost:3000 | ||
| docker run -it --name wp-calypso --rm -p 80:3000 -e NODE_ENV='wpcalypso' -e CALYPSO_ENV='wpcalypso' wp-calypso | ||
|
|
||
|
|
||
| # rule that can be used as a prerequisite for other rules to force them to always run | ||
| FORCE: | ||
|
|
||
| .PHONY: build build-desktop build-server | ||
| .PHONY: run install test clean distclean translate route node-version | ||
| .PHONY: githooks githooks-commit githooks-push analyze-bundles urn | ||
| .PHONY: config-defaults-lint | ||
| @npm run docker |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.