npx ironoutline COMMAND

COMMAND:

  json2csv  Generates a CSV to import into a spreadsheet to manipulate the course outline
  csv2json  Generates JSON outline for md2oedx from a CSV.



json2csv
===

Generates a CSV to import into a spreadsheet to manipulate the course outline

Usage:

  npx ironoutline json2csv [ --yaml ] [ --openlink=OPENLINK ] -- "URL"|PATH|-

Examples:

  $ npx ironoutline json2csv ~/tmp/wdpt202102par.json
  
  $ cat ~/tmp/wdpt202102par.json | npx ironoutline json2csv --openlink=vscode://file//Users/abernier/ironhack/ironhack-web/lessons/modules-1-2-3/%s
  
  $ npx ironoutline json2csv
  {
    "course": {
      "name": "WDPT",
      "number": "MASTER",
      "version": "5.0",
      "chapter": [
        ...
      ]
    }
  }
  ^D

  $ npx ironoutline json2csv -- "https://raw.githubusercontent.com/abernier/ironoutline/master/wdpt202102par.json"

  $ npx ironoutline json2csv --yaml -- ~/tmp/wdpt202102par.yaml
  $ npx ironoutline json2csv --yaml -- "https://raw.githubusercontent.com/abernier/ironoutline/master/wdpt202102par.yaml"

Arguments:

  URL:   A json URL where the outline is configured
  PATH:  A json file path (Default to - for stdin)

Options:

  --yaml      enable yaml to json conversion

  OPENLINK:   a printf-like string to print out a link to open the file (see: https://nodejs.org/api/util.html#util_util_format_format_args)

              NB: %s will be replaced by the file path

                Eg: https://bitbucket.org/abernier_/ironhack-web/src/wdpt202102par/lessons/modules-1-2-3/%s?mode=edit
                Eg: vscode://file//Users/abernier/ironhack/ironhack-web/lessons/modules-1-2-3/%s




csv2json
===

Generates JSON outline for md2oedx from a CSV.

Usage:

  npx ironoutline csv2json PTFT [ --yaml ] [ --tzid=TZID --start=START_DATE --hollidays=HOLLIDAYS ] -- "URL"|PATH|-

Examples:

  $ npx ironoutline csv2json pt --start=2021-02-16 --hollidays=2021-04-03,2021-05-01,2021-05-08,2021-05-13 -- "https://docs.google.com/spreadsheets/d/e/2PACX-1vSPb9g-3UgLBIrjBekCEppZ7k733mCQehR9S3OZBxafwQEuXsxkAzC4VkSzOStT6b0Dc851CyLUOc2i/pub?gid=0&single=true&output=csv"
  
  $ cat ~/tmp/wdpt202102par.csv | npx ironoutline csv2json pt --tzid=Europe/Paris
  
  $ npx ironoutline csv2json pt
  name,active,seq,vert,seq_index,vert_index,tag,file,deliverable_display_name,deliverable_identifier,deliverable_description,deliverable_duedate
  Code of Conduct during the bootcamp,FALSE,Tips & tricks for success,Info tabs,0,0,0,EXTRA,info/code-of-conduct.md,,,,
  ...
  ^D

Arguments:

  PTFT:   ft or pt (Default: ft)
  
  URL:    A CSV URL where the outline is configured
  PATH:   A CSV file path (Default to - for stdin)

Options:

  --yaml      enable yaml output

  TZID:       The timezone name where bootcamp is located (Default to 'Europe/Paris')
              see: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones

  START_DATE: The day in the format YYYY-MM-DD when the course begins

  HOLLIDAYS:  A comma-separated list of days in the format YYYY-MM-DD for days-off