nandenjin/twinkle-parser

<div align="center">
  <img width="200" src="https://storage.googleapis.com/twinkle-resouces/common/bldg-cl.png" alt="">
  <h1>twinkle-parser</h1>
  <p>
    <a href="https://www.npmjs.com/package/twinkle-parser" target="_blank" rel="noopener"><img alt="npm version" src="https://img.shields.io/npm/v/twinkle-parser.svg?style=flat-square"></a>
    <a href="https://codeclimate.com/github/nandenjin/twinkle-parser/maintainability"><img alt="Code Climate maintainability" src="https://img.shields.io/codeclimate/maintainability/nandenjin/twinkle-parser?style=flat-square"></a>
    <a href="https://codecov.io/gh/nandenjin/twinkle-parser"><img alt="Codecov" src="https://img.shields.io/codecov/c/gh/nandenjin/twinkle-parser?style=flat-square"></a>
    <span><img src="http://img.shields.io/badge/license-MIT-blue.svg?style=flat-square"></span>
  </p>
  <p>Parse CSV from https://kdb.tsukuba.ac.jp to structured JSON.</p>
</div>

## Usage

### From CLI

#### Quick use

```shell
npx twinkle-parser data_from_kdb.csv
```

#### Global Install

```shell
# Install with NPM
npm install -g twinkle-parser

# Install with yarn
yarn add --global twinkle-parser

# Then
twinkle-parser data_from_kdb.csv
```

#### Use inside repo

```shell
# * Inside repo directory
# Install dependencies
yarn

# Parse
yarn run parse data_from_kdb.csv
```

### As API

```shell
# Install with NPM
npm install twinkle-parser

# Install with yarn
yarn add twinkle-parser
```

```js
const parse = require('twinkle-parser')
const data = parse('CSV string here') // -> KDBData
```

### CLI options

| Option                      |                                                                   |
| --------------------------- | ----------------------------------------------------------------- |
| `-o PATH` / `--output PATH` | Export result to a file at the `PATH` instead of to stdout.       |
| `-p` / `--pretty`           | Prettify json output.                                             |
| `--fields`                  | Fields to be included (comma-separated, specifing all if not set) |
| `-h` / `--help`             | Print help & usage.                                               |
| `-v` / `--version`          | Print version info

## Output Format

```jsonc
{
  "COURSE_ID": {

    "title": "Twinkle",

    // Class type (defined value by original data)
    "type": 1,

    // Course unit
    "unit": 1,

    // Course target grades
    "targets": [1, 2],

    // Terms & Modules
    // 0 = Spring A, 1 = Spring B, ...
    "termStr": "春AB",
    "terms": [ 0, 1 ],

    // Day & Period sets
    "periodStr": "月1-3\n水4-6",
    "periods": [
      // [ Days( 0 = Sun. 1 = Mon. ... ), Periods ]
      [ [ 1 ], [ 0, 1, 2 ] ],
      [ [ 3 ], [ 4, 5, 6 ] ]
    ],

    // Rooms
    "rooms": [ "7A106", "7C202" ],

    // Instructors
    "instructors": [ "筑波 太郎" ],

    // Overview & Remarks
    "overview": "",
    "remarks": ""

    // Last update in unix time
    "updatedAt": 1583390263000
  }
}
```

## TypeScript Support

TypeScript supported! 🎉

```ts
// This will be imported with types
import parse from 'twinkle-parser'

// And types for output data are also available
import { KDBData, KDBCourse } from 'twinkle-parser'
```

## Contribution

Issue or PR submissions are welcome.