# @sidekick/analyser-common

> Handles input for analysers. Also defines the protocol which other programs can follow - no dependencies on JS

Latest version **1.0.2** (published 2016-03-18) · MIT license · 0 weekly downloads

## Install

```sh
npm install @sidekick/analyser-common
pnpm add @sidekick/analyser-common
yarn add @sidekick/analyser-common
bun add @sidekick/analyser-common
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2016-03-18 |
| First published | 2016-03-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | We Are Sidekick Ltd. |
| Maintainers | rishson, sidekick, timruffles |
| Keywords | javascript, code, quality, dependencies |

## Links

- npm: https://www.npmjs.com/package/@sidekick/analyser-common
- Repository: https://github.com/sidekickcode/analyser-common
- Homepage: https://sidekickcode.com
- Issues: https://github.com/sidekickcode/analyser-common/issues
- npm.io page: https://npm.io/package/@sidekick/analyser-common

## Dependencies (1)

- [easy-stdin](https://npm.io/package/easy-stdin.md) ^1.0.1

## Alternatives

- [flatbuffers](https://npm.io/package/flatbuffers.md) — 6.0M weekly downloads
- [jwt-simple](https://npm.io/package/jwt-simple.md) — 259.5K weekly downloads
- [@exodus/patch-broken-hermes-typed-arrays](https://npm.io/package/@exodus/patch-broken-hermes-typed-arrays.md) — 28.5K weekly downloads
- [@native-to-anchor/buffer-layout](https://npm.io/package/@native-to-anchor/buffer-layout.md) — 12.2K weekly downloads
- [binary-parser-encoder](https://npm.io/package/binary-parser-encoder.md) — 5.3K weekly downloads

## Recent versions

- 1.0.2 (latest) — 2016-03-18
- 1.0.1 — 2016-03-18
- 1.0.0 — 2016-03-17

## README

# analyser-common

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

Module that provides `stdin` input in a pre-defined way to a Sidekick analyser.

Provides analysers with a `setup` object that contains:

 - config (any configuration file contents for the analyser, e.g. .eslintrc file contents)
 - contents (the contents of the file to be analysed)
 - filePath (the file path of the file to be analysed)

You can easily write your own analysers for use with [Sidekick](https://sidekickcode.com).
Sidekick analysers can be written in any language; all you need to do is accept input via `stdin` and provide output via `stdout`.

## Installation

```sh
npm install --save @sidekick/analyser-common
```

## Usage

```sh
var sidekickAnalyser = require("@sidekick/analyser-common");
sidekickAnalyser(function(setup){
  //run the analyser
});
```

---
_Source: https://npm.io/package/@sidekick/analyser-common · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._