serokell/xrefcheck
1
1
Fork 0
mirror of https://github.com/serokell/xrefcheck.git synced 2024-08-16 17:10:26 +03:00
Code Issues Projects Releases Wiki Activity
d6fb95f5b9
xrefcheck/package.yaml

162 lines
3.2 KiB
YAML
Raw Normal View History

[#47] Handle ftp links Problem: Currently we support only http and https links. If there is an `ftp://` link, you will get exception. Solution: Use `ftp-client` to check connection to ftp, see response statuses and check file existence. This produces adding new error types and small refactoring. Provide a test which is separate executable, where we have to pass CLA - ftp host. Co-authored-by: Alexander Bantyev <alexander.bantyev@serokell.io>
2021-07-08 16:22:44 +03:00
# SPDX-FileCopyrightText: 2018-2021 Serokell <https://serokell.io>
[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-License-Identifier: MPL-2.0
Avoid loot-prelude dependency Problem: lootbox is not uploaded to hackage, so when we upload xrefcheck, its build on hackage fails. Solution: we can use `mixins` feature to set Universum as prelude without any intermediate packages. This seems to be supported even by quite old versions of stack, like 1.7.3, so that should not bring build problems in most cases.
2020-05-15 19:22:24 +03:00
spec-version: 0.31.0
Rename the project to `xrefcheck` Problem: the previous name `crossref-verifier` was found long and boring. Solution: rename to `xrefcheck`.
2020-01-13 15:58:14 +03:00
name: xrefcheck
Undo errorneous version increment
2021-11-09 14:50:13 +03:00
version: 0.2
Rename the project to `xrefcheck` Problem: the previous name `crossref-verifier` was found long and boring. Solution: rename to `xrefcheck`.
2020-01-13 15:58:14 +03:00
github: serokell/xrefcheck
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
license: MPL-2.0
license-file: LICENSE
author: Kostya Ivanov, Serokell
maintainer: Serokell <hi@serokell.io>
copyright: 2018-2019 Serokell <https://serokell.io>
[#47] Handle ftp links Problem: Currently we support only http and https links. If there is an `ftp://` link, you will get exception. Solution: Use `ftp-client` to check connection to ftp, see response statuses and check file existence. This produces adding new error types and small refactoring. Provide a test which is separate executable, where we have to pass CLA - ftp host. Co-authored-by: Alexander Bantyev <alexander.bantyev@serokell.io>
2021-07-08 16:22:44 +03:00
description: Please see the README on GitHub at <https://github.com/serokell/xrefcheck#readme>
[INT-31] Implement cross-references verifier
2018-10-11 00:15:08 +03:00
extra-source-files:
[#47] Handle ftp links Problem: Currently we support only http and https links. If there is an `ftp://` link, you will get exception. Solution: Use `ftp-client` to check connection to ftp, see response statuses and check file existence. This produces adding new error types and small refactoring. Provide a test which is separate executable, where we have to pass CLA - ftp host. Co-authored-by: Alexander Bantyev <alexander.bantyev@serokell.io>
2021-07-08 16:22:44 +03:00
- README.md
- CHANGES.md
[INT-31] Implement cross-references verifier
2018-10-11 00:15:08 +03:00
default-extensions:
- AllowAmbiguousTypes
- BangPatterns
- ConstraintKinds
- DataKinds
- DefaultSignatures
- DeriveDataTypeable
- DeriveGeneric
[#71] Separate concerns in Node traversal. Problem: The tree traversal uses explicit recursion and does not-closely-unrelated stuff at once. Solution: Separate different actions.
2021-10-20 14:37:05 +03:00
- DerivingStrategies
[INT-31] Implement cross-references verifier
2018-10-11 00:15:08 +03:00
- FlexibleContexts
- FlexibleInstances
- FunctionalDependencies
- GeneralizedNewtypeDeriving
Improve readability of imports Problem: In ``` import qualified Foo.Bar as Bar import Foo.Bar (Bar) ``` names of the imported modules are on different vertical lines, which disables autosorting, and makes it harder to read. Solution: Use `ImportQualifiedPost`
2021-07-26 11:05:00 +03:00
- ImportQualifiedPost
[INT-31] Implement cross-references verifier
2018-10-11 00:15:08 +03:00
- LambdaCase
- MultiParamTypeClasses
- MultiWayIf
- NamedFieldPuns
Remove mixins Problem: Stack cannot build projects with mixins, and they only used to splice universum instead of base. Solution: Use `NoImplicitPreduce` and import `Universum` everywhere explicitly.
2021-07-26 11:00:21 +03:00
- NoImplicitPrelude
[INT-31] Implement cross-references verifier
2018-10-11 00:15:08 +03:00
- OverloadedStrings
- RankNTypes
- RecordWildCards
- ScopedTypeVariables
- StandaloneDeriving
- TemplateHaskell
- TupleSections
- TypeFamilies
- UndecidableInstances
- ViewPatterns
- TypeApplications
- TypeOperators
ghc-options:
[#105] Add hlint support, enable -Weveryting Problem: we had a lot redundant dependencies and had no linter for handling obvious errors Solution: hlint support and enable -Weverything flag, fix all hints from them, add hlint to the CI pipeline
2022-07-08 18:08:25 +03:00
- -Weverything
Add verification progress bar
2019-03-12 16:29:15 +03:00
- -Wincomplete-record-updates
[#135] Add support of right in-place annotations Problem: It can be convenient not only specifying exclusions in the config, but also annotating the excluded thing right in-place. It is about adding comment before the link or the paragraph or even the whole file to ignore this item. Solution: Support annotation as html comment in a "<!-- xrefcheck: ignore mode -->" format, where mode is "link" or "paragraph" or "file". Modify `nodeExtractInfo` from `Xrefcheck.Scanners.Markdown` just to skip a node in AST while parsing. Take into account that "ignore file" can only be at the top of the file or right after the license. In markdown terms: either the first node must be HTML_BLOCK with "<!-- xrefcheck: ignore file -->" content or the first is HTML_BLOCK comment (smth between "<!--" and "-->") and the second is HTML_BLOCK with "ignore file" content. Also take into account that "ignore link" must be followed by a link. Strictly speaking, there is either LINK after "ignore link" or TEXT and LINK (if there is some text before the link).
2020-11-10 23:38:28 +03:00
- -Wincomplete-uni-patterns
Add explicit strategies to deriving clauses Problem: The `deriving ($classes...)` is becoming obsolete. Solution: Replace with `deriving $strat ($classes...)`; make old deriving a warning.
2021-11-04 17:41:18 +03:00
- -Wmissing-deriving-strategies
[#105] Add hlint support, enable -Weveryting Problem: we had a lot redundant dependencies and had no linter for handling obvious errors Solution: hlint support and enable -Weverything flag, fix all hints from them, add hlint to the CI pipeline
2022-07-08 18:08:25 +03:00
- -Wno-missing-safe-haskell-mode
- -Wno-unsafe
- -Wno-missing-import-lists
- -Wno-missing-local-signatures
- -Wno-missing-export-lists
- -Wno-all-missed-specialisations
- -Wno-prepositive-qualified-module
- -Wno-monomorphism-restriction
[INT-31] Implement cross-references verifier
2018-10-11 00:15:08 +03:00
dependencies:
Remove mixins Problem: Stack cannot build projects with mixins, and they only used to splice universum instead of base. Solution: Use `NoImplicitPreduce` and import `Universum` everywhere explicitly.
2021-07-26 11:00:21 +03:00
- base
[INT-31] Implement cross-references verifier
2018-10-11 00:15:08 +03:00
library:
source-dirs: src
Mention 'Path_*` module in `package.yaml` Problem: after we started using mixins feature, generated .cabal file requires cabal 2.0. Attempt to upload our package to Hackage now reports an error, saying that `autogen-modules` section have to mention `Path_*` files. Solution: add `Paths_xrefcheck` to `generated-other-modules` section of `package.yaml`.
2020-05-16 16:02:38 +03:00
generated-other-modules:
[#47] Handle ftp links Problem: Currently we support only http and https links. If there is an `ftp://` link, you will get exception. Solution: Use `ftp-client` to check connection to ftp, see response statuses and check file existence. This produces adding new error types and small refactoring. Provide a test which is separate executable, where we have to pass CLA - ftp host. Co-authored-by: Alexander Bantyev <alexander.bantyev@serokell.io>
2021-07-08 16:22:44 +03:00
- Paths_xrefcheck
Mention 'Path_*` module in `package.yaml` Problem: after we started using mixins feature, generated .cabal file requires cabal 2.0. Attempt to upload our package to Hackage now reports an error, saying that `autogen-modules` section have to mention `Path_*` files. Solution: add `Paths_xrefcheck` to `generated-other-modules` section of `package.yaml`.
2020-05-16 16:02:38 +03:00
[#105] Add hlint support, enable -Weveryting Problem: we had a lot redundant dependencies and had no linter for handling obvious errors Solution: hlint support and enable -Weverything flag, fix all hints from them, add hlint to the CI pipeline
2022-07-08 18:08:25 +03:00
dependencies:
- aeson
- aeson-casing
- async
- bytestring
- containers
- cmark-gfm
- data-default
- directory-tree
- directory
- dlist
- filepath
- raw-strings-qq
- fmt
- ftp-client
- Glob
- http-client
- http-types
- lens
- pretty-terminal
- modern-uri
- mtl
- o-clock
- optparse-applicative
- regex-tdfa
- req
- roman-numerals
- text
- text-metrics
- th-lift-instances
- universum
- yaml
[INT-31] Implement cross-references verifier
2018-10-11 00:15:08 +03:00
executables:
Rename the project to `xrefcheck` Problem: the previous name `crossref-verifier` was found long and boring. Solution: rename to `xrefcheck`.
2020-01-13 15:58:14 +03:00
xrefcheck:
[#47] Handle ftp links Problem: Currently we support only http and https links. If there is an `ftp://` link, you will get exception. Solution: Use `ftp-client` to check connection to ftp, see response statuses and check file existence. This produces adding new error types and small refactoring. Provide a test which is separate executable, where we have to pass CLA - ftp host. Co-authored-by: Alexander Bantyev <alexander.bantyev@serokell.io>
2021-07-08 16:22:44 +03:00
main: Main.hs
source-dirs: exec
Mention 'Path_*` module in `package.yaml` Problem: after we started using mixins feature, generated .cabal file requires cabal 2.0. Attempt to upload our package to Hackage now reports an error, saying that `autogen-modules` section have to mention `Path_*` files. Solution: add `Paths_xrefcheck` to `generated-other-modules` section of `package.yaml`.
2020-05-16 16:02:38 +03:00
generated-other-modules:
[#47] Handle ftp links Problem: Currently we support only http and https links. If there is an `ftp://` link, you will get exception. Solution: Use `ftp-client` to check connection to ftp, see response statuses and check file existence. This produces adding new error types and small refactoring. Provide a test which is separate executable, where we have to pass CLA - ftp host. Co-authored-by: Alexander Bantyev <alexander.bantyev@serokell.io>
2021-07-08 16:22:44 +03:00
- Paths_xrefcheck
[INT-31] Implement cross-references verifier
2018-10-11 00:15:08 +03:00
ghc-options:
[#47] Handle ftp links Problem: Currently we support only http and https links. If there is an `ftp://` link, you will get exception. Solution: Use `ftp-client` to check connection to ftp, see response statuses and check file existence. This produces adding new error types and small refactoring. Provide a test which is separate executable, where we have to pass CLA - ftp host. Co-authored-by: Alexander Bantyev <alexander.bantyev@serokell.io>
2021-07-08 16:22:44 +03:00
- -threaded
- -rtsopts
- -with-rtsopts=-N
- -O2
[INT-31] Implement cross-references verifier
2018-10-11 00:15:08 +03:00
dependencies:
[#47] Handle ftp links Problem: Currently we support only http and https links. If there is an `ftp://` link, you will get exception. Solution: Use `ftp-client` to check connection to ftp, see response statuses and check file existence. This produces adding new error types and small refactoring. Provide a test which is separate executable, where we have to pass CLA - ftp host. Co-authored-by: Alexander Bantyev <alexander.bantyev@serokell.io>
2021-07-08 16:22:44 +03:00
- xrefcheck
[#105] Add hlint support, enable -Weveryting Problem: we had a lot redundant dependencies and had no linter for handling obvious errors Solution: hlint support and enable -Weverything flag, fix all hints from them, add hlint to the CI pipeline
2022-07-08 18:08:25 +03:00
- bytestring
- universum
- with-utf8
Add tests on header to anchor conversion
2019-03-11 17:16:06 +03:00
tests:
Rename the project to `xrefcheck` Problem: the previous name `crossref-verifier` was found long and boring. Solution: rename to `xrefcheck`.
2020-01-13 15:58:14 +03:00
xrefcheck-tests:
[#47] Handle ftp links Problem: Currently we support only http and https links. If there is an `ftp://` link, you will get exception. Solution: Use `ftp-client` to check connection to ftp, see response statuses and check file existence. This produces adding new error types and small refactoring. Provide a test which is separate executable, where we have to pass CLA - ftp host. Co-authored-by: Alexander Bantyev <alexander.bantyev@serokell.io>
2021-07-08 16:22:44 +03:00
main: Main.hs
source-dirs: tests
Mention 'Path_*` module in `package.yaml` Problem: after we started using mixins feature, generated .cabal file requires cabal 2.0. Attempt to upload our package to Hackage now reports an error, saying that `autogen-modules` section have to mention `Path_*` files. Solution: add `Paths_xrefcheck` to `generated-other-modules` section of `package.yaml`.
2020-05-16 16:02:38 +03:00
generated-other-modules:
[#47] Handle ftp links Problem: Currently we support only http and https links. If there is an `ftp://` link, you will get exception. Solution: Use `ftp-client` to check connection to ftp, see response statuses and check file existence. This produces adding new error types and small refactoring. Provide a test which is separate executable, where we have to pass CLA - ftp host. Co-authored-by: Alexander Bantyev <alexander.bantyev@serokell.io>
2021-07-08 16:22:44 +03:00
- Paths_xrefcheck
Add tests on header to anchor conversion
2019-03-11 17:16:06 +03:00
dependencies:
[#47] Handle ftp links Problem: Currently we support only http and https links. If there is an `ftp://` link, you will get exception. Solution: Use `ftp-client` to check connection to ftp, see response statuses and check file existence. This produces adding new error types and small refactoring. Provide a test which is separate executable, where we have to pass CLA - ftp host. Co-authored-by: Alexander Bantyev <alexander.bantyev@serokell.io>
2021-07-08 16:22:44 +03:00
- firefly
- hspec
[#107] Replace file-embed library with inline config Problem: At new resolver version we recieved obscure error when tried to cross-compile project to Windows on CI. Changing file-embed version to the old one doesn't help us. Solution: inline content of this file into haskell source, using raw-string-qq library, that helps us to avoid escaping and typing newline characters.
2022-07-07 15:09:34 +03:00
- hspec-expectations
[#47] Handle ftp links Problem: Currently we support only http and https links. If there is an `ftp://` link, you will get exception. Solution: Use `ftp-client` to check connection to ftp, see response statuses and check file existence. This produces adding new error types and small refactoring. Provide a test which is separate executable, where we have to pass CLA - ftp host. Co-authored-by: Alexander Bantyev <alexander.bantyev@serokell.io>
2021-07-08 16:22:44 +03:00
- QuickCheck
- xrefcheck
[#105] Add hlint support, enable -Weveryting Problem: we had a lot redundant dependencies and had no linter for handling obvious errors Solution: hlint support and enable -Weverything flag, fix all hints from them, add hlint to the CI pipeline
2022-07-08 18:08:25 +03:00
- bytestring
- directory
- fmt
- http-types
- HUnit
- regex-tdfa
- universum
- yaml
Add hspec-discover to build-tools of test
2019-12-04 18:13:53 +03:00
build-tools:
[#47] Handle ftp links Problem: Currently we support only http and https links. If there is an `ftp://` link, you will get exception. Solution: Use `ftp-client` to check connection to ftp, see response statuses and check file existence. This produces adding new error types and small refactoring. Provide a test which is separate executable, where we have to pass CLA - ftp host. Co-authored-by: Alexander Bantyev <alexander.bantyev@serokell.io>
2021-07-08 16:22:44 +03:00
- hspec-discover
links-tests:
main: Main.hs
source-dirs: links-tests
build-tools: tasty-discover:tasty-discover
generated-other-modules:
- Paths_xrefcheck
dependencies:
- optparse-applicative
- tagged
- tasty
- tasty-hunit
- xrefcheck
[#105] Add hlint support, enable -Weveryting Problem: we had a lot redundant dependencies and had no linter for handling obvious errors Solution: hlint support and enable -Weverything flag, fix all hints from them, add hlint to the CI pipeline
2022-07-08 18:08:25 +03:00
- universum
Reference in New Issue Copy Permalink