https://github.com/katiefenn/parker

Stylesheet analysis tool.
https://github.com/katiefenn/parker

Last synced: 1 day ago
JSON representation

Stylesheet analysis tool.

• Host: GitHub
• URL: https://github.com/katiefenn/parker
• Owner: katiefenn
• License: other
• Created: 2014-02-09T22:21:09.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2021-03-11T22:57:27.000Z (almost 4 years ago)
• Last Synced: 2025-02-06T18:16:48.611Z (8 days ago)
• Language: JavaScript
• Size: 127 KB
• Stars: 2,466
• Watchers: 60
• Forks: 73
• Open Issues: 19
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: docs/contributing/readme.md
  • License: LICENSE.md

Awesome Lists containing this project

• awesome-github-repos - katiefenn/parker - Stylesheet analysis tool. (JavaScript)
• starred-awesome - parker - Stylesheet analysis tool. (JavaScript)

README

        
# Parker

Parker is a stylesheet analysis tool. It runs metrics on your stylesheets and will report on their complexity.

[![Build Status](https://secure.travis-ci.org/katiefenn/parker.png?branch=master)](http://travis-ci.org/katiefenn/parker)

## Installation

Install with npm:

```

npm install -g parker

```

## Usage

### Measuring Local Stylesheets

```

parker a.css b.css c.css

```

```

parker css/

```

### Measuring a Remote Stylesheet Using Curl

```

curl http://www.katiefenn.co.uk/css/shuttle.css -s | parker -s

```

### Output JSON

```

parker example.css --format=json

```

### Programmatic usage

After installing parker as a dependency in your project, you can use it as follows:

```js

var Parker = require('parker/lib/Parker');

var metrics = require('parker/metrics/All'); // Or an array of the metrics you want to measure

var file = fs.readFile('test.css', function (err, data) {

	if (err) throw err;

	var parker = new Parker(metrics);

	var results = parker.run(data.toString());

	// Do something with results

});

```

## Documentation

Documentation can be found in markdown format the [docs folder](https://github.com/katiefenn/parker/tree/master/docs).

## Testing

From the repo root:

```

npm install

npm test

```

## Contributing

Pull requests, issues, new unit tests, code reviews and good advice are all things that would make a difference to Parker. You can even contribute by telling me how useful Parker is to you; please let me know on Twitter at @katie_fenn. Any time generously donated to helping make Parker better is gratefully accepted, and in return I shall do my best to merge contributions.

Please target pull requests at the "develop" branch.

## About

Parker is my first open source project, and your suggestions and feedback are welcome. The project is in a pre-beta phase and is liable to change at any time. Parker is named for the character Parker from Gerry Anderson's Thunderbirds, without which my interest in technology and computers would certainly not be what it is today. Parker is Nosey about your stylesheets.