diff --git a/yesod-core/ChangeLog.md b/yesod-core/ChangeLog.md index 7c2f446f..881c0e87 100644 --- a/yesod-core/ChangeLog.md +++ b/yesod-core/ChangeLog.md @@ -1,5 +1,9 @@ # ChangeLog for yesod-core +## 1.6.18.2 + +* Recommends `.yesodroutes` as the file extension for Yesod routes files. [#1686](https://github.com/yesodweb/yesod/pull/1686) + ## 1.6.18.1 * Increase the size of CSRF token diff --git a/yesod-core/src/Yesod/Routes/Parse.hs b/yesod-core/src/Yesod/Routes/Parse.hs index 7b0ea749..59d0afb1 100644 --- a/yesod-core/src/Yesod/Routes/Parse.hs +++ b/yesod-core/src/Yesod/Routes/Parse.hs @@ -35,9 +35,15 @@ parseRoutes = QuasiQuoter { quoteExp = x } [] -> lift res z -> error $ unlines $ "Overlapping routes: " : map show z +-- | Same as 'parseRoutes', but uses an external file instead of quasiquotation. +-- +-- The recommended file extension is @.yesodroutes@. parseRoutesFile :: FilePath -> Q Exp parseRoutesFile = parseRoutesFileWith parseRoutes +-- | Same as 'parseRoutesNoCheck', but uses an external file instead of quasiquotation. +-- +-- The recommended file extension is @.yesodroutes@. parseRoutesFileNoCheck :: FilePath -> Q Exp parseRoutesFileNoCheck = parseRoutesFileWith parseRoutesNoCheck diff --git a/yesod-core/test/RouteSpec.hs b/yesod-core/test/RouteSpec.hs index db8ac92d..d21867cc 100644 --- a/yesod-core/test/RouteSpec.hs +++ b/yesod-core/test/RouteSpec.hs @@ -227,7 +227,7 @@ main = hspec $ do describe "routing table parsing" $ do it "recognizes trailing backslashes as line continuation directives" $ do let routes :: [ResourceTree String] - routes = $(parseRoutesFile "test/fixtures/routes_with_line_continuations") + routes = $(parseRoutesFile "test/fixtures/routes_with_line_continuations.yesodroutes") length routes @?= 3 describe "overlap checking" $ do diff --git a/yesod-core/test/fixtures/routes_with_line_continuations b/yesod-core/test/fixtures/routes_with_line_continuations.yesodroutes similarity index 100% rename from yesod-core/test/fixtures/routes_with_line_continuations rename to yesod-core/test/fixtures/routes_with_line_continuations.yesodroutes diff --git a/yesod-core/yesod-core.cabal b/yesod-core/yesod-core.cabal index 642b019a..86f030f0 100644 --- a/yesod-core/yesod-core.cabal +++ b/yesod-core/yesod-core.cabal @@ -1,5 +1,5 @@ name: yesod-core -version: 1.6.18.1 +version: 1.6.18.2 license: MIT license-file: LICENSE author: Michael Snoyman