diff --git a/CHANGELOG.md b/CHANGELOG.md --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,11 @@ pandoc-plot uses [Semantic Versioning](http://semver.org/spec/v2.0.0.html) +## Release 1.7.0 + +* Added support for the declarative diagram language [D2](https://d2lang.com/), thanks to a contribution by Sanchayan Maity (#60). +* Added support for `optparse-applicative` v0.18. + ## Release 1.6.2 * Fixed some imports which were removed in `mtl-2.3`. diff --git a/README.md b/README.md --- a/README.md +++ b/README.md @@ -71,6 +71,7 @@ - `plotsjl`: plots using the [Julia `Plots.jl`](https://docs.juliaplots.org/latest/) package; - `plantuml`: diagrams using the [PlantUML](https://plantuml.com/) software suite; - `sageplot`: plots using the [Sage](https://www.sagemath.org/) software system. + - `d2`: plots using [D2](https://d2lang.com/). To know which toolkits are useable on *your machine* (and which ones are not available), you can check with the `toolkits` command: diff --git a/example-config.yml b/example-config.yml --- a/example-config.yml +++ b/example-config.yml @@ -142,3 +142,7 @@ # preamble: sageplot.sage executable: sage command_line_arguments: + +d2: + executable: d2 + command_line_arguments: diff --git a/executable/Main.hs b/executable/Main.hs --- a/executable/Main.hs +++ b/executable/Main.hs @@ -61,11 +61,11 @@ cls, configurationPathMeta, executable, + pathToExe, readDoc, runPlotM, supportedSaveFormats, - toolkits, - pathToExe + toolkits, ) import Text.Pandoc.JSON (toJSONFilter) import Text.ParserCombinators.ReadP (readP_to_S) @@ -105,7 +105,13 @@ ] ) <> header (mconcat ["pandoc-plot ", V.showVersion pandocPlotVersion, " - generate figures directly in documents"]) - <> footerDoc (Just footer') + <> footerDoc + ( Just $ + P.vsep + [ "More information can be found via the manual (pandoc-plot --manual) or the", + "repository README, located at https://github.com/LaurentRDC/pandoc-plot" + ] + ) ) optparse = do @@ -286,7 +292,7 @@ putStrLn $ "Toolkit: " <> show tk when avail $ do exe <- runPlotM Nothing conf $ executable tk - putStrLn $ " Executable: " <> (pathToExe exe) + putStrLn $ " Executable: " <> pathToExe exe putStrLn $ " Code block trigger: " <> (unpack . cls $ tk) putStrLn $ " Supported save formats: " <> (mconcat . intersperse ", " . fmap show $ supportedSaveFormats tk) putStrLn mempty @@ -318,12 +324,3 @@ manualPath <- ( "pandoc-plot-manual.html") <$> getTemporaryDirectory TIO.writeFile manualPath $(embedManualHtml) openFile ("file:///" <> manualPath) - --- | Use Doc type directly because of newline formatting -footer' :: P.Doc -footer' = - mconcat - [ P.text "More information can be found via the manual (pandoc-plot --manual) or the", - P.line, - P.text "repository README, located at https://github.com/LaurentRDC/pandoc-plot" - ] diff --git a/pandoc-plot.cabal b/pandoc-plot.cabal --- a/pandoc-plot.cabal +++ b/pandoc-plot.cabal @@ -1,6 +1,6 @@ cabal-version: 2.2 name: pandoc-plot -version: 1.6.2 +version: 1.7.0 synopsis: A Pandoc filter to include figures generated from code blocks using your plotting toolkit of choice. description: A Pandoc filter to include figures generated from code blocks. Keep the document and code in the same location. Output is @@ -48,6 +48,8 @@ tests/includes/plotly-r.r tests/includes/plotsjl.jl tests/includes/plantuml.txt + tests/includes/sagemath.sage + tests/includes/d2-dd.d2 source-repository head type: git @@ -79,6 +81,7 @@ Text.Pandoc.Filter.Plot.Renderers.Plotsjl Text.Pandoc.Filter.Plot.Renderers.PlantUML Text.Pandoc.Filter.Plot.Renderers.SageMath + Text.Pandoc.Filter.Plot.Renderers.D2 Text.Pandoc.Filter.Plot.Monad Text.Pandoc.Filter.Plot.Monad.Logging Text.Pandoc.Filter.Plot.Monad.Types @@ -98,8 +101,8 @@ -Wmissing-export-lists -Wpartial-fields build-depends: - aeson >= 2 && <3 - , base >= 4.11 && <5 + aeson >= 2 && < 3 + , base >= 4.11 && < 5 , bytestring , containers , data-default @@ -137,11 +140,11 @@ , directory , filepath , gitrev >= 1 && < 2 - , optparse-applicative >= 0.14 && < 1 + , optparse-applicative >= 0.14 && < 0.19 , pandoc , pandoc-plot - , pandoc-types >= 1.21 && <2 - , template-haskell > 2.7 && < 3 + , pandoc-types >= 1.21 && < 2 + , template-haskell > 2.7 && < 3 , typed-process , text default-language: Haskell2010 @@ -151,12 +154,12 @@ hs-source-dirs: tests main-is: Main.hs other-modules: Common - build-depends: base >= 4.11 && < 5 + build-depends: base , containers , directory , filepath , hspec-expectations - , pandoc-types >= 1.20 && <= 2 + , pandoc-types , pandoc-plot , tasty , tasty-hunit diff --git a/src/Text/Pandoc/Filter/Plot.hs b/src/Text/Pandoc/Filter/Plot.hs --- a/src/Text/Pandoc/Filter/Plot.hs +++ b/src/Text/Pandoc/Filter/Plot.hs @@ -22,7 +22,7 @@ -- -- @ -- This is a paragraph. --- +-- -- ```{.matlabplot} -- figure() -- plot([1,2,3,4,5], [1,2,3,4,5], '-k') @@ -34,7 +34,7 @@ -- @ -- ```{.gnuplot format=png caption="Sinusoidal function" source=true} -- sin(x) --- +-- -- set xlabel "x" -- set ylabel "y" -- ``` @@ -63,8 +63,7 @@ -- code block will be ignored. This path should be specified with respect to the current working -- directory, and not with respect to the document. -- --- All attributes are described in the online documentation, linked on the home page. - +-- All attributes are described in the online documentation, linked on the home page. module Text.Pandoc.Filter.Plot ( -- * Operating on whole Pandoc documents plotFilter, @@ -106,7 +105,7 @@ import Data.Text (Text, pack, unpack) import Data.Version (Version) import Paths_pandoc_plot (version) -import Text.Pandoc.Definition (Block, Meta (..), Format, MetaValue (..), Pandoc (..)) +import Text.Pandoc.Definition (Block, Format, Meta (..), MetaValue (..), Pandoc (..)) import Text.Pandoc.Filter.Plot.Internal ( Configuration (..), FigureSpec, @@ -175,7 +174,7 @@ -- on documents without having all necessary toolkits installed. In this case, error -- messages are printed to stderr, and blocks are left unchanged. -- --- __Note that this function is DEPRECATED in favour of @plotFilter@. It will be +-- __Note that this function is DEPRECATED in favour of @plotFilter@. It will be -- removed in the next major update (v2+).__ plotTransform :: -- | Configuration for default values @@ -183,11 +182,12 @@ -- | Input document Pandoc -> IO Pandoc -{-# DEPRECATED plotTransform - [ "plotTransform has been deprecated in favour of plotFilter, which is aware of conversion format." - , "plotTransform will be removed in an upcoming major update." - ] -#-} +{-# DEPRECATED + plotTransform + [ "plotTransform has been deprecated in favour of plotFilter, which is aware of conversion format.", + "plotTransform will be removed in an upcoming major update." + ] + #-} plotTransform conf = plotFilter conf Nothing -- | The version of the pandoc-plot package. @@ -197,7 +197,7 @@ pandocPlotVersion = version -- | Try to process the block with `pandoc-plot`. If a failure happens (or the block) --- was not meant to become a figure, return the block as-is unless running in strict mode. +-- was not meant to become a figure, return the block as-is unless running in strict mode. -- In strict mode, any failure (for example, due to a missing plotting toolkit) will halt execution. -- -- New in version 1.2.0: this function will detect nested code blocks, for example in @Div@ blocks. @@ -208,7 +208,7 @@ onError b e = do whenStrict $ throwStrictError (pack . show $ e) return b - + whenStrict f = asksConfig strictMode >>= \s -> when s f -- | Try to process the block with `pandoc-plot`, documenting the error. @@ -239,4 +239,4 @@ show (ScriptRuntimeError _ exitcode) = "ERROR (pandoc-plot) The script failed with exit code " <> show exitcode <> "." show (ScriptChecksFailedError msg) = "ERROR (pandoc-plot) A script check failed with message: " <> unpack msg <> "." show (ToolkitNotInstalledError tk) = "ERROR (pandoc-plot) The " <> show tk <> " toolkit is required but not installed." - show (IncompatibleSaveFormatError tk sv) = "ERROR (pandoc-plot) Save format " <> show sv <> " not supported by the " <> show tk <> " toolkit." + show (IncompatibleSaveFormatError tk sv) = "ERROR (pandoc-plot) Save format " <> show sv <> " not supported by the " <> show tk <> " toolkit." diff --git a/src/Text/Pandoc/Filter/Plot/Clean.hs b/src/Text/Pandoc/Filter/Plot/Clean.hs --- a/src/Text/Pandoc/Filter/Plot/Clean.hs +++ b/src/Text/Pandoc/Filter/Plot/Clean.hs @@ -31,9 +31,9 @@ import Text.Pandoc.Class (runIO) import Text.Pandoc.Definition (Block, Pandoc) import Text.Pandoc.Error (handleError) -import Text.Pandoc.Format (FlavoredFormat(..)) import Text.Pandoc.Filter.Plot.Monad import Text.Pandoc.Filter.Plot.Parse +import Text.Pandoc.Format (FlavoredFormat (..)) import qualified Text.Pandoc.Options as P import qualified Text.Pandoc.Readers as P import Text.Pandoc.Walk (Walkable, query) @@ -44,7 +44,7 @@ -- -- The cleaned directories are returned. cleanOutputDirs :: - Walkable Block b => + (Walkable Block b) => Configuration -> b -> IO [FilePath] @@ -59,7 +59,7 @@ -- | Analyze a document to determine where would the pandoc-plot output directories be. outputDirs :: - Walkable Block b => + (Walkable Block b) => b -> PlotM [FilePath] outputDirs = fmap (nub . catMaybes) . sequence . query (\b -> [hasDirectory <$> parseFigureSpec b]) @@ -70,7 +70,7 @@ -- | PlotM version of @cleanOutputDirs@ cleanOutputDirsM :: - Walkable Block b => + (Walkable Block b) => b -> PlotM [FilePath] cleanOutputDirsM doc = do diff --git a/src/Text/Pandoc/Filter/Plot/Configuration.hs b/src/Text/Pandoc/Filter/Plot/Configuration.hs --- a/src/Text/Pandoc/Filter/Plot/Configuration.hs +++ b/src/Text/Pandoc/Filter/Plot/Configuration.hs @@ -17,8 +17,8 @@ ) where -import Data.Aeson ( (.:?), (.!=), Key, Value(Object, Null), FromJSON(parseJSON) ) -import Data.String (IsString(..)) +import Data.Aeson (FromJSON (parseJSON), Key, Value (Null, Object), (.!=), (.:?)) +import Data.String (IsString (..)) import Data.Text (Text, unpack) import qualified Data.Text.IO as TIO import Data.Yaml.Config (ignoreEnv, loadYamlSettings) @@ -64,6 +64,7 @@ plotsjlPreamble = mempty, plantumlPreamble = mempty, sagemathPreamble = mempty, + d2Preamble = mempty, -- Executables matplotlibExe = python, matlabExe = "matlab", @@ -78,6 +79,7 @@ plotsjlExe = "julia", plantumlExe = "java", sagemathExe = "sage", + d2Exe = "d2", -- Command line arguments matplotlibCmdArgs = mempty, matlabCmdArgs = mempty, @@ -92,6 +94,7 @@ plotsjlCmdArgs = mempty, plantumlCmdArgs = "-jar plantuml.jar", sagemathCmdArgs = mempty, + d2CmdArgs = mempty, -- Extras matplotlibTightBBox = False, matplotlibTransparent = False @@ -151,7 +154,8 @@ _bokehPrec :: !BokehPrecursor, _plotsjlPrec :: !PlotsjlPrecursor, _plantumlPrec :: !PlantUMLPrecursor, - _sagemathPrec :: !SageMathPrecursor + _sagemathPrec :: !SageMathPrecursor, + _d2Prec :: !D2Precursor } defaultConfigPrecursor :: ConfigPrecursor @@ -178,7 +182,8 @@ _bokehPrec = BokehPrecursor Nothing (bokehExe defaultConfiguration) (bokehCmdArgs defaultConfiguration), _plotsjlPrec = PlotsjlPrecursor Nothing (plotsjlExe defaultConfiguration) (plotsjlCmdArgs defaultConfiguration), _plantumlPrec = PlantUMLPrecursor Nothing (plantumlExe defaultConfiguration) (plantumlCmdArgs defaultConfiguration), - _sagemathPrec = SageMathPrecursor Nothing (sagemathExe defaultConfiguration) (sagemathCmdArgs defaultConfiguration) + _sagemathPrec = SageMathPrecursor Nothing (sagemathExe defaultConfiguration) (sagemathCmdArgs defaultConfiguration), + _d2Prec = D2Precursor Nothing (d2Exe defaultConfiguration) (d2CmdArgs defaultConfiguration) } data LoggingPrecursor = LoggingPrecursor @@ -219,13 +224,16 @@ data SageMathPrecursor = SageMathPrecursor {_sagemathPreamble :: !(Maybe FilePath), _sagemathExe :: !FilePath, _sagemathCmdArgs :: !Text} +data D2Precursor = D2Precursor {_d2Preamble :: !(Maybe FilePath), _d2Exe :: !FilePath, _d2CmdArgs :: !Text} + instance FromJSON LoggingPrecursor where parseJSON (Object v) = - LoggingPrecursor <$> v .:? "verbosity" .!= logVerbosity defaultConfiguration + LoggingPrecursor + <$> v .:? "verbosity" .!= logVerbosity defaultConfiguration <*> v .:? "filepath" parseJSON _ = fail $ mconcat ["Could not parse logging configuration. "] -asKey :: InclusionKey -> Key +asKey :: InclusionKey -> Key asKey = fromString . show instance FromJSON MatplotlibPrecursor where @@ -286,7 +294,11 @@ parseJSON (Object v) = SageMathPrecursor <$> v .:? asKey PreambleK <*> v .:? asKey ExecutableK .!= sagemathExe defaultConfiguration <*> v .:? asKey CommandLineArgsK .!= sagemathCmdArgs defaultConfiguration parseJSON _ = fail $ mconcat ["Could not parse ", show SageMath, " configuration."] -toolkitAsKey :: Toolkit -> Key +instance FromJSON D2Precursor where + parseJSON (Object v) = D2Precursor <$> v .:? asKey PreambleK <*> v .:? asKey ExecutableK .!= d2Exe defaultConfiguration <*> v .:? asKey CommandLineArgsK .!= d2CmdArgs defaultConfiguration + parseJSON _ = fail $ mconcat ["Could not parse ", show SageMath, " configuration."] + +toolkitAsKey :: Toolkit -> Key toolkitAsKey = fromString . unpack . cls instance FromJSON ConfigPrecursor where @@ -315,6 +327,7 @@ _plotsjlPrec <- v .:? toolkitAsKey Plotsjl .!= _plotsjlPrec defaultConfigPrecursor _plantumlPrec <- v .:? toolkitAsKey PlantUML .!= _plantumlPrec defaultConfigPrecursor _sagemathPrec <- v .:? toolkitAsKey SageMath .!= _sagemathPrec defaultConfigPrecursor + _d2Prec <- v .:? toolkitAsKey D2 .!= _d2Prec defaultConfigPrecursor return $ ConfigPrecursor {..} parseJSON _ = fail "Could not parse configuration." @@ -349,6 +362,7 @@ plotsjlExe = _plotsjlExe _plotsjlPrec plantumlExe = _plantumlExe _plantumlPrec sagemathExe = _sagemathExe _sagemathPrec + d2Exe = _d2Exe _d2Prec matplotlibCmdArgs = _matplotlibCmdArgs _matplotlibPrec matlabCmdArgs = _matlabCmdArgs _matlabPrec @@ -363,6 +377,7 @@ plotsjlCmdArgs = _plotsjlCmdArgs _plotsjlPrec plantumlCmdArgs = _plantumlCmdArgs _plantumlPrec sagemathCmdArgs = _sagemathCmdArgs _sagemathPrec + d2CmdArgs = _d2CmdArgs _d2Prec matplotlibPreamble <- readPreamble (_matplotlibPreamble _matplotlibPrec) matlabPreamble <- readPreamble (_matlabPreamble _matlabPrec) @@ -377,8 +392,8 @@ plotsjlPreamble <- readPreamble (_plotsjlPreamble _plotsjlPrec) plantumlPreamble <- readPreamble (_plantumlPreamble _plantumlPrec) sagemathPreamble <- readPreamble (_sagemathPreamble _sagemathPrec) + d2Preamble <- readPreamble (_d2Preamble _d2Prec) return Configuration {..} where readPreamble = maybe mempty TIO.readFile - diff --git a/src/Text/Pandoc/Filter/Plot/Embed.hs b/src/Text/Pandoc/Filter/Plot/Embed.hs --- a/src/Text/Pandoc/Filter/Plot/Embed.hs +++ b/src/Text/Pandoc/Filter/Plot/Embed.hs @@ -32,15 +32,15 @@ ) import Text.Pandoc.Builder as Builder ( Inlines, - fromList, figureWith, + fromList, imageWith, - plain, link, - str, + plain, simpleCaption, + str, toList, - ) + ) import Text.Pandoc.Class (runPure) import Text.Pandoc.Definition (Attr, Block (..), Format, Pandoc (..)) import Text.Pandoc.Error (handleError) @@ -84,7 +84,9 @@ return . head . toList $ -- We want the attributes both on the Figure element and the contained Image element -- so that pandoc-plot plays nice with pandoc-crossref and other filters - figureWith as (simpleCaption (plain caption')) $ plain $ imageWith mempty (pack fp) mempty caption' + figureWith as (simpleCaption (plain caption')) $ + plain $ + imageWith mempty (pack fp) mempty caption' -- TODO: also add the case where SVG plots can be -- embedded in HTML output @@ -172,11 +174,11 @@ extractPlot t = let tags = canonicalizeTags $ parseTagsOptions parseOptionsFast t extracted = headScripts tags <> [inside "body" tags] - -- In the past (e.g. commit 8417b011ccb20263427822c7447840ab4a30a41e), we used to - -- make all JS scripts 'deferred'. This turned out to be problematic for plotly + in -- In the past (e.g. commit 8417b011ccb20263427822c7447840ab4a30a41e), we used to + -- make all JS scripts 'deferred'. This turned out to be problematic for plotly -- specifically (see issue #39). In the future, we may want to defer scripts for -- certain toolkits, but that's a testing nightmare... - in mconcat $ renderTags <$> extracted + mconcat $ renderTags <$> extracted where headScripts = partitions (~== ("