Giter Club home page Giter Club logo

lincoln's Introduction

Lincoln

๐ŸŽฉ Test for broken links. CLI + API.

Test

Roadmap

  • check all html files in a local directory
  • take in an array of pages to check
  • unit tests on /lib

Usage

API

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

CLI

$ 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)

Contribute

This is mainly a personal project, so I don't expect any contributions. That said, I'm open to all suggestions and/or contributions.

Legal

This project is under the MIT license.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.