Merge pull request #208 from neo451/proper-type-check

feat: proper type check in Makefile

Author: neo451

.github/workflows/typecheck.yml

@@ -0,0 +1,42 @@
+# name: Run type check
+#
+# on:
+#   push:
+#     branches-ignore: [sync, stable]
+#     paths: ["colors/**", "lua/**", "tests/**"]
+#   pull_request:
+#     branches-ignore: [sync, stable]
+#     paths: ["colors/**", "lua/**", "tests/**"]
+#
+# concurrency:
+#   group: ${{ github.workflow }}-${{ github.ref }}-${{ github.actor }}
+#   cancel-in-progress: true
+#
+# jobs:
+#   build:
+#     name: Run tests
+#     timeout-minutes: 15
+#     runs-on: ubuntu-latest
+#
+#     steps:
+#       - uses: actions/checkout@v4
+#
+#       - name: Setup neovim
+#         shell: bash
+#         run: |
+#           mkdir -p _neovim
+#           curl -sL https://github.com/neovim/neovim/releases/download/nightly/nvim-linux-x86_64.tar.gz | tar xzf - --strip-components=1 -C "${PWD}/_neovim"
+#           export PATH="${PWD}/_neovim/bin:${PATH}"
+#           export VIMRUNTIME="${PWD}/_neovim/share/nvim/runtime"
+#
+#           nvim --version
+#
+#       - name: Install lua-language-server
+#         uses: jdx/mise-action@v2
+#         with:
+#           tool_versions: |
+#             lua-language-server 3.15.0
+#
+#       - name: Run tests
+#         run:
+#           make types

.gitignore

@@ -0,0 +1,3 @@
+deps/
+data/
+stuff/

.luarc.json

@@ -0,0 +1,8 @@
+{
+  "runtime.version": "LuaJIT", // the version for neovim
+  "diagnostics.libraryFiles": "Disable",
+  "workspace.checkThirdParty": "Disable",
+  "workspace.ignoreDir": ["lib/"],
+  "workspace.library": ["$VIMRUNTIME/lua/", "./lua/"],
+  "diagnostics.globals": ["vim", "MiniTest"]
+}

Makefile

@@ -1,5 +1,8 @@
+LUARC = $(shell readlink -f .luarc.json)
+
 # Run all test files
-test: deps/mini.nvim
+test: deps/mini.nvim deps/nvim-treesitter
+	nvim --headless --noplugin -u ./scripts/install_grammar.lua
 	nvim --headless --noplugin -u ./scripts/minimal_init.lua -c "lua MiniTest.run()"
 
 # Run test from file at `$FILE` environment variable
@@ -12,5 +15,12 @@ deps/mini.nvim:
 	@mkdir -p deps
 	git clone --filter=blob:none https://github.com/echasnovski/mini.nvim $@
 
+# Download 'mini.nvim' to use its 'mini.test' testing module
+deps/nvim-treesitter:
+	git clone --filter=blob:none https://github.com/nvim-treesitter/nvim-treesitter.git --branch main $@
+
 gen_doc:
 	./panvimdoc.sh --project-name feed --input-file doc.md --vim-version 0.11 --shift-heading-level-by -1 --toc true 
+
+types: ## Type check with lua-ls
+	lua-language-server --configpath "$(LUARC)" --check lua/feed/

lua/feed/commands.lua

