Skip to content

Commit be9944f

Browse files
committed
Improve deprecation checks
- Move `layout_defaults` handling to `deprecated.lua` - Check for "layout keys" outside of `layout_config` on `setup`
1 parent eb62a0f commit be9944f

File tree

2 files changed

+19
-10
lines changed

2 files changed

+19
-10
lines changed

lua/telescope/config.lua

+5-9
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
local strings = require "plenary.strings"
2-
local log = require "telescope.log"
2+
local deprecated = require "telescope.deprecated"
33
local sorters = require "telescope.sorters"
44
local if_nil = vim.F.if_nil
55

@@ -308,14 +308,10 @@ function config.set_defaults(user_defaults, tele_defaults)
308308
user_defaults = if_nil(user_defaults, {})
309309
tele_defaults = if_nil(tele_defaults, telescope_defaults)
310310

311-
if user_defaults.layout_defaults then
312-
if user_defaults.layout_config == nil then
313-
log.info "Using 'layout_defaults' in setup() is deprecated. Use 'layout_config' instead."
314-
user_defaults.layout_config = user_defaults.layout_defaults
315-
else
316-
error "Using 'layout_defaults' in setup() is deprecated. Remove this key and use 'layout_config' instead."
317-
end
318-
end
311+
-- Check if using layout keywords outside of `layout_config`
312+
deprecated.picker_window_options(user_defaults)
313+
-- Check if using `layout_defaults` instead of `layout_config`
314+
user_defaults = deprecated.layout_configuration(user_defaults)
319315

320316
local function get(name, default_val)
321317
if name == "layout_config" then

lua/telescope/deprecated.lua

+14-1
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
1+
local log = require "telescope.log"
12

23
local deprecated = {}
34

45
deprecated.picker_window_options = function(opts)
56
local messages = {}
67

7-
-- Deprecated: PR:922, 2021/05/17
8+
-- Deprecated: PR:922, 2021/06/25
89
-- Can be removed in a few weeks.
910

1011
if opts.width then
@@ -43,4 +44,16 @@ deprecated.picker_window_options = function(opts)
4344
end
4445
end
4546

47+
deprecated.layout_configuration = function(user_defaults)
48+
if user_defaults.layout_defaults then
49+
if user_defaults.layout_config == nil then
50+
log.warn "Using 'layout_defaults' in setup() is deprecated. Use 'layout_config' instead."
51+
user_defaults.layout_config = user_defaults.layout_defaults
52+
else
53+
error "Using 'layout_defaults' in setup() is deprecated. Remove this key and use 'layout_config' instead."
54+
end
55+
end
56+
return user_defaults
57+
end
58+
4659
return deprecated

0 commit comments

Comments
 (0)