mirrors/git-annex
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

rename errorid to message-id

Browse source
This commit is contained in:
Joey Hess 2023-04-26 12:53:30 -04:00
parent b43da83a67
commit 4881bc5a53
No known key found for this signature in database
GPG key ID: DB12DB0FF05F8F38
4 changed files with 19 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
Messages.hs
View file

@ -27,7 +27,7 @@ module Messages (
showEndFail,
showEndResult,
endResult,
ErrorId(..),
MessageId(..),
toplevelFileProblem,
toplevelWarning,
warning,
@ -203,10 +203,10 @@ endResult False = "failed"
toplevelMsg :: StringContainingQuotedPath -> StringContainingQuotedPath
toplevelMsg = ("git-annex: " <>)
toplevelFileProblem :: Bool -> ErrorId -> StringContainingQuotedPath -> String -> RawFilePath -> Maybe Key -> SeekInput -> Annex ()
toplevelFileProblem makeway errorid msg action file mkey si = do
toplevelFileProblem :: Bool -> MessageId -> StringContainingQuotedPath -> String -> RawFilePath -> Maybe Key -> SeekInput -> Annex ()
toplevelFileProblem makeway messageid msg action file mkey si = do
maybeShowJSON' $ JSON.start action (Just file) mkey si
maybeShowJSON' $ JSON.errorid errorid
maybeShowJSON' $ JSON.messageid messageid
warning' makeway id (toplevelMsg (QuotedPath file <> " " <> msg))
maybeShowJSON' $ JSON.end False

10
Messages/JSON.hs
View file

@ -20,7 +20,7 @@ module Messages.JSON (
addErrorMessage,
note,
info,
errorid,
messageid,
add,
complete,
progress,
@ -70,7 +70,7 @@ emit' b = do
putMVar emitLock ()
-- Building up a JSON object can be done by first using start,
-- then add and note and errorid any number of times, and finally
-- then add and note and messageid any number of times, and finally
-- complete.
type JSONBuilder = Maybe (Object, Bool) -> Maybe (Object, Bool)
@ -115,9 +115,9 @@ note s (Just (o, e)) = Just (HM.unionWith combinelines (HM.singleton "note" (toJ
String (old <> "\n" <> new)
combinelines new _old = new
errorid :: ErrorId -> JSONBuilder
errorid _ Nothing = Nothing
errorid eid (Just (o, e)) = Just (HM.unionWith replaceold (HM.singleton "errorid" (toJSON' (show eid))) o, e)
messageid :: MessageId -> JSONBuilder
messageid _ Nothing = Nothing
messageid mid (Just (o, e)) = Just (HM.unionWith replaceold (HM.singleton "message-id" (toJSON' (show mid))) o, e)
where
replaceold new _old = new

4
Types/Messages.hs
View file

@ -85,8 +85,8 @@ data SerializedOutputResponse
= ReadyPrompt
deriving (Eq, Show)
-- | Error identifiers. Avoid changing these.
data ErrorId
-- | Message identifiers. Avoid changing these.
data MessageId
= FileNotFound
| FileBeyondSymbolicLink
deriving (Show)

8
doc/todo/api_for_telling_when_nonexistant_or_non_git_files_passed/comment_10_32ebb1ea1278b891b58dd3c4a8546453._comment Normal file
View file

@ -0,0 +1,8 @@
[[!comment format=mdwn
username="joey"
subject="""comment 10"""
date="2023-04-26T16:42:24Z"
content="""
I decided to rename it "message-id" since it could go on warning or other
messages too conceivably.
"""]]