mini.nvim/lua/mini/comment.lua at main · David-Kunz/mini.nvim

Repository navigation

History

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

--- *mini.comment* Comment lines

--- *MiniComment*

---

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

---

--- Features:

--- - Commenting in Normal mode respects |count| and is dot-repeatable.

---

--- - Comment structure by default is inferred from 'commentstring': either

--- from current buffer or from locally active tree-sitter language (only on

--- Neovim>=0.9). It can be customized via `options.custom_commentstring`

--- (see |MiniComment.config| for details).

---

--- - Allows custom hooks before and after successful commenting.

---

--- - Configurable options for some nuanced behavior.

---

--- What it doesn't do:

--- - Block and sub-line comments. This will only support per-line commenting.

---

--- - Handle indentation with mixed tab and space.

---

--- - Preserve trailing whitespace in empty lines.

---

--- Notes:

--- - To use tree-sitter aware commenting, global value of 'commentstring'

--- should be `''` (empty string). This is the default value in Neovim>=0.9,

--- so make sure to not set it manually.

---

--- # Setup~

---

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

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

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

--- `:lua MiniComment.*`).

---

--- See |MiniComment.config| for `config` structure and default values.

---

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

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

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

---

--- # Disabling~

---

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

--- `vim.b.minicomment_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.

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

local MiniComment = {}

local H = {}

--- Module setup

---

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

---

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

MiniComment.setup = function(config)

-- Export module

_G.MiniComment = MiniComment

-- Setup config

config = H.setup_config(config)

-- Apply config

H.apply_config(config)

end

--- Module config

---

--- Default values:

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

---@text # Options ~

---

--- ## Custom commentstring ~

---

--- `options.custom_commentstring` can be a function customizing 'commentstring'

--- option used to infer comment structure. It is called once before every

--- commenting action with the following arguments:

--- - `ref_position` - position at which to compute 'commentstring' (might be

--- relevant for a text with locally different commenting rules). Its structure

--- is the same as `opts.ref_position` in |MiniComment.toggle_lines()|.

---

--- Its output should be a valid 'commentstring' (string containing `%s`).

---

--- If not set or the output is `nil`, |MiniComment.get_commentstring()| is used.

---

--- For example, this option can be used to always use buffer 'commentstring'

--- even in case of present active tree-sitter parser: >

---

--- require('mini.comment').setup({

--- options = {

--- custom_commentstring = function() return vim.bo.commentstring end,

--- }

--- })

MiniComment.config = {

-- Options which control module behavior

options = {

-- Function to compute custom 'commentstring' (optional)

custom_commentstring = nil,

-- Whether to ignore blank lines

ignore_blank_line = false,

-- Whether to recognize as comment only lines without indent

start_of_line = false,

-- Whether to ensure single space pad for comment parts

pad_comment_parts = true,

-- Module mappings. Use `''` (empty string) to disable one.

mappings = {

-- Toggle comment (like `gcip` - comment inner paragraph) for both

-- Normal and Visual modes

comment = 'gc',

-- Toggle comment on current line

comment_line = 'gcc',

-- Define 'comment' textobject (like `dgc` - delete whole comment block)

textobject = 'gc',

-- Hook functions to be executed at certain stage of commenting

hooks = {

-- Before successful commenting. Does nothing by default.

pre = function() end,

-- After successful commenting. Does nothing by default.

post = function() end,

}

--minidoc_afterlines_end

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

--- Main function to be mapped

---

--- It is meant to be used in expression mappings (see |map-<expr>|) to enable

--- dot-repeatability and commenting on range. There is no need to do this

--- manually, everything is done inside |MiniComment.setup()|.

---

--- It has a somewhat unintuitive logic (because of how expression mapping with

--- dot-repeatability works): it should be called without arguments inside

--- expression mapping and with argument when action should be performed.

---

---@param mode string|nil Optional string with 'operatorfunc' mode (see |g@|).

---

---@return string|nil 'g@' if called without argument, '' otherwise (but after

--- performing action).

MiniComment.operator = function(mode)

if H.is_disabled() then return '' end

-- If used without arguments inside expression mapping:

-- - Set itself as `operatorfunc` to be called later to perform action.

-- - Return 'g@' which will then be executed resulting into waiting for a

-- motion or text object. This textobject will then be recorded using `'[`

