feat(#3213): add view.width.lines_excluded option

[simonmandlik]

Closes #3213

[simonmandlik]

Added small improvements to the grow() algorithm including potential early exit

[alex-courtis]

Apologies, my time is very limited right now; I will likely review this change on the weekend.

[alex-courtis]

Testing in /home/alex/src/linux/arch/alpha/include which has children with short names:

Defaults OK:

    -- width = { },

Root should grow. FAIL: it doesn't.

    width = {
      include_root = true,
    },

Root explicitly should not grow. FAIL: it actually does.
It looks like include_root option might be inverted. I'm inverting the values going forward.

    width = {
      include_root = false,
    },

Long root constrained to max, OK:

    width = {
      include_root = false,
      max = 20,
    },

Respects min, OK:

    width = {
      include_root = false,
      min = 50,
    },

Respects padding, OK:

    width = {
      include_root = false,
      padding = 5,
    },

Respects empty table defaults: OK after changing DEFAULT_INCLUDE_ROOT to true

    width = { },

[alex-courtis]

Apologies for the late review. Looking good, please:

• simplify this https://github.com/nvim-tree/nvim-tree.lua/pull/3214/files#r2572631362
• resolve the inverted logic for include_root #3214 (comment)
• refactor include_root option https://github.com/nvim-tree/nvim-tree.lua/pull/3214/files/3d234325d1ed5411a41260ff92718b4f41540717#r2530138318

[alex-courtis]

Defaults OK:

    -- width = { },

Root should grow. OK.

    width = {
      lines_excluded = "none",
    },

Root explicitly should not grow. OK.

    width = {
      lines_excluded = "root",
    },

Long root constrained to max, OK:

    width = {
      lines_excluded = "none",
      max = 20,
    },

Respects min, OK:

    width = {
      lines_excluded = "none",
      min = 50,
    },

Respects padding, OK:

    width = {
      lines_excluded = "none",
      padding = 5,
    },

Respects empty table defaults with root excluded. OK

    width = { },

[alex-courtis]

Having lines_excluded as as a single enum value isn't working, as it won't allow us to add more exclusions in the future e.g. symlinks.

It can be changed to a table of enums e.g.

    width = {
      lines_excluded = {
        "root",
        "symlink",
      },
  },

For now it can just contain "root".

After some frustrating hacking, I've added enum validation to validate_options

Do you think we can implement this?

ACCEPTED_ENUMS.patch

[simonmandlik]

@alex-courtis done

[alex-courtis]

Many thanks for the great contribution @simonmandlik and thank you for handling all the unexpected changes.

[alex-courtis]

Defaults OK:

    -- width = { },

Root should grow. OK.

    width = {
      lines_excluded = { },
    },

Root explicitly should not grow. OK.

    width = {
      lines_excluded = {
        "root",
      }
    },

Long root constrained to max, OK:

    width = {
      max = 20,
      lines_excluded = { }
    },

Respects min, OK:

    width = {
      lines_excluded = { },
      min = 50,
    },

Respects padding, OK:

    width = {
      lines_excluded = "none",
      padding = 5,
    },

Respects empty table defaults with root excluded. OK

    width = { },

Checks type. OK.

    width = {
      lines_excluded = "foo",
    },

Checks value. OK.

    width = {
      lines_excluded = {
        "foo",
      },
    },