Adds option to reverse the path_display

[alycklama]

Description

Long paths make it sometimes difficult to see the file name. You can create a custom formatter, but I thought it would be great if we can have a format similar to Intelij, where the file name is in front.

Type of change

• New feature (non-breaking change which adds functionality)

How Has This Been Tested?

I've tested my code with the following configurations:

Simple config:

          path_display = {
            "reverse"
          },

Extended config:

          path_display = {
            reverse = {
              file_sep = " ",
              dir_open_sep = "(",
              dir_close_sep = ")",
            }
          },

Configuration:

• Neovim version (nvim --version): NVIM v0.9.5 | Build type: Release | LuaJIT 2.1.1710088188
• Operating system and version: MacOs 13.6.4 (22G513)

Checklist:

• [ x ] My code follows the style guidelines of this project (stylua)
• [ x ] I have performed a self-review of my own code
• [ x ] I have commented my code, particularly in hard-to-understand areas
• [ x ] I have made corresponding changes to the documentation (lua annotations)

[jamestrew]

Thanks, something like this has been a pretty heavily requested feature.
#2014

I think ideally, we'd like to have some highlighting added to this like shown in the many examples in that issue but I think this is a start.

Some other thoughts:

• you'll need to recreate the PR against the master branch - we don't really merge PRs into 0.1.x much less new feature
• I'm working through some Windows related bugs related to path_display so until I finish that, this PR will likely be on hold

[jamestrew]

This wouldn't be compatible on Windows with how we currently preserve backslash path separators for Windows.

[alycklama]

I've opened a new PR based on master:
#3010