Merge pull request #2 from jglasovic/jglasovic/venv-selector

refactor: full code refactor and interactive venv and root directory selection

Author: jglasovic

.editorconfig

@@ -8,4 +8,4 @@ end_of_line = lf
 insert_final_newline = true
 
 [*.lua]
-max_line_length = 120
+max_line_length = 100

.github/workflows/ci.yml

@@ -0,0 +1,36 @@
+name: Ci
+
+on: [push]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Stylua
+        uses: JohnnyMorganz/stylua-action@v3
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          version: latest
+          args: --check .
+
+  docs:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+
+    name: pandoc to vimdoc
+    if: ${{ github.ref == 'refs/heads/main' }}
+    steps:
+      - uses: actions/checkout@v3
+      - name: panvimdoc
+        uses: kdheepak/panvimdoc@main
+        with:
+          vimdoc: venv-lsp.nvim
+          treesitter: true
+      - uses: stefanzweifel/git-auto-commit-action@v4
+        with:
+          commit_message: "chore(doc): auto generate docs"
+          commit_user_name: "github-actions[bot]"
+          commit_user_email: "github-actions[bot]@users.noreply.github.com"
+          commit_author: "github-actions[bot] <github-actions[bot]@users.noreply.github.com>"

.github/workflows/test.yml

@@ -0,0 +1,23 @@
+name: Run tests
+on:
+  pull_request: ~
+  push:
+    branches:
+      - main
+
+jobs:
+  build:
+    name: Run tests
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        neovim_version: ['nightly', 'stable']
+
+    steps:
+      - name: Run tests
+        shell: bash
+        run: |
+          echo ${{ matrix.neovim_version }}
+        # uses: nvim-neorocks/nvim-busted-action@v1
+        # with:
+          # nvim_version: ${{ matrix.neovim_version }}

.luarc.json

@@ -10,5 +10,10 @@
       "${3rd}/luv/library"
     ],
     "checkThirdParty": false
+  },
+  "diagnostics": {
+    "disable": [
+      "duplicate-set-field"
+    ]
   }
 }

.stylua.toml

@@ -1,4 +1,4 @@
-column_width = 120
+column_width = 100
 line_endings = "Unix"
 indent_type = "Spaces"
 indent_width = 2

README.md

@@ -91,28 +91,48 @@ require("venv-lsp").setup()
 
 ### Commands
 
-- `:VenvLspAutoDisable` — Disable automatic virtual environment detection.
-- `:VenvLspAutoEnable` — Enable automatic virtual environment detection.
-- `:VenvLspAddVenv` — Manually add a `<root dir path>` → `<virtual environment path>` mapping.
-  (You will be prompted to enter the root dir path and venv path.)
-- `:VenvLspRemoveVenv` — Remove the manually set `<root dir path>` → `<virtual environment path>` mapping.
-  (You will be prompted to select the root path to remove.)
+The following user commands are provided by `venv-lsp`:
+
+- `:VenvLspAddVenv`  
+  Prompt to add a virtual environment mapping for a project root.
+
+- `:VenvLspRemoveVenv`  
+  Prompt to remove a virtual environment mapping.
+
+- `:VenvLspCacheDisable`  
+  Disable the virtual environment cache.
+
+- `:VenvLspCacheEnable`  
+  Enable the virtual environment cache.
+
+- `:VenvLspAutoDisable`  
+  Disable automatic virtual environment detection.
+
+- `:VenvLspAutoEnable`  
+  Enable automatic virtual environment detection.
+
+- `:VenvLspCacheFile`  
+  Open the cache file in the editor.
+
 
 ## Configuration
 
 You can pass a config table to `setup()` to customize behavior:
 
 ```lua
 require("venv-lsp").setup({
-  disabled_auto_venv = false, -- (default) Set to true to disable automatic venv detection
-  cache_json_path = vim.fn.stdpath("cache") .. "/venv_lsp/cache.json", -- (default) Custom path for venv cache file
+  cache_json_path = vim.fn.stdpath('cache') .. '/venv_lsp/cache.json', -- (default) Custom path for venv cache file
+  disable_cache = false, -- (default) Set to true to disable reading/writing cached venv in json file (still uses in-memory cache)
+  disable_auto_venv = false, -- (default) Set to true to disable automatic venv detection
 })
 ```
 
