cpitkin/redirect-test

# redirect-test

[![NPM version](https://img.shields.io/npm/v/redirect-test.svg?style=flat-square)](https://www.npmjs.com/package/redirect-test)
[![Build Status](https://travis-ci.org/cpitkin/redirect-test.svg?branch=master)](https://travis-ci.org/cpitkin/redirect-test)
[![Code Climate](https://codeclimate.com/github/cpitkin/redirect-test/badges/gpa.svg)](https://codeclimate.com/github/cpitkin/redirect-test)
[![Test Coverage](https://codeclimate.com/github/cpitkin/redirect-test/badges/coverage.svg)](https://codeclimate.com/github/cpitkin/redirect-test/coverage)
[![Issue Count](https://codeclimate.com/github/cpitkin/redirect-test/badges/issue_count.svg)](https://codeclimate.com/github/cpitkin/redirect-test)
[![Dependency Status](https://david-dm.org/cpitkin/redirect-test.svg)](https://david-dm.org/cpitkin/redirect-test)

> Test your redirects and get an easily readable and parsable csv file back. Testing a lot of redirects is hard and this cli aims to make it easier and less time consuming.

## Install

yarn

```sh
$ yarn global add redirect-test
```

npm

```sh
$ npm i -g redirect-test
```

## Usage

```sh
redirect-test <file> <url> [options]
```
#### Required fields

`file`: A csv file in the following format:
`old-URI,new-URI` eg. `/about-bob,/about/bob`

`url`: The URL must be the final URL for the site. If it is not the redirect will get caught to early by conditionals such as non-www -> www and http -> https. Since this tool is not meant to test those types of redirects you will want to use the proper FQDN. eg. https://example.com

#### Options

`-c, --csv`: This will allow you to output to a custom csv file name and path. Default: ./results.csv

`-q, --quiet`: This will limit the console output to only print the csv file path.

`-n, --number`: The number of concurrent requests to make to the testing URL at a time. Default: 5

## Results

![Screenshot](images/results.csv.png)

## Tests

yarn
```sh
yarn test
```

If you want to dev locally and run tests on file changes you can run the following.

```sh
yarn test-local
```

*NOTE:* I politely ask that all pull requests have proper tests otherwise you will be asked to add them.

## License

[MIT © 2017 Charlie Pitkin](LICENSE)

### [Changelog](CHANGELOG.md)