LiterateMarkdown-0.1.0.0: LiterateMarkdown.cabal

cabal-version:       2.2

-- Initial package description 'LiterateMarkdown.cabal' generated by 'cabal
--  init'.  For further documentation, see
-- http://haskell.org/cabal/users-guide/

-- The name of the package.
name:                LiterateMarkdown

-- The package version.  See the Haskell package versioning policy (PVP)
-- for standards guiding when and how versions should be incremented.
-- https://pvp.haskell.org
-- PVP summary:      +-+------- breaking API changes
--                   | | +----- non-breaking API additions
--                   | | | +--- code changes with no API change
version:             0.1.0.0

-- A short (one-line) description of the package.
synopsis: Converter to convert from .lhs to .md and vice versa.

-- A longer description of the package.
description: `lhsc` is a program to convert literate haskell files in the 
             birdtick format to correctly rendered (git flavoured, html containing) markdown files 
             and vice versa.
             .
             It strips away the heading tags #, replacing them with the corresponding html tags,
             converts the `'''haskell [...]'''` to `> [...]` as recognised by the GHC literate prepocessor.
             `''' [...] '''` will be converted to `< [...]` and will be discarded by ghc but will still be displayed as code when rendered. 
             (In both cases `'''` is actually the three md backticks, but its a pain to write md about md.)
             .
             Usage:
             .
             `lhsc (toLhs|toMd) file1 [file2] [...]`;
             The `toLhs` and `toMd` commands are not case sensitive. 
             The program will convert each file from the other format to the specified one, 
             creating the files `file1.md` `file2.md` ... or `file1.lhs` `file2.lhs` ... in the same directory respectively.

-- A URL where users can report bugs.
bug-reports: https://github.com/faeblDevelopment/LiterateMarkdown/issues
 
-- The license under which the package is released.
license:             MIT

-- The file containing the license text.
license-file:        LICENSE

-- The package author(s).
author:              Fabian Schneider

-- An email address to which users can send suggestions, bug reports, and
-- patches.
maintainer:          faebl.taylor@pm.me

-- A copyright notice.
-- copyright:

category:            Productivity

-- Extra files to be distributed with the package, such as examples or a
-- README.
extra-source-files:  CHANGELOG.md, README.md

source-repository head 
  type: git
  location: https://github.com/faeblDevelopment/LiterateMarkdown.git
  branch: main

library converter
  exposed-modules:     Converter
  build-depends:       base ^>=4.12.0.0
  default-language:    Haskell2010

executable lhsc
  -- .hs or .lhs file containing the Main module.
  main-is:             literate_converter.hs

  -- Modules included in this executable, other than Main.
  other-modules:       Converter
 
  -- LANGUAGE extensions used by modules in this package.
  -- other-extensions:

  -- Other library packages from which modules are imported.
  build-depends:       base ^>=4.12.0.0, converter

  -- Directories containing source files.
  -- hs-source-dirs:

  -- Base language which the package is written in.
  default-language:    Haskell2010

Test-Suite test-foo
  type:                exitcode-stdio-1.0
  main-is:             test.hs
  other-modules:       Converter
  build-depends:       base ^>=4.12.0.0, converter
  default-language:    Haskell2010