mini.nvim/lua/mini/starter.lua at main · xuanduc987/mini.nvim

Repository navigation

History

8000

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

--- *mini.starter* Start screen

--- *MiniStarter*

---

--- ==============================================================================

---

--- Displayed items are fully customizable both in terms of what they do and

--- how they look (with reasonable defaults). Item selection can be done using

--- prefix query with instant visual feedback.

---

--- Key design ideas:

--- - All available actions are defined inside items. Each item should have the

--- following info:

--- - <action> - function or string for |vim.cmd| which is executed when

--- item is chosen. Empty string result in placeholder "inactive" item.

--- - <name> - string which will be displayed and used for choosing.

--- - <section> - string representing to which section item belongs.

--- There are pre-configured whole sections in |MiniStarter.sections|.

---

--- - Configure what items are displayed by supplying an array which can be

--- normalized to an array of items. Read about how supplied items are

--- normalized in |MiniStarter.refresh|.

---

--- - Modify the final look by supplying content hooks: functions which take

--- buffer content (see |MiniStarter.get_content()|) and identifier as input

--- while returning buffer content as output. There are pre-configured

--- content hook generators in |MiniStarter.gen_hook|.

---

--- - Choosing an item can be done in two ways:

--- - Type prefix query to filter item by matching its name (ignoring

--- case). Displayed information is updated after every typed character.

--- For every item its unique prefix is highlighted.

--- - Use Up/Down arrows and hit Enter.

---

--- - Allow multiple simultaneously open Starter buffers.

---

--- What is doesn't do:

--- - It doesn't support fuzzy query for items. And probably will never do.

---

--- # Setup ~

---

--- This module needs a setup with `require('mini.starter').setup({})`

--- (replace `{}` with your `config` table). It will create global Lua table

--- `MiniStarter` which you can use for scripting or manually (with

--- `:lua MiniStarter.*`).

---

--- See |MiniStarter.config| for `config` structure and default values. For

--- some configuration examples (including one similar to 'vim-startify' and

--- 'dashboard-nvim'), see |MiniStarter-example-config|.

---

--- You can override runtime config settings locally to buffer inside

--- `vim.b.ministarter_config` which should have same structure as

--- `MiniStarter.config`. See |mini.nvim-buffer-local-config| for more details.

--- Note: `vim.b.ministarter_config` is copied to Starter buffer from current

--- buffer allowing full customization.

---

--- To stop module from showing non-error feedback, set `config.silent = true`.

---

--- # Highlight groups ~

---

--- * `MiniStarterCurrent` - current item.

--- * `MiniStarterFooter` - footer units.

--- * `MiniStarterHeader` - header units.

--- * `MiniStarterInactive` - inactive item.

--- * `MiniStarterItem` - item name.

--- * `MiniStarterItemBullet` - units from |MiniStarter.gen_hook.adding_bullet|.

--- * `MiniStarterItemPrefix` - unique query for item.

--- * `MiniStarterSection` - section units.

--- * `MiniStarterQuery` - current query in active items.

---

--- To change any highlight group, modify it directly with |:highlight|.

---

--- # Disabling ~

---

--- To disable core functionality, set `vim.g.ministarter_disable` (globally) or

--- `vim.b.ministarter_disable` (for a buffer) to `true`. Considering high number

--- of different scenarios and customization intentions, writing exact rules

--- for disabling module's functionality is left to user. See

--- |mini.nvim-disabling-recipes| for common recipes.

--- Example configurations

---

--- Configuration similar to 'mhinz/vim-startify':

--- >

--- local starter = require('mini.starter')

--- starter.setup({

--- evaluate_single = true,

--- items = {

--- starter.sections.builtin_actions(),

--- starter.sections.recent_files(10, false),

--- starter.sections.recent_files(10, true),

--- -- Use this if you set up 'mini.sessions'

--- starter.sections.sessions(5, true)

--- },

--- content_hooks = {

--- starter.gen_hook.adding_bullet(),

--- starter.gen_hook.indexing('all', { 'Builtin actions' }),

--- starter.gen_hook.padding(3, 2),

--- },

--- })

--- <

--- Configuration similar to 'glepnir/dashboard-nvim':

--- >

--- local starter = require('mini.starter')

--- starter.setup({

--- items = {

--- starter.sections.telescope(),

--- },

--- content_hooks = {

--- starter.gen_hook.adding_bullet(),

--- starter.gen_hook.aligning('center', 'center'),

--- },

--- })

--- <

