refactor(ex.lsp.null_ls)!: Rename ex.lsp.null_ls to ex.lsp.none_ls

Author: vladimir-popov

Makefile

@@ -18,7 +18,7 @@ LUALINE=$(START)/nvim-lspconfig
 
 # Specific for components:
 LSPCONFIG=$(START)/lualine.nvim
-NULL_LS=$(START)/null-ls.nvim
+NONE_LS=$(START)/none-ls.nvim
 # ====================
 
 define HELP
@@ -74,7 +74,7 @@ install:
 	@[ -d $(DEVICONS) ] || git clone --depth 1 https://github.com/nvim-tree/nvim-web-devicons $(DEVICONS)
 	@[ -d $(LSPCONFIG) ] || git clone --depth 1 https://github.com/neovim/nvim-lspconfig $(LSPCONFIG)
 	@[ -d $(LUALINE) ] || git clone --depth 1 https://github.com/nvim-lualine/lualine.nvim $(LUALINE)
-	@[ -d $(NULL_LS) ] || git clone --depth 1 https://github.com/nvimtools/none-ls.nvim $(NULL_LS)
+	@[ -d $(NONE_LS) ] || git clone --depth 1 https://github.com/nvimtools/none-ls.nvim $(NONE_LS)
 ifdef plugin
 	@[ -d $(START)/$(notdir $(plugin)) ] || git clone --depth 1 https://github.com/$(plugin) $(START)/$(notdir $(plugin))
 endif

README.md

@@ -18,7 +18,7 @@ for `lualine.nvim` with additional components.
     - [ex.git.branch](#exgitbranch)
     - [ex.lsp.single](#exlspsingle)
     - [ex.lsp.all](#exlspall)
-    - [ex.lsp.null_ls](#exlspnull_ls)
+    - [ex.lsp.none_ls](#exlspnone_ls)
  - [🛠️ Tools](#tools)
 
 ## 📥 <a name="installation">Installation</a>
@@ -500,7 +500,7 @@ on_click = function(clicks, button, modified)
 end
 ```
 
-### ex.lsp.null_ls
+### ex.lsp.none_ls
 
 This component shows names of the
 [null-ls](https://github.com/nvimtools/none-ls.nvim) sources according to the specified
@@ -512,7 +512,7 @@ duplicated names are merged.
 sections = {
   lualine_a = {
     {
-      'ex.lsp.null_ls',
+      'ex.lsp.none_ls',
 
       -- The table or function that returns the table with the source query.
       -- By default it shows only actual sorces. To show all registered sources

lua/lualine/components/ex/lsp/null_ls.lua lua/lualine/components/ex/lsp/none_ls.lua

@@ -1,16 +1,18 @@
-local log = require('plenary.log').new({ plugin = 'ex.lsp.null-ls' })
+local log = require('plenary.log').new({ plugin = 'ex.lsp.none-ls' })
 
 -- we should be ready to three possible cases:
--- * when null-ls is not loaded we should load it only on demand;
--- * when null-ls is not installed we should mock it to avoid errors;
+-- * when none-ls is not loaded we should load it only on demand;
+-- * when none-ls is not installed we should mock it to avoid errors;
 -- * when it is installed and loaded we should use it.
-local null_ls = setmetatable({}, {
+local none_ls = setmetatable({}, {
     __index = function(self, key)
-        -- attempt to lazy load null-ls plugin
+        -- attempt to lazy load none-ls plugin
         if rawget(self, 'is_installed') == nil then
-            local is_installed, null_ls = pcall(require, 'null-ls')
+            -- null-ls is old name of the none-ls plugin, 
+            -- which is still used for back compatibility
+            local is_installed, none_ls = pcall(require, 'null-ls')
             rawset(self, 'is_installed', is_installed)
-            rawset(self, 'null_ls', null_ls)
+            rawset(self, 'none_ls', none_ls)
             if is_installed then
                 log.debug('none-ls is installed')
             else
@@ -19,7 +21,7 @@ local null_ls = setmetatable({}, {
         end
         -- return original plugin if it's installed
         if rawget(self, 'is_installed') then
-            return rawget(self, 'null_ls')[key]
+            return rawget(self, 'none_ls')[key]
         end
         -- return mock:
         if key == 'get_source' then
@@ -36,19 +38,19 @@ local null_ls = setmetatable({}, {
     end,
 })
 
-local NullLS = require('lualine.ex.component'):extend({
+local NoneLS = require('lualine.ex.component'):extend({
     icon = '',
     query = function()
         return { filetype = vim.bo.filetype }
     end,
-    component_name = 'ex_lsp_null_ls',
+    component_name = 'ex_lsp_none_ls',
     source_names_separator = ',',
     is_enabled = function(component)
-        return null_ls.is_registered(component:get_query())
+        return none_ls.is_registered(component:get_query())
     end,
 })
 
-function NullLS:get_query()
+function NoneLS:get_query()
     if type(self.options.query) == 'function' then
         return self.options.query()
     else
@@ -57,8 +59,8 @@ function NullLS:get_query()
 end
 
 -- get sources by query, and concatenate their unique names with {source_names_separator}
-function NullLS:update_status()
-    local sources = null_ls.get_source(self:get_query())
+function NoneLS:update_status()
+    local sources = none_ls.get_source(self:get_query())
     log.fmt_debug(
         'For query %s was found sources: %s',
         vim.inspect(self.options.query),
@@ -77,4 +79,4 @@ function NullLS:update_status()
     return table.concat(names, self.options.source_names_separator)
 end
 
-return NullLS
+return NoneLS

tests/components/null_ls_spec.lua tests/components/none_ls_spec.lua

@@ -1,17 +1,17 @@
-local null_ls = require('null-ls')
+local none_ls = require('null-ls')
 local l = require('tests.ex.lualine')
 local t = require('tests.ex.busted') --:ignore_all_tests()
 
 local eq = assert.are.equal
 
-local component_name = 'ex.lsp.null_ls'
+local component_name = 'ex.lsp.none_ls'
 describe(component_name, function()
-    null_ls.setup({
+    none_ls.setup({
         sources = {
-            null_ls.builtins.completion.spell,
-            null_ls.builtins.formatting.stylua,
-            null_ls.builtins.hover.dictionary,
-            null_ls.builtins.diagnostics.clang_check,
+            none_ls.builtins.completion.spell,
+            none_ls.builtins.formatting.stylua,
+            none_ls.builtins.hover.dictionary,
+            none_ls.builtins.diagnostics.clang_check,
         },
     })
     describe('draw method', function()
@@ -38,7 +38,7 @@ describe(component_name, function()
             end)
         end)
         it('should show names only of sources sutisfied to the query', function()
-            local opts = { query = { method = null_ls.methods.HOVER } }
+            local opts = { query = { method = none_ls.methods.HOVER } }
             l.test_matched_component(component_name, opts, function(ctbl)
                 eq('dictionary', ctbl.value)
             end)