aboutsummaryrefslogtreecommitdiffstats
path: root/app/TreeGrepper/Comment.hs
blob: 1a6aed2401af179a3f173653a015cdb9c572bad0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
module TreeGrepper.Comment
  ( Comment (..),
    getComments,
  )
where

import Control.Exception (throw)
import Data.Aeson qualified as A
import Data.ByteString.Lazy.Char8 qualified as B
import Data.Function ((&))
import Data.Text qualified as T
import Exception qualified as E
import GHC.Generics (Generic)
import Process (proc, sh)
import System.FilePath (takeExtension)
import System.Process.Typed (setWorkingDir)
import TreeGrepper.FileType (FileType (..))
import TreeGrepper.Match (Match (..), Position (..))
import TreeGrepper.Match qualified as G
import TreeGrepper.Result (Result (..))
import TreeGrepper.Result qualified as G

data Comment = Comment
  { -- result fields
    file :: String,
    file_type :: FileType,
    -- match fields
    kind :: String,
    name :: String,
    text :: T.Text,
    start :: Position,
    end :: Position
  }
  deriving (Show, Generic)

fromMatch :: Result -> Match -> Comment
fromMatch Result {..} Match {..} = Comment {..}

getComments :: FilePath -> FilePath -> IO [Comment]
getComments cwd fn = do
  let ext = takeExtension fn
  concatMap (\result -> map (fromMatch result) result.matches)
    . map fixTreeGrepper
    . decode
    <$> sh
      ( proc
          "tree-grepper --query % % --format json %"
          (treeGrepperLanguage ext)
          (treeGrepperQuery ext)
          fn
          & setWorkingDir cwd
      )

decode :: B.ByteString -> [Result]
decode = either (throw . E.InvalidTreeGrepperResult) id . A.eitherDecode

fixTreeGrepper :: G.Result -> G.Result
fixTreeGrepper treeGrepperResult =
  treeGrepperResult {G.matches = G.merge treeGrepperResult.matches}

treeGrepperLanguage :: String -> String
treeGrepperLanguage ext =
  -- TODO Add support for all tree-grepper supported files
  --
  -- tree-grepper supported files can be listed through `tree-grepper
  -- --languages`.
  --
  -- @backlog
  case ext of
    ".elm" -> "elm"
    ".hs" -> "haskell"
    ".nix" -> "nix"
    ".sh" -> "sh"
    _ -> throw (E.UnknownFileExtension ext)

treeGrepperQuery :: String -> String
treeGrepperQuery ext =
  case ext of
    ".elm" -> "([(line_comment) (block_comment)])"
    ".hs" -> "(comment)"
    ".nix" -> "(comment)"
    ".sh" -> "(comment)"
    _ -> throw (E.UnknownFileExtension ext)