1.0.0 • Published 3 years ago

@oslo-flanders/oslo-standards-registry-report v1.0.0

Weekly downloads
-
License
MIT
Repository
github
Last release
3 years ago

OSLO Report

Tool to aggregate information about the OSLO standards registry and write it to an Excel file

This tool will read the configuration file used to configure the standards in the OSLO standards registry. For each configured standard, its configuration in their OSLOtheme repository will also be fetched and dates, status and name will be stored. It will output that information in an Excel file and mark a standard as complete if it complies with the following conditions:

  • An acknowledged standard must have a date of registration, date of approval by the data standards working group and date of approval by the steering committee

When a standard is not complete, the compleet? field in the Excel file will be marked with a red color, indicating the this standard needs some follow-up. Because of the ever-increasing number of standards, a separate sheet is provided with standards that already have a data of registration and data of approval by the data standards working group, but not yet a date of approval by the steering committee. This could be derived from the other sheet, but it is just more convenient.

Standards with a status of 'kandidaat-standaard', 'standaard-in-ontwikkeling' or 'zonder-status' are ignored.

Install

> npm i -g @oslo-flanders/oslo-standards-registry-report

Usage

ParameterDescriptionDefaultRequired
-u, --urlRaw URL of the OSLO standards registry configuration file on GitHubhttps://github.com/Informatievlaanderen/OSLO-Standaarden/blob/configuratie/standaardenregister.jsonNo
> generate-standards-registry-report -u https://github.com/Informatievlaanderen/OSLO-Standaarden/blob/configuratie/standaardenregister.json
# OR
> generate-standards-registry-report

Running this tool will output a file in the current working directory, called standaardenregister-status-{CURRENT-DATE}.xlsx