https://github.com/joellefkowitz/nationwide

A Nationwide transactions table parser.
https://github.com/joellefkowitz/nationwide

nationwide parser

Last synced: about 2 months ago
JSON representation

A Nationwide transactions table parser.

• Host: GitHub
• URL: https://github.com/joellefkowitz/nationwide
• Owner: JoelLefkowitz
• License: mit
• Created: 2021-08-17T17:07:22.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-06-27T19:29:09.000Z (6 months ago)
• Last Synced: 2024-10-05T21:41:30.180Z (3 months ago)
• Topics: nationwide, parser
• Language: TypeScript
• Size: 305 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# Nationwide

A Nationwide transactions table parser.

![Review](https://img.shields.io/github/actions/workflow/status/JoelLefkowitz/nationwide/review.yml)

![Version](https://img.shields.io/npm/v/nationwide)

![Downloads](https://img.shields.io/npm/dw/nationwide)

![Size](https://img.shields.io/bundlephobia/min/nationwide)

![Quality](https://img.shields.io/codacy/grade/8fb4d0f0694748c188e083f00ae4ff9f)

![Coverage](https://img.shields.io/codacy/coverage/8fb4d0f0694748c188e083f00ae4ff9f)

## Installing

```bash

npm install nationwide

```

## Documentation

Documentation and more detailed examples are hosted on [Github Pages](https://joellefkowitz.github.io/nationwide).

## Usage

Copy the Nationwide statement table from the browser:

`nationwide.html`

```html

  

    

      

        01 May 2023

        
- 1

      

      Visa purchase

      UBER *TRIP HELP.UBER.COM GB

      £5.00

      

      £55.00

    

    

      

        02 May 2023

        
- 2

      

      Visa purchase

      UBER *TRIP HELP.UBER.COM GB

      £5.00

      

      £50.00

    

    

      

        03 May 2023

        
- 3

      

      Visa purchase

      UBER *TRIP HELP.UBER.COM FR

      £20.00

      

      £30.00

    

  


```

Parse the table:

```ts

import fs from "fs";

import path from "path";

import { Transaction } from "./Transaction";

const transactions = Transaction.table(fs.readFileSync(path.join(__dirname, "nationwide.html"), "utf8"));

```

```json

[

  {

    "date": "2023-01-01",

    "type": "Visa purchase",

    "account": "UBER *TRIP HELP.UBER.COM GB",

    "change": -5,

    "balance": 55

  },

  {

    "date": "2023-01-02",

    "type": "Visa purchase",

    "account": "UBER *TRIP HELP.UBER.COM GB",

    "change": -5,

    "balance": 50

  },

  {

    "date": "2023-01-03",

    "type": "Visa purchase",

    "account": "UBER *TRIP HELP.UBER.COM FR",

    "change": -20,

    "balance": 30

  }

]

```

Collate the transactions:

```ts

Transaction.collate(transactions);

```

```json

{

  "UBER *TRIP HELP.UBER.COM FR": -20,

  "UBER *TRIP HELP.UBER.COM GB": -10

}

```

## Tooling

### Dependencies

To install dependencies:

```bash

yarn install

```

### Tests

To run tests:

```bash

yarn test

```

### Documentation

To generate the documentation locally:

```bash

yarn docs

```

### Linters

To run linters:

```bash

yarn lint

```

### Formatters

To run formatters:

```bash

yarn format

```

## Contributing

Please read this repository's [Code of Conduct](CODE_OF_CONDUCT.md) which outlines our collaboration standards and the [Changelog](CHANGELOG.md) for details on breaking changes that have been made.

This repository adheres to semantic versioning standards. For more information on semantic versioning visit [SemVer](https://semver.org).

Bump2version is used to version and tag changes. For example:

```bash

bump2version patch

```

### Contributors

- [Joel Lefkowitz](https://github.com/joellefkowitz) - Initial work

## Remarks

Lots of love to the open source community!