https://github.com/timbru31/spigot-anti-piracy-csv-exporter

🔎 📈 📊 A helper utility to generate a csv export for the spigot-anti-piracy-backend
https://github.com/timbru31/spigot-anti-piracy-csv-exporter

bukkit csv-export json2csv nodejs spigot typescript

Last synced: 4 months ago
JSON representation

🔎 📈 📊 A helper utility to generate a csv export for the spigot-anti-piracy-backend

• Host: GitHub
• URL: https://github.com/timbru31/spigot-anti-piracy-csv-exporter
• Owner: timbru31
• License: mit
• Created: 2016-05-24T20:02:01.000Z (over 8 years ago)
• Default Branch: main
• Last Pushed: 2024-09-27T08:07:03.000Z (4 months ago)
• Last Synced: 2024-09-28T12:02:50.977Z (4 months ago)
• Topics: bukkit, csv-export, json2csv, nodejs, spigot, typescript
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/spigot-anti-piracy-csv-exporter
• Size: 1.69 MB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# spigot-anti-piracy-csv-exporter

[![Run a security audit](https://github.com/timbru31/spigot-anti-piracy-csv-exporter/workflows/Run%20a%20security%20audit/badge.svg)](https://github.com/timbru31/spigot-anti-piracy-csv-exporter/actions?query=workflow%3A%22Run+a+security+audit%22)

[![Linting](https://github.com/timbru31/spigot-anti-piracy-csv-exporter/workflows/Linting/badge.svg)](https://github.com/timbru31/spigot-anti-piracy-csv-exporter/actions?query=workflow%3ALinting)

[![dependency Status](https://img.shields.io/librariesio/release/npm/spigot-anti-piracy-csv-exporter)](https://github.com/timbru31/spigot-anti-piracy-csv-exporter/network/dependencies)

[![Code Climate](https://codeclimate.com/github/timbru31/spigot-anti-piracy-csv-exporter/badges/gpa.svg)](https://codeclimate.com/github/timbru31/spigot-anti-piracy-csv-exporter)

[![Known Vulnerabilities](https://snyk.io/test/github/timbru31/spigot-anti-piracy-csv-exporter/badge.svg)](https://snyk.io/test/github/timbru31/spigot-anti-piracy-csv-exporter)

[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](https://commitizen.github.io/cz-cli/)

[![License](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)

[![npm](https://img.shields.io/npm/v/spigot-anti-piracy-csv-exporter.svg)](https://www.npmjs.com/package/spigot-anti-piracy-csv-exporter)

#### A helper utility to generate a csv export for the spigot-anti-piracy-backend

### Description

The helper application reduces the log file of spigot-anti-piracy-backend to a CSV with unique user IDs and a count of different ips in order to determine which user could have leaked the resources.

### Installation

This has been tested with Node.js v20 LTS.

#### Normal Installation

```shell

$ npm install -g spigot-anti-piracy-csv-exporter

```

(Optionally without the global flag)

#### Development Installation

```shell

$ git clone https://github.com/timbru31/spigot-anti-piracy-csv-exporter.git

$ cd spigot-anti-piracy-csv-exporter

$ npm install

```

### Usage

You need to specify thr path for the logfile. It defaults to `request.log` in the current directory if omitted.

Just use

```shell

$ npm run start

```

Configuration via environment variables

| Environment Variable | Default       | Description          |

| :------------------- | :------------ | :------------------- |

| CSV_FILE             | ./users.csv   | Output CSV file      |

| LOG_FILE             | ./request.log | Log file of requests |

### Development

To run the linter use

```shell

$ npm run lint

```

The code is linted using `ESLint`.

Keep the warnings to zero. :smile:

**Please follow the commitizen style when making new commits!**

---

Built by (c) Tim Brust and contributors. Released under the MIT license.