Makefile

# Convenience build file for running automated test suite,
# as well as generating completion sources.

# Copyright (C) 2021    Lucas Ritzdorf, Luca Zeuch

# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.

# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.

# You should have received a copy of the GNU General Public License along
# with this program; if not, write to the Free Software Foundation, Inc.,
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.


# ----------------------------------------------------------------------------
#
# Setup
#
# This section contains variables for later use further down; it also
# auto-detects whether a program is installed or not. Due to this, we can skip
# targets if the required program for that target is not installed or not found.
#
# ----------------------------------------------------------------------------

MAKEFILE := $(abspath $(lastword $(MAKEFILE_LIST)))

PYTHON_PROG ?= $(shell which python3)
NVIM_PROG ?= $(shell which nvim)
VIM_PROG ?= $(shell which vim)
GIT_PROG ?= $(shell which git)
GO_PROG ?= $(shell which go)

DATA_HOME ?= $(XDG_DATA_HOME)
# if DATA_HOME is not set, we'll use this default value
ifeq ($(strip $(DATA_HOME)),)
	DATA_HOME := $(HOME)/.local/share
endif

# We'll use this variable in our installation targets,
# Setting DESTDIR to either NVIM_DESTDIR or VIM_DESTDIR, if
# DESTDIR itself was not set from user.
NVIM_DESTDIR ?= $(DATA_HOME)/nvim/site/pack/l-zeuch/start/yagpdb.vim
VIM_DESTDIR ?= ~/.vim/bundle/yagpdb.vim

REPO_URL := https://github.com/l-zeuch/yagpdb.vim.git

current_dir := $(shell pwd)

PHONY :=

# ----------------------------------------------------------------------------
#
# General
#
# These targets are what you'll probably need the most.
#
# ----------------------------------------------------------------------------
# If make is invoked without any target provided, this will be our default
# target.
PHONY += help
help:
	@echo	'Cleaning:'
	@echo	'	clean		- Remove all dependencies and temporary files.'
	@echo	''
	@echo	'Development:'
	@echo	'	test		- Run test suite for Neovim and Vim.'
	@echo	'				  This target automatically skips Neovim and/or Vim'
	@echo	'				  if the respective program is not found.'
	@echo	'	test-vim	- Run test suite only for Vim.'
	@echo	'	test-nvim	- Run test suite only for Neovim.'
	@echo	''
	@echo	'Code Analysis:'
	@echo	'	lint		- Run linter on Vim script codebase,'
	@echo	'				  requires python3 and vim-vint module.'
	@echo	'	generate	- Run completion and syntax targets.'
	@echo	'				  Requires python3 and go.'
	@echo	'	completion	- Create completion sources for nvim-cmp.'
	@echo	'				  Requires python3.'
	@echo	'	syntax		- Generate syntax highlighting for functions.'
	@echo	'				  Requires python3 and go.'
	@echo	''
	@echo	'General:'
	@echo	'	all		- Run everything: test, lint, generate.'
	@echo	'	install		- Install this plugin as a manually installed plugin.'
	@echo	'	install-vim	- Same as above, but only try Vim.'
	@echo	'	install-nvim	- Same as above, but only try Neovim.'
	@echo	'	help		- Print this help message. This is the default.'

PHONY += all
all: test lint generate

PHONY += clean
clean:
	rm -rf .bundle/
	rm syntax/funcs

PHONY += install
install: check-windows
	@echo 'Installing...'
ifdef NVIM_PROG
	@$(MAKE) -f $(MAKEFILE) install-nvim
else ifdef VIM_PROG
	@$(MAKE) -f $(MAKEFILE) install-vim
else
	$(error Neither Vim nor Neovim in PATH. Make sure they are installed.)
endif

PHONY += install-nvim
install-nvim: DESTDIR ?= $(NVIM_DESTDIR)
install-nvim:
ifndef NVIM_PROG
	$(error No Neovim in PATH.)
endif
	@echo 'Found Neovim.'
	@echo 'Installing to $(DESTDIR)...'
	mkdir -p $(DESTDIR)
	git clone $(REPO_URL) $(DESTDIR)
	@echo 'Done.'

