diff --git a/.dir-locals.el b/.dir-locals.el new file mode 100644 index 0000000..78d29fc --- /dev/null +++ b/.dir-locals.el @@ -0,0 +1,4 @@ +;;; Directory Local Variables -*- no-byte-compile: t -*- +;;; For more information see (info "(emacs) Directory Variables") + +((emacs-lisp-mode . ((sentence-end-double-space . t)))) diff --git a/.gitea/workflows/test.yml b/.gitea/workflows/test.yml new file mode 100644 index 0000000..e05d510 --- /dev/null +++ b/.gitea/workflows/test.yml @@ -0,0 +1,24 @@ +name: CI +on: [push, pull_request] + +jobs: + build: + runs-on: ubuntu-latest + strategy: + matrix: + emacs_version: + - 29.4 + - snapshot + steps: + - uses: actions/checkout@v4 + + - uses: purcell/setup-emacs@6 + with: + version: ${{ matrix.emacs_version }} + + - uses: emacs-eask/setup-eask@master + with: + version: 'snapshot' + + - name: "Execute Eask CI" + run: make ci diff --git a/Eask b/Eask new file mode 100644 index 0000000..e9e03f4 --- /dev/null +++ b/Eask @@ -0,0 +1,19 @@ +;;; -*- mode: cask -*- +(package "conlanging" + "0.1.0" + "Helper functions for conlanging") + +(website-url "https://labs.phundrak.com/phundrak/conlanging.el") +(keywords "convenience") + +(package-file "conlanging.el") + +(script "test" "echo \"Error: no test specified\" && exit 1") + +(source "gnu") + +(depends-on "emacs" "26.1") +(depends-on "ivy" "0.13") +(depends-on "org" "9") +(depends-on "counsel" "0.13") +(depends-on "dash" "2.19") diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..1b75e03 --- /dev/null +++ b/Makefile @@ -0,0 +1,38 @@ +EMACS ?= emacs +EASK ?= eask + +.PHONY: clean package install compile test checkdoc lint + +ci: clean package install compile checkdoc lint + +package: + @echo "Packaging..." + $(EASK) package + +install: + @echo "Installing..." + $(EASK) install + +compile: + @echo "Compiling..." + $(EASK) compile + +test: + @echo "Testing..." + $(EASK) install-deps --dev + $(EASK) test ert ./test/*.el + +checkdoc: + @echo "Checking documentation..." + $(EASK) lint checkdoc + +lint: + @echo "Linting..." + $(EASK) lint declare + $(EASK) lint indent + $(EASK) lint keywords + $(EASK) lint package + $(EASK) lint regexps + +clean: + $(EASK) clean all diff --git a/conlanging-eittlandic.el b/conlanging-eittlandic.el index 629cc26..725e4df 100644 --- a/conlanging-eittlandic.el +++ b/conlanging-eittlandic.el @@ -3,7 +3,6 @@ ;; Author: Lucien Cartier-Tilet ;; Maintainer: Lucien Cartier-Tilet ;; Version: 0.1.0 -;; Package-Requires: ((emacs "29.1") (dash "2.19")) ;; Homepage: https://labs.phundrak.com/phundrak/conlanging.el ;; Keywords: convenience @@ -23,6 +22,10 @@ ;; You should have received a copy of the GNU General Public License ;; along with this program. If not, see . +;;; Commentary: +;; This file includes functions to help write the documentation for +;; the Eittlandic language faster. + ;;; Code: (require 'dash) @@ -33,7 +36,7 @@ "Declensions of strong common nouns in Eittlandic. The first element of a pair is the vowel to use if there is no -underlying vowel. The second element is the declension suffix. +underlying vowel. The second element is the declension suffix. The order of the suffixes go like this: - singular nominative @@ -77,7 +80,7 @@ See `conlanging-eittlandic--strong-common-noun-declension' for more info.") "Return which underlying vowel should be used. If DEFAULT-VOWEL is nil, it means there is no need to insert a -vowel. However, if it is not, it should be used, unless +vowel. However, if it is not, it should be used, unless UNDERLYING-VOWEL is non-nil." (if default-vowel (if underlying-vowel underlying-vowel default-vowel) @@ -147,8 +150,8 @@ list, going in the following order: The function will know how to create the declensions on ROOT depending on its GENDER and its STRENGTH (whether it is a strong -or weak noun). The UNDERLYING-VOWEL may or may not be nil and can -influence the word's declensions." +or weak noun). The UNDERLYING-VOWEL may or may not be nil and +can influence the word's declensions." (interactive (list (read-string "Word root: ") diff --git a/conlanging-graphviz.el b/conlanging-graphviz.el index 6369fc1..29eea03 100644 --- a/conlanging-graphviz.el +++ b/conlanging-graphviz.el @@ -3,7 +3,6 @@ ;; Author: Lucien Cartier-Tilet ;; Maintainer: Lucien Cartier-Tilet ;; Version: 0.1.0 -;; Package-Requires: ((emacs "26.1")) ;; Homepage: https://labs.phundrak.com/phundrak/conlanging.el ;; Keywords: convenience @@ -23,6 +22,9 @@ ;; You should have received a copy of the GNU General Public License ;; along with this program. If not, see . +;;; Commentary: +;; This file includes functions to create conlanging-related graphs, +;; namely graphs of phonemes based on their phonological features. ;;; Code: (require 'ox) @@ -87,7 +89,7 @@ tree itself." LABEL is the label of the root node. -PREVIOUS is for internal use. It refers to the parent node of +:PREVIOUS is for internal use. It refers to the parent node of NODE if NODE is a subtree of the root tree." (cond ((stringp node) ;; it's a leaf! diff --git a/conlanging.el b/conlanging.el index 5a9f6d7..557b87c 100644 --- a/conlanging.el +++ b/conlanging.el @@ -3,8 +3,9 @@ ;; Author: Lucien Cartier-Tilet ;; Maintainer: Lucien Cartier-Tilet ;; Version: 0.1.0 -;; Package-Requires: ((emacs "24") (org "9") (ivy "0.13") (counsel "0.13")) +;; Package-Requires: ((emacs "29") (org "9") (ivy "0.13") (counsel "0.13") (dash "2.19")) ;; Homepage: https://labs.phundrak.com/phundrak/conlanging.el +;; Keywords: convenience ;; This file is not part of GNU Emacs @@ -24,7 +25,7 @@ ;;; Commentary: ;; This package is not made in order to be used by a lot of people. -;; Actually, it is made only for me. As such, there is no chance to +;; Actually, it is made only for me. As such, there is no chance to ;; find it on any ELPA or MELPA. ;; ;; Functions and variables in this package are just helpers for myself