https://github.com/perflint/perflint

PerfLint is a tool to identify unexpected performance levels of a Website
https://github.com/perflint/perflint

cli development performance performance-analysis web-performance

Last synced: 11 months ago
JSON representation

PerfLint is a tool to identify unexpected performance levels of a Website

• Host: GitHub
• URL: https://github.com/perflint/perflint
• Owner: perflint
• License: mit
• Created: 2016-02-26T07:05:47.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2022-12-09T07:17:41.000Z (over 3 years ago)
• Last Synced: 2024-04-15T00:13:39.984Z (about 2 years ago)
• Topics: cli, development, performance, performance-analysis, web-performance
• Language: JavaScript
• Homepage: https://perflint.readme.io/
• Size: 377 KB
• Stars: 71
• Watchers: 3
• Forks: 7
• Open Issues: 30
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![NPM version](https://img.shields.io/npm/v/perflint.svg?style=flat)](https://www.npmjs.com/package/perflint)

[![NPM dependencies](https://david-dm.org/perflint/perflint.svg)](https://david-dm.org/perflint/perflint)

[![Build Status](https://travis-ci.org/perflint/perflint.svg?branch=master)](https://travis-ci.org/perflint/perflint)

[![Coverage Status](https://coveralls.io/repos/github/perflint/perflint/badge.svg?branch=master)](https://coveralls.io/github/perflint/perflint?branch=master) [![Greenkeeper badge](https://badges.greenkeeper.io/perflint/perflint.svg)](https://greenkeeper.io/)

# ![PerfLint](https://cloud.githubusercontent.com/assets/367517/13446841/aa0aed32-e00e-11e5-8ca3-f88ec87ce4ae.png)

[Documentation](https://perflint.readme.io/docs) | [Configuring](https://perflint.readme.io/docs/configuring-perflint) | [Rules](https://perflint.readme.io/docs/rules)

PerfLint is a tool to identify unexpected performance levels of a Website, using [WebPageTest](http://www.webpagetest.org/) to obtain results.

## Installation

You can install PerfLint using `npm`:

```shell

npm install -g perflint

```

## Usage

See the [Command Line Interface](https://perflint.readme.io/docs/command-line-interface) documentation.

## Configuration

See the [Configuring PerfLint](https://perflint.readme.io/docs/configuring-perflint) documentation.

## Results

See the [Exit Codes and Results](https://perflint.readme.io/docs/results) documentation.

### Example Results

These results are an example of the ['Stylish' formatter](https://perflint.readme.io/docs/stylish).

#### With errors

```shell

http://example.com — http://www.webpagetest.org/results.php?test=160301_S3_1F0H

    error  'SpeedIndex' is 5617 should be less than 2000  SpeedIndex

  warning  'requestsDoc' is 57 should be less than 30     requestsDoc

    error  'responses_404' is 1 should be 0               responses_404

✖ 3 problems (2 errors, 1 warning)

```

#### With too many warnings

```shell

http://example.com — http://www.webpagetest.org/results.php?test=160301_S3_1F0H

  warning  'SpeedIndex' is 5617 should be less than 2000  SpeedIndex

  warning  'requestsDoc' is 57 should be less than 30     requestsDoc

  warning  'responses_404' is 1 should be 0               responses_404

✖ 3 problems (0 errors, 3 warnings)

PerfLint found too many warnings (maximum: 1).

```

## Contributors

* Matthew Harrison-Jones ([@matthojo](https://github.com/matthojo))