hakyll-shortcut-links (empty) → 0.0.0.0
raw patch · 9 files changed
+986/−0 lines, 9 filesdep +basedep +hakylldep +hakyll-shortcut-links
Dependencies added: base, hakyll, hakyll-shortcut-links, hspec, megaparsec, mtl, pandoc, pandoc-types, shortcut-links, text
Files
- CHANGELOG.md +11/−0
- LICENSE +373/−0
- README.md +114/−0
- hakyll-shortcut-links.cabal +101/−0
- src/Hakyll/ShortcutLinks.hs +214/−0
- src/Hakyll/ShortcutLinks/Parser.hs +61/−0
- test/Spec.hs +12/−0
- test/Test/Links.hs +67/−0
- test/Test/Parser.hs +33/−0
+ CHANGELOG.md view
@@ -0,0 +1,11 @@+# Changelog++`hakyll-shortcut-links` uses [PVP Versioning][1].+The changelog is available [on GitHub][2].++## 0.0.0.0 — May 2, 2019++* Initially created.++[1]: https://pvp.haskell.org+[2]: https://github.com/kowainik/hakyll-shortcut-links/releases
+ LICENSE view
@@ -0,0 +1,373 @@+Mozilla Public License Version 2.0+==================================++1. Definitions+--------------++1.1. "Contributor"+ means each individual or legal entity that creates, contributes to+ the creation of, or owns Covered Software.++1.2. "Contributor Version"+ means the combination of the Contributions of others (if any) used+ by a Contributor and that particular Contributor's Contribution.++1.3. "Contribution"+ means Covered Software of a particular Contributor.++1.4. "Covered Software"+ means Source Code Form to which the initial Contributor has attached+ the notice in Exhibit A, the Executable Form of such Source Code+ Form, and Modifications of such Source Code Form, in each case+ including portions thereof.++1.5. "Incompatible With Secondary Licenses"+ means++ (a) that the initial Contributor has attached the notice described+ in Exhibit B to the Covered Software; or++ (b) that the Covered Software was made available under the terms of+ version 1.1 or earlier of the License, but not also under the+ terms of a Secondary License.++1.6. "Executable Form"+ means any form of the work other than Source Code Form.++1.7. "Larger Work"+ means a work that combines Covered Software with other material, in+ a separate file or files, that is not Covered Software.++1.8. "License"+ means this document.++1.9. "Licensable"+ means having the right to grant, to the maximum extent possible,+ whether at the time of the initial grant or subsequently, any and+ all of the rights conveyed by this License.++1.10. "Modifications"+ means any of the following:++ (a) any file in Source Code Form that results from an addition to,+ deletion from, or modification of the contents of Covered+ Software; or++ (b) any new file in Source Code Form that contains any Covered+ Software.++1.11. "Patent Claims" of a Contributor+ means any patent claim(s), including without limitation, method,+ process, and apparatus claims, in any patent Licensable by such+ Contributor that would be infringed, but for the grant of the+ License, by the making, using, selling, offering for sale, having+ made, import, or transfer of either its Contributions or its+ Contributor Version.++1.12. "Secondary License"+ means either the GNU General Public License, Version 2.0, the GNU+ Lesser General Public License, Version 2.1, the GNU Affero General+ Public License, Version 3.0, or any later versions of those+ licenses.++1.13. "Source Code Form"+ means the form of the work preferred for making modifications.++1.14. "You" (or "Your")+ means an individual or a legal entity exercising rights under this+ License. For legal entities, "You" includes any entity that+ controls, is controlled by, or is under common control with You. For+ purposes of this definition, "control" means (a) the power, direct+ or indirect, to cause the direction or management of such entity,+ whether by contract or otherwise, or (b) ownership of more than+ fifty percent (50%) of the outstanding shares or beneficial+ ownership of such entity.++2. License Grants and Conditions+--------------------------------++2.1. Grants++Each Contributor hereby grants You a world-wide, royalty-free,+non-exclusive license:++(a) under intellectual property rights (other than patent or trademark)+ Licensable by such Contributor to use, reproduce, make available,+ modify, display, perform, distribute, and otherwise exploit its+ Contributions, either on an unmodified basis, with Modifications, or+ as part of a Larger Work; and++(b) under Patent Claims of such Contributor to make, use, sell, offer+ for sale, have made, import, and otherwise transfer either its+ Contributions or its Contributor Version.++2.2. Effective Date++The licenses granted in Section 2.1 with respect to any Contribution+become effective for each Contribution on the date the Contributor first+distributes such Contribution.++2.3. Limitations on Grant Scope++The licenses granted in this Section 2 are the only rights granted under+this License. No additional rights or licenses will be implied from the+distribution or licensing of Covered Software under this License.+Notwithstanding Section 2.1(b) above, no patent license is granted by a+Contributor:++(a) for any code that a Contributor has removed from Covered Software;+ or++(b) for infringements caused by: (i) Your and any other third party's+ modifications of Covered Software, or (ii) the combination of its+ Contributions with other software (except as part of its Contributor+ Version); or++(c) under Patent Claims infringed by Covered Software in the absence of+ its Contributions.++This License does not grant any rights in the trademarks, service marks,+or logos of any Contributor (except as may be necessary to comply with+the notice requirements in Section 3.4).++2.4. Subsequent Licenses++No Contributor makes additional grants as a result of Your choice to+distribute the Covered Software under a subsequent version of this+License (see Section 10.2) or under the terms of a Secondary License (if+permitted under the terms of Section 3.3).++2.5. Representation++Each Contributor represents that the Contributor believes its+Contributions are its original creation(s) or it has sufficient rights+to grant the rights to its Contributions conveyed by this License.++2.6. Fair Use++This License is not intended to limit any rights You have under+applicable copyright doctrines of fair use, fair dealing, or other+equivalents.++2.7. Conditions++Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted+in Section 2.1.++3. Responsibilities+-------------------++3.1. Distribution of Source Form++All distribution of Covered Software in Source Code Form, including any+Modifications that You create or to which You contribute, must be under+the terms of this License. You must inform recipients that the Source+Code Form of the Covered Software is governed by the terms of this+License, and how they can obtain a copy of this License. You may not+attempt to alter or restrict the recipients' rights in the Source Code+Form.++3.2. Distribution of Executable Form++If You distribute Covered Software in Executable Form then:++(a) such Covered Software must also be made available in Source Code+ Form, as described in Section 3.1, and You must inform recipients of+ the Executable Form how they can obtain a copy of such Source Code+ Form by reasonable means in a timely manner, at a charge no more+ than the cost of distribution to the recipient; and++(b) You may distribute such Executable Form under the terms of this+ License, or sublicense it under different terms, provided that the+ license for the Executable Form does not attempt to limit or alter+ the recipients' rights in the Source Code Form under this License.++3.3. Distribution of a Larger Work++You may create and distribute a Larger Work under terms of Your choice,+provided that You also comply with the requirements of this License for+the Covered Software. If the Larger Work is a combination of Covered+Software with a work governed by one or more Secondary Licenses, and the+Covered Software is not Incompatible With Secondary Licenses, this+License permits You to additionally distribute such Covered Software+under the terms of such Secondary License(s), so that the recipient of+the Larger Work may, at their option, further distribute the Covered+Software under the terms of either this License or such Secondary+License(s).++3.4. Notices++You may not remove or alter the substance of any license notices+(including copyright notices, patent notices, disclaimers of warranty,+or limitations of liability) contained within the Source Code Form of+the Covered Software, except that You may alter any license notices to+the extent required to remedy known factual inaccuracies.++3.5. Application of Additional Terms++You may choose to offer, and to charge a fee for, warranty, support,+indemnity or liability obligations to one or more recipients of Covered+Software. However, You may do so only on Your own behalf, and not on+behalf of any Contributor. You must make it absolutely clear that any+such warranty, support, indemnity, or liability obligation is offered by+You alone, and You hereby agree to indemnify every Contributor for any+liability incurred by such Contributor as a result of warranty, support,+indemnity or liability terms You offer. You may include additional+disclaimers of warranty and limitations of liability specific to any+jurisdiction.++4. Inability to Comply Due to Statute or Regulation+---------------------------------------------------++If it is impossible for You to comply with any of the terms of this+License with respect to some or all of the Covered Software due to+statute, judicial order, or regulation then You must: (a) comply with+the terms of this License to the maximum extent possible; and (b)+describe the limitations and the code they affect. Such description must+be placed in a text file included with all distributions of the Covered+Software under this License. Except to the extent prohibited by statute+or regulation, such description must be sufficiently detailed for a+recipient of ordinary skill to be able to understand it.++5. Termination+--------------++5.1. The rights granted under this License will terminate automatically+if You fail to comply with any of its terms. However, if You become+compliant, then the rights granted under this License from a particular+Contributor are reinstated (a) provisionally, unless and until such+Contributor explicitly and finally terminates Your grants, and (b) on an+ongoing basis, if such Contributor fails to notify You of the+non-compliance by some reasonable means prior to 60 days after You have+come back into compliance. Moreover, Your grants from a particular+Contributor are reinstated on an ongoing basis if such Contributor+notifies You of the non-compliance by some reasonable means, this is the+first time You have received notice of non-compliance with this License+from such Contributor, and You become compliant prior to 30 days after+Your receipt of the notice.++5.2. If You initiate litigation against any entity by asserting a patent+infringement claim (excluding declaratory judgment actions,+counter-claims, and cross-claims) alleging that a Contributor Version+directly or indirectly infringes any patent, then the rights granted to+You by any and all Contributors for the Covered Software under Section+2.1 of this License shall terminate.++5.3. In the event of termination under Sections 5.1 or 5.2 above, all+end user license agreements (excluding distributors and resellers) which+have been validly granted by You or Your distributors under this License+prior to termination shall survive termination.++************************************************************************+* *+* 6. Disclaimer of Warranty *+* ------------------------- *+* *+* Covered Software is provided under this License on an "as is" *+* basis, without warranty of any kind, either expressed, implied, or *+* statutory, including, without limitation, warranties that the *+* Covered Software is free of defects, merchantable, fit for a *+* particular purpose or non-infringing. The entire risk as to the *+* quality and performance of the Covered Software is with You. *+* Should any Covered Software prove defective in any respect, You *+* (not any Contributor) assume the cost of any necessary servicing, *+* repair, or correction. This disclaimer of warranty constitutes an *+* essential part of this License. No use of any Covered Software is *+* authorized under this License except under this disclaimer. *+* *+************************************************************************++************************************************************************+* *+* 7. Limitation of Liability *+* -------------------------- *+* *+* Under no circumstances and under no legal theory, whether tort *+* (including negligence), contract, or otherwise, shall any *+* Contributor, or anyone who distributes Covered Software as *+* permitted above, be liable to You for any direct, indirect, *+* special, incidental, or consequential damages of any character *+* including, without limitation, damages for lost profits, loss of *+* goodwill, work stoppage, computer failure or malfunction, or any *+* and all other commercial damages or losses, even if such party *+* shall have been informed of the possibility of such damages. This *+* limitation of liability shall not apply to liability for death or *+* personal injury resulting from such party's negligence to the *+* extent applicable law prohibits such limitation. Some *+* jurisdictions do not allow the exclusion or limitation of *+* incidental or consequential damages, so this exclusion and *+* limitation may not apply to You. *+* *+************************************************************************++8. Litigation+-------------++Any litigation relating to this License may be brought only in the+courts of a jurisdiction where the defendant maintains its principal+place of business and such litigation shall be governed by laws of that+jurisdiction, without reference to its conflict-of-law provisions.+Nothing in this Section shall prevent a party's ability to bring+cross-claims or counter-claims.++9. Miscellaneous+----------------++This License represents the complete agreement concerning the subject+matter hereof. If any provision of this License is held to be+unenforceable, such provision shall be reformed only to the extent+necessary to make it enforceable. Any law or regulation which provides+that the language of a contract shall be construed against the drafter+shall not be used to construe this License against a Contributor.++10. Versions of the License+---------------------------++10.1. New Versions++Mozilla Foundation is the license steward. Except as provided in Section+10.3, no one other than the license steward has the right to modify or+publish new versions of this License. Each version will be given a+distinguishing version number.++10.2. Effect of New Versions++You may distribute the Covered Software under the terms of the version+of the License under which You originally received the Covered Software,+or under the terms of any subsequent version published by the license+steward.++10.3. Modified Versions++If you create software not governed by this License, and you want to+create a new license for such software, you may create and use a+modified version of this License if you rename the license and remove+any references to the name of the license steward (except to note that+such modified license differs from this License).++10.4. Distributing Source Code Form that is Incompatible With Secondary+Licenses++If You choose to distribute Source Code Form that is Incompatible With+Secondary Licenses under the terms of this version of the License, the+notice described in Exhibit B of this License must be attached.++Exhibit A - Source Code Form License Notice+-------------------------------------------++ This Source Code Form is subject to the terms of the Mozilla Public+ License, v. 2.0. If a copy of the MPL was not distributed with this+ file, You can obtain one at http://mozilla.org/MPL/2.0/.++If it is not possible or desirable to put the notice in a particular+file, then You may include the notice in a location (such as a LICENSE+file in a relevant directory) where a recipient would be likely to look+for such a notice.++You may add additional accurate notices of copyright ownership.++Exhibit B - "Incompatible With Secondary Licenses" Notice+---------------------------------------------------------++ This Source Code Form is "Incompatible With Secondary Licenses", as+ defined by the Mozilla Public License, v. 2.0.
+ README.md view
@@ -0,0 +1,114 @@+# hakyll-shortcut-links+++[](https://hackage.haskell.org/package/hakyll-shortcut-links)+[](LICENSE)+[](https://travis-ci.org/kowainik/hakyll-shortcut-links)++This library adds the support of the+[`shortcut-links`](https://hackage.haskell.org/package/shortcut-links) library+in the static website generator library —+[`Hakyll`](https://hackage.haskell.org/package/hakyll).++That being said, it means that you can use shortcuts from `shortcut-links`+library or custom ones in your markdown files which would be extended into+complete URLs during the Hakyll site compilation process.++Here is the example of how links could look like before expansion:++```+Here is going to be a link to the [hakyll-shortcut-links](@hackage) library on Hackage.+And another link to the [GitHub sources](@github(kowainik):hakyll-shortcut-links).+```++which is going to be transformed into the ordinary links automatically by the+library functions:++```+Here is going to be a link to the [hakyll-shortcut-links](http://hackage.haskell.org/package/hakyll-shortcut-links) library on Hackage.+And another link to the [GitHub sources](https://github.com/kowainik/hakyll-shortcut-links).+```+For the full list of the supported shortcuts, you can check+[ShortcutLinks.All module](https://hackage.haskell.org/package/shortcut-links/docs/ShortcutLinks-All.html)+of the `shortcut-links` library.++## How to use in a Hakyll project++To use `hakyll-shortcut-links` in your ready Hakyll project, you would need to+go through the following steps:++### Add the dependency++Add `hakyll-shortcut-links` under the `build-depends` section in your `.cabal`+file.+If you use `Stack` build tool, you would need to add the library into+`extra-deps` list in the `stack.yaml` file.++### Change a standard pandocCompiler++Here we assume that you already have a Hakyll project. If not then you can use+[these tutorials](https://jaspervdj.be/hakyll/tutorials.html) to create one.+Anyway, you would eventually have the code that uses `pandocCompiler` that could+look like this function:++```haskell+compile $+ pandocCompiler >>= loadAndApplyTemplate "templates/post.html" postCtx+```++All you need to change is to use `allShortcutLinksCompiler` or+`shortcutLinksCompiler` function from this library instead of the standard+`pandocCompiler`:++```haskell+import Hakyll.ShortcutLinks (allShortcutLinksCompiler)++...++compile $+ allShortcutLinksCompiler >>= loadAndApplyTemplate "templates/post.html" postCtx+```++That's all!++There could be another situation. You could already have some custom Compiler+function:++```haskell+-- | A pandoc compiler which makes all entries of "42" bold automatically.+bold42Compiler :: Compiler (Item String)+bold42Compiler = pandocCompilerWithTransform+ myHakyllReaderOptions+ myHakyllWriterOptions+ make42Bold+```++In this case, you can use the `applyAllShortcuts` function directly. All you+need is to combine two transformations:++```haskell+myCompiler :: Compiler (Item String)+myCompiler = pandocCompilerWithTransformM+ myHakyllReaderOptions+ myHakyllWriterOptions+ (applyAllShortcuts . make42Bold)+```++### Use shortcuts in your docs++The hardest part is done, now you can create links using the shortcuts, and the+Hakyll is going to build full URLs for them. Happy coding!++### Example++Here is an example of the pull request that introduces the+`hakyll-shortcut-links` library into the scope:++* [Some Hakyll website](https://github.com/vrom911/vrom911.github.io/pull/32)++As you can see by the diff the only actual change needed for that was replacing+`pandocCompiler` with `allShortcutLinksCompiler`.++## Acknowledgement++Icons made by [Freepik](http://www.freepik.com) from [www.flaticon.com](https://www.flaticon.com/) is licensed by [CC 3.0 BY](http://creativecommons.org/licenses/by/3.0/).
+ hakyll-shortcut-links.cabal view
@@ -0,0 +1,101 @@+cabal-version: 2.0+name: hakyll-shortcut-links+version: 0.0.0.0+synopsis: Use shortcut-links in markdown file for Hakyll+description: Use shortcut-links in markdown file for Hakyll. See README for more details.+homepage: https://github.com/kowainik/hakyll-shortcut-links+bug-reports: https://github.com/kowainik/hakyll-shortcut-links/issues+license: MPL-2.0+license-file: LICENSE+author: Kowainik+maintainer: xrom.xkov@gmail.com+copyright: 2019 Kowainik+category: Web, Hakyll, Markdown+build-type: Simple+extra-doc-files: README.md+ , CHANGELOG.md+tested-with: GHC == 8.6.3++source-repository head+ type: git+ location: https://github.com/kowainik/hakyll-shortcut-links.git++library+ hs-source-dirs: src+ exposed-modules: Hakyll.ShortcutLinks+ Hakyll.ShortcutLinks.Parser++ build-depends: base ^>= 4.12.0.0+ , hakyll ^>= 4.12.5+ , megaparsec ^>= 7.0.4+ , mtl ^>= 2.2.2+ , pandoc-types ^>= 1.17+ , shortcut-links ^>= 0.4.2.1+ , text ^>= 1.2++ ghc-options: -Wall+ -Wincomplete-uni-patterns+ -Wincomplete-record-updates+ -Wcompat+ -Widentities+ -Wredundant-constraints+ -fhide-source-paths+ -Wmissing-export-lists+ -Wpartial-fields++ default-language: Haskell2010+ default-extensions: ConstraintKinds+ DeriveGeneric+ GeneralizedNewtypeDeriving+ InstanceSigs+ KindSignatures+ LambdaCase+ OverloadedStrings+ RecordWildCards+ ScopedTypeVariables+ StandaloneDeriving+ TupleSections+ TypeApplications+ ViewPatterns++test-suite hakyll-shortcut-links-test+ type: exitcode-stdio-1.0+ hs-source-dirs: test+ main-is: Spec.hs+ other-modules: Test.Links+ Test.Parser++ build-depends: base ^>= 4.12.0.0+ , hakyll-shortcut-links+ , hspec ^>= 2.7.1+ , mtl+ , pandoc >= 2.6+ , text++ ghc-options: -Wall+ -threaded+ -rtsopts+ -with-rtsopts=-N+ -Wincomplete-uni-patterns+ -Wincomplete-record-updates+ -Wcompat+ -Widentities+ -Wredundant-constraints+ -fhide-source-paths+ -Wmissing-export-lists+ -Wpartial-fields++ default-language: Haskell2010+ default-extensions: ConstraintKinds+ DeriveGeneric+ GeneralizedNewtypeDeriving+ InstanceSigs+ KindSignatures+ LambdaCase+ OverloadedStrings+ RecordWildCards+ ScopedTypeVariables+ StandaloneDeriving+ TupleSections+ TypeApplications+ ViewPatterns
+ src/Hakyll/ShortcutLinks.hs view
@@ -0,0 +1,214 @@+{-# LANGUAGE FlexibleContexts #-}++{- |+Copyright: (c) 2019 Kowainik+License: MPL-2.0+Maintainer: Kowainik <xrom.xkov@gmail.com>++This package allows to use [shortcut-links](https://hackage.haskell.org/package/shortcut-links)+package in websites generated by [hakyll](https://hackage.haskell.org/package/hakyll).++The flexible interface allows to use the supported huge collection of shortcuts+along with using custom ones.+-}++module Hakyll.ShortcutLinks+ ( -- * Pandoc functions+ -- $pandoc+ applyShortcuts+ , applyAllShortcuts++ -- * Hakyll functions+ -- $hakyll+ , shortcutLinksCompiler+ , allShortcutLinksCompiler++ -- * Shortcut-links reexports+ -- $sh+ , module Sh+ -- $allSh+ , module ShortcutLinks.All+ ) where++import Control.Monad.Except (MonadError (..))+import Data.Text (Text)+import Hakyll (Compiler, Item, defaultHakyllReaderOptions, defaultHakyllWriterOptions,+ pandocCompilerWithTransformM)+import ShortcutLinks (Result (..), Shortcut, allShortcuts, useShortcutFrom)+import Text.Pandoc.Generic (bottomUpM)++import Hakyll.ShortcutLinks.Parser (parseShortcut)++-- exports+import ShortcutLinks as Sh+import ShortcutLinks.All++import qualified Data.Text as T+import qualified Text.Pandoc.Definition as Pandoc+++{- $pandoc+Functions to transform 'Pandoc.Pandoc' documents. These functions modify+markdown links to the extended links.++These are the most generic functions. They work inside the monad @m@ that has+@'MonadError' ['String']@ instance.+You can use the pure version of these function because there's 'MonadError'+instance for 'Either':++@+applyShorcuts :: [(['Text'], 'Shortcut')] -> 'Pandoc.Pandoc' -> 'Either' ['String'] 'Pandoc.Pandoc'+applyAllShorcuts :: 'Pandoc.Pandoc' -> 'Either' ['String'] 'Pandoc.Pandoc'+@++If you have your own @hakyll@ options for your custom pandoc compiler, you can+use this function like this:++@+'pandocCompilerWithTransformM'+ myHakyllReaderOptions+ myHakyllWriterOptions+ ('applyShortcuts' myShortcuts)+@+++-}++{- | Modifies markdown shortcut links to the extended version and returns+'Pandoc.Pandoc' with the complete links instead.++Unlike 'applyAllShortcuts' which uses the hardcoded list of the possible+shortcuts (see 'allShortcuts'), the 'applyShortcuts' function uses the given+list of custom provided shortcuts.+For your help you can use 'ShortcutLinks.All' module to see all available+shortcuts.++If you want to add a couple of custom shortcuts to the list of already existing+shortcuts you can do it in the following way:++@+(["hk", "hackage"], 'hackage') : 'allShortcuts'+@+-}+applyShortcuts+ :: forall m . MonadError [String] m+ => [([Text], Shortcut)] -- ^ Shortcuts+ -> Pandoc.Pandoc -- ^ Pandoc document that possibly contains shortened links+ -> m Pandoc.Pandoc -- ^ Result pandoc document with shorcuts expanded+applyShortcuts shortcuts = bottomUpM applyLink+ where+ applyLink :: Pandoc.Inline -> m Pandoc.Inline+ applyLink l@(Pandoc.Link attr inl (url, title)) = case parseShortcut $ T.pack url of+ Right (name, option, text) -> maybe (checkTitle inl) pure text >>= \txtTitle ->+ case useShortcutFrom shortcuts name option txtTitle of+ Success link -> pure $ Pandoc.Link attr inl (T.unpack link, title)+ Warning ws _ -> throwError ws+ Failure msg -> throwError [msg]+ Left _ -> pure l -- the link is not shortcut+ applyLink other = pure other++ checkTitle :: [Pandoc.Inline] -> m Text+ checkTitle = \case+ [] -> throwError ["Empty shortcut link title arguments"]+ [Pandoc.Str s] -> pure $ T.pack s+ _ -> throwError ["Shortcut title is not a single string element"]++{- | Modifies markdown shortcut links to the extended version and returns+'Pandoc.Pandoc' with the complete links instead.++Similar to 'applyShortcuts' but uses 'allShortcuts' as a list of shortcuts to+parse against.+-}+applyAllShortcuts :: MonadError [String] m => Pandoc.Pandoc -> m Pandoc.Pandoc+applyAllShortcuts = applyShortcuts allShortcuts++{- $hakyll+Functions to integrate shortcut links to [hakyll](http://hackage.haskell.org/package/hakyll).++@hakyll-shortcut-links@ provides out-of-the-box 'Compiler's that translate+markdown documents with shortcut links into the documents with extended links.++Usually you would want to use this feature on your blog post markdown files.+Assuming that you already have similar code for it:++@+match "blog/*" $ do+ route $ setExtension "html"+ compile $+ __pandocCompiler__+ >>= loadAndApplyTemplate "templates/post.html" defaultContext+ >>= relativizeUrls+@++All that you would need to do is to replace 'Hakyll.pandocCompiler' with+'shortcutLinksCompiler' or 'allShortcutLinksCompiler':++@+match "blog/*" $ do+ route $ setExtension "html"+ compile $+ __'allShortcutLinksCompiler'__+ >>= loadAndApplyTemplate "templates/post.html" defaultContext+ >>= relativizeUrls+@++-}++{- | Our own pandoc compiler which parses shortcut links automatically.+It takes a custom list of shortcut links to be used in the document.+-}+shortcutLinksCompiler :: [([Text], Shortcut)] -> Compiler (Item String)+shortcutLinksCompiler = pandocCompilerWithTransformM+ defaultHakyllReaderOptions+ defaultHakyllWriterOptions+ . applyShortcuts++{- | Our own pandoc compiler which parses shortcut links automatically. Same as+'shortcutLinksCompiler' but passes 'allShortcuts' as an argument.+-}+allShortcutLinksCompiler :: Compiler (Item String)+allShortcutLinksCompiler = shortcutLinksCompiler allShortcuts++{- $sh+This is the module from @shortcut-links@ library that introduces the functions+that by given shortcuts creates the 'Result'ing URL (if possible).+-}++{- $allSh+This module stores a large number of supported 'Shortcut's.+It also reexports a useful function 'allShortcuts' that is a list of all+shortcuts, together with suggested names for them.++In @hakyll-shortcut-links@ we are exporting both functions that work with the+standard list of 'allShortcuts', but also we provide the option to use your own+lists of shortcuts (including self-created ones).++For example, if you want to use just 'github' and 'hackage' shortcuts you can+create the following list:++@+(["github"], github) : (["hackage"], hackage) : []+@++If you want to create your own shortcut that is not included in+"ShortcutLinks.All" module you can achieve that implementing the following+function:++@+kowainik :: 'Shortcut'+kowainik _ text = pure $ "https://kowainik.github.io/posts/" <> text++myShortcuts :: [(['Text'], 'Shortcut')]+myShortcuts = [(["kowainik"], kowainik)]+@++And it would work like this:++@+[blog post]\(@kowainik:2019-02-06-style-guide)++=>++[blog post]\(https:\/\/kowainik.github.io\/posts\/2019-02-06-style-guide)+@+-}
+ src/Hakyll/ShortcutLinks/Parser.hs view
@@ -0,0 +1,61 @@+{- |+Copyright: (c) 2019 Kowainik+License: MPL-2.0+Maintainer: Kowainik <xrom.xkov@gmail.com>++This module implements parser of the shortcut links that are introduced in the+[shortcut-links](https://hackage.haskell.org/package/shortcut-links) package.++The markdown example of the shortcut link:++@+[This project]\(\@github(Kowainik):hakyll-shortcut-links)+@++The implemented parser should parse the @url@ part of the link.+In this example the parsed links would look like this:++>>> parseShortcut "@github(Kowainik):hakyll-shortcut-links"+Right ("github", Just "Kowainik", Just "hakyll-shortcut-links")++-}++module Hakyll.ShortcutLinks.Parser+ ( parseShortcut+ ) where++import Data.Text (Text)+import Data.Void (Void)+import Text.Megaparsec (Parsec, anySingle, noneOf, optional, parse, some, (<|>))+import Text.Megaparsec.Char (alphaNumChar, char)++import qualified Data.Text as T+++type Parser = Parsec Void Text++{- | Parses a shortcut link. Allowed formats:++@+\@name+\@name:text+\@name(option)+\@name(option):text+@+-}+parseShortcut :: Text -> Either String (Text, Maybe Text, Maybe Text)+parseShortcut = either (Left . show) Right . parse p ""+ where+ name :: Parser Text+ name = T.pack <$> some (alphaNumChar <|> char '-')++ option, text :: Parser Text+ option = fmap T.pack $ char '(' *> some (noneOf [')']) <* char ')'+ text = fmap T.pack $ char ':' *> some anySingle++ p :: Parser (Text, Maybe Text, Maybe Text)+ p = do+ _ <- char '@'+ (,,) <$> name+ <*> optional option+ <*> optional text
+ test/Spec.hs view
@@ -0,0 +1,12 @@+module Main (main) where++import Test.Hspec (hspec)++import Test.Links (linksSpec)+import Test.Parser (parserSpecs)+++main :: IO ()+main = hspec $ do+ parserSpecs+ linksSpec
+ test/Test/Links.hs view
@@ -0,0 +1,67 @@+module Test.Links+ ( linksSpec+ ) where++import Control.Monad.Except (throwError)+import Data.Bifunctor (first)+import Data.Either (isLeft)+import Data.Text (Text)+import Test.Hspec (Spec, describe, it, shouldBe, shouldSatisfy)+import Text.Pandoc.Class (runPure)+import Text.Pandoc.Error (PandocError (PandocSomeError))+import Text.Pandoc.Options (WrapOption (..), WriterOptions (..), def)+import Text.Pandoc.Readers.Markdown (readMarkdown)+import Text.Pandoc.Writers.Markdown (writeMarkdown)++import Hakyll.ShortcutLinks (applyAllShortcuts)++import qualified Data.Text as T+++linksSpec :: Spec+linksSpec = describe "shortcuts expanding" $ do+ it "expands single valid shortcut" $+ expandShortcuts md1Before `shouldBe` Right md1After+ it "expands multiple mixed links" $+ expandShortcuts md2Before `shouldBe` Right md2After+ it "fails on invalid shortcut" $ do+ expandShortcuts mdError1 `shouldSatisfy` isLeft+ expandShortcuts mdError2 `shouldSatisfy` isLeft+ it "fails on multiple words without text" $ do+ expandShortcuts mdError3 `shouldSatisfy` isLeft+ it "idempotence: doesn't not touch content if it doesn't have shorcuts" $ do+ expandShortcuts md1After `shouldBe` Right md1After+ expandShortcuts md2After `shouldBe` Right md2After++{- | Helper function that feeds markdown text to pandoc, applies shortcuts and+returns either error or new text.+-}+expandShortcuts :: Text -> Either String Text+expandShortcuts txt = first show $ runPure $ do+ md <- readMarkdown def txt+ case applyAllShortcuts md of+ Left errs -> throwError $ PandocSomeError $ unlines errs+ Right newMd -> writeMarkdown def{ writerWrapText = WrapPreserve } newMd++md1Before, md1After :: Text+md1Before = "This is [Hello](@github:kowainik)"+md1After = "This is [Hello](https://github.com/kowainik)"++md2Before, md2After :: Text+md2Before = T.intercalate "\n"+ [ "Link 1: [Hello World](@github:kowainik)"+ , "Link 2: [Ordinary link](https://stackoverflow.com/)"+ , "Link 3: [kowainik/hakyll-shortcut-links](@github)"+ , "Link 4: [summoner](@hackage)"+ ]+md2After = T.intercalate "\n"+ [ "Link 1: [Hello World](https://github.com/kowainik)"+ , "Link 2: [Ordinary link](https://stackoverflow.com/)"+ , "Link 3: [kowainik/hakyll-shortcut-links](https://github.com/kowainik/hakyll-shortcut-links)"+ , "Link 4: [summoner](https://hackage.haskell.org/package/summoner)"+ ]++mdError1, mdError2, mdError3 :: Text+mdError1 = "This is invalid [shortcut](@unknown)"+mdError2 = "Another invalid [`shortcut`](@github)"+mdError3 = "Strange link [many words](@github)"
+ test/Test/Parser.hs view
@@ -0,0 +1,33 @@+module Test.Parser+ ( parserSpecs+ ) where++import Data.Either (isLeft)+import Test.Hspec (Spec, describe, it, shouldBe, shouldSatisfy)++import Hakyll.ShortcutLinks.Parser (parseShortcut)+++parserSpecs :: Spec+parserSpecs = describe "links parsing" $ do+ it "can parse name" $+ parseShortcut "@github" `shouldBe`+ Right ("github", Nothing, Nothing)+ it "can parse name and option" $+ parseShortcut "@github(kowainik)" `shouldBe`+ Right ("github", Just "kowainik", Nothing)+ it "can parse name,option and text" $+ parseShortcut "@github(kowainik):hakyll-shortcut-links" `shouldBe`+ Right ("github", Just "kowainik", Just "hakyll-shortcut-links")+ it "can parse name and text" $+ parseShortcut "@github:hakyll-shortcut-links" `shouldBe`+ Right ("github", Nothing, Just "hakyll-shortcut-links")+ it "doesn't parse link without @" $+ parseShortcut "github" `shouldSatisfy` isLeft+ it "doesn't parse not closed bracket in option" $+ parseShortcut "@github(kowainik" `shouldSatisfy` isLeft+ it "parse until valid symbol" $ do+ parseShortcut "@github kowainik" `shouldBe` Right ("github", Nothing, Nothing)+ parseShortcut "@github)" `shouldBe` Right ("github", Nothing, Nothing)+ it "doesn't parse empty text" $+ parseShortcut "@github:" `shouldSatisfy` isLeft