-- `disabled_auto_venv`: (boolean) If true, disables automatic virtual environment detection and activation.
+- `disable_auto_venv`: (boolean) If true, disables automatic virtual environment detection and activation.  
+  Default: `false`
+- `disable_cache`: (boolean) If true, disables reading/writing cached venvs in the JSON file (still uses in-memory cache).  
   Default: `false`
 - `cache_json_path`: (string) Path to the JSON file used for caching venv locations per project.  
-  Default: `utils.path_join(vim.fn.stdpath("cache"), 'venv_lsp', 'cache.json')`
+  Default: `vim.fn.stdpath('cache') .. '/venv_lsp/cache.json'`
 
 ## How it works
 
@@ -183,7 +203,8 @@ MIT License
 
 ## TODO
 
-- [ ] Support `pipenv` venvs
+- [ ] Add venv search as in [vscode-python](https://github.com/microsoft/vscode-python/tree/2faa16417084e4b3f9a448127f361dcb336d3ce6/src/client/pythonEnvironments/common/environmentManagers)
+- [ ] fzf.vim, fzf-lua, telescope.nvim support for venv search
 - [ ] Support for `jedi-language-server`
 - [ ] Support for `pylsp`
 - [ ] Support for `pylyzer`

doc/.gitkeep

@@ -0,0 +1,17 @@
+venv-lsp.nvim-links	venv-lsp.nvim.txt	/*venv-lsp.nvim-links*
+venv-lsp.nvim-table-of-contents	venv-lsp.nvim.txt	/*venv-lsp.nvim-table-of-contents*
+venv-lsp.nvim-venv-lsp.nvim	venv-lsp.nvim.txt	/*venv-lsp.nvim-venv-lsp.nvim*
+venv-lsp.nvim-venv-lsp.nvim-configuration	venv-lsp.nvim.txt	/*venv-lsp.nvim-venv-lsp.nvim-configuration*
+venv-lsp.nvim-venv-lsp.nvim-contributing	venv-lsp.nvim.txt	/*venv-lsp.nvim-venv-lsp.nvim-contributing*
+venv-lsp.nvim-venv-lsp.nvim-faq	venv-lsp.nvim.txt	/*venv-lsp.nvim-venv-lsp.nvim-faq*
+venv-lsp.nvim-venv-lsp.nvim-features	venv-lsp.nvim.txt	/*venv-lsp.nvim-venv-lsp.nvim-features*
+venv-lsp.nvim-venv-lsp.nvim-how-it-works	venv-lsp.nvim.txt	/*venv-lsp.nvim-venv-lsp.nvim-how-it-works*
+venv-lsp.nvim-venv-lsp.nvim-installation	venv-lsp.nvim.txt	/*venv-lsp.nvim-venv-lsp.nvim-installation*
+venv-lsp.nvim-venv-lsp.nvim-license	venv-lsp.nvim.txt	/*venv-lsp.nvim-venv-lsp.nvim-license*
+venv-lsp.nvim-venv-lsp.nvim-quick-start	venv-lsp.nvim.txt	/*venv-lsp.nvim-venv-lsp.nvim-quick-start*
+venv-lsp.nvim-venv-lsp.nvim-requirements	venv-lsp.nvim.txt	/*venv-lsp.nvim-venv-lsp.nvim-requirements*
+venv-lsp.nvim-venv-lsp.nvim-supported-lsps	venv-lsp.nvim.txt	/*venv-lsp.nvim-venv-lsp.nvim-supported-lsps*
+venv-lsp.nvim-venv-lsp.nvim-todo	venv-lsp.nvim.txt	/*venv-lsp.nvim-venv-lsp.nvim-todo*
+venv-lsp.nvim-venv-lsp.nvim-troubleshooting	venv-lsp.nvim.txt	/*venv-lsp.nvim-venv-lsp.nvim-troubleshooting*
+venv-lsp.nvim-venv-lsp.nvim-usage	venv-lsp.nvim.txt	/*venv-lsp.nvim-venv-lsp.nvim-usage*
+venv-lsp.nvim.txt	venv-lsp.nvim.txt	/*venv-lsp.nvim.txt*