souhailas / apicture Goto Github PK

Add an option to generate a human readable evolution report

Show API titles as a table

Commit Date and Time | API Title
2020-07-06 23:51:18 | IPFS Pinning Service API
2020-07-08 03:02:02 | (WIP) IPFS Pinning Service API
2020-07-23 19:02:24 | IPFS Pinning Service API

Render the date&time with dayjs format

Use the most recent title to refer to the API title

Some projects might be implementing several APIs. add an option -oas for manually adding the path to the OAS file one wants to visualize.

the versions on the left and the changes on the right (or give an option where to place them)

Add metadata to the visualisations such as:

• Number of commits
• API title
• Number of version changes
• Some repo metdata if possible to extract from the package.json
• API Age

Extract the commits that affect the references too

Metadata inside the generated HTML should be the same as the one in the markdown readme

timestamps should be 0-padded

https://day.js.org/docs/en/display/format

https://github.com/souhailaS/APIcture/blob/d0d05914f798ffdfc76132d03e75340d2212871c/bin/create_sunburst.js#LL580C20-L580C20

    if (true) { // TODO: add a flag to disable logs

add a flag to decide whether the user wants verbose mode on or not. By default should be on.

when shown in the iframe, display the plots (not the metadata)

in the iframe HTML:

API tags modified -> tags modified
api version modified -> version modified

API is usually capitalized