--- Elaborated configuration showing capabilities of custom items,

--- header/footer, and content hooks:

--- >

--- local my_items = {

--- { name = 'Echo random number', action = 'lua print(math.random())', section = 'Section 1' },

--- function()

--- return {

--- { name = 'Item #1 from function', action = [[echo 'Item #1']], section = 'From function' },

--- { name = 'Placeholder (always inactive) item', action = '', section = 'From function' },

--- function()

--- return {

--- name = 'Item #1 from double function',

--- action = [[echo 'Double function']],

--- section = 'From double function',

--- }

--- end,

--- }

--- end,

--- { name = [[Another item in 'Section 1']], action = 'lua print(math.random() + 10)', section = 'Section 1' },

--- }

---

--- local footer_n_seconds = (function()

--- local timer = vim.loop.new_timer()

--- local n_seconds = 0

--- timer:start(0, 1000, vim.schedule_wrap(function()

--- if vim.bo.filetype ~= 'starter' then

--- timer:stop()

--- return

--- end

--- n_seconds = n_seconds + 1

--- MiniStarter.refresh()

--- end))

---

--- return function()

--- return 'Number of seconds since opening: ' .. n_seconds

--- end

--- end)()

---

--- local hook_top_pad_10 = function(content)

--- -- Pad from top

--- for _ = 1, 10 do

--- -- Insert at start a line with single content unit

--- table.insert(content, 1, { { type = 'empty', string = '' } })

--- end

--- return content

--- end

---

--- local starter = require('mini.starter')

--- starter.setup({

--- items = my_items,

--- footer = footer_n_seconds,

--- content_hooks = { hook_top_pad_10 },

--- })

--- <

---@tag MiniStarter-example-config

--- # Lifecycle of Starter buffer ~

---

--- - Open with |MiniStarter.open()|. It includes creating buffer with

--- appropriate options, mappings, behavior; call to |MiniStarter.refresh()|;

--- issue `MiniStarterOpened` |User| event.

--- - Wait for user to choose an item. This is done using following logic:

--- - Typing any character from `MiniStarter.config.query_updaters` leads

--- to updating query. Read more in |MiniStarter.add_to_query|.

--- - <BS> deletes latest character from query.

--- - <Down>/<Up>, <C-n>/<C-p>, <M-j>/<M-k> move current item.

--- - <CR> executes action of current item.

--- - <C-c> closes Starter buffer.

--- - Evaluate current item when appropriate (after `<CR>` or when there is a

--- single item and `MiniStarter.config.evaluate_single` is `true`). This

--- executes item's `action`.

---@tag MiniStarter-lifecycle

---@alias __starter_buf_id number|nil Buffer identifier of a valid Starter buffer.

--- Default: current buffer.

---@alias __starter_section_fun function Function which returns array of items.

-- Module definition ==========================================================

local MiniStarter = {}

local H = {}

--- Module setup

---

---@param config table|nil Module config table. See |MiniStarter.config|.

---

---@usage `require('mini.starter').setup({})` (replace `{}` with your `config` table)

MiniStarter.setup = function(config)

-- Export module

_G.MiniStarter = MiniStarter

-- Setup config

config = H.setup_config(config)

-- Apply config

H.apply_config(config)

-- Define behavior

H.create_autocommands(config)

-- Create default highlighting

H.create_default_hl()

end

--- Module config

---

--- Default values:

---@eval return MiniDoc.afterlines_to_code(MiniDoc.current.eval_section)

MiniStarter.config = {

-- Whether to open starter buffer on VimEnter. Not opened if Neovim was

-- started with intent to show something else.

autoopen = true,

-- Whether to evaluate action of single active item

evaluate_single = false,

-- Items to be displayed. Should be an array with the following elements:

-- - Item: table with <action>, <name>, and <section> keys.

-- - Function: should return one of these three categories.

-- - Array: elements of these three types (i.e. item, array, function).

-- If `nil` (default), default items will be used (see |mini.starter|).

items = nil,

-- Header to be displayed before items. Converted to single string via

-- `tostring` (use `\n` to display several lines). If function, it is

-- evaluated first. If `nil` (default), polite greeting will be used.

header = nil,

-- Footer to be displayed after items. Converted to single string via

-- `tostring` (use `\n` to display several lines). If function, it is

-- evaluated first. If `nil` (default), default usage help will be shown.

footer = nil,

-- Array of functions to be applied consecutively to initial content.

-- Each function should take and return content for 'Starter' buffer (see

-- |mini.starter| and |MiniStarter.get_content()| for more details).

content_hooks = nil,

-- Characters to update query. Each character will have special buffer

-- mapping overriding your global ones. Be careful to not add `:` as it

-- allows you to go into command mode.

query_updaters = 'abcdefghijklmnopqrstuvwxyz0123456789_-.',

-- Whether to disable showing non-error feedback

silent = false,

}

