# nitriq-npm

> NPM package of Nitriq static code analysis tool for .NET.

Latest version **0.0.4** (published 2016-10-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install nitriq-npm
pnpm add nitriq-npm
yarn add nitriq-npm
bun add nitriq-npm
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.4 |
| Published | 2016-10-25 |
| First published | 2016-10-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Peter Morlion |
| Maintainers | peter.morlion |
| Keywords | net, dotnet, csharp, static, code, analysis |

## Links

- npm: https://www.npmjs.com/package/nitriq-npm
- Repository: https://github.com/petermorlion/nitriq-npm
- Issues: https://github.com/petermorlion/nitriq-npm/issues
- npm.io page: https://npm.io/package/nitriq-npm

## 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

- 0.0.4 (latest) — 2016-10-25
- 0.0.3 — 2016-10-25
- 0.0.2 — 2016-10-25
- 0.0.1 — 2016-10-25

## README

A simple NPM wrapper around Nitriq, a static code analysis tool for .NET.

## Usage

```
var nitriq = require('nitriq-npm');

nitriq.run({
    queriesFile: 'customQueries.nq',
    assemblies: ['assembly.dll', 'executable.exe'],
    resultsFile: 'results.html'
});
```

## Options

### queriesFile

A Nitriq queries file (.nq file).

The default value is the queries.nq file that can be found in the `lib` folder.

### assemblies

An array of assemblies (dll or exe).

### resultsFile

The location to store the results file.

The default value is results.html and will be store at the root of your project.

## Disclaimer

Nitriq is a discontinued application that no longer works on Windows 8 and above. Luckily, 
[Artur Kordowski](https://github.com/akordowski) extracted 
[the source][https://github.com/akordowski/Source-Code-Nitriq), fixed it and recompiled it.
The Nitriq binaries are included in this repository as-is.

This repository just contains an NPM wrapper around it, so it can be used in NPM build scripts.
The MIT license of this repository concerns all files *excluding* the Nitriq folder.

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