# @loxon-solutions/surveyor

> ![Surveyor](documentation/surveyor.png)

Latest version **1.0.3** (published 2020-08-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install @loxon-solutions/surveyor
pnpm add @loxon-solutions/surveyor
yarn add @loxon-solutions/surveyor
bun add @loxon-solutions/surveyor
```

## Health

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

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2020-08-07 |
| First published | 2020-06-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 308.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | loxon-solutions |
| Maintainers | loxon-solutions |

## Links

- npm: https://www.npmjs.com/package/@loxon-solutions/surveyor
- npm.io page: https://npm.io/package/@loxon-solutions/surveyor

## Dependencies (4)

- [glob](https://npm.io/package/glob.md) ^7.1.4
- [maven](https://npm.io/package/maven.md) ^4.7.0
- [shelljs](https://npm.io/package/shelljs.md) ^0.8.3
- [neo4j-driver](https://npm.io/package/neo4j-driver.md) ^4.0.2

## Recent versions

- 1.0.3 (latest) — 2020-08-07
- 1.0.2 — 2020-08-07
- 1.0.1 — 2020-08-07
- 1.0.0 — 2020-06-12

## README

![Surveyor](documentation/surveyor.png)

![npm-publish](https://github.com/loxon-solutions/surveyor/workflows/npm-publish/badge.svg) 
[![npm version](https://badge.fury.io/js/%40loxon-solutions%2Fsurveyor.svg)](https://badge.fury.io/js/%40loxon-solutions%2Fsurveyor)
[!project status](https://img.shields.io/badge/project%20status-beta-red)

Surveyor is a tool to parse a project and create documentation diagrams (like maps for the software) automatically. Diagrams are represented internally as a graph, and this graph can be exported in various formats.

## Features

- Export to PUML notation
- Export to Neo4J database
- Extendible with new parsers and writers
- Job queue mechanism, parsers can push new elements to the queue.
- Parameters can be read from file (where secrets can be kept)

## Usage

1. Install this library
    ```shell script
    npm install --save @loxon-solutions/surveyor
    ```
2. Create index.ts file in your project
    ```typescript
    import {Surveyor} from '@loxon-solutions/surveyor';
   
    new Surveyor()
        .addParser(ProjectDependencyParser)
        .addParser(TepeeMessageParser)
        .addParser(TepeeMessageAgentParser)
        .run();
    ```   
   In this file, you have to add your custom parsers and writers. (PUML and Neo4J writer is added by default, together with a sample maven dependency tree parser).
   
3. Execute your program:
    ```shell script
    npm start -- --help
    ```

## Contribution

Contributions are welcome, just create a pull request.

- [Architecture](documentation/architecture.md)

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