-- and `']` marks. After that, `operatorfunc` is called with `mode` equal

-- to one of "line", "char", or "block".

-- NOTE: setting `operatorfunc` inside this function enables usage of 'count'

-- like `10gc_` toggles comments of 10 lines below (starting with current).

if mode == nil then

vim.o.operatorfunc = 'v:lua.MiniComment.operator'

return 'g@'

end

-- If called with non-nil `mode`, get target region and perform comment

-- toggling over it.

local mark_left, mark_right = '[', ']'

if mode == 'visual' then

mark_left, mark_right = '<', '>'

end

local line_left, col_left = unpack(vim.api.nvim_buf_get_mark(0, mark_left))

local line_right, col_right = unpack(vim.api.nvim_buf_get_mark(0, mark_right))

-- Do nothing if "left" mark is not on the left (earlier in text) of "right"

-- mark (indicating that there is nothing to do, like in comment textobject).

if (line_left > line_right) or (line_left == line_right and col_left > col_right) then return end

-- Use `vim.cmd()` wrapper to allow usage of `lockmarks` command, because raw

-- execution deletes marks in region (due to `vim.api.nvim_buf_set_lines()`).

vim.cmd(string.format(

-- NOTE: use cursor position as reference for possibly computing local

-- tree-sitter-based 'commentstring'. Compute them inside command for

-- a proper dot-repeat. For Visual mode and sometimes Normal mode it uses

-- left position.

[[lockmarks lua MiniComment.toggle_lines(%d, %d, { ref_position = { vim.fn.line('.'), vim.fn.col('.') } })]],

line_left,

line_right

))

return ''

end

--- Toggle comments between two line numbers

---

--- It uncomments if lines are comment (every line is a comment) and comments

--- otherwise. It respects indentation and doesn't insert trailing

--- whitespace. Toggle commenting not in visual mode is also dot-repeatable

--- and respects |count|.

---

--- Before successful commenting it executes `config.hooks.pre`.

--- After successful commenting it executes `config.hooks.post`.

--- If hook returns `false`, any further action is terminated.

---

--- # Notes ~

---

--- - Comment structure is inferred from buffer's 'commentstring' option or

--- local language of tree-sitter parser (if active; only on Neovim>=0.9).

---

--- - Currently call to this function will remove marks inside written range.

--- Use |lockmarks| to preserve marks.

---

---@param line_start number Start line number (inclusive from 1 to number of lines).

---@param line_end number End line number (inclusive from 1 to number of lines).

---@param opts table|nil Options. Possible fields:

--- - <ref_position> `(table)` - A two-value array with `{ row, col }` (both

--- starting at 1) of reference position at which 'commentstring' value

--- will be computed. Default: `{ line_start, 1 }`.

MiniComment.toggle_lines = function(line_start, line_end, opts)

if H.is_disabled() then return end

opts = opts or {}

local ref_position = opts.ref_position or { line_start, 1 }

local n_lines = vim.api.nvim_buf_line_count(0)

if not (1 <= line_start and line_start <= n_lines and 1 <= line_end and line_end <= n_lines) then

error(('(mini.comment) `line_start` and `line_end` should be within range [1; %s].'):format(n_lines))

end

if not (line_start <= line_end) then

error('(mini.comment) `line_start` should be less than or equal to `line_end`.')

end

local config = H.get_config()

if config.hooks.pre() == false then return end

local comment_parts = H.make_comment_parts(ref_position)

local lines = vim.api.nvim_buf_get_lines(0, line_start - 1, line_end, false)

local indent, is_comment = H.get_lines_info(lines, comment_parts, H.get_config().options)

local f

if is_comment then

f = H.make_uncomment_function(comment_parts)

else

