Commit Graph

19 Commits

Author SHA1 Message Date
martoon
8f0c955230
Make a new release
This should fix the build problems on Hackage.
2020-05-15 21:01:52 +03:00
martoon
553c41c385
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:26:09 +03:00
martoon
8e85855eb7
Bump version to 0.1.1 2020-04-28 19:25:28 +03:00
martoon
be9d750624
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:37:43 +03:00
Ivan Gromakovskii
ec9f8bae5e
Add a changelog, require its maintenance
Problem: we are going to release this tool and from that point
it would be nice to maintain its changelog.

Solution: add a simple CHANGES.md and update PR template.
2020-01-14 20:24:01 +03:00
martoon
fd949bc3c8
Rename the project to xrefcheck
Problem: the previous name `crossref-verifier` was found long and
boring.

Solution: rename to `xrefcheck`.
2020-01-14 12:17:01 +03:00
Ivan Gromakovskii
8060c7187b
[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-19 16:19:27 +03:00
Ivan Gromakovskii
4592392f02
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-19 16:19:25 +03:00
Alexander Bantyev
198725b792
Add hspec-discover to build-tools of test 2019-12-05 00:00:36 +03:00
Ivan Gromakovskii
2ebbbc1d63
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-12-05 00:00:34 +03:00
martoon
0671986bcb
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 23:19:37 +03:00
martoon
90e160e7d2
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 15:29:33 +03:00
martoon
444fa7349f
Add verification progress bar 2019-03-12 16:40:10 +03:00
martoon
2f4101c361
Add tests on header to anchor conversion 2019-03-11 17:16:06 +03:00
martoon
dc14c19e45
[INT-31] Enable external references checker 2018-10-16 14:58:53 +03:00
martoon
56b4e38308
[INT-31] Add config and CLI options 2018-10-11 17:27:59 +03:00
martoon
d1ee907cfb
[INT-31] Prettify output 2018-10-11 15:40:39 +03:00
martoon
b06ef33541
[INT-31] Use cmark-gfm to parse markdown instead of manual parser 2018-10-11 14:06:32 +03:00
martoon
ea83f75643
[INT-31] Implement cross-references verifier 2018-10-11 02:51:28 +03:00