devonfw / asciidoc-link-checker Goto Github PK

Tool to check links in AsciiDoc files

License: Apache License 2.0

TypeScript 93.99% JavaScript 6.01%

asciidoc-link-checker's Introduction

devonfw default community health files

devonfw is a standard development platform and consists of many repositories. This repository is for default community health files of this entire devonfw github organization.

asciidoc-link-checker's People

Contributors

Stargazers

Watchers

Forkers

maoddoy gaurav-nelson jorge-dacal sjimenez77 sujith-mn suprishi yf-b dolvie1012 isandesh1986 tlueecke

asciidoc-link-checker's Issues

Recursive validation of all links in a directory is not complete

Expected behavior

As a user, I want to check all links in all files of a directory incl. also links in lists contained in a file so that I have no invalid link anywhere in the source directory.

Actual behavior

Steps to reproduce (bug) / Use Case of feature request (enhancement)

Create a directory with adoc files and also with a subdirectory incl. adoc files
In one of the adoc files put in a adoc list with links as the members
Run linkchecker on the created directory

Related/Dependent Issues

N/A

Comments/Hints:

Already fixed the issue and will push a branch for it, once the issue is created

Affected version:

All

Unit test is failing in github action

npm run test is failing.

Error: Cannot find module '../build/index'

I am getting following error in the latest version.

linkchecker Documents/openshift-docs/install_config/persistent_storage/
module.js:491
    throw err;
    ^

Error: Cannot find module '../build/index'
    at Function.Module._resolveFilename (module.js:489:15)
    at Function.Module._load (module.js:439:25)
    at Module.require (module.js:517:17)
    at require (internal/module.js:11:18)
    at Object.<anonymous> (/home/gnelson/.nvm/versions/node/v8.4.0/lib/node_modules/@oasp/asciidoc-link-checker/bin/linkchecker:5:20)
    at Module._compile (module.js:573:30)
    at Object.Module._extensions..js (module.js:584:10)
    at Module.load (module.js:507:32)
    at tryModuleLoad (module.js:470:12)
    at Function.Module._load (module.js:462:3)

Version:
├── @oasp/[email protected] (github:oasp/asciidoc-link-checker#ac64831a376cd642f27ed09d334a1ad4e6a16708)
Node: v8.4.0
NPM: 5.4.1

NPM Warning Messages on install

Everything is working fine but I am getting following message when I install:

npm WARN registry Unexpected warning for https://registry.npmjs.org/:
Miscellaneous Warning EINTEGRITY: sha1-Yi4y6CSItJJ5EUpPns9F581rulU= integrity
checksum failed when using sha1: wanted sha1-Yi4y6CSItJJ5EUpPns9F581rulU= but
got
sha512-q4spe4KTfsAS1SUHLO0wz8Qiyf1+vMIAgpRYioFYDMNqKfHQbg+AVDH3i4fvpl71/P1L0dBl+fQi+P37UYf0ew==.
(6052 bytes) npm WARN registry Using stale package data from
https://registry.npmjs.org/ due to a request error during revalidation.
/home/user/.nvm/versions/node/v7.10.0/bin/linkchecker ->
/home/user/.nvm/versions/node/v7.10.0/lib/node_modules/@oasp/asciidoc-link-checker/bin/linkchecker +
@oasp/[email protected] added 176 packages in 3.934s

Add option to validate that internal links depending on configuration

As a user, I want to be able to validate internal links to only point to non-adoc files and to also validate xref tags correctly so that a static created website from my asciidoc repository will still work also for HTML files.

Comment: will work on that myself and provide a PR to showcase the idea.

Enhancement - Make output easy to read

The current output lists filename ---> link, and status. Some links are red colored(internal links), with no explanation to why it is so. Follwoing is current output:

$ linkchecker openshift-docs/install_config/persistent_storage/
Documents/openshift-docs/install_config/persistent_storage/dynamically_provisioning_pvs.adoc ---> http://127.0.0.1:8081 site can't be reached
Documents/openshift-docs/install_config/persistent_storage/persistent_storage_azure.adoc ---> https://someacount.blob.core.windows.net/vhds/test2.vhd site can't be reached
Documents/openshift-docs/install_config/persistent_storage/persistent_storage_nfs.adoc ---> https://github.com/openshift/openshift-ansible/tree/master/roles/kube_nfs_volumes cannot be verified
 Documents/openshift-docs/install_config/persistent_storage/persistent_storage_fibre_channel.adoc ---> https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Linux/7/html/Storage_Administration_Guide/ch25.html ---> 404 
 Documents/openshift-docs/install_config/persistent_storage/persistent_storage_glusterfs.adoc ---> Documents/openshift-docs/install_config/persistent_storage/OpenShift_Containerization_Gluster_412816_0716_JCS_converged.png False 
 Documents/openshift-docs/install_config/persistent_storage/persistent_storage_glusterfs.adoc ---> Documents/openshift-docs/install_config/persistent_storage/OpenShift_Containerization_Gluster_412816_0716_JCS_dedicated.png False 
DONE: Some link failed

It would be great if we can improve the output to be more clear and cleaner. Something along the lines of following:

FILE: long/path/to/file/with/extension/filename.asciidoc
[Unreachable]   http://this.is.link/that/failed
[Unreachable]   http://another.link/that/failed
[404]                 local/file/link/ti/image.png

FILE: long/path/to/file/with/extension/filename/another.adoc
[Status]   http://this.is.link/that/failed
[Status]   http://another.link/that/failed
[Status]   local/file/link/ti/image.png

FILE: Documents/openshift-docs/install_config/persistent_storage/dynamically_provisioning_pvs.adoc
[Unreachable]   http://127.0.0.1:8081

FILE: Documents/openshift-docs/install_config/persistent_storage/persistent_storage_azure.adoc 
[Unreachable]   https://someacount.blob.core.windows.net/vhds/test2.vhd


DONE: Some links failed!

Check link to a relative file

As an AsciiDoc readme author, I want to have relative links automatically checked for existence so that readers don't find 404 page when clicking on relative links.

/usr/bin/env: ‘node\r’: No such file or directory

OS: Fedora 26
Node: v7.10.0
NPM: 5.0.3

Steps:

npm install -g @oasp/asciidoc-link-checker
linkchecker ./test-docs-repo/
Getting the error /usr/bin/env: ‘node\r’: No such file or directory.