The milv from magicmatatjahu

milv's Issues

Add flag to ignore spaces in internal links and images

Whenever an internal link or image contains a space, it is considered as a dead link.

For example, if you have this [My title](My internal link) but frameworks such as mkdocs are tolerant to this and therefore it should be possible to set a flag in the milv.config.yaml file to indicate that we want to ignore this kind of errors.

validation retry policy

First of all, great project, I love it.

Would be cool if it would support validation retry of a given link, through some configuration file.
I know that some of my links fail randomly and would like to protect from having error reports in such case, instead I would like to configure that for a given link validation retry should be perform, 3 or 5 or whatever times, with 1, 2 or 5 sec delay between retires ;)

Cheers
Lukasz

Problems with headers in backticks

Hello,

It looks like headers verification doesn't work when header is inside backticks.

For example this is marked as not existing header:

[Link](#test)

## `test`

It is for example used here: https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md

Ignore links with mailto:xxx

I have some links such as mailto:[email protected]

and they appear with a false status. It should be ignored IMHO.

Thanks

External link doesn't work

Hello,

Sometimes external links doesn't works. For example there is a problem with: https://istio.io/docs/setup/kubernetes/quick-start#deploy-your-application

Http header:

HTTP/2 200
cache-control: public, max-age=0, must-revalidate
content-type: text/html; charset=UTF-8
date: Wed, 08 Aug 2018 10:41:23 GMT
etag: "05ebadd25d610adc020ae2687ad48531-ssl"
strict-transport-security: max-age=31536000
age: 90664
content-length: 60689
server: Netlify

The false positive error during link validation with anchor

Confirm these statements before you submit the issue:

I have searched open and closed issues for duplicates.
I have read the contributing guidelines.

Description
Validator produces the false positive error during link validation with anchor. The link points to the existing localization but error The specified anchor doesn't exist is raised.

Logs:

+ docker run --rm --dns=8.8.8.8 --dns=8.8.4.4 -v /home/jenkins/workspace/community/governance:/community:ro magicmatatjahu/milv:0.0.6 --base-path=/community --ignore-internal ./community/sig-and-wg/sig-core/proposals/common-libraries.md
#################################################
#                     SUMMARY                   #
#################################################

+---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+--------------------------------+
|                             FILE                              |                                                                  LINK                                                                  |          DESCRIPTION           |
+---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+--------------------------------+
| ./community/sig-and-wg/sig-core/proposals/common-libraries.md | https://github.com/kyma-project/kyma/blob/09b945ec0a897822b40666e518f2f258ae66e7e8/tests/acceptance/servicecatalog/wait/wait.go#L8-L24 | The specified anchor doesn't   |
|                                                               |                                                                                                                                        | exist                          |
+                                                               +                                                                                                                                        +                                +
|                                                               |                                                                                                                                        |                                |
|                                                               |                                                                                                                                        |                                |
+---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+--------------------------------+

Disable by default links with special characters

Confirm these statements before you submit the issue:

I have searched open and closed issues for duplicates.
I have read the contributing guidelines.

Description
Disable by default checking internal and external links with special characters like {[;|, because this is very frustrating when user must always add to white-list links with this chars.

Simplify whitelist config

Confirm these statements before you submit the issue:

I have searched open and closed issues for duplicates.
I have read the contributing guidelines.

Description

Hi @magicmatatjahu,
First of all: Great tool!

I have an idea for simplifying the whitelist config. Currently we have:

  - path: "path"
    config:
      white-list-internal: ["./test.md"]
      white-list-external: ["https://foo.bar"]

Can't we have just whitelist key?

  - path: "path"
    config:
      whitelist: ["./test.md", "https://foo.bar"]

Sometimes we have false positives, which we doesn't know whether they are classified as internal or external links.

Thanks!

Add --base-url flag

Confirm these statements before you submit the issue:

I have searched open and closed issues for duplicates.
I have read the contributing guidelines.

Description
Provide a new feature by flag --base-url, where value will be a URL to use for relative links (for support gatsby and other framework for blogs written in .md files)

Add line number to output

Confirm these statements before you submit the issue:

I have searched open and closed issues for duplicates.
I have read the contributing guidelines.

Description

It would be great to have the line # of the occurance(s) next to the LINK column.

#################################################
#                     SUMMARY                   #
#################################################

+-----------------------------------+----------------------------------------------------------+---------------------------------+
|               FILE                |                           LINK                           |           DESCRIPTION           |
+-----------------------------------+----------------------------------------------------------+---------------------------------+
| docs/application-information.md   | #aplication-log                                          | The specified header doesn't    |
|                                   |                                                          | exist in file                   |

problems with heading for relative links

Description

Milv has issues with handling headers in relative links, look on below example

12:03:43 +--------------------------------+-------------------------------------------------------------------+--------------------------------+
12:03:43 |              FILE              |                               LINK                                |          DESCRIPTION           |
12:03:43 +--------------------------------+-------------------------------------------------------------------+--------------------------------+
12:03:43 | ./community/issues-workflow.md | ./sig-and-wg/README.md#special-interest-groups-and-working-groups | The specified header doesn't   |
12:03:43 |                                |                                                                   | exist in file. Did you mean    |
12:03:43 |                                |                                                                   | about #team-backlog-optional?  |
12:03:43 +                                +                                                                   +                                +
12:03:43 |                                |                                                                   |                                |
12:03:43 |                                |                                                                   |                                |
12:03:43 |                                |                                                                   |                                |
12:03:43 +--------------------------------+-------------------------------------------------------------------+--------------------------------+

Add blacklist flag for relative and external links

Confirm these statements before you submit the issue:

I have searched open and closed issues for duplicates.
I have read the contributing guidelines.

Description

At the moment milv doesn't support blacklist of files for internal and external links, but only for all kind of links.

Example solution:

blacklist-internals: ["./README.md]
blacklist-externals: ["./README.md]

magicmatatjahu / milv Goto Github PK

milv's People

Contributors

Stargazers

Watchers

Forkers

milv's Issues

Recommend Projects

Recommend Topics

Recommend Org