├── .github └── workflows │ └── push.yml ├── LICENSE ├── README.md ├── lua └── pqf │ └── init.lua ├── stylua.toml └── syntax └── qf.vim /.github/workflows/push.yml: -------------------------------------------------------------------------------- 1 | --- 2 | name: Push 3 | on: 4 | push: 5 | pull_request: 6 | 7 | concurrency: 8 | group: ${{ github.workflow }}-${{ github.event_name == 'pull_request' && github.head_ref || github.sha }} 9 | cancel-in-progress: true 10 | 11 | jobs: 12 | stylua: 13 | runs-on: ubuntu-latest 14 | steps: 15 | - uses: actions/checkout@v3 16 | - uses: JohnnyMorganz/stylua-action@v3 17 | name: Run StyLua 18 | with: 19 | token: ${{ secrets.GITHUB_TOKEN }} 20 | version: 0.18.1 21 | args: --check . 22 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Mozilla Public License, version 2.0 2 | 3 | 1. Definitions 4 | 5 | 1.1. "Contributor" 6 | 7 | means each individual or legal entity that creates, contributes to the 8 | creation of, or owns Covered Software. 9 | 10 | 1.2. "Contributor Version" 11 | 12 | means the combination of the Contributions of others (if any) used by a 13 | Contributor and that particular Contributor's Contribution. 14 | 15 | 1.3. "Contribution" 16 | 17 | means Covered Software of a particular Contributor. 18 | 19 | 1.4. "Covered Software" 20 | 21 | means Source Code Form to which the initial Contributor has attached the 22 | notice in Exhibit A, the Executable Form of such Source Code Form, and 23 | Modifications of such Source Code Form, in each case including portions 24 | thereof. 25 | 26 | 1.5. "Incompatible With Secondary Licenses" 27 | means 28 | 29 | a. that the initial Contributor has attached the notice described in 30 | Exhibit B to the Covered Software; or 31 | 32 | b. that the Covered Software was made available under the terms of 33 | version 1.1 or earlier of the License, but not also under the terms of 34 | a Secondary License. 35 | 36 | 1.6. "Executable Form" 37 | 38 | means any form of the work other than Source Code Form. 39 | 40 | 1.7. "Larger Work" 41 | 42 | means a work that combines Covered Software with other material, in a 43 | separate file or files, that is not Covered Software. 44 | 45 | 1.8. "License" 46 | 47 | means this document. 48 | 49 | 1.9. "Licensable" 50 | 51 | means having the right to grant, to the maximum extent possible, whether 52 | at the time of the initial grant or subsequently, any and all of the 53 | rights conveyed by this License. 54 | 55 | 1.10. "Modifications" 56 | 57 | means any of the following: 58 | 59 | a. any file in Source Code Form that results from an addition to, 60 | deletion from, or modification of the contents of Covered Software; or 61 | 62 | b. any new file in Source Code Form that contains any Covered Software. 63 | 64 | 1.11. "Patent Claims" of a Contributor 65 | 66 | means any patent claim(s), including without limitation, method, 67 | process, and apparatus claims, in any patent Licensable by such 68 | Contributor that would be infringed, but for the grant of the License, 69 | by the making, using, selling, offering for sale, having made, import, 70 | or transfer of either its Contributions or its Contributor Version. 71 | 72 | 1.12. "Secondary License" 73 | 74 | means either the GNU General Public License, Version 2.0, the GNU Lesser 75 | General Public License, Version 2.1, the GNU Affero General Public 76 | License, Version 3.0, or any later versions of those licenses. 77 | 78 | 1.13. "Source Code Form" 79 | 80 | means the form of the work preferred for making modifications. 81 | 82 | 1.14. "You" (or "Your") 83 | 84 | means an individual or a legal entity exercising rights under this 85 | License. For legal entities, "You" includes any entity that controls, is 86 | controlled by, or is under common control with You. For purposes of this 87 | definition, "control" means (a) the power, direct or indirect, to cause 88 | the direction or management of such entity, whether by contract or 89 | otherwise, or (b) ownership of more than fifty percent (50%) of the 90 | outstanding shares or beneficial ownership of such entity. 91 | 92 | 93 | 2. License Grants and Conditions 94 | 95 | 2.1. Grants 96 | 97 | Each Contributor hereby grants You a world-wide, royalty-free, 98 | non-exclusive license: 99 | 100 | a. under intellectual property rights (other than patent or trademark) 101 | Licensable by such Contributor to use, reproduce, make available, 102 | modify, display, perform, distribute, and otherwise exploit its 103 | Contributions, either on an unmodified basis, with Modifications, or 104 | as part of a Larger Work; and 105 | 106 | b. under Patent Claims of such Contributor to make, use, sell, offer for 107 | sale, have made, import, and otherwise transfer either its 108 | Contributions or its Contributor Version. 109 | 110 | 2.2. Effective Date 111 | 112 | The licenses granted in Section 2.1 with respect to any Contribution 113 | become effective for each Contribution on the date the Contributor first 114 | distributes such Contribution. 115 | 116 | 2.3. Limitations on Grant Scope 117 | 118 | The licenses granted in this Section 2 are the only rights granted under 119 | this License. No additional rights or licenses will be implied from the 120 | distribution or licensing of Covered Software under this License. 121 | Notwithstanding Section 2.1(b) above, no patent license is granted by a 122 | Contributor: 123 | 124 | a. for any code that a Contributor has removed from Covered Software; or 125 | 126 | b. for infringements caused by: (i) Your and any other third party's 127 | modifications of Covered Software, or (ii) the combination of its 128 | Contributions with other software (except as part of its Contributor 129 | Version); or 130 | 131 | c. under Patent Claims infringed by Covered Software in the absence of 132 | its Contributions. 133 | 134 | This License does not grant any rights in the trademarks, service marks, 135 | or logos of any Contributor (except as may be necessary to comply with 136 | the notice requirements in Section 3.4). 137 | 138 | 2.4. Subsequent Licenses 139 | 140 | No Contributor makes additional grants as a result of Your choice to 141 | distribute the Covered Software under a subsequent version of this 142 | License (see Section 10.2) or under the terms of a Secondary License (if 143 | permitted under the terms of Section 3.3). 144 | 145 | 2.5. Representation 146 | 147 | Each Contributor represents that the Contributor believes its 148 | Contributions are its original creation(s) or it has sufficient rights to 149 | grant the rights to its Contributions conveyed by this License. 150 | 151 | 2.6. Fair Use 152 | 153 | This License is not intended to limit any rights You have under 154 | applicable copyright doctrines of fair use, fair dealing, or other 155 | equivalents. 156 | 157 | 2.7. Conditions 158 | 159 | Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted in 160 | Section 2.1. 161 | 162 | 163 | 3. Responsibilities 164 | 165 | 3.1. Distribution of Source Form 166 | 167 | All distribution of Covered Software in Source Code Form, including any 168 | Modifications that You create or to which You contribute, must be under 169 | the terms of this License. You must inform recipients that the Source 170 | Code Form of the Covered Software is governed by the terms of this 171 | License, and how they can obtain a copy of this License. You may not 172 | attempt to alter or restrict the recipients' rights in the Source Code 173 | Form. 174 | 175 | 3.2. Distribution of Executable Form 176 | 177 | If You distribute Covered Software in Executable Form then: 178 | 179 | a. such Covered Software must also be made available in Source Code Form, 180 | as described in Section 3.1, and You must inform recipients of the 181 | Executable Form how they can obtain a copy of such Source Code Form by 182 | reasonable means in a timely manner, at a charge no more than the cost 183 | of distribution to the recipient; and 184 | 185 | b. You may distribute such Executable Form under the terms of this 186 | License, or sublicense it under different terms, provided that the 187 | license for the Executable Form does not attempt to limit or alter the 188 | recipients' rights in the Source Code Form under this License. 189 | 190 | 3.3. Distribution of a Larger Work 191 | 192 | You may create and distribute a Larger Work under terms of Your choice, 193 | provided that You also comply with the requirements of this License for 194 | the Covered Software. If the Larger Work is a combination of Covered 195 | Software with a work governed by one or more Secondary Licenses, and the 196 | Covered Software is not Incompatible With Secondary Licenses, this 197 | License permits You to additionally distribute such Covered Software 198 | under the terms of such Secondary License(s), so that the recipient of 199 | the Larger Work may, at their option, further distribute the Covered 200 | Software under the terms of either this License or such Secondary 201 | License(s). 202 | 203 | 3.4. Notices 204 | 205 | You may not remove or alter the substance of any license notices 206 | (including copyright notices, patent notices, disclaimers of warranty, or 207 | limitations of liability) contained within the Source Code Form of the 208 | Covered Software, except that You may alter any license notices to the 209 | extent required to remedy known factual inaccuracies. 210 | 211 | 3.5. Application of Additional Terms 212 | 213 | You may choose to offer, and to charge a fee for, warranty, support, 214 | indemnity or liability obligations to one or more recipients of Covered 215 | Software. However, You may do so only on Your own behalf, and not on 216 | behalf of any Contributor. You must make it absolutely clear that any 217 | such warranty, support, indemnity, or liability obligation is offered by 218 | You alone, and You hereby agree to indemnify every Contributor for any 219 | liability incurred by such Contributor as a result of warranty, support, 220 | indemnity or liability terms You offer. You may include additional 221 | disclaimers of warranty and limitations of liability specific to any 222 | jurisdiction. 223 | 224 | 4. Inability to Comply Due to Statute or Regulation 225 | 226 | If it is impossible for You to comply with any of the terms of this License 227 | with respect to some or all of the Covered Software due to statute, 228 | judicial order, or regulation then You must: (a) comply with the terms of 229 | this License to the maximum extent possible; and (b) describe the 230 | limitations and the code they affect. Such description must be placed in a 231 | text file included with all distributions of the Covered Software under 232 | this License. Except to the extent prohibited by statute or regulation, 233 | such description must be sufficiently detailed for a recipient of ordinary 234 | skill to be able to understand it. 235 | 236 | 5. Termination 237 | 238 | 5.1. The rights granted under this License will terminate automatically if You 239 | fail to comply with any of its terms. However, if You become compliant, 240 | then the rights granted under this License from a particular Contributor 241 | are reinstated (a) provisionally, unless and until such Contributor 242 | explicitly and finally terminates Your grants, and (b) on an ongoing 243 | basis, if such Contributor fails to notify You of the non-compliance by 244 | some reasonable means prior to 60 days after You have come back into 245 | compliance. Moreover, Your grants from a particular Contributor are 246 | reinstated on an ongoing basis if such Contributor notifies You of the 247 | non-compliance by some reasonable means, this is the first time You have 248 | received notice of non-compliance with this License from such 249 | Contributor, and You become compliant prior to 30 days after Your receipt 250 | of the notice. 251 | 252 | 5.2. If You initiate litigation against any entity by asserting a patent 253 | infringement claim (excluding declaratory judgment actions, 254 | counter-claims, and cross-claims) alleging that a Contributor Version 255 | directly or indirectly infringes any patent, then the rights granted to 256 | You by any and all Contributors for the Covered Software under Section 257 | 2.1 of this License shall terminate. 258 | 259 | 5.3. In the event of termination under Sections 5.1 or 5.2 above, all end user 260 | license agreements (excluding distributors and resellers) which have been 261 | validly granted by You or Your distributors under this License prior to 262 | termination shall survive termination. 263 | 264 | 6. Disclaimer of Warranty 265 | 266 | Covered Software is provided under this License on an "as is" basis, 267 | without warranty of any kind, either expressed, implied, or statutory, 268 | including, without limitation, warranties that the Covered Software is free 269 | of defects, merchantable, fit for a particular purpose or non-infringing. 270 | The entire risk as to the quality and performance of the Covered Software 271 | is with You. Should any Covered Software prove defective in any respect, 272 | You (not any Contributor) assume the cost of any necessary servicing, 273 | repair, or correction. This disclaimer of warranty constitutes an essential 274 | part of this License. No use of any Covered Software is authorized under 275 | this License except under this disclaimer. 276 | 277 | 7. Limitation of Liability 278 | 279 | Under no circumstances and under no legal theory, whether tort (including 280 | negligence), contract, or otherwise, shall any Contributor, or anyone who 281 | distributes Covered Software as permitted above, be liable to You for any 282 | direct, indirect, special, incidental, or consequential damages of any 283 | character including, without limitation, damages for lost profits, loss of 284 | goodwill, work stoppage, computer failure or malfunction, or any and all 285 | other commercial damages or losses, even if such party shall have been 286 | informed of the possibility of such damages. This limitation of liability 287 | shall not apply to liability for death or personal injury resulting from 288 | such party's negligence to the extent applicable law prohibits such 289 | limitation. Some jurisdictions do not allow the exclusion or limitation of 290 | incidental or consequential damages, so this exclusion and limitation may 291 | not apply to You. 292 | 293 | 8. Litigation 294 | 295 | Any litigation relating to this License may be brought only in the courts 296 | of a jurisdiction where the defendant maintains its principal place of 297 | business and such litigation shall be governed by laws of that 298 | jurisdiction, without reference to its conflict-of-law provisions. Nothing 299 | in this Section shall prevent a party's ability to bring cross-claims or 300 | counter-claims. 301 | 302 | 9. Miscellaneous 303 | 304 | This License represents the complete agreement concerning the subject 305 | matter hereof. If any provision of this License is held to be 306 | unenforceable, such provision shall be reformed only to the extent 307 | necessary to make it enforceable. Any law or regulation which provides that 308 | the language of a contract shall be construed against the drafter shall not 309 | be used to construe this License against a Contributor. 310 | 311 | 312 | 10. Versions of the License 313 | 314 | 10.1. New Versions 315 | 316 | Mozilla Foundation is the license steward. Except as provided in Section 317 | 10.3, no one other than the license steward has the right to modify or 318 | publish new versions of this License. Each version will be given a 319 | distinguishing version number. 320 | 321 | 10.2. Effect of New Versions 322 | 323 | You may distribute the Covered Software under the terms of the version 324 | of the License under which You originally received the Covered Software, 325 | or under the terms of any subsequent version published by the license 326 | steward. 327 | 328 | 10.3. Modified Versions 329 | 330 | If you create software not governed by this License, and you want to 331 | create a new license for such software, you may create and use a 332 | modified version of this License if you rename the license and remove 333 | any references to the name of the license steward (except to note that 334 | such modified license differs from this License). 335 | 336 | 10.4. Distributing Source Code Form that is Incompatible With Secondary 337 | Licenses If You choose to distribute Source Code Form that is 338 | Incompatible With Secondary Licenses under the terms of this version of 339 | the License, the notice described in Exhibit B of this License must be 340 | attached. 341 | 342 | Exhibit A - Source Code Form License Notice 343 | 344 | This Source Code Form is subject to the 345 | terms of the Mozilla Public License, v. 346 | 2.0. If a copy of the MPL was not 347 | distributed with this file, You can 348 | obtain one at 349 | http://mozilla.org/MPL/2.0/. 350 | 351 | If it is not possible or desirable to put the notice in a particular file, 352 | then You may include the notice in a location (such as a LICENSE file in a 353 | relevant directory) where a recipient would be likely to look for such a 354 | notice. 355 | 356 | You may add additional accurate notices of copyright ownership. 357 | 358 | Exhibit B - "Incompatible With Secondary Licenses" Notice 359 | 360 | This Source Code Form is "Incompatible 361 | With Secondary Licenses", as defined by 362 | the Mozilla Public License, v. 2.0. 363 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Pretty Quickfix windows for NeoVim 2 | 3 | nvim-pqf makes your quickfix and location list windows look nicer, thanks to a 4 | combination of a custom `quickfixtextfunc` function and custom syntax rules for 5 | quickfix/location list buffers. 6 | 7 | Without nvim-pqf, your quickfix window looks like this: 8 | 9 | ![Without nvim-pqf](https://github.com/yorickpeterse/nvim-pqf/assets/86065/6635fdf3-49f0-4585-9495-34fcaffba065) 10 | 11 | With nvim-pqf, it looks like this (colours depend on your theme of course); 12 | 13 | ![With nvim-pqf](https://github.com/yorickpeterse/nvim-pqf/assets/86065/a4098631-b2ad-424a-9990-16f2bcbe5dea) 14 | 15 | ## Features 16 | 17 | - Better highlights for line and column numbers 18 | - Highlights for the item type (error, warning, etc), using the same highlights 19 | as NeoVim's diagnostics 20 | - File paths are aligned so messages always start at the same column, making 21 | them easier to read 22 | - Works for both quickfix and location list windows 23 | - Items (by default) only display the first line in case they contain multiple 24 | lines 25 | 26 | ## Requirements 27 | 28 | - NeoVim 0.8 or newer 29 | 30 | ## Installation 31 | 32 | First install this plugin using your plugin manager of choice. For example, when 33 | using vim-plug use the following: 34 | 35 | Plug 'yorickpeterse/nvim-pqf' 36 | 37 | Once installed, add the following Lua snippet to your `init.lua`: 38 | 39 | require('pqf').setup() 40 | 41 | And that's it! 42 | 43 | ## Configuration 44 | 45 | Each item in the quickfix list starts with a sign that indicates the type of 46 | item, if this information is available. For example, when displaying diagnostics 47 | an item may start with `E` for an error, and `W` for a warning. 48 | 49 | You can configure these signs (and various other settings) as follows: 50 | 51 | ```lua 52 | require('pqf').setup({ 53 | signs = { 54 | error = { text = 'E', hl = 'DiagnosticSignError' }, 55 | warning = { text = 'W', hl = 'DiagnosticSignWarn' }, 56 | info = { text = 'I', hl = 'DiagnosticSignInfo' }, 57 | hint = { text = 'H', hl = 'DiagnosticSignHint' }, 58 | }, 59 | 60 | -- By default, only the first line of a multi line message will be shown. 61 | -- When this is true, multiple lines will be shown for an entry, separated by 62 | -- a space 63 | show_multiple_lines = false, 64 | 65 | -- How long filenames in the quickfix are allowed to be. 0 means no limit. 66 | -- Filenames above this limit will be truncated from the beginning with 67 | -- `filename_truncate_prefix`. 68 | max_filename_length = 0, 69 | 70 | -- Prefix to use for truncated filenames. 71 | filename_truncate_prefix = '[...]', 72 | }) 73 | ``` 74 | 75 | ## Tweaking the highlights 76 | 77 | Depending on your theme, you may need to tweak the highlights used by nvim-pqf. 78 | The following highlight groups are used: 79 | 80 | | Group | Use 81 | |:----------------------|:-------------------------- 82 | | `Directory` | The file path 83 | | `Number` | Line and column numbers 84 | | `DiagnosticSignError` | The default highlight group for error signs 85 | | `DiagnosticSignWarn` | The default highlight group for warning signs 86 | | `DiagnosticSignInfo` | The default highlight group for info signs 87 | | `DiagnosticSignHint` | The default highlight group for hint signs 88 | 89 | ## License 90 | 91 | All source code in this repository is licensed under the Mozilla Public License 92 | version 2.0, unless stated otherwise. A copy of this license can be found in the 93 | file "LICENSE". 94 | -------------------------------------------------------------------------------- /lua/pqf/init.lua: -------------------------------------------------------------------------------- 1 | local api = vim.api 2 | local fn = vim.fn 3 | local M = {} 4 | 5 | local signs = { 6 | error = { text = 'E', hl = 'DiagnosticSignError' }, 7 | warning = { text = 'W', hl = 'DiagnosticSignWarn' }, 8 | info = { text = 'I', hl = 'DiagnosticSignInfo' }, 9 | hint = { text = 'H', hl = 'DiagnosticSignHint' }, 10 | } 11 | 12 | local namespace = api.nvim_create_namespace('pqf') 13 | local show_multiple_lines = false 14 | local max_filename_length = 0 15 | local filename_truncate_prefix = '[...]' 16 | 17 | local function pad_right(string, pad_to) 18 | local new = string 19 | 20 | if pad_to == 0 then 21 | return string 22 | end 23 | 24 | for i = fn.strwidth(string), pad_to do 25 | new = new .. ' ' 26 | end 27 | 28 | return new 29 | end 30 | 31 | local function trim_path(path) 32 | local fname = fn.fnamemodify(path, ':p:.') 33 | local len = fn.strchars(fname) 34 | 35 | if max_filename_length > 0 and len > max_filename_length then 36 | fname = filename_truncate_prefix 37 | .. fn.strpart(fname, len - max_filename_length, max_filename_length, 1) 38 | end 39 | 40 | return fname 41 | end 42 | 43 | local function list_items(info) 44 | if info.quickfix == 1 then 45 | return fn.getqflist({ id = info.id, items = 1, qfbufnr = 1 }) 46 | else 47 | return fn.getloclist(info.winid, { id = info.id, items = 1, qfbufnr = 1 }) 48 | end 49 | end 50 | 51 | local function apply_highlights(bufnr, highlights) 52 | for _, hl in ipairs(highlights) do 53 | vim.highlight.range( 54 | bufnr, 55 | namespace, 56 | hl.group, 57 | { hl.line, hl.col }, 58 | { hl.line, hl.end_col } 59 | ) 60 | end 61 | end 62 | 63 | function M.format(info) 64 | local list = list_items(info) 65 | local qf_bufnr = list.qfbufnr 66 | local raw_items = list.items 67 | local lines = {} 68 | local pad_to = 0 69 | local type_mapping = { 70 | E = signs.error, 71 | W = signs.warning, 72 | I = signs.info, 73 | N = signs.hint, 74 | } 75 | 76 | local items = {} 77 | local show_sign = false 78 | 79 | -- If we're adding a new list rather than appending to an existing one, we 80 | -- need to clear existing highlights. 81 | if info.start_idx == 1 then 82 | api.nvim_buf_clear_namespace(qf_bufnr, namespace, 0, -1) 83 | end 84 | 85 | for i = info.start_idx, info.end_idx do 86 | local raw = raw_items[i] 87 | 88 | if raw then 89 | local item = { 90 | type = raw.type, 91 | text = raw.text, 92 | location = '', 93 | path_size = 0, 94 | line_col_size = 0, 95 | index = i, 96 | } 97 | 98 | if type_mapping[item.type] then 99 | show_sign = true 100 | end 101 | 102 | if raw.bufnr > 0 then 103 | item.location = trim_path(fn.bufname(raw.bufnr)) 104 | item.path_size = #item.location 105 | end 106 | 107 | if raw.lnum and raw.lnum > 0 then 108 | local lnum = raw.lnum 109 | 110 | if raw.end_lnum and raw.end_lnum > 0 and raw.end_lnum ~= lnum then 111 | lnum = lnum .. '-' .. raw.end_lnum 112 | end 113 | 114 | if #item.location > 0 then 115 | item.location = item.location .. ' ' .. lnum 116 | else 117 | item.location = tostring(lnum) 118 | end 119 | 120 | -- Column numbers without line numbers make no sense, and may confuse 121 | -- the user into thinking they are actually line numbers. 122 | if raw.col and raw.col > 0 then 123 | local col = raw.col 124 | 125 | if raw.end_col and raw.end_col > 0 and raw.end_col ~= col then 126 | col = col .. '-' .. raw.end_col 127 | end 128 | 129 | item.location = item.location .. ':' .. col 130 | end 131 | 132 | item.line_col_size = #item.location - item.path_size 133 | end 134 | 135 | local size = fn.strwidth(item.location) 136 | 137 | if size > pad_to then 138 | pad_to = size 139 | end 140 | 141 | table.insert(items, item) 142 | end 143 | end 144 | 145 | local highlights = {} 146 | 147 | for _, item in ipairs(items) do 148 | local line_idx = item.index - 1 149 | 150 | -- Quickfix items only support singe-line messages, and show newlines as 151 | -- funny characters. In addition, many language servers (e.g. 152 | -- rust-analyzer) produce super noisy multi-line messages where only the 153 | -- first line is relevant. 154 | -- 155 | -- To handle this, we only include the first line of the message in the 156 | -- quickfix line. 157 | local text = vim.split(item.text, '\n')[1] 158 | local location = item.location 159 | 160 | -- Optionally show multiple lines joined with single space 161 | if show_multiple_lines then 162 | text = fn.substitute(item.text, '\n\\s*', ' ', 'g') 163 | end 164 | 165 | text = fn.trim(text) 166 | 167 | if text ~= '' then 168 | location = pad_right(location, pad_to) 169 | end 170 | 171 | local sign_conf = type_mapping[item.type] 172 | local sign = ' ' 173 | local sign_hl = nil 174 | 175 | if sign_conf then 176 | sign = sign_conf.text 177 | sign_hl = sign_conf.hl 178 | end 179 | 180 | local prefix = show_sign and sign .. ' ' or '' 181 | local line = prefix .. location .. text 182 | 183 | -- If a line is completely empty, Vim uses the default format, which 184 | -- involves inserting `|| `. To prevent this from happening we'll just 185 | -- insert an empty space instead. 186 | if line == '' then 187 | line = ' ' 188 | end 189 | 190 | if show_sign and sign_hl then 191 | table.insert( 192 | highlights, 193 | { group = sign_hl, line = line_idx, col = 0, end_col = #sign } 194 | ) 195 | end 196 | 197 | if item.path_size > 0 then 198 | table.insert(highlights, { 199 | group = 'Directory', 200 | line = line_idx, 201 | col = #prefix, 202 | end_col = #prefix + item.path_size, 203 | }) 204 | end 205 | 206 | if item.line_col_size > 0 then 207 | local col_start = #prefix + item.path_size 208 | 209 | table.insert(highlights, { 210 | group = 'Number', 211 | line = line_idx, 212 | col = col_start, 213 | end_col = col_start + item.line_col_size, 214 | }) 215 | end 216 | 217 | table.insert(lines, line) 218 | end 219 | 220 | -- Applying highlights has to be deferred, otherwise they won't apply to the 221 | -- lines inserted into the quickfix window. 222 | vim.schedule(function() 223 | apply_highlights(qf_bufnr, highlights) 224 | end) 225 | 226 | return lines 227 | end 228 | 229 | function M.setup(opts) 230 | opts = opts or {} 231 | 232 | if opts.signs then 233 | assert(type(opts.signs) == 'table', 'the "signs" option must be a table') 234 | signs = vim.tbl_deep_extend('force', signs, opts.signs) 235 | end 236 | 237 | if opts.show_multiple_lines then 238 | show_multiple_lines = true 239 | end 240 | 241 | if opts.max_filename_length then 242 | max_filename_length = opts.max_filename_length 243 | assert( 244 | type(max_filename_length) == 'number', 245 | 'the "max_filename_length" option must be a number' 246 | ) 247 | end 248 | 249 | if opts.filename_truncate_prefix then 250 | filename_truncate_prefix = opts.filename_truncate_prefix 251 | assert( 252 | type(filename_truncate_prefix) == 'string', 253 | 'the "filename_truncate_prefix" option must be a string' 254 | ) 255 | end 256 | 257 | vim.o.quickfixtextfunc = "v:lua.require'pqf'.format" 258 | end 259 | 260 | return M 261 | -------------------------------------------------------------------------------- /stylua.toml: -------------------------------------------------------------------------------- 1 | column_width = 80 2 | indent_type = 'Spaces' 3 | indent_width = 2 4 | quote_style = 'AutoPreferSingle' 5 | -------------------------------------------------------------------------------- /syntax/qf.vim: -------------------------------------------------------------------------------- 1 | if exists('b:current_syntax') 2 | finish 3 | end 4 | 5 | syntax clear 6 | 7 | let b:current_syntax = 'qf' 8 | --------------------------------------------------------------------------------