Discussion: accept `pantry.toml` as the pantry file name (keeping `pantry.conf`)

Đang mở
  • Có gì không ổn?
#689 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
25/100
Loại issue
Tính năng
Độ rõ ràng
Cần làm rõ
Mức độ hoạt động
Sôi nổi
Công nghệ
rust
Lĩnh vực
cli

Hướng nghiên cứu

Start with crates/core/src/context.rs and the pantry edit path at crates/core/src/pantry/mod.rs:1142; inspect how Context::discover and Context::search find pantry files. The proposal is still under discussion, with compatibility questions about other apps and older CookCLI versions unresolved, so first determine whether the change is agreed before attempting implementation.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

area: pantry feature request needs discussion

This is a proposal for discussion, not a decided change. Comments are welcome, especially from anyone who maintains another app that reads the pantry file.

Background

A recipe folder can hold two hand-written config files side by side, in two different formats:

File Format Comments
config/aisle.conf Cooklang's own format ([aisle], then name | synonym) //
config/pantry.conf TOML #

Both end in .conf, so nothing tells you which one is which. #687 (reported on Discord) is the result: someone wrote # comments in aisle.conf, the way pantry.conf beside it takes them, and they became ingredients. #688 now warns about those lines, but the cause is still there. The same confusion works in reverse: // note or -- note in pantry.conf is a TOML error, and the web shopping list then ignores the whole pantry.

The spec's conventions.md says the pantry file is TOML, but it doesn't name the file. pantry.conf is a CookCLI convention.

Proposal

Accept pantry.toml as the pantry file's name, and keep reading pantry.conf:

  1. Look for pantry.toml first, then pantry.conf, in ./config/ and in the global config dir (COOK_CONFIG_DIR, ~/.config/cook/, …). All lookups go through Context::discover / Context::search in crates/core/src/context.rs, so this is mostly one place.
  2. If both exist, use pantry.toml. cook doctor pantry and the /pantry page say that pantry.conf is being ignored.
  3. Edits (the CLI and the /pantry page) go back to the file that was read, whatever its name.
  4. When there is no pantry yet, the first edit creates config/pantry.toml instead of config/pantry.conf (crates/core/src/pantry/mod.rs:1142). The exception is if another app turns out to look for pantry.conf by name (question 1): then new pantries stay pantry.conf until those apps read both names. Otherwise, new users would still get the two .conf files side by side.
  5. Docs, README and help texts say "pantry.toml (or pantry.conf)".

aisle.conf keeps its name and its format. With pantry.toml next to it, the different extensions show that the two files have different formats.

Questions

  1. Does anything else look for config/pantry.conf by name? For example the Cook mobile apps, cook.md, or the sync service. If one does and a user renames the file, that app loses the pantry without saying why. This is the main question; if the answer is yes, those apps need to read pantry.toml too before CookCLI creates it.
  2. Is it worth it? About 60 files on main mention pantry.conf (tests, docs, the 9 locales, core, server). The alternative is to keep the name and rely on documentation plus the #688-style warnings.
  3. Should the spec name the files? conventions.md could say "pantry.toml (formerly pantry.conf)", so that every app agrees.
  4. When should new pantries become pantry.toml? Right away, or after one release that reads both names, so that an older cook on the same folder still finds the pantry?

Not part of this proposal: changing the aisle.conf format. That needs the spec and cooklang-rs, and was option 3 in #687.

Ngôn ngữ chính
Rust
Star
1.4k
Fork
120
Merge trung bình
1 ngày 20 giờ
Pull request đã merge (30 ngày)
116

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của cooklang/cookcli

Tất cả issue của cooklang/cookcli

Issue tương tự

Thêm issue về Rust

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.