Update README.md + remove unused parameters

Informatievlaanderen · Mar 13, 2024 · 04a8115 · 04a8115
1 parent e7824dc
commit 04a8115
Show file tree

Hide file tree

Showing 5 changed files with 26 additions and 54 deletions.
diff --git a/packages/oslo-generator-json-webuniversum/README.md b/packages/oslo-generator-json-webuniversum/README.md
@@ -1,11 +1,29 @@
-# `oslo-generator-json-webuniversum`
+# `oslo-generator-json-webuniversum` `OSLO JSON Webuniversum Generator
 
-> TODO: description
+> This package transforms an OSLO JSON-LD file into a JSON configuration file which will be used by the Nuxt.JS Service to render vocabularies and application profiles
 
-## Usage
+## Install
 
+```bash
+npm install @oslo-flanders/json-webuniversum-generator
 ```
-const osloGeneratorJsonWebuniversum = require('oslo-generator-json-webuniversum');
 
-// TODO: DEMONSTRATE API
+## Global install
+
+```bash
+npm install -g @oslo-flanders/json-webuniversum-generator
 ```
+
+## API
+
+The service is executed from the CLI and expects the following parameters:
+| Parameter  | Description                                                 | Required                          | Possible values |
+| ---------- | ----------------------------------------------------------- | --------------------------------- | --------------- |
+| `--input`  | The URL or local file path of an OSLO stakeholders csv file |:heavy_check_mark:                |                 |
+| `--output` | Name of the output file                                     | No, default `webuniversum-config.json` |                 |
+| `--language` | The language in which the config must be generated | :heavy_check_mark: | |
+
+## Usage
+```bash
+oslo-webuniversum-json-generator --input report.jsonld --language nl
+```
diff --git a/packages/oslo-generator-json-webuniversum/lib/JsonWebuniversumGenerationServiceRunner.ts b/packages/oslo-generator-json-webuniversum/lib/JsonWebuniversumGenerationServiceRunner.ts
@@ -16,8 +16,6 @@ export class JsonWebuniversumGenerationServiceRunner
             .option('input', { describe: 'The input file to generate a JSON-LD context from.' })
             .option('output', { describe: 'Name of the output file.', default: 'webuniversum-config.json' })
             .option('language', { describe: 'The language in which the config must be generated.' })
-            .option('apTemplateMetadata', { describe: 'Markdown file with metadata for the AP template.' })
-            .option('vocTemplateMetadata', { describe: 'Markdown file with metadata for the VOC template.' })
             .option('silent',
                 {
                     describe: 'All logs are suppressed',

diff --git a/...-generator-json-webuniversum/lib/config/JsonWebuniversumGenerationServiceConfiguration.ts b/...-generator-json-webuniversum/lib/config/JsonWebuniversumGenerationServiceConfiguration.ts
@@ -18,22 +18,10 @@ export class JsonWebuniversumGenerationServiceConfiguration implements IConfigur
      */
     private _language: string | undefined;
 
-    /**
-     * Local path to a markdown file with metadata for the AP template
-     */
-    private _apTemplateMetadata: string | undefined;
-
-    /**
-     * Local path to a markdown file with metadata for the VOC template
-     */
-    private _vocTemplateMetadata: string | undefined;
-
     public async createFromCli(params: YargsParams): Promise<void> {
         this._input = <string>params.input;
         this._output = <string>params.output;
         this._language = <string>params.language;
-        this._apTemplateMetadata = <string>params.apTemplateMetadata;
-        this._vocTemplateMetadata = <string>params.vocTemplateMetadata;
     }
 
     public get input(): string {
@@ -56,18 +44,4 @@ export class JsonWebuniversumGenerationServiceConfiguration implements IConfigur
         }
         return this._language;
     }
-
-    public get apTemplateMetadata(): string {
-        if (!this._apTemplateMetadata) {
-            throw new Error('Trying to access "apTemplateMetadata" before it was set.')
-        }
-        return this._apTemplateMetadata;
-    }
-
-    public get vocTemplateMetadata(): string {
-        if (!this._vocTemplateMetadata) {
-            throw new Error('Trying to access "vocTemplateMetadata" before it was set.')
-        }
-        return this._vocTemplateMetadata;
-    }
 }
diff --git a/packages/oslo-generator-json-webuniversum/package.json b/packages/oslo-generator-json-webuniversum/package.json
@@ -10,6 +10,9 @@
     "@oslo-generator-json-webuniversum": "./lib",
     "@oslo-core": "node_modules/@oslo-flanders/core/lib"
   },
+  "bin": {
+    "oslo-webuniversum-json-generator": "bin/runner.js"
+  },
   "directories": {
     "bin": "bin",
     "lib": "lib",

diff --git a/...erator-json-webuniversum/test/JsonWebuniversumGenerationServiceConfiguration.unit.test.ts b/...erator-json-webuniversum/test/JsonWebuniversumGenerationServiceConfiguration.unit.test.ts
@@ -25,8 +25,6 @@ describe('JsonWebuniversumGenerationServiceConfiguration', () => {
         expect((<any>config)._input).toBeDefined();
         expect((<any>config)._output).toBeDefined();
         expect((<any>config)._language).toBeDefined();
-        expect((<any>config)._apTemplateMetadata).toBeDefined();
-        expect((<any>config)._vocTemplateMetadata).toBeDefined();
     });
 
     it('should throw an error when "input" is undefined or otherwise return its value', async () => {
@@ -52,23 +50,4 @@ describe('JsonWebuniversumGenerationServiceConfiguration', () => {
         await config.createFromCli(params);
         expect(config.language).toBe('en');
     });
-
-    it('should throw an error when "apTemplateMetadata" is undefined or otherwise return its value', async () => {
-        const config = new JsonWebuniversumGenerationServiceConfiguration();
-
-        expect(() => config.apTemplateMetadata)
-            .toThrow(new Error('Trying to access "apTemplateMetadata" before it was set.'));
-        await config.createFromCli(params);
-        expect(config.apTemplateMetadata).toBe('ap-markdown.md');
-    });
-
-    it('should throw an error when "vocTemplateMetadata" is undefined or otherwise return its value', async () => {
-        const config = new JsonWebuniversumGenerationServiceConfiguration();
-
-        expect(() => config.vocTemplateMetadata)
-            .toThrow(new Error('Trying to access "vocTemplateMetadata" before it was set.'));
-        await config.createFromCli(params);
-        expect(config.vocTemplateMetadata).toBe('voc-markdown.md');
-    });
-
 })