misc: update docs and clear code

Author: AbaoFromCUG

.github/workflows/update-docs.yml

@@ -15,7 +15,7 @@ jobs:
         uses: rhysd/action-setup-vim@v1
         with:
           neovim: true
-          version: stable
+          version: nightly
       - name: Make document
         run: |
           make document

README.md

@@ -133,8 +133,8 @@ Configure `JupyterLab` in side panel
     "SUSTech-data/neopyter",
     dependencies = {
       'nvim-lua/plenary.nvim',
+      'nvim-treesitter/nvim-treesitter', -- neopyter don't depend on `nvim-treesitter`, but does depend on treesitter parser of python
       'AbaoFromCUG/websocket.nvim',  -- for mode='direct'
-      'nvim-treesitter',
     },
 
     ---@type neopyter.Option

lua/neopyter/health.lua

@@ -19,7 +19,7 @@ function M.check()
         local nvim_plugin_ver = jupyter.jupyterlab:get_nvim_plugin_version()
         if status then
             health.info(string.format("neovim plugin(neopyter@%s) status: active", nvim_plugin_ver))
-            local is_connecting = jupyter.jupyterlab.client:is_connecting()
+            local is_connecting = jupyter.jupyterlab:is_connecting()
             if is_connecting then
                 local jupyterlab_extension_ver = jupyter.jupyterlab:get_jupyterlab_extension_version()
                 health.info(string.format("jupyter lab extension(neopyter@%s): active", jupyterlab_extension_ver))

lua/neopyter/jupyter/jupyterlab.lua

@@ -50,16 +50,12 @@ function JupyterLab:new(opts)
     local config = require("neopyter").config
     local RpcClient
     if config["rpc_client"] ~= nil then
-        vim.notify(
-            "`rpc_client` is deprecated, please reference to https://github.com/SUSTech-data/neopyter/issues/4",
-            vim.log.levels.ERROR,
-            { title = "Neopyter" }
-        )
+        utils.notify_error("`rpc_client` is deprecated, please reference to https://github.com/SUSTech-data/neopyter/issues/4")
     end
     if config.mode == "direct" then
-        RpcClient = require("neopyter.rpc.wsserverclient")
+        RpcClient = require("neopyter.rpc.direct")
     else
