Mesabloo/diagnose
1
1
Fork 0
mirror of https://github.com/Mesabloo/diagnose.git synced 2024-09-11 19:27:32 +03:00
Code Issues Projects Releases Wiki Activity

include quick description in package.yaml

Browse Source
This commit is contained in:
Mesabloo 2022-04-21 19:27:13 +02:00
parent 6db53b7020
commit d003df5782
2 changed files with 33 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
diagnose.cabal
View File

@ -6,11 +6,18 @@ cabal-version: 1.12
name: diagnose
version: 1.6.2
description: # Error reporting made easy
.
This library provides a simple way of getting beautiful compiler/interpreter errors
using a very simple interface for the programmer.
.
A quick tutorial is available in the module `Error.Diagnose`, which goes on most of the basis
of how to use it.
homepage: https://github.com/mesabloo/diagnose#readme
bug-reports: https://github.com/mesabloo/diagnose/issues
author: Mesabloo
maintainer: Mesabloo
copyright: 2020 Mesabloo
copyright: 2021- Mesabloo
license: BSD3
license-file: LICENSE
build-type: Simple
@ -25,12 +32,12 @@ flag json
default: False
flag megaparsec-compat
description: Includes a small compatibility layer (in the module Error.Diagnose.Compat.Megaparsec) to transform megaparsec errors into reports for this library.
description: Includes a small compatibility layer (in the module `Error.Diagnose.Compat.Megaparsec`) to transform megaparsec errors into reports for this library.
manual: True
default: False
flag parsec-compat
description: Includes a small compatibility layer (in the module Error.Diagnose.Compat.Parsec) to transform parsec errors into reports for this library.
description: Includes a small compatibility layer (in the module `Error.Diagnose.Compat.Parsec`) to transform parsec errors into reports for this library.
manual: True
default: False
@ -66,10 +73,10 @@ library
if flag(json)
cpp-options: -DUSE_AESON
build-depends:
aeson ==1.5.6.0
aeson ==1.5.*
if flag(megaparsec-compat)
build-depends:
containers ==0.6.2.1
containers ==0.6.*
, megaparsec >=9.0.0
if flag(parsec-compat)
build-depends:
@ -107,10 +114,10 @@ test-suite diagnose-megaparsec-tests
if flag(json)
cpp-options: -DUSE_AESON
build-depends:
aeson ==1.5.6.0
aeson ==1.5.*
if flag(megaparsec-compat)
build-depends:
containers ==0.6.2.1
containers ==0.6.*
, megaparsec >=9.0.0
if flag(parsec-compat)
build-depends:
@ -144,10 +151,10 @@ test-suite diagnose-parsec-tests
if flag(json)
cpp-options: -DUSE_AESON
build-depends:
aeson ==1.5.6.0
aeson ==1.5.*
if flag(megaparsec-compat)
build-depends:
containers ==0.6.2.1
containers ==0.6.*
, megaparsec >=9.0.0
if flag(parsec-compat)
build-depends:
@ -181,10 +188,10 @@ test-suite diagnose-rendering-tests
if flag(json)
cpp-options: -DUSE_AESON
build-depends:
aeson ==1.5.6.0
aeson ==1.5.*
if flag(megaparsec-compat)
build-depends:
containers ==0.6.2.1
containers ==0.6.*
, megaparsec >=9.0.0
if flag(parsec-compat)
build-depends:

20
package.yaml
View File

@ -3,7 +3,7 @@ version: 1.6.2
github: "mesabloo/diagnose"
license: BSD3
author: "Mesabloo"
copyright: "2020 Mesabloo"
copyright: "2021- Mesabloo"
dependencies:
- base >= 4.7 && < 5
@ -43,11 +43,11 @@ flags:
manual: true
default: false
megaparsec-compat:
description: "Includes a small compatibility layer (in the module Error.Diagnose.Compat.Megaparsec) to transform megaparsec errors into reports for this library."
description: "Includes a small compatibility layer (in the module `Error.Diagnose.Compat.Megaparsec`) to transform megaparsec errors into reports for this library."
manual: true
default: false
parsec-compat:
description: "Includes a small compatibility layer (in the module Error.Diagnose.Compat.Parsec) to transform parsec errors into reports for this library."
description: "Includes a small compatibility layer (in the module `Error.Diagnose.Compat.Parsec`) to transform parsec errors into reports for this library."
manual: true
default: false
# do the same for other parsing libraries like parsec or attoparsec
@ -55,14 +55,14 @@ flags:
when:
- condition: flag(json)
dependencies:
- aeson == 1.5.6.0
- aeson == 1.5.*
cpp-options:
- -DUSE_AESON
- condition: flag(megaparsec-compat)
dependencies:
- megaparsec >= 9.0.0
- containers == 0.6.2.1
- containers == 0.6.*
- condition: flag(parsec-compat)
dependencies:
- parsec >= 3.1.14
@ -114,3 +114,13 @@ tests:
- condition: ! '!(flag(parsec-compat))'
buildable: false
# This is put at the end for convenience.
description: |
# Error reporting made easy
This library provides a simple way of getting beautiful compiler/interpreter errors
using a very simple interface for the programmer.
A quick tutorial is available in the module `Error.Diagnose`, which goes on most of the basis
of how to use it.