sample config.yaml contains invalid fields

lsd-rs / lsd

The next gen ls command

Apache License 2.0

13.05k stars 425 forks source link

sample config.yaml contains invalid fields #922

Closed dimitrilw closed 9 months ago

dimitrilw commented 11 months ago

os: MacOS Sonoma 14.0, current as of time of this post
lsd --version: 1.0.0, installed 10 mins ago via Homebrew
echo $TERM: xterm-256color
echo $LS_COLORS: none -- empty return value (see pic, below)

Expected behavior

Process all fields given in sample config.yaml content.

Actual behavior

lsd: Configuration file /Users/dimitri/.config/lsd/config.yaml format error, unknown field `literal`, expected one of `classic`, `blocks`, `color`, `date`, `dereference`, `display`, `icons`, `ignore-globs`, `indicators`, `layout`, `recursion`, `size`, `permission`, `sorting`, `no-symlink`, `total-size`, `symlink-arrow`, `hyperlink`, `header` at line 143 column 1.

...and:

lsd: Configuration file /Users/dimitri/.config/lsd/config.yaml format error, unknown field `truncate-owner`, expected one of...

zwpaper commented 11 months ago

Hi @dimitrilw , the master is for the latest dev features, you can check 1.0 by changing the code to v1.0.0 tag

Can you also help adding a notice under configuration in readme?

zwpaper commented 11 months ago

/kind support

muniu-bot[bot] commented 11 months ago

@zwpaper: The label(s) kind/support cannot be applied, because the repository doesn't have them.

In response to [this](https://github.com/lsd-rs/lsd/issues/922#issuecomment-1742626578): >/kind support Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes/test-infra](https://github.com/kubernetes/test-infra/issues/new?title=Prow%20issue:) repository.

dimitrilw commented 10 months ago

Thank you for that explanation. ...it is always a 50/50 chance on "is main (aka master) prod, or is main dev" 😄 ...anyway, since your repo's primary readme is the main branch, that's what users (like me) will probably expect to match the released version -- worth adding header statement pointing peeps to old readme files hidden in release branches

rlovell3 commented 9 months ago

The config file issues just tripped me up as well on a fresh (10-minutes ago) install.

zwpaper commented 9 months ago

sorry for that @rlovell3, fixed now by https://github.com/lsd-rs/lsd/pull/960