f = H.make_comment_function(comment_parts, indent)

end

for n, l in pairs(lines) do

lines[n] = f(l)

end

-- NOTE: This function call removes marks inside written range. To write

-- lines in a way that saves marks, use one of:

-- - `lockmarks` command when doing mapping (current approach).

-- - `vim.fn.setline(line_start, lines)`, but this is **considerably**

-- slower: on 10000 lines 280ms compared to 40ms currently.

vim.api.nvim_buf_set_lines(0, line_start - 1, line_end, false, lines)

if config.hooks.post() == false then return end

end

--- Select comment textobject

---

--- This selects all commented lines adjacent to cursor line (if it itself is

--- commented). Designed to be used with operator mode mappings (see |mapmode-o|).

---

--- Before successful selection it executes `config.hooks.pre`.

--- After successful selection it executes `config.hooks.post`.

--- If hook returns `false`, any further action is terminated.

MiniComment.textobject = function()

if H.is_disabled() then return end

local config = H.get_config()

if config.hooks.pre() == false then return end

local comment_parts = H.make_comment_parts({ vim.fn.line('.'), vim.fn.col('.') })

local comment_check = H.make_comment_check(comment_parts)

local line_cur = vim.api.nvim_win_get_cursor(0)[1]

if comment_check(vim.fn.getline(line_cur)) then

local line_start = line_cur

while (line_start >= 2) and comment_check(vim.fn.getline(line_start - 1)) do

line_start = line_start - 1

end

local line_end = line_cur

local n_lines = vim.api.nvim_buf_line_count(0)

while (line_end <= n_lines - 1) and comment_check(vim.fn.getline(line_end + 1)) do

line_end = line_end + 1

end

-- This visual selection doesn't seem to change `'<` and `'>` marks when

-- executed as `onoremap` mapping

vim.cmd(string.format('normal! %dGV%dG', line_start, line_end))

end

if config.hooks.post() == false then return end

end

--- Get 'commentstring'

---

--- This function represents default approach of computing relevant

--- 'commentstring' option in current buffer. Used to infer comment structure.

---

--- It has the following logic:

--- - (Only on Neovim>=0.9) If there is an active tree-sitter parser, try to get

--- 'commentstring' from the local language at `ref_position`.

---

--- - If first step is not successful, use buffer's 'commentstring' directly.

---

---@param ref_position table Reference position inside current buffer at which

--- to compute 'commentstring'. Same structure as `opts.ref_position`

--- in |MiniComment.toggle_lines()|.

---

---@return string Relevant value of 'commentstring'.

MiniComment.get_commentstring = function(ref_position)

local buf_cs = vim.api.nvim_buf_get_option(0, 'commentstring')

-- Neovim<0.9 can only have buffer 'commentstring'

if vim.fn.has('nvim-0.9') == 0 then return buf_cs end

local has_ts_parser, ts_parser = pcall(vim.treesitter.get_parser)

if not has_ts_parser then return buf_cs end

-- Try to get 'commentstring' associated with local tree-sitter language.

-- This is useful for injected languages (like markdown with code blocks).

-- Sources:

-- - https://github.com/neovim/neovim/pull/22634#issue-1620078948

-- - https://github.com/neovim/neovim/pull/22643

local row, col = ref_position[1] - 1, ref_position[2] - 1

local ref_range = { row, col, row, col + 1 }

-- - Get 'commentstring' from the deepest LanguageTree which both contains

-- reference range and has valid 'commentstring' (meaning it has at least

-- one associated 'filetype' with valid 'commentstring').

-- In simple cases using `parser:language_for_range()` would be enough, but

-- it fails for languages without valid 'commentstring' (like 'comment').

local ts_cs, res_level = nil, 0

local traverse

traverse = function(lang_tree, level)

if not lang_tree:contains(ref_range) then return end

local lang = lang_tree:lang()

local filetypes = vim.treesitter.language.get_filetypes(lang)

for _, ft in ipairs(filetypes) do

-- Using `vim.filetype.get_option()` for performance as it has caching

