feat(filesystem): customizable timestamp formats

[MastarCheeze]

I've added a format field in the configs for the components last_modified and created so that users can change the format string used to display timestamps in the file explorer. The field also accepts a function that returns a string so that features like relative timestamps can be implemented. The change is also applied to the file details popup window.

Here's an example setup:

require("neo-tree").setup({
  default_component_configs = {
    last_modified = {
      enabled = true,
      format = function(seconds)
        local now = os.time()
        local diff = now - seconds

        local function pluralise(value, unit)
          return value .. " " .. unit .. (value == 1 and "" or "s") .. " ago"
        end

        if diff < 60 then
          return "Just now"
        elseif diff < 3600 then
          local minutes = math.floor(diff / 60)
          return pluralise(minutes, "minute")
        elseif diff < 86400 then
          local hours = math.floor(diff / 3600)
          return pluralise(hours, "hour")
        elseif diff < 86400 * 30 then
          local days = math.floor(diff / 86400)
          return pluralise(days, "day")
        elseif diff < 86400 * 365 then
          local months = math.floor(diff / (86400 * 30))
          return pluralise(months, "month")
        else
          local years = math.floor(diff / (86400 * 365))
          return pluralise(years, "year")
        end
      end,
    },
    created = {
      enabled = true,
      format = "%e %b %y at %I:%M %p",
    },
  },
})

The columns are offset in the image because the the timestamp is longer than the column heading. I'll be opening a separate pull request that deals with that.

[MastarCheeze]

I just found out that there is already an existing issue (#1505) and a PR (#1506) for this exact topic.

[MastarCheeze]

I've added the changes you suggested @pynappo.

On second thought, I think its better to use default_component_configs.created.format and default_component_configs.modified.format as fallback values for the mapping level configs, as you suggested, to reduce the amount of configuration the user has to do. I've implemented this in my commit, along with documentation.

Thanks for the suggestions!

[MastarCheeze]

I'm thinking of adding relative timestamps as a builtin feature that can be enabled by specifying:

default_component_configs = {
  last_modified = {
    relative = true
  }
}

Or perhaps like this:

default_component_configs = {
  last_modified = {
    format = "relative"
  }
}

Or even just include a commented-out implementation of a relative timestamp function in README.md.

Any opinions about this? Should this be in its own PR?

[pynappo]

I'm thinking of adding relative timestamps as a builtin feature that can be enabled by specifying:

default_component_configs = {
  last_modified = {
    relative = true
  }
}

Or perhaps like this:

default_component_configs = {
  last_modified = {
    format = "relative"
  }
}

Or even just include a commented-out implementation of a relative timestamp function in README.md.

Any opinions about this? Should this be in its own PR?

Personally I'm leaning towards format = "relative". Commented out implementation would work as well.

I think it can be bundled in with this PR. Separately is okay too if you don't want to do that rn.

[MastarCheeze]

All done! I've added the suggested changes.

[MastarCheeze]

Any updates on this @pynappo?

[pynappo]

Apologies, had to think about the best way to reduce the amount of configuration needed. I've decided to remove the fallback of file_details's timestamps on the component configs because I think it should always default to giving a detailed absolute time. I also added format = "relative" as shorthand.