mirror of
https://github.com/koalaman/shellcheck
synced 2025-07-07 13:31:36 -07:00
856d57f7d8
This change makes PositionedComment and ParseNote contain end columns. It additionally modifies the JSON formatter to show the end column in an "endColumn" property. No modifications to the messages shown by any other formatter have been made. Currently, all checks set the end column to the start column. It should now be possible however to start setting the end column in the parser. Additional work is needed to set the end column during AST analysis.
66 lines
2.4 KiB
Haskell
66 lines
2.4 KiB
Haskell
{-
|
|
Copyright 2012-2015 Vidar Holen
|
|
|
|
This file is part of ShellCheck.
|
|
http://www.vidarholen.net/contents/shellcheck
|
|
|
|
ShellCheck is free software: you can redistribute it and/or modify
|
|
it under the terms of the GNU General Public License as published by
|
|
the Free Software Foundation, either version 3 of the License, or
|
|
(at your option) any later version.
|
|
|
|
ShellCheck is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
GNU General Public License for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
-}
|
|
module ShellCheck.Formatter.Format where
|
|
|
|
import ShellCheck.Data
|
|
import ShellCheck.Interface
|
|
|
|
-- A formatter that carries along an arbitrary piece of data
|
|
data Formatter = Formatter {
|
|
header :: IO (),
|
|
onResult :: CheckResult -> String -> IO (),
|
|
onFailure :: FilePath -> ErrorMessage -> IO (),
|
|
footer :: IO ()
|
|
}
|
|
|
|
lineNo (PositionedComment pos _ _) = posLine pos
|
|
endLineNo (PositionedComment _ end _) = posLine end
|
|
colNo (PositionedComment pos _ _) = posColumn pos
|
|
endColNo (PositionedComment _ end _) = posColumn end
|
|
codeNo (PositionedComment _ _ (Comment _ code _)) = code
|
|
messageText (PositionedComment _ _ (Comment _ _ t)) = t
|
|
|
|
severityText :: PositionedComment -> String
|
|
severityText (PositionedComment _ _ (Comment c _ _)) =
|
|
case c of
|
|
ErrorC -> "error"
|
|
WarningC -> "warning"
|
|
InfoC -> "info"
|
|
StyleC -> "style"
|
|
|
|
-- Realign comments from a tabstop of 8 to 1
|
|
makeNonVirtual comments contents =
|
|
map fix comments
|
|
where
|
|
ls = lines contents
|
|
fix c@(PositionedComment start end comment) = PositionedComment start {
|
|
posColumn = realignColumn lineNo colNo c
|
|
} end {
|
|
posColumn = realignColumn endLineNo endColNo c
|
|
} comment
|
|
realignColumn lineNo colNo c =
|
|
if lineNo c > 0 && lineNo c <= fromIntegral (length ls)
|
|
then real (ls !! fromIntegral (lineNo c - 1)) 0 0 (colNo c)
|
|
else colNo c
|
|
real _ r v target | target <= v = r
|
|
real [] r v _ = r -- should never happen
|
|
real ('\t':rest) r v target =
|
|
real rest (r+1) (v + 8 - (v `mod` 8)) target
|
|
real (_:rest) r v target = real rest (r+1) (v+1) target
|