🎩 Test for broken links. CLI + API.
Roadmap
- check all html files in a local directory
- take in an array of pages to check
- unit tests on
/lib
Basic Example
const lincoln = require('@binyamin/lincoln');
lincoln('https://binyam.in').then((results) => {
console.log(results);
// => {
// total: (number of links found),
// broken: [{
// url (link which is dead),
// src (page it was on),
// response_code (404),
// msg (not found)
// }, ...]
// }
});
Examples
lincoln('https://binyam.in');
// => There's a sitemap.xml in the root, so we check all those urls
lincoln('https://no-sitem.app');
// => No sitemap.xml exists. We only check the given url
lincoln('https://examp.le');
// => Site doesn't exist, so we get an error
$ npx @binyamin/lincoln https://binyam.in
Flags
- -h, --help - Prints usage information
- -v, --version - prints version
- -a, --allow - Allow total broken links less than the given number (Default: 0)
This is mainly a personal project, so I don't expect any contributions. That said, I'm open to all suggestions and/or contributions.
This project is under the MIT license.