local cur_cs = vim.filetype.get_option(ft, 'commentstring')

if type(cur_cs) == 'string' and cur_cs ~= '' and level > res_level then ts_cs = cur_cs end

end

for _, child_lang_tree in pairs(lang_tree:children()) do

traverse(child_lang_tree, level + 1)

end

traverse(ts_parser, 1)

return ts_cs or buf_cs

end

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

-- Module default config

H.default_config = MiniComment.config

-- Helper functionality =======================================================

-- Settings -------------------------------------------------------------------

H.setup_config = function(config)

-- General idea: if some table elements are not present in user-supplied

-- `config`, take them from default config

vim.validate({ config = { config, 'table', true } })

config = vim.tbl_deep_extend('force', H.default_config, config or {})

-- Validate per nesting level to produce correct error message

vim.validate({

options = { config.options, 'table' },

mappings = { config.mappings, 'table' },

hooks = { config.hooks, 'table' },

})

vim.validate({

['options.custom_commentstring'] = { config.options.custom_commentstring, 'function', true },

['options.ignore_blank_line'] = { config.options.ignore_blank_line, 'boolean' },

['options.start_of_line'] = { config.options.start_of_line, 'boolean' },

['options.pad_comment_parts'] = { config.options.pad_comment_parts, 'boolean' },

['mappings.comment'] = { config.mappings.comment, 'string' },

['mappings.comment_line'] = { config.mappings.comment_line, 'string' },

['mappings.textobject'] = { config.mappings.textobject, 'string' },

['hooks.pre'] = { config.hooks.pre, 'function' },

['hooks.post'] = { config.hooks.post, 'function' },

})

return config

end

H.apply_config = function(config)

MiniComment.config = config

-- Make mappings

H.map('n', config.mappings.comment, function() return MiniComment.operator() end, { expr = true, desc = 'Comment' })

H.map(

'x',

config.mappings.comment,

-- Using `:<c-u>` instead of `<cmd>` as latter results into executing before

-- proper update of `'<` and `'>` marks which is needed to work correctly.

[[:<c-u>lua MiniComment.operator('visual')<cr>]],

{ desc = 'Comment selection' }

)

H.map(

'n',

config.mappings.comment_line,

function() return MiniComment.operator() .. '_' end,

{ expr = true, desc = 'Comment line' }

)

-- Use `<Cmd>...<CR>` to have proper dot-repeat

-- See https://github.com/neovim/neovim/issues/23406

H.map('o', config.mappings.textobject, '<Cmd>lua MiniComment.textobject()<CR>', { desc = 'Comment textobject' })

end

H.is_disabled = function() return vim.g.minicomment_disable == true or vim.b.minicomment_disable == true end

H.get_config = function(config)

return vim.tbl_deep_extend('force', MiniComment.config, vim.b.minicomment_config or {}, config or {})

end

-- Core implementations -------------------------------------------------------

H.make_comment_parts = function(ref_position)

local options = H.get_config().options

local cs = H.call_safely(options.custom_commentstring, ref_position) or MiniComment.get_commentstring(ref_position)

if cs == nil or cs == '' then

vim.api.nvim_echo({ { '(mini.comment) ', 'WarningMsg' }, { [[Option 'commentstring' is empty.]] } }, true, {})

return { left = '', right = '' }

end

if not (type(cs) == 'string' and cs:find('%%s') ~= nil) then

H.error(vim.inspect(cs) .. " is not a valid 'commentstring'.")

end

-- Assumed structure of 'commentstring':

-- <space> <left> <'%s'> <right> <space>

-- So this extracts parts without surrounding whitespace

local left, right = cs:match('^%s*(.*)%%s(.-)%s*$')

-- Trim comment parts from inner whitespace to ensure single space pad

if options.pad_comment_parts then

left, right = vim.trim(left), vim.trim(right)

end

return { left = left, right = right }

end

H.make_comment_check = function(comment_parts)

local l, r = comment_parts.left, comment_parts.right

-- String is commented if it has structure:

