Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

[Feature] Improve `Path:normalize` to return shorter relative path using ../

Aperta
  • Qualcosa non va?
#600 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
35/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
lua, neovim
Ambito
tooling

Direzione di ricerca

Locate plenary.path's Path:normalize implementation and any related path tests. Compare its existing absolute and relative-down results with the proposed relative-up form, while accounting for Windows support. Done means normalize returns the shortest valid path without breaking existing behavior.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

Currently Path:normalize returns 3 possible paths:

  • absolute from /
  • absolute from ~
  • relative down from cwd

I propose to add a fourth one:

  • relative up from cwd

At a glance this changes behaviour in a compatible way and shouldn't break any uses.

The point is to get the shortest possible path (which is anyway feels like a current goal for this method) - sometimes it may be the absolute one, sometimes up from cwd.

I've found it really useful in Neovim, when file is opened using Telescope plugin and you doesn't control how file name will be formed (manually you can either do :tabnew ../file or :tabnew ~/proj/file), but you wanna see as short as possible file name in statusline/tab name. Here is my current implementation (as a Lazy plugin):

---@type LazySpec
return {
    {
        'nvim-lua/plenary.nvim', -- Not a plugin, just a useful library.
        config = function()
            local Path = require 'plenary.path'

            local normalize = Path.normalize
            --- Monkey-patch Path:normalize method to make it try harder looking for shortest
            --- relative path by checking also path UP from cwd: '../../…'.
            ---@diagnostic disable-next-line: duplicate-set-field
            Path.normalize = function(self, cwd)
                -- Absolute (DOWN FROM / or ~) or relative (DOWN FROM cwd).
                local orig = normalize(self, cwd)
                -- Absolute (DOWN FROM / or ~), but we'll make it relative (UP FROM cwd).
                local rel = vim.fn.fnamemodify(orig, ':p:~')

                if string.match(orig, '^[/~]') then -- Absolute, thus may be shorter.
                    local abs = vim.fn.fnamemodify(rel, ':p')
                    local abs_path = Path:new(abs)
                    local dir = cwd .. '/'
                    local up = ''
                    repeat
                        up = up .. '../'
                        rel = abs_path:make_relative(Path:new(dir .. up):absolute())
                    until rel ~= abs
                    rel = up .. rel
                end

                return string.len(orig) <= string.len(rel) and orig or rel
            end
        end,
    },
}

This implementation is not suitable for the lib (because there is no Windows support and it depends on Neovim), but sometimes code worth thousands words 😄 and also it may be useful for other Neovim users until this change will be implemented (if it will be accepted at all).

Lingua principale
Lua
Stelle
3.5k
Fork
341
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di nvim-lua/plenary.nvim

Tutte le issue di nvim-lua/plenary.nvim

Issue simili

Altre issue su Lua

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.