--minidoc_afterlines_end

-- Module functionality =======================================================

--- Open Starter buffer

---

--- - Create buffer if necessary and move into it.

--- - Set buffer options. Note that settings are done with |noautocmd| to

--- achieve a massive speedup.

--- - Set buffer mappings. Besides basic mappings (described inside "Lifecycle

--- of Starter buffer" of |mini.starter|), map every character from

--- `MiniStarter.config.query_updaters` to add itself to query with

--- |MiniStarter.add_to_query|.

--- - Populate buffer with |MiniStarter.refresh|.

--- - Issue custom `MiniStarterOpened` event to allow acting upon opening

--- Starter buffer. Use it with

--- `autocmd User MiniStarterOpened <your command>`.

---

--- Note: to fully use it in autocommand, it is recommended to utilize

--- |autocmd-nested|. Example:

--- `autocmd TabNewEntered * ++nested lua MiniStarter.open()`

---

---@param buf_id number|nil Identifier of existing valid buffer (see |bufnr()|) to

--- open inside. Default: create a new one.

MiniStarter.open = function(buf_id)

if H.is_disabled() then return end

-- Ensure proper buffer and open it

if H.is_in_vimenter then

-- Use current buffer as it should be empty and not needed. This also

-- solves the issue of redundant buffer when opening a file from Starter.

buf_id = vim.api.nvim_get_current_buf()

end

if buf_id == nil or not vim.api.nvim_buf_is_valid(buf_id) then buf_id = vim.api.nvim_create_buf(false, true) end

-- Create buffer data entry

H.buffer_data[buf_id] = { current_item_id = 1, query = '' }

-- Ensure that local config in opened Starter buffer is the same as current.

-- This allow more advanced usage of buffer local configuration.

local config_local = vim.b.ministarter_config

vim.api.nvim_set_current_buf(buf_id)

vim.b.ministarter_config = config_local

-- Setup buffer behavior

H.make_buffer_autocmd(buf_id)

H.apply_buffer_options(buf_id)

H.apply_buffer_mappings(buf_id)

-- Populate buffer

MiniStarter.refresh()

-- Issue custom event. Delay at startup, as it is executed with `noautocmd`.

local trigger_event = function() vim.api.nvim_exec_autocmds('User', { pattern = 'MiniStarterOpened' }) end

if H.is_in_vimenter then trigger_event = vim.schedule_wrap(trigger_event) end

trigger_event()

-- Ensure not being in VimEnter

H.is_in_vimenter = false

end

--- Refresh Starter buffer

---

--- - Normalize `MiniStarter.config.items`:

--- - Flatten: recursively (in depth-first fashion) parse its elements. If

--- function is found, execute it and continue with parsing its output

--- (this allows deferring item collection up until it is actually

--- needed). If proper item is found (table with fields `action`,

--- `name`, `section`), add it to output.

--- - Sort: order first by section and then by item id (both in order of

--- appearance).

--- - Normalize `MiniStarter.config.header` and `MiniStarter.config.footer` to

--- be multiple lines by splitting at `\n`. If function - evaluate it first.

--- - Make initial buffer content (see |MiniStarter.get_content()| for a

--- description of what a buffer content is). It consist from content lines

--- with single content unit:

--- - First lines contain strings of normalized header.

--- - Body is for normalized items. Section names have own lines preceded

--- by empty line.

--- - Last lines contain separate strings of normalized footer.

--- - Sequentially apply hooks from `MiniStarter.config.content_hooks` to

--- content. All hooks are applied with `(content, buf_id)` signature. Output

--- of one hook serves as first argument to the next.

--- - Gather final items from content with |MiniStarter.content_to_items|.

--- - Convert content to buffer lines with |MiniStarter.content_to_lines| and

--- add them to buffer.

--- - Add highlighting of content units.

--- - Position cursor.

--- - Make current query. This results into some items being marked as

--- "inactive" and updating highlighting of current query on "active" items.

---

--- Note: this function is executed on every |VimResized| to allow more

--- responsive behavior.

---

---@param buf_id __starter_buf_id

MiniStarter.refresh = function(buf_id)

buf_id = buf_id or vim.api.nvim_get_current_buf()

if not H.validate_starter_buf_id(buf_id, 'refresh()') then return end

local data = H.buffer_data[buf_id]

local config = H.get_config()

-- Normalize certain config values

data.header = H.normalize_header_footer(config.header or H.default_header)

local items = H.normalize_items(config.items or H.default_items)

data.footer = H.normalize_header_footer(config.footer or H.default_footer)

-- Evaluate content

local content = H.make_initial_content(data.header, items, data.footer)

local hooks = config.content_hooks or H.default_content_hooks

for _, f in ipairs(hooks) do

content = f(content, buf_id)

end

data.content = content

-- Set items. Possibly reset current item id if items have changed.

local old_items = data.items

data.items = MiniStarter.content_to_items(content)

if not vim.deep_equal(data.items, old_items) then data.current_item_id = 1 end

-- Add content

vim.api.nvim_buf_set_option(buf_id, 'modifiable', true)

vim.api.nvim_buf_set_lines(buf_id, 0, -1, false, MiniStarter.content_to_lines(content))

vim.api.nvim_buf_set_option(buf_id, 'modifiable', false)

-- Add highlighting

H.content_highlight(buf_id)

H.items_highlight(buf_id)

-- -- Always position cursor on current item

H.position_cursor_on_current_item(buf_id)

H.add_hl_current_item(buf_id)

-- Apply current query (clear command line afterwards)

H.make_query(buf_id)

end

--- Close Starter buffer

---

---@param buf_id __starter_buf_id

MiniStarter.close = function(buf_id)

buf_id = buf_id or vim.api.nvim_get_current_buf()

if not H.validate_starter_buf_id(buf_id, 'close()') then return end

-- Use `pcall` to allow calling for already non-existing buffer

pcall(vim.api.nvim_buf_delete, buf_id, {})

end

-- Sections -------------------------------------------------------------------

--- Table of pre-configured sections

MiniStarter.sections = {}

--- Section with builtin actions

---

---@return table Array of items.

MiniStarter.sections.builtin_actions = function()

return {

{ name = 'Edit new buffer', action = 'enew', section = 'Builtin actions' },

{ name = 'Quit Neovim', action = 'qall', section = 'Builtin actions' },

}

end

--- Section with |MiniSessions| sessions

---

--- Sessions are taken from |MiniSessions.detected|. Notes:

--- - If it shows "'mini.sessions' is not set up", it means that you didn't

--- call `require('mini.sessions').setup()`.

--- - If it shows "There are no detected sessions in 'mini.sessions'", it means

--- that there are no sessions at the current sessions directory. Either

--- create session or supply different directory where session files are

--- stored (see |MiniSessions.setup|).

--- - Local session (if detected) is always displayed first.

---

---@param n number|nil Number of returned items. Default: 5.

---@param recent boolean|nil Whether to use recent sessions (instead of

--- alphabetically by name). Default: true.

---

---@return __starter_section_fun

MiniStarter.sections.sessions = function(n, recent)

n = n or 5

if recent == nil then recent = true end

return function()

if _G.MiniSessions == nil then

return { { name = [['mini.sessions' is not set up]], action = '', section = 'Sessions' } }

end

local items = {}

for session_name, session in pairs(_G.MiniSessions.detected) do

table.insert(items, {

_session = session,

name = ('%s%s'):format(session_name, session.type == 'local' and ' (local)' or ''),

action = ([[lua _G.MiniSessions.read('%s')]]):format(session_name),

section = 'Sessions',

})

end

if vim.tbl_count(items) == 0 then

return { { name = [[There are no detected sessions in 'mini.sessions']], action = '', section = 'Sessions' } }

end

local sort_fun

if recent then

sort_fun = function(a, b)

local a_time = a._session.type == 'local' and math.huge or a._session.modify_time

local b_time = b._session.type == 'local' and math.huge or b._session.modify_time

return a_time > b_time

end

else

sort_fun = function(a, b)

local a_name = a._session.type == 'local' and '' or a.name

local b_name = b._session.type == 'local' and '' or b.name

return a_name < b_name

end

table.sort(items, sort_fun)

-- Take only first `n` elements and remove helper fields

return vim.tbl_map(function(x)

x._session = nil

return x

end, vim.list_slice(items, 1, n))

end

--- Section with most recently used files

---

--- Files are taken from |vim.v.oldfiles|.

---

---@param n number|nil Number of returned items. Default: 5.

---@param current_dir boolean|nil Whether to return files only from current working

--- directory and its subdirectories. Default: `false`.

---@param show_path boolean|function|nil Whether to append file name with its path.

--- If callable, will be called with full path and should return string to be

--- directly appended to file name. Default: `true`.

---

---@return __starter_section_fun

MiniStarter.sections.recent_files = function(n, current_dir, show_path)

n = n or 5

if current_dir == nil then current_dir = false end

if show_path == nil then show_path = true end

if show_path == false then show_path = function() return '' end end

if show_path == true then

show_path = function(path) return string.format(' (%s)', vim.fn.fnamemodify(path, ':~:.')) end

end

if not vim.is_callable(show_path) then H.error('`show_path` should be boolean or callable.') end

return function()

local section = string.format('Recent files%s', current_dir and ' (current directory)' or '')

-- Use only actual readable files

local files = vim.tbl_filter(function(f) return vim.fn.filereadable(f) == 1 end, vim.v.oldfiles or {})

if #files == 0 then

return { { name = 'There are no recent files (`v:oldfiles` is empty)', action = '', section = section } }

end

-- Possibly filter files from current directory

if current_dir then

local sep = vim.loop.os_uname().sysname == 'Windows_NT' and [[%\]] or '%/'

local cwd_pattern = '^' .. vim.pesc(vim.fn.getcwd()) .. sep

-- Use only files from current directory and its subdirectories

files = vim.tbl_filter(function(f) return f:find(cwd_pattern) ~= nil end, files)

end

if #files == 0 then

return { { name = 'There are no recent files in current directory', action = '', section = section } }

end

-- Create items

local items = {}

for _, f in ipairs(vim.list_slice(files, 1, n)) do

local name = vim.fn.fnamemodify(f, ':t') .. show_path(f)

table.insert(items, { action = 'edit ' .. f, name = name, section = section })

end

return items

end

-- stylua: ignore

--- Section with 'mini.pick' pickers

---

--- Notes:

--- - All actions require |mini.pick| module of 'mini.nvim'.

--- - "Command history", "Explorer", and "Visited paths" items

--- require |mini.extra| module of 'mini.nvim'.

--- - "Visited paths" items requires |mini.visits| module of 'mini.nvim'.

---

---@return __starter_section_fun

MiniStarter.sections.pick = function()

return function()

return {

{ action = 'Pick history scope=":"', name = 'Command history', section = 'Pick' },

{ action = 'Pick explorer', name = 'Explorer', section = 'Pick' },

{ action = 'Pick files', name = 'Files', section = 'Pick' },

{ action = 'Pick grep_live', name = 'Grep live', section = 'Pick' },

{ action = 'Pick help', name = 'Help tags', section = 'Pick' },

{ action = 'Pick visit_paths', name = 'Visited paths', section = 'Pick' },

}

end

-- stylua: ignore

--- Section with basic Telescope pickers relevant to start screen

---

--- Notes:

--- - All actions require 'nvim-telescope/telescope.nvim' plugin.

--- - "Browser" item requires 'nvim-telescope/telescope-file-browser.nvim'.

---

---@return __starter_section_fun

MiniStarter.sections.telescope = function()

return function()

return {

{ action = 'Telescope file_browser', name = 'Browser', section = 'Telescope' },

{ action = 'Telescope command_history', name = 'Command history', section = 'Telescope' },

{ action = 'Telescope find_files', name = 'Files', section = 'Telescope' },

{ action = 'Telescope help_tags', name = 'Help tags', section = 'Telescope' },

{ action = 'Telescope live_grep', name = 'Live grep', section = 'Telescope' },

{ action = 'Telescope oldfiles', name = 'Old files', section = 'Telescope' },

}

end

-- Content hooks --------------------------------------------------------------

--- Table with pre-configured content hook generators

---

--- Each element is a function which returns content hook. So to use them

--- inside |MiniStarter.setup|, call them.

MiniStarter.gen_hook = {}

--- Hook generator for padding

---

--- Output is a content hook which adds constant padding from left and top.

--- This allows tweaking the screen position of buffer content.

---

---@param left number|nil Number of empty spaces to add to start of each content

--- line. Default: 0.

---@param top number|nil Number of empty lines to add to start of content.

--- Default: 0.

---

---@return function Content hook.

MiniStarter.gen_hook.padding = function(left, top)

left = math.max(left or 0, 0)

top = math.max(top or 0, 0)

return function(content, _)

-- Add left padding

local left_pad = string.rep(' ', left)

for _, line in ipairs(content) do

local is_empty_line = #line == 0 or (#line == 1 and line[1].string == '')

if not is_empty_line then table.insert(line, 1, H.content_unit(left_pad, 'empty', nil)) end

end

-- Add top padding

local top_lines = {}

for _ = 1, top do

table.insert(top_lines, { H.content_unit('', 'empty', nil) })

end

content = vim.list_extend(top_lines, content)

return content

end

--- Hook generator for adding bullet to items

---

--- Output is a content hook which adds supplied string to be displayed to the

--- left of item.

---

---@param bullet string|nil String to be placed to the left of item name.

--- Default: "░ ".

---@param place_cursor boolean|nil Whether to place cursor on the first character

--- of bullet when corresponding item becomes current. Default: true.

---

---@return function Content hook.

MiniStarter.gen_hook.adding_bullet = function(bullet, place_cursor)

bullet = bullet or '░ '

if place_cursor == nil then place_cursor = true end

return function(content)

local coords = MiniStarter.content_coords(content, 'item')

-- Go backwards to avoid conflict when inserting units

for i = #coords, 1, -1 do

local l_num, u_num = coords[i].line, coords[i].unit

local bullet_unit = {

string = bullet,

type = 'item_bullet',

hl = 'MiniStarterItemBullet',

-- Use `_item` instead of `item` because it is better to be 'private'

_item = content[l_num][u_num].item,

_place_cursor = place_cursor,

}

table.insert(content[l_num], u_num, bullet_unit)

end

return content

end

--- Hook generator for indexing items

---

--- Output is a content hook which adds unique index to the start of item's

--- name. It results into shortening queries required to choose an item (at

--- expense of clarity).

---

---@param grouping string|nil One of "all" (number indexing across all sections) or

--- "section" (letter-number indexing within each section). Default: "all".

---@param exclude_sections table|nil Array of section names (values of `section`

--- element of item) for which index won't be added. Default: `{}`.

---

---@return function Content hook.

MiniStarter.gen_hook.indexing = function(grouping, exclude_sections)

grouping = grouping or 'all'

exclude_sections = exclude_sections or {}

local per_section = grouping == 'section'

return function(content, _)

local cur_section, n_section, n_item = nil, 0, 0

local coords = MiniStarter.content_coords(content, 'item')

for _, c in ipairs(coords) do

local unit = content[c.line][c.unit]

local item = unit.item

if not vim.tbl_contains(exclude_sections, item.section) then

n_item = n_item + 1

if cur_section ~= item.section then

cur_section = item.section

-- Cycle through lower case letters

n_section = math.fmod(n_section, 26) + 1

n_item = per_section and 1 or n_item

end

local section_index = per_section and string.char(96 + n_section) or ''

unit.string = ('%s%s. %s'):format(section_index, n_item, unit.string)

end

return content

end

--- Hook generator for aligning content

---

--- Output is a content hook which independently aligns content horizontally

--- and vertically. Window width and height are taken from first window in current

--- tabpage displaying the starter buffer.

---

--- Basically, this computes left and top pads for |MiniStarter.gen_hook.padding|

--- such that output lines would appear aligned in certain way.

---

---@param horizontal string|nil One of "left", "center", "right". Default: "left".

---@param vertical string|nil One of "top", "center", "bottom". Default: "top".

---

---@return function Content hook.

MiniStarter.gen_hook.aligning = function(horizontal, vertical)

horizontal = horizontal or 'left'

vertical = vertical or 'top'

local horiz_coef = ({ left = 0, center = 0.5, right = 1.0 })[horizontal]

local vert_coef = ({ top = 0, center = 0.5, bottom = 1.0 })[vertical]

return function(content, buf_id)

local win_id = vim.fn.bufwinid(buf_id)

if win_id < 0 then return end

local line_strings = MiniStarter.content_to_lines(content)

-- Align horizontally

-- Don't use `string.len()` to account for multibyte characters

local lines_width = vim.tbl_map(function(l) return vim.fn.strdisplaywidth(l) end, line_strings)

local min_right_space = vim.api.nvim_win_get_width(win_id) - math.max(unpack(lines_width))

local left_pad = math.max(math.floor(horiz_coef * min_right_space), 0)

-- Align vertically

local bottom_space = vim.api.nvim_win_get_height(win_id) - #line_strings

local top_pad = math.max(math.floor(vert_coef * bottom_space), 0)

return MiniStarter.gen_hook.padding(left_pad, top_pad)(content)

end

-- Work with content ----------------------------------------------------------

--- Get content of Starter buffer

---

--- Generally, buffer content is a table in the form of "2d array" (or rather

--- "2d list" because number of elements can differ):

--- - Each element represents content line: an array with content units to be

--- displayed in one buffer line.

--- - Each content unit is a table with at least the following elements:

--- - "type" - string with type of content. Something like "item",

--- "section", "header", "footer", "empty", etc.

--- - "string" - which string should be displayed. May be an empty string.

--- - "hl" - which highlighting should be applied to content string. May be

--- `nil` for no highlighting.

---

--- See |MiniStarter.content_to_lines| for converting content to buffer lines

--- and |MiniStarter.content_to_items| - to list of parsed items.

---

--- Notes:

--- - Content units with type "item" also have `item` element with all

--- information about an item it represents. Those elements are used directly

--- to create an array of items used for query.

---

---@param buf_id __starter_buf_id

MiniStarter.get_content = function(buf_id)

buf_id = buf_id or vim.api.nvim_get_current_buf()

if not H.validate_starter_buf_id(buf_id, 'get_content()', 'error') then return end

return H.buffer_data[buf_id].content

end

--- Helper to iterate through content

---

--- Basically, this traverses content "2d array" (in depth-first fashion; top

--- to bottom, left to right) and returns "coordinates" of units for which

--- `predicate` is true-ish.

---

---@param content table|nil Content "2d array". Default: content of current buffer.

---@param predicate function|string|nil Predictate to filter units. If it is:

--- - Function, then it is evaluated with unit as input.

--- - String, then it checks unit to have this type (allows easy getting of

--- units with some type).

--- - `nil`, all units are kept.

---

---@return table Array of resulting units' coordinates. Each coordinate is a

--- table with <line> and <unit> keys. To retrieve actual unit from coordinate

--- `c`, use `content[c.line][c.unit]`.

MiniStarter.content_coords = function(content, predicate)

content = content or MiniStarter.get_content()

if predicate == nil then predicate = function(_) return true end end

if type(predicate) == 'string' then

local pred_type = predicate

predicate = function(unit) return unit.type == pred_type end

end

local res = {}

for l_num, line in ipairs(content) do

for u_num, unit in ipairs(line) do

if predicate(unit) then table.insert(res, { line = l_num, unit = u_num }) end

end

return res

end

-- stylua: ignore start

--- Convert content to buffer lines

---

--- One buffer line is made by concatenating `string` element of units within

--- same content line.

---

---@param content table|nil Content "2d array". Default: content of current buffer.

---

---@return table Array of strings for each buffer line.

MiniStarter.content_to_lines = function(content)

return vim.tbl_map(

function(content_line)

return table.concat(

-- Ensure that each content line is indeed a single buffer line

vim.tbl_map(function(x) return x.string:gsub('\n', ' ') end, content_line), ''

)

end,

content or MiniStarter.get_content()

)

end

-- stylua: ignore end

--- Convert content to items

---

--- Parse content (in depth-first fashion) and retrieve each item from `item`

--- element of content units with type "item". This also:

--- - Computes some helper information about how item will be actually

--- displayed (after |MiniStarter.content_to_lines|) and minimum number of

--- prefix characters needed for a particular item to be queried single.

--- - Modifies item's `name` element taking it from corresponding `string`

--- element of content unit. This allows modifying item's `name` at the stage

--- of content hooks (like, for example, in |MiniStarter.gen_hook.indexing|).

---

---@param content table|nil Content "2d array". Default: content of current buffer.

---

---@return table Array of items.

MiniStarter.content_to_items = function(content)

content = content or MiniStarter.get_content()

-- NOTE: this havily utilizes 'modify by reference' nature of Lua tables

local items = {}

for l_num, line in ipairs(content) do

-- Track 0-based starting column of current unit (using byte length)

local start_col = 0

for _, unit in ipairs(line) do

-- Cursor position is (1, 0)-based

local cursorpos = { l_num, start_col }

if unit.type == 'item' then

local item = unit.item

-- Take item's name from content string

item.name = unit.string:gsub('\n', ' ')

item._line = l_num - 1

item._start_col = start_col

item._end_col = start_col + unit.string:len()

-- Don't overwrite possible cursor position from item's bullet

item._cursorpos = item._cursorpos or cursorpos

table.insert(items, item)

end

-- Prefer placing cursor at start of item's bullet

if unit.type == 'item_bullet' and unit._place_cursor then

-- Item bullet uses 'private' `_item` element instead of `item`

unit._item._cursorpos = cursorpos

end

start_col = start_col + unit.string:len()

end

-- Compute length of unique prefix for every item's name (ignoring case)

local strings = vim.tbl_map(function(x) return x.name:lower() end, items)

local nprefix = H.unique_nprefix(strings)

for i, n in ipairs(nprefix) do

items[i]._nprefix = n

end

return items

end

-- Other exported functions ---------------------------------------------------

--- Evaluate current item

---

--- Note that it resets current query before evaluation, as it is rarely needed

--- any more.

---

---@param buf_id __starter_buf_id

MiniStarter.eval_current_item = function(buf_id)

buf_id = buf_id or vim.api.nvim_get_current_buf()

if not H.validate_starter_buf_id(buf_id, 'eval_current_item()') then return end

-- Reset query before evaluation without query echo (avoids hit-enter-prompt)

H.make_query(vim.api.nvim_get_current_buf(), '', false)

local data = H.buffer_data[buf_id]

H.eval_fun_or_string(data.items[data.current_item_id].action, true)

end

--- Update current item

---

--- This makes next (with respect to `direction`) active item to be current.

---

---@param direction string One of "next" or "previous".

---@param buf_id __starter_buf_id

MiniStarter.update_current_item = function(direction, buf_id)

buf_id = buf_id or vim.api.nvim_get_current_buf()

if not H.validate_starter_buf_id(buf_id, 'update_current_item()') then return end

local data = H.buffer_data[buf_id]

-- Advance current item

local prev_current = data.current_item_id

data.current_item_id = H.next_active_item_id(buf_id, data.current_item_id, direction)

if data.current_item_id == prev_current then return end

-- Update cursor position

H.position_cursor_on_current_item(buf_id)

-- Highlight current item

vim.api.nvim_buf_clear_namespace(buf_id, H.ns.current_item, 0, -1)

H.add_hl_current_item(buf_id)

end

--- Add character to current query

---

--- - Update current query by appending `char` to its end (only if it results

--- into at least one active item) or delete latest character if `char` is `nil`.

--- - Recompute status of items: "active" if its name starts with new query,

--- "inactive" otherwise.

--- - Update highlighting: whole strings for "inactive" items, current query

--- for "active" items.

---

---@param char string|nil Single character to be added to query. If `nil`, deletes

--- latest character from query.

---@param buf_id __starter_buf_id

MiniStarter.add_to_query = function(char, buf_id)

buf_id = buf_id or vim.api.nvim_get_current_buf()

if not H.validate_starter_buf_id(buf_id, 'add_to_query()') then return end

local data = H.buffer_data[buf_id]

local new_query

if char == nil then

new_query = data.query:sub(0, data.query:len() - 1)

else

new_query = ('%s%s'):format(data.query, char)

end

H.make_query(buf_id, new_query)

end

--- Set current query

---

---@param query string|nil Query to be set (only if it results into at least one

--- active item). Default: `nil` for setting query to empty string, which

--- essentially resets query.

---@param buf_id __starter_buf_id

MiniStarter.set_query = function(query, buf_id)

query = query or ''

if type(query) ~= 'string' then error('`query` should be either `nil` or string.') end

buf_id = buf_id or vim.api.nvim_get_current_buf()

if not H.validate_starter_buf_id(buf_id, 'add_to_query()') then return end

H.make_query(buf_id, query)

end

-- Helper data ================================================================

-- Module default config

H.default_config = vim.deepcopy(MiniStarter.config)

-- Default config values

H.default_items = {

function()

if _G.MiniSessions == nil then return {} end

return MiniStarter.sections.sessions(5, true)()

end,

MiniStarter.sections.recent_files(5, false, false),

MiniStarter.sections.builtin_actions(),

}

H.default_header = function()

local hour = tonumber(vim.fn.strftime('%H'))

-- [04:00, 12:00) - morning, [12:00, 20:00) - day, [20:00, 04:00) - evening

local part_id = math.floor((hour + 4) / 8) + 1

local day_part = ({ 'evening', 'morning', 'afternoon', 'evening' })[part_id]

local username = vim.loop.os_get_passwd()['username'] or 'USERNAME'

return ('Good %s, %s'):format(day_part, username)

end

H.default_footer = [[

Type query to filter items

<BS> deletes latest character from query

<Esc> resets current query

View remainder of file in raw view

FilesExpand file tree

starter.lua

Latest commit

History

starter.lua

File metadata and controls