-        RpcClient = require("neopyter.rpc.asyncclient")
+        RpcClient = require("neopyter.rpc.proxy")
     end
     o.client = RpcClient:new({
         address = opts.address,

lua/neopyter/jupyter/notebook.lua

@@ -78,10 +78,6 @@ function Notebook:attach()
             on_lines = function(_, _, _, start_row, old_end_row, new_end_row, _)
                 a.run(function()
                     local syncable = self:safe_sync()
-                    -- local connecting = self.client:is_connecting()
-                    -- local line = api.nvim_buf_get_lines(self.bufnr, a.fn.line(".") - 1, a.fn.line("."), true)[1]
-                    -- vim.notify(line.. "/" .. vim.inspect(connecting) .. "/" .. vim.inspect(syncable), nil, { id = "current line" })
-
                     if syncable then
                         self:partial_sync(start_row, old_end_row - 1, new_end_row - 1)
                     else

lua/neopyter/rpc/blockclient.lua

@@ -5,18 +5,18 @@ local logger = require("neopyter.logger")
 local websocket = require("websocket")
 local a = require("plenary.async")
 
----@class neopyter.WSServerClient:neopyter.RpcClient
+---@class neopyter.DirectRpcClient:neopyter.RpcClient
 ---@field server? websocket.Server # nil means not connect
 ---@field single_connection? websocket.Connection
 ---@field private msg_count number
 ---@field private request_pool table<number, fun(...):any>
-local WSServerClient = RpcClient:new({}) --[[@as neopyter.WSServerClient]]
+local DirectRpcClient = RpcClient:new({}) --[[@as neopyter.DirectRpcClient]]
 
 ---RpcClient constructor
 ---@param opt neopyter.NewRpcClientOption
----@return neopyter.WSServerClient
-function WSServerClient:new(opt)
-    local o = setmetatable(opt or {}, { __index = self }) --[[@as neopyter.WSServerClient]]
+---@return neopyter.DirectRpcClient
+function DirectRpcClient:new(opt)
+    local o = setmetatable(opt or {}, { __index = self }) --[[@as neopyter.DirectRpcClient]]
     o.msg_count = 0
     o.request_pool = {}
     return o
@@ -26,7 +26,7 @@ end
 ---@param address? string
 ---@param on_connected? fun() # call while connected
 ---@async
-function WSServerClient:connect(address, on_connected)
+function DirectRpcClient:connect(address, on_connected)
     local restart_server = address ~= nil and self.address ~= address
     for _, fun in pairs(self.request_pool) do
         fun(false, "cancel")
@@ -75,7 +75,7 @@ function WSServerClient:connect(address, on_connected)
 end
 
 ---disconnect connect
-function WSServerClient:disconnect()
+function DirectRpcClient:disconnect()
     if self.single_connection then
         self.single_connection:close()
         self.single_connection = nil
@@ -92,11 +92,11 @@ end
 
 ---check client is connecting
 ---@return boolean
-function WSServerClient:is_connecting()
+function DirectRpcClient:is_connecting()
     return self.single_connection ~= nil
 end
 
-function WSServerClient:gen_id()
+function DirectRpcClient:gen_id()
     self.msg_count = self.msg_count + 1
     return self.msg_count
 end
@@ -105,7 +105,7 @@ end
 ---@param method string
 ---@param ... unknown # name
 ---@return unknown|nil
-function WSServerClient:request(method, ...)
+function DirectRpcClient:request(method, ...)
     if self.server == nil then
         utils.notify_error(string.format("RPC websocket server is stop, can't request [%s]", method))
         return
@@ -139,7 +139,7 @@ end
 ---handle rpc response
 ---@param data string
 ---@package
-function WSServerClient:handle_response(data)
+function DirectRpcClient:handle_response(data)
     local mpack = vim.base64.decode(data)
     local status, msg = pcall(vim.mpack.decode, mpack)
     if not status then
@@ -174,13 +174,13 @@ function WSServerClient:handle_response(data)
     end
 end
 
-function WSServerClient:notify(event, ...) end
+function DirectRpcClient:notify(event, ...) end
 
-function WSServerClient:reset_request()
+function DirectRpcClient:reset_request()
     for _, fun in pairs(self.request_pool) do
         fun(false, "reset")
     end
     self.request_pool = {}
 end
 
-return WSServerClient
+return DirectRpcClient

lua/neopyter/rpc/wsserverclient.lua renamed to lua/neopyter/rpc/direct.lua

@@ -9,12 +9,12 @@ local a = require("plenary.async")
 ---@field private msg_count number
 ---@field private request_pool table<number, fun(...):any>
 ---@field private decoder neopyter.MsgpackDecoder
-local AsyncRpcClient = RpcClient:new({}) --[[@as neopyter.AsyncRpcClient]]
+local ProxyRpcClient = RpcClient:new({}) --[[@as neopyter.AsyncRpcClient]]
 
 ---RpcClient constructor
 ---@param opt neopyter.NewRpcClientOption
 ---@return neopyter.AsyncRpcClient
-function AsyncRpcClient:new(opt)
+function ProxyRpcClient:new(opt)
     opt = opt or {}
     local o = setmetatable(opt, self)
     self.__index = self
@@ -29,7 +29,7 @@ end
 ---@param address? string
 ---@param on_connected? fun() # call while connected
 ---@async
-function AsyncRpcClient:connect(address, on_connected)
+function ProxyRpcClient:connect(address, on_connected)
     self.address = address or self.address
     assert(self.tcp_client == nil, "current connection exists, can't call connect, please disconnect first")
     assert(self.address, "Rpc client address is empty")
@@ -59,7 +59,7 @@ function AsyncRpcClient:connect(address, on_connected)
 end
 
 ---disconnect connect
-function AsyncRpcClient:disconnect()
+function ProxyRpcClient:disconnect()
     if self.tcp_client then
         self.tcp_client:close()
         self.tcp_client = nil
@@ -72,11 +72,11 @@ end
 
 ---check client is connecting
 ---@return boolean
-function AsyncRpcClient:is_connecting()
+function ProxyRpcClient:is_connecting()
     return self.tcp_client ~= nil
 end
 
-function AsyncRpcClient:gen_id()
+function ProxyRpcClient:gen_id()
     self.msg_count = self.msg_count + 1
     return self.msg_count
 end
@@ -85,7 +85,7 @@ end
 ---@param method string
 ---@param ... unknown # name
 ---@return unknown|nil
-function AsyncRpcClient:request(method, ...)
+function ProxyRpcClient:request(method, ...)
     if not self:is_connecting() then
         utils.notify_error(string.format("RPC tcp client is disconnected, can't request [%s]", method))
         return
@@ -116,7 +116,7 @@ end
 ---handle rpc response
 ---@param data string
 ---@package
-function AsyncRpcClient:handle_response(data)
+function ProxyRpcClient:handle_response(data)
     self.decoder:feed(data)
     while true do
         local msg = self.decoder:next()
@@ -141,6 +141,6 @@ function AsyncRpcClient:handle_response(data)
     end
 end
 
-function AsyncRpcClient:notify(event, ...) end
+function ProxyRpcClient:notify(event, ...) end
 
-return AsyncRpcClient
+return ProxyRpcClient