Merge branch 'release/0.2.0'

README.md

@@ -29,7 +29,9 @@ A `.cmt` file consist of two parts: the input parts and the output format.
 For example, the [AngularJS Commit Message Guidelines](https://gist.github.com/stephenparish/9941e89d80e2bc58a153):
 
 ```txt
+# The input parts
 {
+    # Shows a list of options
     "Type" = [
         "feat",
         "fix",
@@ -39,12 +41,15 @@ For example, the [AngularJS Commit Message Guidelines](https://gist.github.com/s
         "test",
         "chore"
     ]
-    "Scope" = @
+    "Scope" = @ # Allows a single line of input
     "Subject" = @
-    "Body" = !@
+    "Body" = !@ # Allows multi-line input
     "Footer" = !@
 }
 
+# The output format
+# Takes the values provided from the input stage
+# and interpolates them in
 ${Type} (${Scope}): ${Subject}
 
 ${Body}
@@ -70,10 +75,13 @@ You can accept a output called `${*}`, which will add in whatever is passed to `
 For example:
 
 ```txt
+# Input parts
+# * input not needed, as comes from command-line
 {
     "Scope" = @
 }
 
+# Scope from input and * from command-line
 (${Scope}): ${*}
 ```
 

package.yaml

@@ -1,5 +1,5 @@
 name:                cmt
-version:             0.1.3.0
+version:             0.2.0.0
 github:              "smallhadroncollider/cmt"
 license:             BSD3
 author:              "Small Hadron Collider / Mark Wales"
@@ -51,6 +51,7 @@ tests:
     - -with-rtsopts=-N
     dependencies:
     - cmt
+    - file-embed
     - tasty
     - tasty-discover
     - tasty-hunit

roadmap.md

@@ -2,15 +2,15 @@
 
 - pre-commit errors don't get displayed at all
     > Probably need to show stderr in some cases?
+- Extra new-line at the end of the output
 
 ## Features
 
+- Show options in flat list if short?
 - Store previous commit info if it fails
     > Store if commit fails. `cmt --prev` option?
 - List option?
     > Automatically adds a hyphen to each entry?
-- Add comments to .cmt
-- Show options in flat list if short?
 - Make parts optional
     > @? and !@? operators?
 - Option to show files that have changed
@@ -32,3 +32,4 @@
     > If ${*} detected, then say if no command line argument given
 - Should search up directories to find .cmt
 - Should support ~/.cmt for global option
+- Add comments to .cmt

src/Cmt/Parser/Config.hs

@@ -9,33 +9,52 @@ import ClassyPrelude
 
 import Data.Attoparsec.Text
 
-import Cmt.Parser.Attoparsec (chopt, lexeme, tnotChar)
 import Cmt.Types.Config
 
+-- useful bits
+lexeme :: Parser a -> Parser a
+lexeme p = skipSpace *> p <* skipSpace
+
+tchar :: Char -> Parser Text
+tchar ch = singleton <$> char ch
+
+chopt :: Char -> Parser Text
+chopt ch = option "" (tchar ch)
+
+tnotChar :: Char -> Parser Text
+tnotChar c = pack <$> many1 (notChar c)
+
+commentP :: Parser ()
+commentP = lexeme $ many' (char '#' *> many' (notChar '\n') *> char '\n') $> ()
+
+stripComments :: Parser a -> Parser a
+stripComments p = lexeme $ commentP *> p <* commentP
+
 word :: Parser Text
 word = pack <$> many1 (letter <|> space)
 
 valid :: [Name] -> Parser Text
 valid names = choice $ "*" : (string <$> names)
 
+-- format parts
 formatNamedP :: [Name] -> Parser FormatPart
 formatNamedP names = Named <$> (string "${" *> valid names <* char '}')
 
 formatLiteralP :: Parser FormatPart
 formatLiteralP = Literal <$> (singleton <$> anyChar)
 
 formatP :: [Name] -> Parser Format
-formatP names = lexeme $ many1 (formatNamedP names <|> formatLiteralP)
+formatP names = stripComments $ many1 (formatNamedP names <|> formatLiteralP)
 
--- part types
+-- input parts
 lineP :: Parser PartType
 lineP = char '@' $> Line
 
 linesP :: Parser PartType
 linesP = string "!@" $> Lines
 
 listItemP :: Parser Text
-listItemP = lexeme $ char '"' *> tnotChar '"' <* char '"' <* chopt ','
+listItemP = stripComments $ char '"' *> tnotChar '"' <* char '"' <* chopt ','
 
 listP :: Parser PartType
 listP = Options <$> (char '[' *> many' listItemP <* char ']')
@@ -46,10 +65,10 @@ nameP = char '"' *> word <* char '"' <* lexeme (char '=')
 
 -- part
 partP :: Parser Part
-partP = lexeme $ Part <$> nameP <*> (listP <|> lineP <|> linesP)
+partP = stripComments $ Part <$> nameP <*> (listP <|> lineP <|> linesP)
 
 partsP :: Parser [Part]
-partsP = lexeme $ char '{' *> many' partP <* char '}'
+partsP = stripComments $ stripComments (char '{') *> many' partP <* stripComments (char '}')
 
 configP :: Parser Config
 configP = do