@@ -169,7 +169,7 @@ M.update = {
       local args = vim.v.argv
       table.remove(args, 1)
       table.remove(args, 1)
-      local cmds = vim.tbl_flatten({
+      local cmds = ut.tbl_flatten({
          "nvim",
          args,
          "--headless",
@@ -251,9 +251,14 @@ M.export = {
    doc = "use pandoc to convert entry to any format",
    impl = function(to, fp)
       local entry, id = ui.get_entry()
-      require("feed.pandoc").convert({ id = id, to = to }, function(res)
-         ut.save_file(vim.fs.joinpath(fp, entry.title .. "." .. to), res)
-      end)
+      assert(entry, "no valid entry")
+      require("feed.pandoc").convert({
+         id = id,
+         to = to,
+         stdout = function(res)
+            ut.save_file(vim.fs.joinpath(fp, entry.title .. "." .. to), res)
+         end,
+      })
    end,
 }
 

lua/feed/config.lua

@@ -1,5 +1,5 @@
 ---@class feed.searchOpts
----@field backend "telescope" | "mini.pick" | "fzf-lua" | "snacks.pick"
+---@field backend "telescope" | "mini.pick" | "fzf-lua" | "snacks.pick" | table -- TODO: not nice
 ---@field sort_order? "ascending" | "descending"
 ---@field ignorecase? boolean
 ---@field default_query? string

lua/feed/curl.lua

@@ -53,7 +53,7 @@ end
 ---@param url string
 ---@param opts { headers: table, data: string | table, etag: string, last_modified: string, timeout: string, cmds: table }
 ---@param cb? any
----@return vim.SystemCompleted?
+---@return vim.SystemObj
 function M.get(url, opts, cb)
    opts = opts or {}
    opts.timeout = vim.F.if_nil(opts.timeout, "10")
@@ -64,7 +64,7 @@ function M.get(url, opts, cb)
       user_agent = "feed.nvim/2.0",
    }, opts.headers or {}))
    local dump_fp = vim.fn.tempname()
-   local cmds = vim.tbl_flatten({
+   local cmds = ut.tbl_flatten({
       "curl",
       req_header,
       "-sSL",
@@ -103,8 +103,21 @@ function M.get(url, opts, cb)
       return cb and cb(obj) or obj
    end
 
-   return cb and vim.system(cmds, { text = true }, cb and process or nil)
-      or process(vim.system(cmds, { text = true }):wait())
+   if cb then
+      return vim.system(cmds, { text = true }, cb and process or nil)
+   else
+      return setmetatable({}, {
+         __index = function(_, k)
+            if k == "wait" then
+               return process(vim.system(cmds, { text = true }):wait())
+            end
+         end,
+      })
+   end
+
+   -- TODO: Curl.get just return the vim.system obj, call :wait to sync
+   -- return cb and vim.system(cmds, { text = true }, cb and process or nil)
+   --    or process(vim.system(cmds, { text = true }):wait())
 end
 
 ---@async

lua/feed/db/local.lua

@@ -432,6 +432,7 @@ function M:setup_sync(c_feeds)
             table.sort(merged_tags)
 
             if not feeds[url] then
+               ---@diagnostic disable-next-line: missing-fields
                feeds[url] = {}
             end
 

lua/feed/db/ttrss.lua

@@ -104,13 +104,14 @@
 ---@field getCounters fun(self: ttrssApi): table
 ---@field setArticleLabel fun(self: ttrssApi, param: { article_ids: string, label_id: integer, assign: boolean })
 ---@field updateArticle fun(self: ttrssApi, param: { article_ids: string, mode: integer, field: integer, data: string })
+
 local api = {}
 local Curl = require("feed.curl")
 local Config = require("feed.config")
 
 api.__index = api
 
----@param obj vim.SystemCompleted?
+---@param obj table? -- TODO: properly type
 local function decode_check(obj, method) --- TODO: assert decode gets the method
    assert(obj, "no response")
    assert(obj.code == 0, "curl err")
@@ -153,13 +154,13 @@ for k, v in pairs(methods) do
       data.sid = self.sid
       data.op = k
       if type(v) == "string" then
-         return decode_check(Curl.get(url, { data = data }), k)[v]
+         return decode_check(Curl.get(url, { data = data }):wait(), k)[v]
       elseif type(v) == "table" and v.async then
          return Curl.get(url, { data = data }, function(obj)
             return decode_check(obj, k)
          end)
       else
-         return decode_check(Curl.get(url, { data = data }), k)
+         return decode_check(Curl.get(url, { data = data }):wait(), k)
       end
    end
 end

lua/feed/pandoc.lua

@@ -18,7 +18,7 @@ local function convert(ctx)
    local src = ctx.src
    local fp = ctx.id and tostring(db.dir / "data" / ctx.id) or nil
    local from = ctx.from or "html"
-   local to = ctx.to or vim.api.nvim_get_runtime_file("lua/feed/pandoc/gfm.lua", false)[1]
+   local to = ctx.to or vim.api.nvim_get_runtime_file("scripts/gfm.lua", false)[1]
    local stdout = ctx.stdout
    local on_exit = ctx.on_exit