ci: check for deprecated util functions neovim#3462

.github/ci/run_sanitizer.sh

@@ -5,12 +5,20 @@ REF_BRANCH="$1"
 PR_BRANCH="$2"
 
 # checks for added lines that contain search pattern and prints them
-SEARCH_PATTERN="(path\.dirname|fn\.cwd)"
+SEARCH_PATTERN='(path\.dirname|fn\.cwd)'
 
 if git diff --pickaxe-all -U0 -G "${SEARCH_PATTERN}" "${REF_BRANCH}" "${PR_BRANCH}" -- '*.lua' | grep -Ev '(configs|utils)\.lua$' | grep -E "^\+.*${SEARCH_PATTERN}" ; then
   echo
   echo 'String "dirname" found. There is a high risk that this might contradict the directive:'
-  echo '"Do not add vim.fn.cwd or util.path.dirname in root_dir".'
+  echo '"Do not use vim.fn.cwd or util.path.dirname in root_dir".'
   echo "see: https://github.com/neovim/nvim-lspconfig/blob/master/CONTRIBUTING.md#adding-a-server-to-lspconfig."
   exit 1
 fi
+
+SEARCH_PATTERN='(util\.path\.dirname)'
+
+if git diff --pickaxe-all -U0 -G "${SEARCH_PATTERN}" "${REF_BRANCH}" "${PR_BRANCH}" -- '*.lua' | grep -Ev '\.lua$' | grep -E "^\+.*${SEARCH_PATTERN}" ; then
+  echo
+  echo 'Do not use deprecated util functions: '"${SEARCH_PATTERN}"
+  exit 1
+fi

.github/workflows/lint.yml

@@ -6,6 +6,18 @@ on:
       - master
 
 jobs:
+  deprecated-functions:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          ref: ${{ github.event.pull_request.head.sha }}
+      - run: |
+          if ! bash .github/ci/run_sanitizer.sh ${{ github.event.pull_request.base.sha }} ${{ github.event.pull_request.head.sha }}; then
+            exit 1
+          fi
+
   luacheck:
     runs-on: ubuntu-latest
     steps:

CONTRIBUTING.md

@@ -43,7 +43,7 @@ reading your `config` source code, so the less indirection in your code, the mor
 * `root_dir`: function which returns the root of the project, used to decide if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.
     * See `:help lspconfig-new`.
     * See `vim.fs.root()`
-    * Do not use `vim.fn.cwd` or `util.path.dirname`.
+    * Do not use `vim.fn.cwd` or `vim.fs.dirname`.
 
 Additionally, these options are often useful:
 

lua/lspconfig/util.lua

@@ -151,9 +151,7 @@ M.path = (function()
     end
   end
 
-  --- @generic T: string?
-  --- @param path T
-  --- @return T
+  ---@deprecated use `vim.fs.dirname` instead
   local function dirname(path)
     return vim.fs.dirname(path)
   end