https://github.com/joeybaker/jscs-minimal

A minimal JSCS reporter.
https://github.com/joeybaker/jscs-minimal

Last synced: 6 days ago
JSON representation

A minimal JSCS reporter.

• Host: GitHub
• URL: https://github.com/joeybaker/jscs-minimal
• Owner: joeybaker
• License: other
• Created: 2015-04-23T17:10:27.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2015-04-23T17:11:16.000Z (over 9 years ago)
• Last Synced: 2024-11-26T14:42:42.190Z (about 2 months ago)
• Language: Shell
• Size: 125 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# jscs-minimal [![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependency Status][daviddm-url]][daviddm-image]

Minimal JSCS reporter

**Table of Contents**  *generated with [DocToc](http://doctoc.herokuapp.com/)*

- [Install](#install)

- [Usage](#usage)

- [Tests](#tests)

- [Developing](#developing)

  - [Requirements](#requirements)

- [License](#license)

## Install

```sh

npm i -D jscs-minimal

```

## Usage

```js

jscs --reporter=node_modules/jscs-minimal/index.js

```

## Tests

Tests are in [tape](https://github.com/substack/tape) and code coverage is run though [covert](https://github.com/substack/covert).

* `npm test` will run the tests.

* `npm run tdd` will run the tests on every file change.

## Developing

To publish, run `npm run release -- [{patch,minor,major}]`

_NOTE: you might need to `sudo ln -s /usr/local/bin/node /usr/bin/node` to ensure node is in your path for the git hooks to work_

### Requirements

* **npm > 2.0.0** So that passing args to a npm script will work. `npm i -g npm`

* **git > 1.8.3** So that `git push --follow-tags` will work. `brew install git`

## License

Artistic 2.0 © [Joey Baker](https://byjoeybaker.com)

[npm-url]: https://npmjs.org/package/jscs-minimal

[npm-image]: https://badge.fury.io/js/jscs-minimal.svg

[travis-url]: https://travis-ci.org/joeybaker/jscs-minimal

[travis-image]: https://travis-ci.org/joeybaker/jscs-minimal.svg?branch=master

[daviddm-url]: https://david-dm.org/joeybaker/jscs-minimal.svg?theme=shields.io

[daviddm-image]: https://david-dm.org/joeybaker/jscs-minimal