xrefcheck/package.yaml

# SPDX-FileCopyrightText: 2018-2019 Serokell <https://serokell.io>
#
# SPDX-License-Identifier: MPL-2.0

name:                crossref-verifier
version:             0.1.0.0
github:              serokell/crossref-verifier
license:             MPL-2.0
license-file:        LICENSE
author:              Kostya Ivanov, Serokell
maintainer:          Serokell <hi@serokell.io>
copyright:           2018-2019 Serokell <https://serokell.io>

extra-source-files:
- README.md
- src-files/*

description:         Please see the README on GitHub at <https://github.com/serokell/crossref-verifier#readme>

default-extensions:
  - AllowAmbiguousTypes
  - BangPatterns
  - ConstraintKinds
  - DataKinds
  - DefaultSignatures
  - DeriveDataTypeable
  - DeriveGeneric
  - FlexibleContexts
  - FlexibleInstances
  - FunctionalDependencies
  - GeneralizedNewtypeDeriving
  - LambdaCase
  - MonadFailDesugaring
  - MultiParamTypeClasses
  - MultiWayIf
  - NamedFieldPuns
  - OverloadedStrings
  - RankNTypes
  - RecordWildCards
  - ScopedTypeVariables
  - StandaloneDeriving
  - TemplateHaskell
  - TupleSections
  - TypeFamilies
  - UndecidableInstances
  - ViewPatterns
  - TypeApplications
  - TypeOperators

build-tools:
  - autoexporter

ghc-options:
  - -Wall
  - -Wincomplete-record-updates

dependencies:
  - aeson
  - aeson-options
  - async
  - base-noprelude
  - bytestring
  - containers
  - cmark-gfm
  - data-default
  - deepseq
  - directory-tree
  - directory
  - filepath
  - fmt
  - Glob
  - http-client
  - http-types
  - lens
  - loot-prelude
  - pretty-terminal
  - mtl
  - o-clock
  - optparse-applicative
  - req
  - roman-numerals
  - template-haskell
  - text
  - text-metrics
  - th-lift-instances
  - th-utilities
  - yaml

library:
  source-dirs: src

executables:
  crossref-verify:
    main:                Main.hs
    source-dirs:         exec
    ghc-options:
    - -threaded
    - -rtsopts
    - -with-rtsopts=-N
    - -O2
    dependencies:
    - crossref-verifier

tests:
  crossref-verifier-tests:
    main:                Main.hs
    source-dirs:         tests
    dependencies:
    - crossref-verifier
    - hspec
    - QuickCheck
    build-tools:
    - hspec-discover
[INT-128] Make the repository REUSE compliant Problem: nowadays we want all files to store licensing information in machine-readable format and to use reuse tool to check that. But the repo is not REUSE compliant. Solution: add `LICENSES` folder and licensing information for each file. 2019-12-18 17:18:55 +03:00			`# SPDX-FileCopyrightText: 2018-2019 Serokell <https://serokell.io>`
			`#`
			`# SPDX-License-Identifier: MPL-2.0`

[INT-31] Implement cross-references verifier 2018-10-11 00:15:08 +03:00			`name: crossref-verifier`
			`version: 0.1.0.0`
Update licensing information in package.yaml Problem: it was agreed with Kostya Ivanov that the copyright owner is Serokell, so it should be updated in package.yaml. Also it mentions incorrect license (the one in the repo is MPL-2.0) and does not have license-file. Solution: update `copyright` field and `license` field. Also add `license-file`. Update maintainer as well, because now many people from Serokell are involved. I also took the liberty to fix the `github` field. 2019-12-18 17:11:24 +03:00			`github: serokell/crossref-verifier`
			`license: MPL-2.0`
			`license-file: LICENSE`
			`author: Kostya Ivanov, Serokell`
			`maintainer: Serokell <hi@serokell.io>`
			`copyright: 2018-2019 Serokell <https://serokell.io>`
[INT-31] Implement cross-references verifier 2018-10-11 00:15:08 +03:00
			`extra-source-files:`
			`- README.md`
Make providing config optional Problem: currently `crossref-verify` executable does not work without configuration, and user was supposed to use one from the repository if he does not have its own. This is very inconvenient. Solution: make executable remember some config and use it by default. 2019-12-03 22:02:00 +03:00			`- src-files/*`
[INT-31] Implement cross-references verifier 2018-10-11 00:15:08 +03:00
			`description: Please see the README on GitHub at <https://github.com/serokell/crossref-verifier#readme>`

			`default-extensions:`
			`- AllowAmbiguousTypes`
			`- BangPatterns`
			`- ConstraintKinds`
			`- DataKinds`
			`- DefaultSignatures`
			`- DeriveDataTypeable`
			`- DeriveGeneric`
			`- FlexibleContexts`
			`- FlexibleInstances`
			`- FunctionalDependencies`
			`- GeneralizedNewtypeDeriving`
			`- LambdaCase`
			`- MonadFailDesugaring`
			`- MultiParamTypeClasses`
			`- MultiWayIf`
			`- NamedFieldPuns`
			`- OverloadedStrings`
			`- RankNTypes`
			`- RecordWildCards`
			`- ScopedTypeVariables`
			`- StandaloneDeriving`
			`- TemplateHaskell`
			`- TupleSections`
			`- TypeFamilies`
			`- UndecidableInstances`
			`- ViewPatterns`
			`- TypeApplications`
			`- TypeOperators`

			`build-tools:`
			`- autoexporter`

			`ghc-options:`
			`- -Wall`
Add verification progress bar 2019-03-12 16:29:15 +03:00			`- -Wincomplete-record-updates`
[INT-31] Implement cross-references verifier 2018-10-11 00:15:08 +03:00
			`dependencies:`
[INT-31] Add config and CLI options 2018-10-11 17:27:59 +03:00			`- aeson`
			`- aeson-options`
[INT-31] Enable external references checker 2018-10-16 14:58:53 +03:00			`- async`
[INT-31] Implement cross-references verifier 2018-10-11 00:15:08 +03:00			`- base-noprelude`
[INT-31] Enable external references checker 2018-10-16 14:58:53 +03:00			`- bytestring`
[INT-31] Implement cross-references verifier 2018-10-11 00:15:08 +03:00			`- containers`
[INT-31] Use cmark-gfm to parse markdown instead of manual parser 2018-10-11 14:06:32 +03:00			`- cmark-gfm`
[INT-31] Implement cross-references verifier 2018-10-11 00:15:08 +03:00			`- data-default`
			`- deepseq`
			`- directory-tree`
			`- directory`
			`- filepath`
			`- fmt`
Allow to specify virtual files For instance, reference to `issues` github page is a valid one despite there is no such file physically in the repository. Now user can specify list of "existing" virtual files in config. 2019-03-13 14:39:33 +03:00			`- Glob`
[INT-31] Implement cross-references verifier 2018-10-11 00:15:08 +03:00			`- http-client`
			`- http-types`
			`- lens`
			`- loot-prelude`
			`- pretty-terminal`
			`- mtl`
[INT-31] Add config and CLI options 2018-10-11 17:27:59 +03:00			`- o-clock`
			`- optparse-applicative`
[INT-31] Use cmark-gfm to parse markdown instead of manual parser 2018-10-11 14:06:32 +03:00			`- req`
[INT-31] Implement cross-references verifier 2018-10-11 00:15:08 +03:00			`- roman-numerals`
Use newer resolver Problem: latest available LTS resolver is 14.16 and `crossref-verifier` doesn't compile with it. Solution: update resolver to 14.16. Newer versions of some packages are used from now on. I assume that it shouldn't break anything as long as tests pass. `req` stopped using `Default` class, that's the only change in the code I had to make. 2019-11-26 19:26:56 +03:00			`- template-haskell`
[INT-31] Implement cross-references verifier 2018-10-11 00:15:08 +03:00			`- text`
[INT-31] Prettify output 2018-10-11 15:40:39 +03:00			`- text-metrics`
Make providing config optional Problem: currently `crossref-verify` executable does not work without configuration, and user was supposed to use one from the repository if he does not have its own. This is very inconvenient. Solution: make executable remember some config and use it by default. 2019-12-03 22:02:00 +03:00			`- th-lift-instances`
			`- th-utilities`
[INT-31] Add config and CLI options 2018-10-11 17:27:59 +03:00			`- yaml`
[INT-31] Implement cross-references verifier 2018-10-11 00:15:08 +03:00
			`library:`
			`source-dirs: src`

			`executables:`
			`crossref-verify:`
			`main: Main.hs`
			`source-dirs: exec`
			`ghc-options:`
			`- -threaded`
			`- -rtsopts`
			`- -with-rtsopts=-N`
			`- -O2`
			`dependencies:`
			`- crossref-verifier`
Add tests on header to anchor conversion 2019-03-11 17:16:06 +03:00
			`tests:`
			`crossref-verifier-tests:`
			`main: Main.hs`
			`source-dirs: tests`
			`dependencies:`
			`- crossref-verifier`
			`- hspec`
			`- QuickCheck`
Add hspec-discover to build-tools of test 2019-12-04 18:13:53 +03:00			`build-tools:`
			`- hspec-discover`