| /- | |
| Copyright (c) 2025 Lean FRO, LLC. All rights reserved. | |
| Released under Apache 2.0 license as described in the file LICENSE. | |
| Authors: David Thrane Christiansen | |
| -/ | |
| module | |
| prelude | |
| import Lean.Parser.Syntax | |
| public import Lean.Data.Options | |
| import Lean.Elab.Command | |
| import Lean.Linter.Basic | |
| import Lean.Server.InfoUtils | |
| public section | |
| namespace Lean.Linter | |
| open Elab.Command Parser Command | |
| open Parser.Term hiding «set_option» | |
| register_builtin_option linter.tactic.docsOnAlt : Bool := { | |
| defValue := true | |
| descr := "enable the 'documentation on tactic alternatives' linter" | |
| } | |
| private def getLinterDocsOnAlt (o : LinterOptions) : Bool := | |
| getLinterValue linter.tactic.docsOnAlt o | |
| namespace DocsOnAlt | |
| private partial def docsOnAlt : Linter where | |
| run stx := do | |
| if getLinterDocsOnAlt (← getLinterOptions) then | |
| if let some mods := stx.find? (·.getKind ∈ [``declModifiers, ``Command.syntax]) then | |
| if mods.find? isAltAttr |>.isSome then | |
| if let some doc := mods.find? (·.getKind == ``docComment) then | |
| let msg := m!"Documentation is ignored on a tactic alternative." | |
| logLint linter.tactic.docsOnAlt doc msg | |
| else if let some cmd := stx.find? (·.getKind == ``Command.attribute) then | |
| let attrs := cmd[2] | |
| let names := cmd[4].getArgs | |
| if (attrs.find? isAltAttr).isSome then | |
| let infoTrees := (← get).infoState.trees.toArray | |
| for tree in infoTrees do | |
| tree.visitM' (postNode := fun ci info _ => do | |
| match info with | |
| | .ofTermInfo ti => | |
| if names.contains ti.stx then | |
| if let some (x, _) := ti.expr.const? then | |
| if (← findInternalDocString? ci.env x).isSome then | |
| let msg := m!"Documentation for `{.ofConstName x}` is ignored because it is \ | |
| a tactic alternative." | |
| logLint linter.tactic.docsOnAlt ti.stx msg | |
| | _ => pure ()) | |
| where | |
| isAltAttr : Syntax → Bool | |
| | `(attr|tactic_alt $_) => true | |
| | _ => false | |
| builtin_initialize addLinter docsOnAlt |