-- <possible space> <left> <anything> <right> <space>

local start_blank = H.get_config().options.start_of_line and '' or '%s-'

local regex = '^' .. start_blank .. vim.pesc(l) .. '.*' .. vim.pesc(r) .. '%s-$'

return function(line) return line:find(regex) ~= nil end

end

H.get_lines_info = function(lines, comment_parts, options)

local n_indent, n_indent_cur = math.huge, math.huge

local indent, indent_cur

local is_comment = true

local comment_check = H.make_comment_check(comment_parts)

local ignore_blank_line = options.ignore_blank_line

for _, l in pairs(lines) do

-- Update lines indent: minimum of all indents except blank lines

_, n_indent_cur, indent_cur = l:find('^(%s*)')

local is_blank = n_indent_cur == l:len()

if n_indent_cur < n_indent and not is_blank then

-- NOTE: Copy of actual indent instead of recreating it with `n_indent`

-- allows to handle both tabs and spaces

n_indent = n_indent_cur

indent = indent_cur

end

-- Update comment info: lines are comment if every single line is comment

-- Ignore blank lines if corresponding option is set to `true`

if not (ignore_blank_line and is_blank) then is_comment = is_comment and comment_check(l) end

end

-- `indent` can still be `nil` in case all `lines` are empty

return indent or '', is_comment

end

H.make_comment_function = function(comment_parts, indent)

local options = H.get_config().options

-- NOTE: this assumes that indent doesn't mix tabs with spaces

local nonindent_start = indent:len() + 1

local l, r = comment_parts.left, comment_parts.right

local lpad = (options.pad_comment_parts and l ~= '') and ' ' or ''

local rpad = (options.pad_comment_parts and r ~= '') and ' ' or ''

local blank_comment = indent .. l .. r

-- Escape literal '%' symbols in comment parts (like in LaTeX) to be '%%'

-- because they have special meaning in `string.format` input. NOTE: don't

-- use `vim.pesc()` here because it also escapes other special characters

-- (like '-', '*', etc.).

local l_esc, r_esc = l:gsub('%%', '%%%%'), r:gsub('%%', '%%%%')

local left = options.start_of_line and (l_esc .. indent) or (indent .. l_esc)

local nonblank_format = left .. lpad .. '%s' .. rpad .. r_esc

local ignore_blank_line = options.ignore_blank_line

return function(line)

-- Line is blank if it doesn't have anything except whitespace

if line:find('^%s*$') ~= nil then return ignore_blank_line and line or blank_comment end

return string.format(nonblank_format, line:sub(nonindent_start))

end

H.make_uncomment_function = function(comment_parts)

local options = H.get_config().options

local l, r = comment_parts.left, comment_parts.right

local lpad = (options.pad_comment_parts and l ~= '') and '[ ]?' or ''

local rpad = (options.pad_comment_parts and r ~= '') and '[ ]?' or ''

-- Usage of `lpad` and `rpad` as possbile single space enables uncommenting

-- of commented empty lines without trailing whitespace (like ' #').

local uncomment_regex = string.format('^(%%s*)%s%s(.-)%s%s%%s-$', vim.pesc(l), lpad, rpad, vim.pesc(r))

return function(line)

local indent, new_line = string.match(line, uncomment_regex)

-- Return original if line is not commented

if new_line == nil then return line end

-- Remove indent if line is a commented empty line

if new_line == '' then indent = '' end

return ('%s%s'):format(indent, new_line)

end

-- Utilities ------------------------------------------------------------------

H.error = function(msg) error(string.format('(mini.comment) %s', msg), 0) end

H.map = function(mode, lhs, rhs, opts)

if lhs == '' then return end

opts = vim.tbl_deep_extend('force', { silent = true }, opts or {})

vim.keymap.set(mode, lhs, rhs, opts)

end

H.call_safely = function(f, ...)

if not vim.is_callable(f) then return nil end

return f(...)

end

return MiniComment

FilesExpand file tree

comment.lua

Latest commit

History

comment.lua

File metadata and controls