src/Cmt/Types/Config.hs

@@ -2,7 +2,7 @@
 
 module Cmt.Types.Config where
 
-import ClassyPrelude (Maybe (..), Show, Text)
+import ClassyPrelude (Eq, Maybe (..), Show, Text)
 
 type Output = (Name, Text)
 
@@ -11,25 +11,25 @@ type Name = Text
 data FormatPart
     = Named Name
     | Literal Text
-    deriving (Show)
+    deriving (Show, Eq)
 
 type Format = [FormatPart]
 
 data PartType
     = Options [Text]
     | Line
     | Lines
-    deriving (Show)
+    deriving (Show, Eq)
 
 data Part =
     Part Name
          PartType
-    deriving (Show)
+    deriving (Show, Eq)
 
 data Config =
     Config [Part]
            Format
-    deriving (Show)
+    deriving (Show, Eq)
 
 partName :: Part -> Name
 partName (Part name _) = name

test/Cmt/Parser/ConfigTest.hs

@@ -0,0 +1,66 @@
+{-# LANGUAGE NoImplicitPrelude #-}
+{-# LANGUAGE OverloadedStrings #-}
+{-# LANGUAGE TemplateHaskell #-}
+
+module Cmt.Parser.ConfigTest where
+
+import ClassyPrelude
+
+import Test.Tasty
+import Test.Tasty.HUnit
+
+import Data.FileEmbed (embedFile)
+
+import Cmt.Parser.Config (config)
+import Cmt.Types.Config
+
+basic :: Text
+basic = decodeUtf8 $(embedFile "test/data/.cmt")
+
+basicConfig :: Config
+basicConfig =
+    Config [Part "Week" Line] [Named "Week", Literal ":", Literal " ", Named "*", Literal "\n"]
+
+angular :: Text
+angular = decodeUtf8 $(embedFile "test/data/.cmt-angular")
+
+comments :: Text
+comments = decodeUtf8 $(embedFile "test/data/.cmt-comments")
+
+angularConfig :: Config
+angularConfig =
+    Config
+        [ Part "Type" (Options ["feat", "fix", "docs", "style", "refactor", "test", "chore"])
+        , Part "Scope" Line
+        , Part "Short Message" Line
+        , Part "Body" Lines
+        ]
+        [ Named "Type"
+        , Literal " "
+        , Literal "("
+        , Named "Scope"
+        , Literal ")"
+        , Literal ":"
+        , Literal " "
+        , Named "Short Message"
+        , Literal "\n"
+        , Literal "\n"
+        , Named "Body"
+        , Literal "\n"
+        ]
+
+-- import Test.Tasty.HUnit
+test_config :: TestTree
+test_config =
+    testGroup
+        "Cmt.Parser.Config"
+        [ testCase
+              "basic"
+              (assertEqual "Gives back correct format" (Right basicConfig) (config basic))
+        , testCase
+              "angular"
+              (assertEqual "Gives back correct format" (Right angularConfig) (config angular))
+        , testCase
+              "comments"
+              (assertEqual "Gives back correct format" (Right angularConfig) (config comments))
+        ]

test/Spec.hs

@@ -0,0 +1 @@
+{-# OPTIONS_GHC -F -pgmF tasty-discover #-}

test/data/.cmt

@@ -0,0 +1,5 @@
+{
+    "Week" = @
+}
+
+${Week}: ${*}

test/data/.cmt-angular

@@ -0,0 +1,18 @@
+{
+    "Type" = [
+        "feat",
+        "fix",
+        "docs",
+        "style",
+        "refactor",
+        "test",
+        "chore"
+    ]
+    "Scope" = @
+    "Short Message" = @
+    "Body" = !@
+}
+
+${Type} (${Scope}): ${Short Message}
+
+${Body}

test/data/.cmt-comments

@@ -0,0 +1,28 @@
+# The input parts
+# Blah blah blah
+#
+# Blah blah blah
+
+# Blah blah blah
+{ # A comment
+    # A list of stuff
+    "Type" = [ # A list of options
+        "feat",
+        "fix",
+        "docs",
+        "style",
+        "refactor", ## A comment here too
+        "test",
+        "chore"
+    ] # A comment
+    # The scope
+    "Scope" = @ # Another comment
+    "Short Message" = @ # All the comments all the time
+    "Body" = !@ # So many comments!
+} # Another comment
+
+# Blah blah blah
+# Blah blah blah
+${Type} (${Scope}): ${Short Message}
+
+${Body}