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
7e954c20a4
xrefcheck/package.yaml

146 lines
2.7 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
[#62] [INT-141] Add to changelog, update version
2021-07-13 20:17:22 +03:00
version: 0.2.1
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
- src-files/*
[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:
- -Wall
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
[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
[#35] Stop using `aeson-options` `aeson-options` package is going to be deprecated. Moreover, it does not work in the recent lts. Solution: use `aeson-casing` package instead.
2021-03-09 20:20:26 +03:00
- aeson-casing
[INT-31] Enable external references checker
2018-10-16 14:58:53 +03:00
- async
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] 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
[#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
- dlist
[INT-31] Implement cross-references verifier
2018-10-11 00:15:08 +03:00
- filepath
Add a windows build
2020-04-11 13:22:26 +03:00
- file-embed
[INT-31] Implement cross-references verifier
2018-10-11 00:15:08 +03:00
- fmt
[#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
- ftp-client
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
[#135] Add tests and markdowns to check ignoring regex performance Problem: There are no tests checking ignoring regex performance. Solution: Add test checking that broken links matched by regexs are not verified and test checking that not matched broken links are verified as links with error.
2020-12-28 15:44:41 +03:00
- HUnit
[INT-31] Implement cross-references verifier
2018-10-11 00:15:08 +03:00
- lens
- pretty-terminal
[#36] Switch to lts-15.13 Problem: LTS-14.16 that we currently using and a bit old. And its GHC is old as well. Solution: update the resolver, make some changes that were necessary. They are pretty trivial. The only essential breaking change is the removal of `parseUrl` from `req`.
2020-05-19 21:17:58 +03:00
- modern-uri
[INT-31] Implement cross-references verifier
2018-10-11 00:15:08 +03:00
- mtl
[INT-31] Add config and CLI options
2018-10-11 17:27:59 +03:00
- o-clock
- optparse-applicative
[#135] Add `vcIgnoreRefs` as regexs to `Xrefcheck.Config` Problem: External links must be ignored sometimes and not be checked for validity. Solution: Add `vcIgnoreRefs` to `Config` that is a list of regexs using `regex-tdfa`. Each regex define a link we want to ignore while validating. Change `checkExternalResource` to support matching the regex.
2020-10-30 12:53:44 +03:00
- regex-tdfa
[INT-31] Use cmark-gfm to parse markdown instead of manual parser
2018-10-11 14:06:32 +03:00
- req
[#55] Generate config depending on the repo type Problem: now when we include repository type into the config, it seems to make sense to generate config differently depending on the repository type. Especially taking into account that currently in some fields we mix GitHub and GitLab -specific contents. Solution: Leave placeholders in the default config and later fill them from the code depending on the required repository type. Add a mandatory repository type parameter to `dump-config` CLI command. Along with a test checking for config validity, add a golden test on the produced config so that we could assess how sane it looks like.
2021-02-25 18:48:51 +03:00
- regex-tdfa
[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
[#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
- transformers
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
- universum
[INT-31] Add config and CLI options
2018-10-11 17:27:59 +03:00
- yaml
Use UTF-8 encoding for stdin/stdout Problem: we use many unusual unicode characters, on some locales this may cause failures on attempt to print to stdout. Solution: it is generally a good practice to set encoding of all handlers to UTF-8, and this commit brings `with-utf8` package which does that.
2020-03-25 16:34:32 +03:00
- with-utf8
[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
[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
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
- QuickCheck
- xrefcheck
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
Reference in New Issue Copy Permalink