🔖 release v1.0.0 (#105)

see https://github.com/tami5/sqlite.lua/releases/tag/v1.0.0

Author: kkharji

.github/chglog/CHANGELOG.release.md

@@ -0,0 +1,47 @@
+{{- $repourl := $.Info.RepositoryURL -}}
+
+{{ range .CommitGroups -}}
+## {{ .Title }}
+
+{{ range .Commits -}}
+  {{- /** Remove markdown urls when there's a pull request linked and replace it with a tag **/ -}}
+  {{- $subject := (regexReplaceAll `URL` (regexReplaceAll `\[(.*)(\d\d)\]\(.*?\)` .Subject "<a href=\"URL/pull/${2}\">${1}${2}</a>") $repourl) -}}
+  {{- /** Filter out refs mentioned in the title **/ -}}
+  {{- $list := (list) -}}
+  {{- range $idx, $ref := .Refs -}}
+    {{- if not (regexMatch $ref.Ref $subject) -}}
+      {{ $list = append $list $ref }}
+    {{- end -}}
+  {{- end -}}
+  {{- /** end custom varaibles **/ -}}
+
+{{ if .TrimmedBody -}}<dl><dd><details><summary>{{ else -}}- {{ end -}}
+  <a href="{{$repourl}}/commit/{{.Hash.Long}}"><tt>{{.Hash.Short}}</tt></a> {{ $subject }}
+  {{- if $list -}}
+    {{ printf " %s " "(closes"}}
+    {{- range $idx, $ref := $list -}}{{ if $idx }}, {{ end -}}
+    <a href="{{ $repourl }}/issues/{{ $ref.Ref}}"> #{{ $ref.Ref}}</a>{{ end }})
+  {{- end -}}
+{{ if .TrimmedBody -}}</summary>{{ printf "\n\n%s\n\n" .TrimmedBody }}</details></dd></dl>{{ end }}
+
+{{ end }}
+{{ end }}
+
+{{- if .RevertCommits -}}
+### Reverts
+
+{{ range .RevertCommits -}}
+* {{ .Revert.Header }}
+{{ end }}
+{{ end -}}
+
+{{- if .NoteGroups -}}
+{{ range .NoteGroups -}}
+### {{ .Title }}
+
+{{ range .Notes }}
+{{ .Body }}
+{{ end }}
+{{ end -}}
+{{ end -}}
+{{ end -}}

.github/chglog/CHANGELOG.tpl.md

@@ -4,8 +4,6 @@
 
 ## {{ if .Tag.Previous }}[{{ .Tag.Name }}]({{ $repourl }}/compare/{{ .Tag.Previous.Name }}...{{ .Tag.Name }}){{ else }}{{ .Tag.Name }}{{ end }}
 
-> {{ datetime "2006-01-02" .Tag.Date }}
-
 {{ range .CommitGroups -}}
 ### {{ .Title }}
 

.github/workflows/changelog.yml

@@ -2,7 +2,7 @@ name: Generator Changelog
 
 on:
   schedule:
-    - cron: "0 8 */2 * *"
+    - cron: "0 8 */1 * *"
 
 jobs:
   build-sources:
@@ -35,7 +35,7 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           COMMIT_MSG: |
-            :card_file_box: update CHANGELOG.md
+            :card_file_box: update changelog
         run: |
           git config --global user.name "github-actions[bot]"
           git config --global user.email "github-actions[bot]@users.noreply.github.com"

.github/workflows/docgen.yml

@@ -1,7 +1,5 @@
 name: Generate docs
-
 on: push
-
 jobs:
   build-sources:
     name: Generate docs
@@ -41,13 +39,13 @@ jobs:
       - name: Generating docs
         run: |
           export PATH="${PWD}/build/:${PATH}"
-          make docgen
+          make gen_nvimhelp
       # inspired by nvim-lspconfigs
       - name: Update documentation
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           COMMIT_MSG: |
-            :card_file_box: Update doc/sql.txt
+            :card_file_box: update doc/sqlite.txt
         run: |
           git config --global user.name "github-actions[bot]"
           git config --global user.email "github-actions[bot]@users.noreply.github.com"

.github/workflows/release.yml

@@ -0,0 +1,93 @@
+# name: Create Release
+# on:
+#   push:
+#     tags: ["v*"]
+# jobs:
+#   release:
+#     if: github.event.base_ref == 'refs/heads/master' # not sure, maybe not
+#     runs-on: ubuntu-20.04
+#     container:
+#       image: golang:1.16
+#     steps:
+#       -
+#         name: Check out a copy of the repo
+#         uses: actions/checkout@v2
+#         with: { fetch-depth: 0 }
+#       -
+#         run: date +%F > todays-date
+#       -
+#         name: Restore cache for today's nightly.
+#         uses: actions/cache@v2
+#         with:
+#           path: build
+#           key: ${{ runner.os }}-appimage-${{ hashFiles('todays-date') }}
+#       -
+#         name: Show Tag
+#         id: tag
+#         run: echo ::set-output name=TAG::${GITHUB_REF##*/}
+#       -
+#         name: Install required utils
+#         run: |
+#           apt-get update
+#           apt-get -y install luarocks
+#           go get github.com/git-chglog/git-chglog/cmd/git-chglog
+#       -
+#         name: Setup  Environment
+#         run: |
+#           test -d build || {
+#             mkdir -p build
+#             wget https://github.com/neovim/neovim/releases/download/nightly/nvim.appimage
+#             chmod +x nvim.appimage
+#             ./nvim.appimage --appimage-extract
+#             mv ./squashfs-root/usr/bin/nvim ./build/nvim
+#           }
+#           mkdir -p ~/.local/share/nvim/site/pack/vendor/start
+#           git clone --depth 1 https://github.com/nvim-lua/plenary.nvim \
+#             ~/.local/share/nvim/site/pack/vendor/start/plenary.nvim
+#           ln -s $(pwd) ~/.local/share/nvim/site/pack/vendor/start
+#       -
+#         name: Generate changelog
+#         run: |
+#           $(go env GOPATH)/bin/git-chglog \
+#             -c .github/chglog/config.yml \
+#             -t .github/chglog/CHANGELOG.release.md \
+#             -o RELEASE_CHANGELOG.md ${{ steps.tag.outputs.TAG }}
+#           cat RELEASE_CHANGELOG.md
+#       -
+#         name: Generate Luarocks
+#         run: |
+#           export GTAG=${{ steps.tag.outputs.TAG }}
+#           export PATH="${PWD}/build/:${PATH}"
+#           make genluarock
+#       -
+#         name: Update version in files
+#         run: |
+#           sed -i '/sqlite\.db\.__version/s/".*"/"${{ steps.tag.outputs.TAG }}"/' ./lua/sqlite/db.lua
+#           git add ./lua/sqlite/init.lua
+#       -
+#         name: Upload to luarocks
+#         env:
+#           LUAROCKS_TOKEN: ${{ secrets.LUAROCKS_TOKEN }}
+#         run: |
+#           luarocks upload \
+#             .sqlite-${{ steps.tag.outputs.TAG }}-0.rockspec \
+#             --api-key=${LUAROCKS_TOKEN}
+#       -
+#         name: Push Release Changes
+#         env:
+#           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+#           COMMIT_MSG: |
+#             :bookmark: release ${{ steps.tag.outputs.TAG }}
+
+#             see https://github.com/${{ github.repository }}/releases/tag/${{ steps.tag.outputs.TAG }}
+#         run: |
+#           git config --global user.name 'github-actions[bot]'
+#           git config --global user.email 'github-actions[bot]@users.noreply.github.com'
+#           git remote set-url origin https://x-access-token:${GITHUB_TOKEN}@github.com/${GITHUB_REPOSITORY}.git
+#           git commit -m "${COMMIT_MSG}"
+#           git push origin HEAD:master
+#       -
+#         name: Create GH Release
+#         uses: softprops/action-gh-release@v1
+#         with:
+#           body_path: RELEASE_CHANGELOG.md

.sqlite-master-0.rockspec

@@ -0,0 +1,33 @@
+rockspec_format = "3.0"
+package = "sqlite"
+version = "master-0"
+source = {
+  url = "git://github.com/tami5/sqlite.lua",
+  branch = "master",
+}
+
+dependencies = {
+  "luv",
+}
+
+description = {
+  detailed = "",
+  homepage = "https://github.com/tami5/sqlite.lua",
+  labels = { "sqlite3", "binding", "luajit", "database" },
+  license = "MIT",
+  summary = "SQLite/LuaJIT binding and a highly opinionated wrapper for storing, retrieving, caching, and persisting [SQLite] databases",
+}
+
+build = {
+  type = "builtin",
+  modules = {
+    ["sqlite.db"] = "/lua/sqlite/db.lua",
+    ["sqlite.defs"] = "/lua/sqlite/defs.lua",
+    ["sqlite.init"] = "/lua/sqlite/init.lua",
+    ["sqlite.json"] = "/lua/sqlite/json.lua",
+    ["sqlite.tbl"] = "/lua/sqlite/tbl.lua",
+    ["sqlite.tbl.cache"] = "/lua/sqlite/tbl/cache.lua",
+    ["sqlite.tbl.extend"] = "/lua/sqlite/tbl/extend.lua",
+    ["sqlite.utils"] = "/lua/sqlite/utils.lua",
+  },
+}

Makefile

@@ -5,8 +5,12 @@ test:
 lint:
 	luacheck lua/
 
-docgen:
-	nvim --headless --noplugin -u test/minimal_init.vim -c "luafile ./scripts/gendocs.lua" -c 'qa'
+gen_nvimhelp:
+	nvim --headless --noplugin -u test/minimal_init.vim -c "luafile ./scripts/gen_nvimhelp.lua" -c 'qa'
 
 testfile:
 	nvim --headless --noplugin -u test/minimal_init.vim -c "PlenaryBustedDirectory test/auto/$(file)_spec.lua { minimal_init = './test/minimal_init.vim' }"
+
+gen_luarock:
+	nvim --headless --noplugin -u test/minimal_init.vim -c "luafile ./scripts/gen_rockspec.lua" -c 'qa'
+

README.md

@@ -1,25 +1,21 @@
-sql.nvim 💫 
+sqlite.lua 💫
 =================
 
 
 [SQLite]/[LuaJIT] binding and a highly opinionated wrapper for storing, retrieving, caching, and persisting [SQLite] databases.
-[sql.nvim] present new possibilities for plugin development and while it's primarily created for [neovim], it support all luajit environments.
+[sqlite.lua] present new possibilities for plugin development and while it's primarily created for [neovim], it support all luajit environments.
 
-- [Changelog](https://github.com/tami5/sql.nvim/blob/master/CHANGELOG.md)
-- [Docs](https://github.com/tami5/sql.nvim/blob/master/doc/sql.txt)
-
-⏲️ Status
-------------------
-Under heavy development. Low level API is stable for usage, however, top level API and new features are subject to change. 
-Please wait for 0.1 relaese or watch the repo for changes.
+- [Changelog](https://github.com/tami5/sqlite.lua/blob/master/CHANGELOG.md)
+- [Docs](https://github.com/tami5/sqlite.lua/blob/master/doc/sql.txt)
 
+<p align="center"> <img src="./doc/preview.svg"> </p>
 
 ✨ Features:
 ------------------
-- Connect, reconnect, close sql db connections `sql:open/sql:close`
-- Evaluate any sqlite statement and return result if any `sql:eval`
-- Helper function over `sql:eval` to do all sort of operation.
-- High level API with `sql:table` for better experience
+- Connect, reconnect, close sql db connections `sqlite:open/sql:close`
+- Evaluate any sqlite statement and return result if any `sqlite:eval`
+- Helper function over `sqlite:eval` to do all sort of operation.
+- High level API with `sqlite.tbl` for better experience.
 - lua tables deserialization/serialization (in helper functions and high level api)
 - 90% test coverage.
 - Up-to-date docs and changelog
@@ -28,14 +24,23 @@ Please wait for 0.1 relaese or watch the repo for changes.
 🚧 Installation
 -----------------
 
-Add `sql.nvim` to your lua `package.path`, neovim `/**/start/` or use your
-favorite vim package manager, and ensure you have `sqlite3` installed locally. 
-If you are using macos, then sqlite3 should be installed already, otherwise install using brew.
+### [Packer.nvim](https://github.com/wbthomason/packer.nvim)
+
+```lua
+use { "tami5/sqlite.lua" }
+```
+
+### [luarocks](https://luarocks.org/)
+
+```bash
+luarocks install sqlite
+```
 
+**Ensure you have `sqlite3` installed locally.**
 
 #### Windows
 
-[Download precompiled](https://www.sqlite.org/download.html) and set `let g:sql_clib_path = path/to/sqlite3.dll` (note: `/`)
+[Download precompiled](https://www.sqlite.org/download.html) and set `let g:sqlite_clib_path = path/to/sqlite3.dll` (note: `/`)
 
 #### Linux
 ```bash
@@ -48,14 +53,13 @@ sudo apt-get install sqlite3 libsqlite3-dev # Ubuntu
 programs.neovim.plugins = [
     {
       plugin = pkgs.vimPlugins.sql-nvim;
-      config = "let g:sql_clib_path = '${pkgs.sqlite.out}/lib/libsqlite3.so'";
+      config = "let g:sqlite_clib_path = '${pkgs.sqlite.out}/lib/libsqlite3.so'";
     }
 ];
 ```
 
 [Installation]: #🚧_installation
-[Status]: #status
 [SQLite]: https://www.sqlite.org/index.html
 [LuaJIT]: https://luajit.org
-[sql.nvim]: https://github.com/tami5/sql.nvim
+[sqlite.lua]: https://github.com/tami5/sqlite.lua
 [neovim]: https://github.com/neovim/neovim