eac9315962
This PR adds a `deprecated_module` command that marks the current module as deprecated. When another module imports a deprecated module, a warning is emitted during elaboration suggesting replacement imports. Example usage: ```lean deprecated_module "use NewModule instead" (since := "2026-03-30") ``` The warning message is optional but recommended. The `since` parameter is required. Warnings can be disabled, by setting `linter.deprecated.module` option to false in the command line. Because the check happens when importing , using `set_option linter.deprecated.module` in the source file won't affect the warnings. Instead, a whole file can be marked not to display depreciation warnings, by putting a comment `deprecated_module: ignore` next to `module` keyword. Similarly, individual keywords can be silenced. A `#show_deprecated_modules` command is also provided for inspecting which modules in the current environment are deprecated. `linter.deprecated.module` has no effect on this command, and hence one can view deprecated modules, even when having warnings silenced.
37 lines
2 KiB
Bash
37 lines
2 KiB
Bash
rm -rf .lake/build
|
|
|
|
# Build Main library — includes all test modules
|
|
capture lake build Main
|
|
|
|
# With-message format: custom message on its own line, then deprecation with replacement imports
|
|
check_out_contains "use DeprecatedModule.New instead"
|
|
check_out_contains "'DeprecatedModule.Old' has been deprecated: please replace this import by"
|
|
check_out_contains "import DeprecatedModule.New"
|
|
|
|
# Without-message format: deprecation with replacement imports but no custom message
|
|
check_out_contains "'DeprecatedModule.OldNoMessage' has been deprecated: please replace this import by"
|
|
|
|
# OldDouble has two deprecated_module commands — second triggers duplicate warning
|
|
check_out_contains "module is already marked as deprecated"
|
|
|
|
# TransitiveConsumer only imports Transitive (which imports Old) — no direct import, no warning
|
|
# (covered implicitly: if transitive warnings leaked, we'd see extra output)
|
|
|
|
# ConsumerIgnoreOne: "deprecated_module: ignore" on Old import only — OldNoMessage should still warn
|
|
check_out_contains "ConsumerIgnoreOne.lean:1:0: 'DeprecatedModule.OldNoMessage' has been deprecated"
|
|
|
|
# ConsumerIgnoreOnlyImport: single import with "deprecated_module: ignore" — no warning
|
|
if grep -Fq "ConsumerIgnoreOnlyImport.lean" "$CAPTURED.out.produced"; then
|
|
fail "ConsumerIgnoreOnlyImport should not produce any deprecation warning"
|
|
fi
|
|
|
|
# ConsumerIgnoreLastImport: "deprecated_module: ignore" on last import (Old) — OldNoMessage should
|
|
# still warn, but Old should be suppressed
|
|
check_out_contains "ConsumerIgnoreLastImport.lean:1:0: 'DeprecatedModule.OldNoMessage' has been deprecated"
|
|
if grep -Fq "ConsumerIgnoreLastImport.lean:1:0: 'DeprecatedModule.Old' has been deprecated" "$CAPTURED.out.produced"; then
|
|
fail "ConsumerIgnoreLastImport should not warn about Old (annotated with deprecated_module: ignore)"
|
|
fi
|
|
|
|
# ConsumerShowDeprecated: #show_deprecated_modules should still list deprecated modules
|
|
# even when warnings are suppressed via "deprecated_module: ignore"
|
|
check_out_contains "ConsumerShowDeprecated.lean:6:0: Deprecated modules"
|