PHONY += install-vim
install-vim: DESTDIR ?= $(VIM_DESTDIR)
install-vim:
ifndef VIM_PROG
	$(error No Vim in PATH.)
endif
	@echo 'Found Vim.'
	@echo 'Installing to $(DESTDIR)...'
	mkdir -p $(DESTDIR)
	git clone $(REPO_URL) $(DESTDIR)
	@echo 'Done.'
	@echo 'Remember to add this plugin to your runtimepath:'
	@echo 'set rtp ^= $(DESTDIR)'

define WINDOWS_ERROR

It appears that you are running Windows as your OS.
We recommend one of the three actions to continue:
	- Set DESTDIR to the desired location
	- Use a plugin manager
	- Clone the repo manually

endef

PHONY += check-windows
check-windows:
ifeq ($(OS),WINDOWS_NT)
ifndef DESTDIR
	$(error $(WINDOWS_ERROR))
endif
endif

# ----------------------------------------------------------------------------
#
#  Development Targets
#
#  Usually these should already be run locally, before you even open any pull
#  request. However, for consistency reasons, these will also be executed as a
#  GitHub workflow, thus it is not *that* important if you don't run them.
#  However, please do.
#
# ----------------------------------------------------------------------------
PHONY += test
test: test-vim test-nvim

PHONY += test-vim
test-vim: .bundle/vader.vim
ifdef VIM_PROG
	@echo Found Vim installation, running tests...
	cd test/ && \
		$(VIM_PROG) -EsNu vimrc --not-a-term -c 'Vader! * */*'
else
	@echo Vim not found, skipping tests...
endif

PHONY += test-nvim
test-nvim: .bundle/vader.vim
ifdef NVIM_PROG
	@echo Found Neovim installation, running tests...
	cd test/ && \
		$(NVIM_PROG) -EsNu vimrc --headless -c 'Vader! * */*'
else
	@echo Neovim not found, skipping tests...
endif

# ----------------------------------------------------------------------------
#
# Code Analysis
#
# You should definitely run the lint target, or better yet, set up vint as the
# linter for Vim Script on your system.
# This target is also executed as a workflow -- linter warnings don't mean we
# won't accept your PR, but it does make us a little grumpy.
#
# The generate target is in general not necessary for opening a pull request --
# our workflow scans your code and determines if it is necessary to regenerate
# completion sources.
# However, it might be interesting to you.
#
# ----------------------------------------------------------------------------
PHONY += lint
lint:
ifdef PYTHON_PROG
	$(PYTHON_PROG) scripts/vint.py
else
	$(error python3 not found, skipping linter.)
endif

PHONY += generate
generate: syntax completion

PHONY += completion
completion:
ifdef PYTHON_PROG
	$(PYTHON_PROG) scripts/gen_code_completion.py
else
	$(error python3 not found, aborting generation.)
endif

PHONY += syntax
syntax: .bundle/lytfs
	.bundle/lytfs > syntax/funcs
ifdef PYTHON_PROG
	$(PYTHON_PROG) scripts/gen_funcs.py
else
	$(error python3 not found, aborting generation.)
endif

# ----------------------------------------------------------------------------
#
# Dependencies
#
# This section contains all dependencies you need to run the test suite.
# Currently, this is only vader.vim, a Vim script testing framework.
#
# You need not run this target directly, it a) has no use other than pulling the
# deps, and b) it's already a requirement for the test targets.
#
# ----------------------------------------------------------------------------

# We use this name for the dependency, so that make can determine whether it
# needs to be run or not. As make tracks the target name, and given it matches
# with the file name and said file already exists, make will not run it.
.bundle/vader.vim:
ifdef GIT_PROG
	$(GIT_PROG) clone --depth 1 https://github.com/junegunn/vader.vim.git \
		.bundle/vader.vim
else
	$(error git not found, aborting test suites.)
endif

.bundle/lytfs:
ifdef GO_PROG
	GOBIN=$(current_dir)/.bundle/ $(GO_PROG) install github.com/jo3-l/yagfuncdata/cmd/lytfs@latest
else
	$(error go not found, aborting syntax check.)
endif

# Evaluate all PHONY targets, i.e. which either don't match any file or don't
# generate any file output (generally both).
.PHONY: $(PHONY)