serokell/xrefcheck
1
1
Fork 0
mirror of https://github.com/serokell/xrefcheck.git synced 2024-09-11 13:37:36 +03:00
Code Issues Projects Releases Wiki Activity
015b12126a
xrefcheck/CHANGES.md

195 lines
9.2 KiB
Markdown
Raw Normal View History

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:22:20 +03:00
<!--
[#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: 2021 Serokell <https://serokell.io>
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:22:20 +03:00
-
- SPDX-License-Identifier: MPL-2.0
-->
Unreleased
==========
v0.2.2 release
2022-10-25 12:27:27 +03:00
[#157] Add support for autolinks Problem: GitHub renders "implicit" links like `visit www.google.com` as links, but we don't check them, since cmark-gfm renders them as text Solution: add `autolink` extension to `cmark-gfm`, so both `www.google.com` and `https://google.com` will be parsed as link and successfuly verified
2022-09-28 12:52:32 +03:00
* [#176](https://github.com/serokell/xrefcheck/pull/176)
+ Enabled `autolink` extension for `cmark-gfm`, so now we're finding strings
[#25] Redirect links with configuration rules Problem: We previously changed the default behaviour of Xrefcheck when following link redirects, but did not provide a way to configure it. Solution: We are adding a new field in the configuration file to allow writing a list of redirect rules that will be applied to links that match them.
2022-12-19 19:50:07 +03:00
like `www.google.com` or `https://google.com`, treating them as links
and checking.
[#170] [#119] Reorganize top-level config keys Problem: At the moment, the config yaml is organized in 3 top-level keys: `traversal`, `verification` and `scanners`. However, the distinction between the "traversal" and the "verification" stages is not relevant to the user. This is entirely an internal concern. Solution: Reorganize yaml config options under `exclusions`, `networking` and `scanners`.
2022-09-27 10:30:24 +03:00
* [#175](https://github.com/serokell/xrefcheck/pull/175)
+ Reorganize top-level config keys.
[#171] Rename exclusion-related config options Problem: The behaviours of `ignoreRefs`, `virtualFiles`, `notScanned` and `ignored` are closely related. We need to make intent of these more obvious to the user. Solution: Rename `ignoreRefs`, `virtualFiles`, `notScanned` and `ignored` to `ignoreExternalRefsTo`, `ignoreLocalRefsTo`, `ignoreRefsFrom` and `ignore`. Also, update their yaml comments in default config file.
2022-09-28 11:04:08 +03:00
* [#178](https://github.com/serokell/xrefcheck/pull/178)
+ Rename exclusion-related config options.
[#92] Add support for image links Problem: We should add support for image links. Solution: Extract image links as regular links.
2022-09-29 12:11:42 +03:00
* [#183](https://github.com/serokell/xrefcheck/pull/183)
+ Add support for image links.
[Chore] Fix changelog entry (#205)
2022-10-26 13:30:47 +03:00
* [#199](https://github.com/serokell/xrefcheck/pull/199)
+ Now annotation
[#25] Redirect links with configuration rules Problem: We previously changed the default behaviour of Xrefcheck when following link redirects, but did not provide a way to configure it. Solution: We are adding a new field in the configuration file to allow writing a list of redirect rules that will be applied to links that match them.
2022-12-19 19:50:07 +03:00
`<!-- xrefcheck: ignore all -->` instead of `<!-- xrefcheck: ignore file -->`
should be used to disable checking for links in file, so it's clearer that
file itself is not ignored (and links can target it).
[#200] Add `--include-untracked` CLI option Problem: xrefcheck checks only files that are tracked by Git, but sometimes we want to run xrefcheck on files without adding them to Git, e.g. when we want to test some generator of markdown files or when we actively create markdown files during development. Solution: add option to treat files that were neither added to git nor ignored as existing.
2022-11-16 01:52:43 +03:00
* [#215](https://github.com/serokell/xrefcheck/pull/215)
+ Now we notify user when there are scannable files that were not added to Git
[#25] Redirect links with configuration rules Problem: We previously changed the default behaviour of Xrefcheck when following link redirects, but did not provide a way to configure it. Solution: We are adding a new field in the configuration file to allow writing a list of redirect rules that will be applied to links that match them.
2022-12-19 19:50:07 +03:00
yet. Also added CLI option `--include-untracked` to scan such files and treat
as existing.
[#164] Add workflow for running Windows tests on CI Problem: we are not testing behavior of xrefcheck on Windows Solution: and add workflow to run golden and tasty tests on CI via github-actions windows runner Some subproblems appear: 1. Problem: CI build fails beacuse it needs `pcre` package Solution: add it (somehow), see `install pacman dependencies` in ci.yml 2. Problem: Network errors displayed different on different platforms Solution: collect output from both and use `assert_diff expected_linux.gold || assert_diff expected_windows.gold` 3: Problem: "Config matches" test is failing because checkout action clone files with CRLF, and test assert equality of two ByteStrings Solution: manually remove CR
2022-10-13 17:07:19 +03:00
* [#191](https://github.com/serokell/xrefcheck/pull/191)
+ Now we consider slash `/` (and only it) as path separator in local links for all OS,
so xrefcheck's report is OS-independent
+ Use utf-8 compatible codepage on Windows
[#202] Remove poorly supported unicode symbols from the program output Problem: We are using unicode symbols as visual clues in the program output that are not commonly supported and are therefore not always displayed as intended. Solution: Remove the usage of these symbols, as the program output is already using other visual clues and the result will remain understandable for the user.
2022-11-29 13:16:56 +03:00
* [#224](https://github.com/serokell/xrefcheck/pull/224)
+ Now the program output does not contain unicode characters that are not widely supported.
[#228] Changelog entry
2022-12-01 14:00:49 +03:00
* [#229](https://github.com/serokell/xrefcheck/pull/229)
[#228] Rename local file reference tag Problem: We have found that the current tag for local file references, current file, may lead to ambiguities. Solution: Rename the tag that we use for local file references to be file-local instead.
2022-12-01 13:54:32 +03:00
+ Now we call references to anchors in current file (e.g. `[a](#b)`) as
`file-local` references instead of calling them `current file` (which was ambiguous).
[#218] Change redirects default behaviour Problem: Xrefcheck currently always follows redirect links. Solution: We are changing its default behaviour regarding redirect links to fail and report permanent redirects, and to pass for temporary redirects. Further PRs will allow the user to configure other policies.
2022-12-07 17:48:09 +03:00
* [#233](https://github.com/serokell/xrefcheck/pull/233)
+ Now xrefxcheck does not follow redirect links by default. It fails for permanent
redirect responses (i.e. 301 and 308) and passes for temporary ones (i.e. 302, 303, 307).
[#211] Case insensitive anchors Problem: Some Markdown flavours such as the GitHub one are case insensitive regarding anchors, but our analysis is currently case sensitive and it produces false positives. Solution: Support case-insensitivity depending on the configured Markdown flavour. Apply this also to ambiguous and similar anchors detection.
2022-12-13 12:20:32 +03:00
* [#231](https://github.com/serokell/xrefcheck/pull/231)
+ Anchor analysis takes now into account the appropriate case-sensitivity depending on
[#25] Redirect links with configuration rules Problem: We previously changed the default behaviour of Xrefcheck when following link redirects, but did not provide a way to configure it. Solution: We are adding a new field in the configuration file to allow writing a list of redirect rules that will be applied to links that match them.
2022-12-19 19:50:07 +03:00
the configured Markdown flavour.
[#254] Revise dump-config command Problem: xrefcheck does not allow to print the config to stdout instead of writing it to a file. Also, it is easy to overwrite your changes by mistake by executing the command again. Solution: provide a --stdout flag to print the config to stdout, and do not write it to a file unless a --force flag has been included.
2022-12-22 15:20:05 +03:00
* [#254](https://github.com/serokell/xrefcheck/pull/254)
+ Now the `dump-config` command does not overwrite a file unless explicitly told with a
`--force` flag. Also, a `--stdout` flag allows to print the config to stdout instead.
[#25] Redirect links with configuration rules Problem: We previously changed the default behaviour of Xrefcheck when following link redirects, but did not provide a way to configure it. Solution: We are adding a new field in the configuration file to allow writing a list of redirect rules that will be applied to links that match them.
2022-12-19 19:50:07 +03:00
* [#250](https://github.com/serokell/xrefcheck/pull/250)
+ Now the redirect behavior for external references can be modified via rules in the
configuration file with the `externalRefRedirects` parameter.
[#242] No scan symlinks as md files Problem: When the repository contains a symlink to a markdown file, it is processed by xrefcheck as if it was the same markdown file but in the symlink's location. This leads to broken references and can be avoided because neither GitHub nor GitLab try to render symlinks as the file they point to. Solution: Consider symlinks as no scannable files. In the future, we will consider to include a new dedicated scanner for symlinks if it works.
2023-01-12 22:12:43 +03:00
* [#261](https://github.com/serokell/xrefcheck/pull/261)
+ Symlinks are now not processed by the scanner.
[#237] Modify coloring options Problem: We noticed that output was not being colorized in GitLab CI due to the current implemented guesses for whether showing colors or not. Solution: On the one hand, we extend the current guesses to also enable coloring by default when the CI env var is set to true. On the other hand, we also add a new flag, color, which avoids these guesses and enables colors.
2023-01-19 21:58:12 +03:00
* [#268](https://github.com/serokell/xrefcheck/pull/268)
+ Added CLI option `--color` that enables ANSI colors in output.
+ Changed the output coloring defaults to show colors when `CI` env variable is `true`.
[#270] Handle relative redirects Problem: Currently, Xrefcheck can follow redirects with an absolute location link, but it cannot handle relative ones. Solution: After parsing the location link, obtain the corresponding absolute link by using the original request one.
2023-01-26 13:35:57 +03:00
* [#271](https://github.com/serokell/xrefcheck/pull/271)
+ Now Xrefcheck is able to follow relative redirects.
[#244] Symlink scanner Problem: As GitHub and GitLab do not render symlinks as the file they point to, we are considering to implement a new scanner for symlinks that verifies them up to some extent. Solution: A scanner that validates the reference from a symlink has been implemented in the same style as the markdown scanner.
2022-12-30 20:37:37 +03:00
* [#262](https://github.com/serokell/xrefcheck/pull/262)
+ Now Xrefcheck includes a scanner that verifies the repository symlinks.
[#157] Add support for autolinks Problem: GitHub renders "implicit" links like `visit www.google.com` as links, but we don't check them, since cmark-gfm renders them as text Solution: add `autolink` extension to `cmark-gfm`, so both `www.google.com` and `https://google.com` will be parsed as link and successfuly verified
2022-09-28 12:52:32 +03:00
v0.2.2 release
2022-10-25 12:27:27 +03:00
0.2.2
==========
[#140] Reject unknown fields in yaml config Problem: during parsing yaml file, `fromJSON` instance is used, and by default it ignores unknown field, and we want to get errors instead (issue #140) Solution: change `fromJSON` instance for `Config` and types inside it. Luckily, they and only they use `aesonConfigOption`
2022-09-25 20:03:57 +03:00
* [#145](https://github.com/serokell/xrefcheck/pull/145)
+ Add check that there is no unknown fields in config.
[#155] Footnote syntax support Problem: we can wrongly report footnotes as broken links (#155), because footnotes support is disabled by default in cmark-gfm Solution: add `optFootnotes` to `commonMarkToNode` (this option was recently added to cmark-gfm-hs, so we need to temporarily pull it from github instead hackage)
2022-09-23 17:55:49 +03:00
* [#158](https://github.com/serokell/xrefcheck/pull/158)
[#170] [#119] Reorganize top-level config keys Problem: At the moment, the config yaml is organized in 3 top-level keys: `traversal`, `verification` and `scanners`. However, the distinction between the "traversal" and the "verification" stages is not relevant to the user. This is entirely an internal concern. Solution: Reorganize yaml config options under `exclusions`, `networking` and `scanners`.
2022-09-27 10:30:24 +03:00
+ Fixed bug when we reported footnotes as broken links.
[#162] Do not cancel the progress bar thread Problem: The output of xrefcheck sometimes appears as a confusing mess, see here for details and examples: https://github.com/serokell/xrefcheck/issues/162 The culprit seems to be the `withAsync` used in `verifyRepo`. This spawns a thread that prints and refreshes the progress bar, while the main thread coordinates the verification of references. The problem here is that, as the docs of `withAsync` explain, when the main thread finishes/throws, the spawned thread will be cancelled with `uninterruptibleCancel`. If the thread is in the middle of updating the progress bar (printing return carriages, writing over an existing line, printing control characters to change the text color, etc), it'll be abruptly interrupted and will not be given the chance to finish cleanly. Solution: replace `withAsync` with `loopAsyncUntil`. This lets the printer thread finish what it's currently doing.
2022-09-24 18:50:29 +03:00
* [#163](https://github.com/serokell/xrefcheck/pull/163)
+ Fixed an issue where the progress bar thread might be unexpectedly cancelled and jumble up the output.
[#180] Make `flavor` a required parameter Problem: As of #159 we made all config fields optional. However, it makes sense to make the `flavor` field mandatory, as it affects correctness and the user must make a choice here. Solution: Make `flavor` a required parameter.
2022-09-29 12:56:05 +03:00
* [#184](https://github.com/serokell/xrefcheck/pull/184)
+ Make `flavor` a required parameter.
[#166] Rename references to current file Problem: as in #166, we use are wrongly calling links to current file e.g. `[a](#heading)` as "local", which is confusing with using "local" as "link to anything in current repository". Solution: call them "links to current file" and rename constructor `LocalLoc` to `CurrentFileLoc`
2022-09-28 21:58:17 +03:00
* [#182](https://github.com/serokell/xrefcheck/pull/182)
+ Now we call references to anchors in current file (e.g. `[a](#b)`) as
[#228] Rename local file reference tag Problem: We have found that the current tag for local file references, current file, may lead to ambiguities. Solution: Rename the tag that we use for local file references to be file-local instead.
2022-12-01 13:54:32 +03:00
`current file` references instead of calling them `local` (which was ambiguous).
[#185] Add CLI option to disable output coloring Problem: output of xrefcheck contains ANSI-colored text, which is bad when we redirect output to file or when our terminal is not supporting colors. Colorising is performed in `Buildable` instances of various types, so we can't just pass some extra flag here Solution: add CLI option `--no-color` Create `colorIfNeeded` and `styleIfNeeded` functions that have `Data.Reflection.Given ColorMode` constraint, and replace all usages of `color` and `style` by them, adding new constraint to instances.
2022-10-01 20:28:44 +03:00
* [#188](https://github.com/serokell/xrefcheck/pull/188)
+ Added CLI option `--no-colors` that disables ANSI colors in output.
Automatically disable coloring if it is not supported Problem: users need to manually disable ANSI coloring when their terminal is not supporting it. Also we need to explicitly disable colors if we want to redirect output in file during test Solution: use `System.Console.Pretty.supportsPretty` to detect if our terminal is not supporting colors
2022-10-01 20:29:20 +03:00
+ Automatically disable coloring if it is not supported
[#138] Report links that escape repo directory Problem: as in #138, when we see a local link, we are checking only existance of referred file, not checking that this file is a part of repo and link will compatible with Github's renderer Solution: manually count "nesting levels" of all local links, checking that number of `".."`'s is always less then number of real directories
2022-09-19 12:40:37 +03:00
* [#152](https://github.com/serokell/xrefcheck/pull/152)
+ Now we report links that target a file outside repository (e.g. `/../a.md`)
as broken (with message `Link targets a local file outside repository`).
Same for links that are using directories outside repository (e.g. `/../repo/a.md`),
since such things are not supported by GitHub markdown renderer.
[#139] Ignore build-related files Problem: At the moment, we're using the ignored option for mainly 2 purposes: 1) to ignore all files in the `.git` folder (`.git/**/*`) to ignore all build-related temporary files (the default config ignores `.stack-work/**/*`). A more robust alternative might be to ignore all files implicitly ignored by git. Solution: Use `git ls-files` to ignore all files implicitly ignored by git.
2022-09-26 08:34:13 +03:00
* [#174](https://github.com/serokell/xrefcheck/pull/174)
+ Make xrefcheck only scan files that are tracked by git.
+ Fixed bug where links to ignored files were valid.
+ Fixed bug where links with trailing slashes were invalid.
[#187] Check globs in config fields and CLI args Problem: user can think that globs in e.g. config field `ignored` have same root as all markdown links, so if he will add e.g. `/scripts/*` to ignore, link `[a](/scripts/*)` will be not checked. But we were understanding this glob as filesystem-level absolute path (so this link will still be checked). Also we pretend to check correctness of user-supplied globs, but we're using glob parser in mode that always succeed (and transform bad globs to correct somehow). Solution: make function `mkGlobPattern` that throws readable error when see absolute paths (like `/scripts/*`) or malformed globs (like `<a>`), use it for parsing all globs in config fields and cli args. Also remove redundant "canonization" of globs
2022-10-18 23:15:40 +03:00
* [#198](https://github.com/serokell/xrefcheck/pull/198)
+ Now we're checking globs in config fields and CLI args (e.g. `ignored`),
they must be valid globs relative to repository root (`foo/*` instead of `/foo/*`)
[#150] Change `ignore link` behavior Problem: Currently `ignore link` annotation works for a first link after it (in a whole file). That can be bad for user, e.g. he may forgot to delete this annotation, and now it ignores link in some random place Solution: Throw scan errors when `ignore link` is not followed by a node with link. To do this, we need to increase amount of context in `ScannerM`
2022-10-18 00:47:18 +03:00
* [#196](https://github.com/serokell/xrefcheck/pull/196)
+ Now `xrefcheck: ignore link` annotation expects a link to ignore in next markdown node,
instead of expecting link in whole rest of file.
If you've got `Expected a LINK after "ignore link" annotation` message, see
PR's description for examples and details.
[#138] Report links that escape repo directory Problem: as in #138, when we see a local link, we are checking only existance of referred file, not checking that this file is a part of repo and link will compatible with Github's renderer Solution: manually count "nesting levels" of all local links, checking that number of `".."`'s is always less then number of real directories
2022-09-19 12:40:37 +03:00
v0.2.1 release
2022-09-23 14:21:30 +03:00
0.2.1
==========
[#99] Support `Retry-After` headers with dates Problem: We currently support obtaining `Retry-After` header values as seconds. However, the http specs state that the header value can be also a date, e.g: `Wed, 21 Oct 2015 07:28:00 GMT`. Solution: Support `Retry-After` headers with dates.
2022-08-01 13:26:56 +03:00
* [#127](https://github.com/serokell/xrefcheck/pull/127)
+ Support `Retry-After` headers with dates.
[#90] Forbid verifying a single file Problem: Verifying a single file using `-r` option missbehaves when there are absolute links present in the file. Since `-r` option expects a directory, we can just forbid verifying a single file. Solution: Fail with an error message when the user tries to specify a file as the repository's root directory.
2022-07-22 15:29:09 +03:00
* [#117](https://github.com/serokell/xrefcheck/pull/117)
+ Forbid verifying a single file using `--root` command line option.
[Chore] Add missing changelog entries
2022-07-22 18:51:28 +03:00
* [#115](https://github.com/serokell/xrefcheck/pull/115)
+ Improved parsing of anchor html tags inside headers.
* [#109](https://github.com/serokell/xrefcheck/pull/109)
+ Fixed bug when prefixing `--ignored` and `--root` paths with `./`
[#81] Add config option for localhost links Problem: Almost all the time we can't validate localhost links, so we just skip them. But to run ftp links tests (#47) we need to refer to localhost. Solution: Add config option whether to ignore localhost links and provide bats tests for this new feature. Co-authored-by: Alexander Bantyev <alexander.bantyev@serokell.io>
2021-08-04 12:21:34 +03:00
* [#85](https://github.com/serokell/xrefcheck/pull/85)
+ Make possible to specify whether ignore localhost links, use
`check-localhost` CLA argument (by default localhost links will not be checked).
[#81] Add config option for protected links Problem: We do not know what to do with protected links, because we cannot check them. So we have two options, assume that these links is valid or not. Solution: Provide config option for user to decide what to do - assume protected links valid or not.
2021-08-04 12:05:38 +03:00
+ Make possible to ignore auth failures (assume 'protected' links
[#25] Redirect links with configuration rules Problem: We previously changed the default behaviour of Xrefcheck when following link redirects, but did not provide a way to configure it. Solution: We are adding a new field in the configuration file to allow writing a list of redirect rules that will be applied to links that match them.
2022-12-19 19:50:07 +03:00
valid), use `ignoreAuthFailures` parameter of config.
[#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
* [#66](https://github.com/serokell/xrefcheck/pull/66)
+ Added support for ftp links.
[#74] Detect and handle duplicate links during verification Problem: All the duplicate external links get verified independently, which is wasteful. Solution: Store the verification results in the map. Verify the link once if it hasn't been verified already, and insert the results into the map; alternatively, if the link has been verified before, return the results by retrieving the respective value from the map. The traversal of all the filepath-reference pairs is done via 'forConcurrentlyCaching', which is semantically similar to Control.Concurrent.Async.forConcurrently, except it stores the action results in a map (in our case, we need to store the verification results of only the external references).
2021-10-04 21:58:24 +03:00
* [#74](https://github.com/serokell/xrefcheck/pull/83)
+ Add the duplication detection & verification result caching algorithm for external references.
[#75] Fix the root with an appended slash support Problem: The results of the repository analysis will always contain invalid references if the root contains a trailing forward slash. Solution: Strip the root's trailing slash (if present) when having it be given as an argument of the System.FilePath.Posix.takeDirectory function.
2021-09-07 20:25:32 +03:00
* [#82](https://github.com/serokell/xrefcheck/pull/82)
+ Fix the issue of having the lowest level context duplicated, caused by the root's trailing path separator.
[#49] Allow certain reserved characters in the URLs Problem: The current version of xrefcheck doesn't allow the square brackets and some other special characters, like the angle brackets and the curly brackets, to be present in the URLs, even in the query strings, as they need to be percent-encoded first. Solution: Allow some of the reserved characters, like the brackets, to be present in the query strings of the URLs. There exist two main standards of URL parsing: RFC 3986 and the Web Hypertext Application Technology Working Group's URL standard. Ideally, we want to be able to parse the URLs in accordance with the latter standard, because it provides a much less ambiguous set of rules for percent-encoding special characters, and is essentially a living standard that gets updated constantly. We allow these characters to be present in the query strings by using the `parseURI` function from the `uri-bytestring` library with `laxURIParseOptions`.
2022-07-15 01:10:12 +03:00
* [#88](https://github.com/serokell/xrefcheck/pull/88)
[#31] Handle the "429 too many requests" errors Problem: The current version of xrefcheck handles the HTTP responses with the 429 status code just like every other error, when it is possible to try and eliminate the occurrences of such errors within the program itself. Solution: Each time the result of performing a request on a given link is a 429 error, retrieve the Retry-After information, describing the delay (in seconds), from the headers of the HTTP response, or, alternatively, use a configurable default value if the Retry-After header is absent, and rerun the request after an amount of time described by the said value had passed. Only after the number of retries had reached its limiting value, which, as of right now, is not configurable and is hardcoded, is when the 429 error is converted into becoming 'unfixable', and any further attempts to remove the error are terminated. Additionally, the progress bar has been upgraded and the following elements are supplied: 1. an extra color -- Blue -- indicating the errors that might get eliminated during the verification; 2. a timer with the number of seconds left to wait for the restart of the request; if, during the verification, a new 429 error had emerged with the new Retry-After value being greater than or equal to the elapsed time, the timer is immediately updated with that value and begins ticking down each second from scratch.
2021-10-22 01:00:18 +03:00
+ Handle the "429 too many requests" errors & attempt to eliminate them during verification.
[#126] Changelog update: Make `ignoreRefs` a required parameter Problem: We made `ignoreRefs` a required option. Since this is "user-facing change", we should add an entry to `CHANGES.md`. Solution: Add an entry to `CHANGES.md`.
2022-08-29 10:20:01 +03:00
* [#128](https://github.com/serokell/xrefcheck/pull/128)
+ Make `ignoreRefs` a required parameter.
[#94] Changelog update: Add support for the `id` attribute in anchors Problem: We added support for the `id` attribute in anchors. Since this is "user-facing change", we should add an entry to `CHANGES.md`. Solution: Add an entry to `CHANGES.md`.
2022-08-29 10:46:32 +03:00
* [#129](https://github.com/serokell/xrefcheck/pull/129)
[#49] Allow certain reserved characters in the URLs Problem: The current version of xrefcheck doesn't allow the square brackets and some other special characters, like the angle brackets and the curly brackets, to be present in the URLs, even in the query strings, as they need to be percent-encoded first. Solution: Allow some of the reserved characters, like the brackets, to be present in the query strings of the URLs. There exist two main standards of URL parsing: RFC 3986 and the Web Hypertext Application Technology Working Group's URL standard. Ideally, we want to be able to parse the URLs in accordance with the latter standard, because it provides a much less ambiguous set of rules for percent-encoding special characters, and is essentially a living standard that gets updated constantly. We allow these characters to be present in the query strings by using the `parseURI` function from the `uri-bytestring` library with `laxURIParseOptions`.
2022-07-15 01:10:12 +03:00
+ Add support for the `id` attribute in anchors.
* [#116](https://github.com/serokell/xrefcheck/pull/116)
+ Allow certain reserved characters to be present in the query strings of the URLs.
[#120] Fix bug with ignoring checks for relative anchors Problem: When a file contains a reference to another file, and that reference contains an anchor, that anchor is not checked. Solution: Normalise relative anchor links before check.
2022-08-30 20:05:18 +03:00
* [#130](https://github.com/serokell/xrefcheck/pull/130)
+ Fixed bug with ignoring checks for relative anchors.
[#125] Display URL parsing errors Problem: We use a 2-step process to parse a URL: we use `parseURI` and then `mkURIBs`. Both of these functions can fail. At the moment, we're ignoring their errors and simply throwing a `ExternalResourceInvalidUri`, and then displaying a generic error message to the user. Solution: Catch errors from `parseUri` and `mkURIBs` and use them to tell user why the URL was invalid.
2022-09-07 00:19:17 +03:00
* [#132](https://github.com/serokell/xrefcheck/pull/132)
+ Display URL parsing errors.
[#77] Add support for glob patterns to `ignored` and `notScanned` Problem: The `virtualFiles` config option supports glob patterns. On the other hand, `ignored` only supports exact matches and `notScanned` mathches on prefixes. There is also a bug where `ignored` does not ignore files if they contain broken xrefcheck annotations. Solution: Add support for glob patterns to `ignored` and `notScanned`. Filter ignored files before parsing their contents.
2022-09-03 20:25:02 +03:00
* [#131](https://github.com/serokell/xrefcheck/pull/131)
+ Add support for glob patterns to `ignored` and `notScanned`.
+ Remove support for directory names from `ignored` and `notScanned`.
+ Fix bug with `ignored` not ignoring files with broken xrefcheck annotations.
[#137] Remove `checkLocalhost` option Problem: In #85, we added the `checkLocalhost` option to decide whether to verify links to localhost. However, upon further reflection, it seems like this could have been subsumed by the existing `ignoreRefs` option instead. Solution: Remove `check-localhost` CLI option and `checkLocalhost` config option. Add a regex matching localhost links to the `ignoreRefs` field of the default config.
2022-09-14 13:00:28 +03:00
* [#142](https://github.com/serokell/xrefcheck/pull/142)
+ Remove `check-localhost` CLI option and `checkLocalhost` config option.
+ Add a regex matching localhost links to the `ignoreRefs` field of the default config.
[#62] [INT-141] Add to changelog, update version
2021-07-13 20:17:22 +03:00
* [#68](https://github.com/serokell/xrefcheck/pull/68)
+ Recognise manual HTML-anchors inside headers.
[#56] Dump all the errors from different files Problem: Currently, xrefcheck fails immediately after the first observed error because `die` is used right in `markdownScanner` What we want is dumping all the errors from different markdowns and then print them as a final xrefcheck's result together with the broken links. Also, despite the fact that in the `makeError` function we have 4 error messages, 2 of them are not reported, and the test case that should check this only checks that at least one of the four files throws an error. Solution: Make xrefcheck to report all errors. Add `ScanError` type and propagate errors to report all of them, rather than failing immediately after the first error is detected.
2022-09-08 22:17:27 +03:00
* [#141](https://github.com/serokell/xrefcheck/pull/141)
+ Dump all the errors from different files.
+ Fix bug where no errors were reported about broken link annotation and unrecognised annotation.
[#156] Make all config options optional Problem: In #126 we made the `ignoreRefs` option required (to match the other options). However, having it optional is better for backwards-compatibility and to help users migrate to newer xrefcheck versions. Solution: Make all config options optional.
2022-09-23 22:51:39 +03:00
* [#159](https://github.com/serokell/xrefcheck/pull/159)
+ Make all config options optional.
[#62] [INT-141] Add to changelog, update version
2021-07-13 20:17:22 +03:00
Make 0.2 release
2021-05-04 15:51:28 +03:00
0.2
==========
v0.2.1 release
2022-09-23 14:21:30 +03:00
Update changelog
2021-02-25 20:09:17 +03:00
* [#57](https://github.com/serokell/xrefcheck/pull/57)
+ Added `flavor` field to config.
Also see [config sample](tests/configs/github-config.yaml).
+ Config generated with `dump-config` CLI command now depends on the provided repository type.
Prepare 0.1.3 release Problem: the feature with ignoring links has been added, and it is necessary in many places. Solution: make a release.
2021-03-17 15:02:49 +03:00
0.1.3
=======
* [#58](https://github.com/serokell/xrefcheck/pull/58)
+ Switch to lts-17.3.
[#135] Add "ignoring" changes to `CHANGES.md` Problem: Changes connected with adding `ignoreRefs` and ignorong modes are not stated in `CHANGES.md` Solution: Add information about such changes.
2020-12-25 17:23:29 +03:00
* [#53](https://github.com/serokell/xrefcheck/pull/53)
+ Make possible to include a regular expression in
[#25] Redirect links with configuration rules Problem: We previously changed the default behaviour of Xrefcheck when following link redirects, but did not provide a way to configure it. Solution: We are adding a new field in the configuration file to allow writing a list of redirect rules that will be applied to links that match them.
2022-12-19 19:50:07 +03:00
`ignoreRefs` parameter of config to ignore external
references.
[#135] Add "ignoring" changes to `CHANGES.md` Problem: Changes connected with adding `ignoreRefs` and ignorong modes are not stated in `CHANGES.md` Solution: Add information about such changes.
2020-12-25 17:23:29 +03:00
+ Add support of right in-place ignoring annotations
[#25] Redirect links with configuration rules Problem: We previously changed the default behaviour of Xrefcheck when following link redirects, but did not provide a way to configure it. Solution: We are adding a new field in the configuration file to allow writing a list of redirect rules that will be applied to links that match them.
2022-12-19 19:50:07 +03:00
such as `ignore file`, `ignore paragraph` and `ignore link`.
[#135] Add "ignoring" changes to `CHANGES.md` Problem: Changes connected with adding `ignoreRefs` and ignorong modes are not stated in `CHANGES.md` Solution: Add information about such changes.
2020-12-25 17:23:29 +03:00
Make a release
2020-06-26 15:41:52 +03:00
0.1.2
=======
Disable progress bar in CI automatically Problem: we have two major use cases: 1. Using xrefcheck in CI, in this case it is annoying for devops to always pass mostly always reasonable `--no-progress` option. 2. Using it locally, here we want progress bar to be enabled by default so that user could run `xrefcheck` without any options most of the time. Solution: Detect whether are we running in CI and use the respective default for whether progress bar should be displayed. Detecting whether we are within CI is possible using `CI` env variable, at least Github actions, Gitlab CI and Buildkite pass this env. `--no-progress` option still can be passed if user wants to suppress progress bar in local run. The opposite `--progress` seems to also make sense, because in case if high timeouts are set, user probably wants to track progress somehow to make sure that CI didn't hang. So we add the latter, and these two options can be used to override the default behaviour defined by `CI` env var.
2020-06-26 10:48:12 +03:00
* [#44](https://github.com/serokell/xrefcheck/pull/44)
+ Decide whether to show progress bar by default depending on `CI` env variable.
+ Added `--progress` option.
Update version and changelog Hopefully with recent changes Hackage will finally manage to build this package, so let's try uploading again.
2020-05-19 21:15:51 +03:00
0.1.1.2
=======
* [#34](https://github.com/serokell/xrefcheck/pull/34)
+ Do not depend on `autoexporter` and `base-noprelude`.
Make a new release This should fix the build problems on Hackage.
2020-05-15 21:00:52 +03:00
0.1.1.1
=======
* [#30](https://github.com/serokell/xrefcheck/pull/32)
+ Do not depend on `loot-prelude` package.
Bump version to 0.1.1
2020-04-25 18:41:39 +03:00
0.1.1
=======
Update changelog
2020-04-25 18:40:49 +03:00
* [#19](https://github.com/serokell/xrefcheck/pull/24)
+ Make `ignored` in config consider only exact matches.
+ Improve virtual files consideration.
+ Add `ignored` CLI option.
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:22:20 +03:00
0.1.0.0
=======
Initial release.
Reference in New Issue Copy Permalink