branch: externals/bnf-mode
commit e2b2725685ab06c0f29c65a6f12c3c44941efcf8
Merge: d88eef6 57935fc
Author: Serghei Iakovlev <sergeyk...@users.noreply.github.com>
Commit: GitHub <nore...@github.com>
Merge pull request #17 from sergeyklay/fix/build-package
Amend tests, fix misspelling, update build system
---
.github/workflows/build.yml | 6 +++---
.github/workflows/release.yml | 6 +++---
Cask | 1 -
Makefile | 24 ++++++++++++++++++------
README.org | 1 -
default.mk | 4 +++-
test/utils.el | 12 ++++++------
7 files changed, 33 insertions(+), 21 deletions(-)
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
index ac0bc2a..df485a5 100644
--- a/.github/workflows/build.yml
+++ b/.github/workflows/build.yml
@@ -62,14 +62,14 @@ jobs:
version: ${{ matrix.emacs_version }}
- name: Setup Cask
- run: curl -fsSkL https://raw.github.com/cask/cask/master/go | python
+ run: git clone https://github.com/cask/cask ~/.cask
- name: Set Environment Variables
run: |
- echo "::set-env name=PATH::$HOME/.cask/bin:$PATH"
+ echo "$HOME/.cask/bin" >> $GITHUB_PATH
if [ "${{ matrix.emacs_version }}" != "snapshot" ]; then
- echo "::set-env name=UNDERCOVER_FORCE::1"
+ echo UNDERCOVER_FORCE=1 >> $GITHUB_ENV
fi
- name: Fast Makefile Test
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
index 3d62112..af66ac7 100644
--- a/.github/workflows/release.yml
+++ b/.github/workflows/release.yml
@@ -39,12 +39,12 @@ jobs:
version: 26.3
- name: Setup Cask
- run: curl -fsSkL https://raw.github.com/cask/cask/master/go | python
+ run: git clone https://github.com/cask/cask ~/.cask
- name: Set Environment Variables
run: |
- echo "::set-env name=PATH::$HOME/.cask/bin:$PATH"
- echo ::set-output name=VERSION::${GITHUB_REF#refs/tags/}
+ echo "$HOME/.cask/bin" >> $GITHUB_PATH
+ echo "VERSION=${GITHUB_REF#refs/tags/}" >> $GITHUB_ENV
- name: Common settings
run: |
diff --git a/Cask b/Cask
index d926bdc..53f39f9 100644
--- a/Cask
+++ b/Cask
@@ -10,6 +10,5 @@
(depends-on "cl-lib" "0.5")
(development
- (depends-on "f")
(depends-on "buttercup")
(depends-on "undercover"))
diff --git a/Makefile b/Makefile
index 5a032f6..e4a2c08 100644
--- a/Makefile
+++ b/Makefile
@@ -30,6 +30,12 @@ dir: $(INFOPAGES)
$(info Generating dir)
@echo $^ | xargs -n 1 $(INSTALL_INFO) --dir=$@
+$(AUTOLOADS): $(SRCS)
+ @$(EMACSBATCH) --eval \
+ "(progn \
+ (require 'package) \
+ (package-generate-autoloads \"bnf-mode\" default-directory))"
+
# Remove badges
define org-clean
@cat $^ | sed -e "s/\[\[.*\.svg\]\]//g"
@@ -37,7 +43,7 @@ endef
README: README.org
$(call org-clean,$^) | \
- $(PANDOC) $(PANDOCLAGS) -t plain | sed -e "s/\[\]//g" > $@
+ $(PANDOC) $(PANDOCFLAGS) -t plain | sed -e "s/\[\]//g" > $@
ChangeLog: NEWS
@cp $^ $@
@@ -61,12 +67,17 @@ init: Cask
.PHONY: checkdoc
checkdoc:
- @$(EMACSBATCH) --eval '(checkdoc-file "$(SRCS)")'
- $(info Done.)
+ @for f in $(SRCS) ; do \
+ echo "Checking $$f ..."; \
+ $(EMACSBATCH) --eval "(checkdoc-file \"$$f\")"; \
+ done && echo "Done."
.PHONY: build
build: $(OBJS)
+.PHONY: autoloads
+autoloads: $(AUTOLOADS)
+
.PHONY: test
test:
@$(CASK) exec buttercup $(TESTFLAGS)
@@ -75,9 +86,9 @@ test:
clean:
$(info Remove all byte compiled Elisp files...)
@$(CASK) clean-elc
- $(info Remove build artefacts...)
+ $(info Remove build artifacts...)
@$(RM) README ChangeLog coverage-final.json
- @$(RM) $(PACKAGE)-pkg.el $(PACKAGE)-*.tar
+ @$(RM) $(PACKAGE)-pkg.el $(PACKAGE)-*.tar $(AUTOLOADS)
.PHONY: package
package: $(ARCHIVE_NAME).tar
@@ -101,9 +112,10 @@ help: .title
@echo ' init: Initialize the project (has to be launched first)'
@echo ' checkdoc: Checks BNF Mode code for errors in the
documentation'
@echo ' build: Byte compile BNF Mode package'
+ @echo ' autoloads: Generate autoloads file'
@echo ' test: Run the non-interactive unit test suite'
@echo ' clean: Remove all byte compiled Elisp files,
documentation,'
- @echo ' build artefacts and tarball'
+ @echo ' build artifacts and tarball'
@echo ' package: Build package'
@echo ' install: Install BNF Mode'
@echo ' info: Generate info manual'
diff --git a/README.org b/README.org
index ad5ced9..6dc7ba4 100644
--- a/README.org
+++ b/README.org
@@ -2,7 +2,6 @@
[[https://www.gnu.org/licenses/gpl-3.0.txt][https://img.shields.io/badge/license-GPL_3-green.svg]]
[[https://github.com/sergeyklay/bnf-mode/actions][https://github.com/sergeyklay/bnf-mode/workflows/build/badge.svg]]
-[[https://codecov.io/gh/sergeyklay/bnf-mode][https://codecov.io/gh/sergeyklay/bnf-mode/branch/master/graph/badge.svg]]
[[https://melpa.org/#/bnf-mode][https://melpa.org/packages/bnf-mode-badge.svg]]
[[https://stable.melpa.org/#/bnf-mode][https://stable.melpa.org/packages/bnf-mode-badge.svg]]
diff --git a/default.mk b/default.mk
index 3c527f2..9408477 100644
--- a/default.mk
+++ b/default.mk
@@ -30,7 +30,7 @@ MAKEINFO ?= makeinfo
EMACSFLAGS ?=
TESTFLAGS ?= -L .
-PANDOCLAGS ?= --fail-if-warnings \
+PANDOCFLAGS ?= --fail-if-warnings \
--reference-links \
--atx-headers \
-f org+empty_paragraphs
@@ -53,6 +53,7 @@ PACKAGE = bnf-mode
ARCHIVE_NAME = $(PACKAGE)-$(VERSION)
# File lists
+AUTOLOADS = bnf-mode-autoloads.el
SRCS = bnf-mode.el
OBJS = $(SRCS:.el=.elc)
@@ -60,6 +61,7 @@ INFOPAGES = $(addsuffix .info,$(PACKAGE))
ARCHIVE_CONTENTS = README \
ChangeLog \
LICENSE \
+ $(AUTOLOADS) \
$(PACKAGE).el \
$(PACKAGE)-pkg.el \
$(INFOPAGES) dir
diff --git a/test/utils.el b/test/utils.el
index c204cdb..7b40fde 100644
--- a/test/utils.el
+++ b/test/utils.el
@@ -68,10 +68,10 @@ decorate each of symbol."
(defun get-str-faces (str)
"Find contiguous spans of non-default faces in STR.
-E.g. for properly fontified Lua string \"local x = 100\" it should return
- '(\"local\" font-lock-keyword-face
- \"x\" font-lock-variable-name-face
- \"100\" font-lock-constant-face)"
+E.g. for properly fontified BNF string \"<stm> ::= <decl>\" it should return
+ '(\"stm\" font-lock-function-name-face
+ \"::=\" font-lock-constant-face
+ \"decl\" font-lock-builtin-face)"
(let ((pos 0)
nextpos
result prop newprop)
@@ -122,8 +122,8 @@ Fontification check failed for:
(buttercup-fail "\
Fontification check failed on line %d for:
%S
- Result faces: %S
- Expected faces: %S"
+ Expected faces: %S
+ Actual faces: %S"
lineno text (car expected-faces) (car result-faces)))
(setq expected-faces (cdr expected-faces)
result-faces (cdr result-faces)
![https://www.gnu.org/licenses/gpl-3.0.txt][https://img.shields.io/badge/license-GPL_3-green.svg](https://www.gnu.org/licenses/gpl-3.0.txt][https://img.shields.io/badge/license-GPL_3-green.svg){kind=link}
![https://github.com/sergeyklay/bnf-mode/actions][https://github.com/sergeyklay/bnf-mode/workflows/build/badge.svg](https://github.com/sergeyklay/bnf-mode/actions][https://github.com/sergeyklay/bnf-mode/workflows/build/badge.svg){kind=link}
![https://codecov.io/gh/sergeyklay/bnf-mode][https://codecov.io/gh/sergeyklay/bnf-mode/branch/master/graph/badge.svg](https://codecov.io/gh/sergeyklay/bnf-mode][https://codecov.io/gh/sergeyklay/bnf-mode/branch/master/graph/badge.svg){kind=link}
![https://melpa.org/#/bnf-mode][https://melpa.org/packages/bnf-mode-badge.svg](https://melpa.org/#/bnf-mode][https://melpa.org/packages/bnf-mode-badge.svg){kind=link}
![https://stable.melpa.org/#/bnf-mode][https://stable.melpa.org/packages/bnf-mode-badge.svg](https://stable.melpa.org/#/bnf-mode][https://stable.melpa.org/packages/bnf-mode-badge.svg){kind=link}