Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/abernier/ironoutline
https://github.com/abernier/ironoutline
cli csv ironhack nodejs
Last synced: 2 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/abernier/ironoutline
- Owner: abernier
- Created: 2020-05-28T04:37:05.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-03-02T21:13:07.000Z (over 1 year ago)
- Last Synced: 2024-09-07T20:26:00.647Z (26 days ago)
- Topics: cli, csv, ironhack, nodejs
- Language: JavaScript
- Homepage: https://docs.google.com/spreadsheets/d/1EdyLktmJA36Fzeug8NwrTQjUDt4C9wB2eoqs9E6kXK0/edit#gid=0
- Size: 340 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://www.npmjs.com/package/ironoutline)
Generates an `.json` file for [`md2oedx`](https://github.com/ironhack/md2oedx) from a CSV and reciprocally.
```
JSON/YAML <-> CSV
```
# cli
## Usage
See:
```sh
$ npx ironoutline --help
```
which will outputs [`man.txt`](man.txt) file.
## `csv2json` command
From a CSV [spreadsheet](https://docs.google.com/spreadsheets/d/1EdyLktmJA36Fzeug8NwrTQjUDt4C9wB2eoqs9E6kXK0/edit):
[](https://docs.google.com/spreadsheets/d/1EdyLktmJA36Fzeug8NwrTQjUDt4C9wB2eoqs9E6kXK0/edit)
```sh
$ npx ironoutline csv2json pt "https://docs.google.com/spreadsheets/d/e/2PACX-1vSPb9g-3UgLBIrjBekCEppZ7k733mCQehR9S3OZBxafwQEuXsxkAzC4VkSzOStT6b0Dc851CyLUOc2i/pub?gid=0&single=true&output=csv"
```
Or from a local file:
```sh
$ npx ironoutline csv2json pt -- ~/Downloads/outline.csv
```
NB: The json file is directly printed to stdout: to save it to disk, remember to redirect the stdout `> myoutline.json`.
## `json2csv` command
```sh
$ npx ironoutline json2csv --openlink=vscode://file//Users/abernier/ironhack/ironhack-web/lessons/modules-1-2-3/%s -- wdpt202102par.json
```
# JS api
## `csv2json`
```js
const {readFileSync} = require('fs')
const {csv2json} = require('ironoutline')
// file content
const csv = readFileSync('path/to/outline.csv', {encoding: 'utf-8'})
const json = csv2json('pt', csv, {
tzid: 'Europe/Paris',
start: '2020-06-02',
hollidays: ['2020-06-20','2020-07-04','2020-07-14','2020-08-11','2020-08-13','2020-08-15','2020-08-18','2020-08-20','2020-08-22','2020-09-19','2020-10-17','2020-11-10','2020-11-21']
})
console.log(json)
```
Defaults options:
|Name|Value|
|----|-----|
|`tzid`|`'Europe/Paris'`|
|`start`|`undefined`|
|`hollidays`|`[]`|
## `json2csv`
```js
const {readFileSync} = require('fs')
const {json2csv} = require('ironoutline')
// file content
const json = readFileSync('path/to/outline.json', {encoding: 'utf-8'})
const csv = json2csv(json, {
openlink: 'vscode://file//Users/abernier/ironhack/ironhack-web/lessons/modules-1-2-3/%s'
})
console.log(csv)
```
Defaults options:
|Name|Value|
|----|-----|
|`openlink`|`undefined`|
# JSON structure
JSON structure is as followed:
```js
{
"course": {
"name": "WDPT",
"number": "MASTER",
"version": "5.0",
"chapter": [
{
"name": "Week 1",
"sequential": [
{
"name": "Day 1",
"vertical": [
{
"name": "Foo",
"component": [
{
"type": "html",
"file": "foo.md"
},
{
"type": "deliverable",
"display_name": "Homework",
"deliverable_identifier": "assign1",
"deliverable_description": "Your first homework is to do 100 pushups.",
"deliverable_duedate": "2030-10-28"
}
]
},
...
},
...
]
}
]
}
}
```
as defined per [`md2oedx` JSON file structure](https://github.com/ironhack/md2oedx#json-file-structure)
# CSV structure
CSV structure is as followed:
|name|active|seq|vert|seq_index|vert_index|tag|file|openlink|deliverable_display_name|deliverable_identifier|deliverable_description|deliverable_duedate|
|----|------|---|----|---------|----------|---|----|--------|------------------------|----------------------|-----------------------|-------------------|
| | | | | | | | | | | | | | |
# Clasp
Pre-requisite: `$ npx clasp login`
To update google script, edit `gscript/*` source code then:
```sh
$ sh -c "cd gscript && npx clasp push"
```