Bundle plenary as a submodule (#18)

* Bundle plenary as a submodule

Closes #7

* README and CHANGELOG

Author: epwalsh

.github/workflows/main.yml

@@ -15,8 +15,6 @@ on:
       - 'v*.*.*'
 
 env:
-  plenary-git: https://github.com/nvim-lua/plenary.nvim
-  plenary-path: ~/.local/share/nvim/site/pack/vendor/start/plenary.nvim
   runtime: ~/.local/share/nvim/site/pack/vendor/start
 
 jobs:
@@ -86,7 +84,6 @@ jobs:
             mkdir -p _neovim
             curl -sL ${{ matrix.nvim_url }} | tar xzf - --strip-components=1 -C "${PWD}/_neovim"
           }
-          git clone --depth 1 ${{ env.plenary-git }} ${{ env.plenary-path }}
           ln -s $(pwd) ${{ env.runtime }}
 
       - name: Prepare

.gitmodules

@@ -1,3 +1,6 @@
 [submodule "lua/deps/lua_yaml"]
 	path = lua/deps/lua_yaml
 	url = https://github.com/exosite/lua-yaml.git
+[submodule "lua/deps/plenary"]
+	path = lua/deps/plenary
+	url = https://github.com/nvim-lua/plenary.nvim.git

.styluaignore

@@ -1 +1,3 @@
-lua/deps/lua_yaml
+lua/deps/
+lua/plenary/
+lua/yaml.lua

CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+### Changed
+
+- `plenary.nvim` is no longer required to be installed seperately. It's now bundled as a submodule.
+
 ## [v1.2.1](https://github.com/epwalsh/obsidian.nvim/releases/tag/v1.2.1) - 2022-09-23
 
 ### Added

Makefile

@@ -1,3 +1,5 @@
+TEST = test/obsidian
+
 .PHONY : all
 all : style lint test
 
@@ -7,11 +9,14 @@ test :
 		--headless \
 		--noplugin \
 		-u test/minimal_init.vim \
-		-c "PlenaryBustedDirectory test/obsidian/ { minimal_init = './test/minimal_init.vim' }"
+		-c "PlenaryBustedDirectory $(TEST) { minimal_init = './test/minimal_init.vim' }"
 
 .PHONY : lint
 lint :
-	luacheck after lua --exclude-files='lua/deps/lua_yaml/*'
+	luacheck after lua \
+		--exclude-files='lua/deps/*' \
+		--exclude-files='lua/plenary/*' \
+		--exclude-files='lua/yaml.lua'
 
 .PHONY : style
 style :

README.md

@@ -22,7 +22,6 @@ This is for people who love the concept of Obsidian -- a simple, markdown-based
 ### Requirements
 
 - A nightly build of NeoVim (this plugin uses `vim.fs`).
-- The [plenary.nvim](https://github.com/nvim-lua/plenary.nvim) plugin.
 - If you want completion features (recommended) you'll also need [ripgrep](https://github.com/BurntSushi/ripgrep) to be installed and on your `$PATH`.
 See [ripgrep#installation](https://github.com/BurntSushi/ripgrep) for install options.
 
@@ -31,7 +30,6 @@ See [ripgrep#installation](https://github.com/BurntSushi/ripgrep) for install op
 Using `vim-plug`, for example:
 
 ```vim
-Plug 'nvim-lua/plenary.nvim'  " required
 Plug 'hrsh7th/nvim-cmp'       " optional, for completion
 Plug 'godlygeek/tabular'      " optional, needed for 'preservim/vim-markdown'
 Plug 'preservim/vim-markdown' " optional, recommended for syntax highlighting, folding, etc if you're not using nvim-treesitter

lua/deps/init.lua

@@ -1,5 +1,4 @@
 local Path = require "plenary.path"
-
 local Note = require "obsidian.note"
 local echo = require "obsidian.echo"
 local util = require "obsidian.util"

lua/deps/plenary

@@ -1,6 +1,6 @@
 local Path = require "plenary.path"
+local yaml = require "yaml"
 local util = require "obsidian.util"
-local yaml = require "deps.lua_yaml.yaml"
 local echo = require "obsidian.echo"
 
 local SKIP_UPDATING_FRONTMATTER = { "README.md", "CONTRIBUTING.md", "CHANGELOG.md" }

lua/obsidian/command.lua

@@ -1,4 +1,5 @@
 local scan = require "plenary.scandir"
+
 local util = {}
 
 ---Check if a table (list) contains a value.

lua/obsidian/note.lua

@@ -0,0 +1 @@
+deps/plenary/lua/plenary

lua/obsidian/util.lua

@@ -0,0 +1 @@
+deps/lua_yaml/yaml.lua

lua/plenary

@@ -1,5 +1,4 @@
 set rtp+=.
-set rtp+=~/.config/nvim/plugged/plenary.nvim
-set rtp+=~/.config/nvim/plugged/sqlite.lua
+set rtp+=./lua/deps/plenary
 
 runtime! plugin/plenary.vim