lake does not validate lakefile.toml
Nobody has claimed this yet.
- Dominant language
- Lean
- Stars
- 9.2k
- Forks
- 990
- Avg merge
- 1d 17h
- Merged PRs (30d)
- 175
Description
Prerequisites
Please put an X between the brackets as you perform the following steps:
- Check that your issue is not already filed:
https://github.com/leanprover/lean4/issues - Reduce the issue to a minimal, self-contained, reproducible test case.
Avoid dependencies to Mathlib or Batteries. - Test your test case against the latest nightly release, for example on
https://live.lean-lang.org/#project=lean-nightly
(You can also use the settings there to switch to “Lean nightly”)
Description
lake silently ignores bad option combinations in lakefile.toml, for instance a version field for a require from git.
Context
https://leanprover.zulipchat.com/#narrow/channel/270676-lean4/topic/invalid.20atom/near/491387823
Steps to Reproduce
Create a new project with lakefile.toml containing:
[[require]]
name = "mathlib"
git = "https://github.com/leanprover-community/mathlib4.git"
version = "v4.14.0"
and run lake update.
Expected behavior:
Expected behavior: lake should at least emit a warning saying git and version are incompatible, maybe even suggesting to replace version by rev and explain that rev is intended for reservoir require.
Actual behavior:
lake silently ignores the version field and updates mathlib to git master.
Versions
Lean 4.14.0 on Linux.
Impact
Add 👍 to issues you consider important. If others are impacted by this issue, please ask them to add 👍 to it.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Create the reported lakefile.toml and run the lake update entry point to reproduce the silent handling of incompatible require fields. Trace the validation or parsing path for git and version options; done means lake warns about their incompatibility and explains the appropriate alternative.
Written by the indexing model from the issue text.
Assessment
- Domain
- build-system, cli
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100