@intelligentgraphics/ig.gfx.packager 2.2.0 → 2.3.0

package/locales/en.json

@@ -18,6 +18,7 @@
   "options.pushOnly.description": "Try to upload an existing zip file without building and validating the version number",
   "options.noValidate.description": "Skip validation of wether newVersion is higher than the current version for releases",
   "options.docs.description": "Generates typedoc",
+  "options.ignore.description": "Files to ignore while generating index",
   "options.license.description": "Path to a license file",
   "messages.buildSkipEmpty": "No build targets found. Please check wether a folder with the provided name exists and wether it has _Package.json.",
   "messages.releaseSkipEmpty": "No release targets found. Please check wether a folder with the provided name exists and wether it has _Package.json.",

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@intelligentgraphics/ig.gfx.packager",
-  "version": "2.2.0",
-  "description": "IG.GFX.Packager 2.2.0 (2.2.0.100)",
+  "version": "2.3.0",
+  "description": "IG.GFX.Packager 2.3.0 (2.3.0.100)",
   "author": "Michael Beier <mb@intelligentgraphics.biz>",
   "main": "build/index.js",
   "private": false,
@@ -24,7 +24,8 @@
     "clean": "rimraf build *.tsbuildinfo",
     "prepublishOnly": "yarn clean && yarn dist",
     "test": "jest",
-    "_postinstall": "node scripts/postinstall.js"
+    "_postinstall": "node scripts/postinstall.js",
+    "format": "prettier --write \"**/*.{ts,tsx,json}\""
   },
   "dependencies": {
     "ajv": "^8.6.2",

package/readme.md

@@ -244,8 +244,46 @@ class Test {
 
 The path specified after the media:// schema will be resolved within a directory called `Media` next to the \_Package.json file.
 
+### \_Index.json generation
+
+The packager has a cli command `generateIndex [directory]`, it will generate an \_Index.json file for Evaluator packages.
+The ts files have to adhere to a certain form to be processed.
+
+1. The namespace/module name has to have two parts like: `namespace IG.Test`
+2. The evaluator class has to extend the base evaluator class IEvaluator from IGX.Eval
+3. The parameters have the following JSDoc structure
+    ```javascript
+    /** Symbolische Angabe der Korpusbreite in der Form "W100"
+     * Wird in der abgeleitetet Klasse kontextbezogen in den Realwert Width gemappt.
+     * @default "W50"
+     * @creatorType String
+     * @summary Symbolische Angabe der Korpusbreite
+     */
+    Corpus_Width: string;
+    ```
+    which results in the following
+    ```
+    {
+        "Name": "Corpus_Width",
+        "Description": "Symbolische Angabe der Korpusbreite",
+        "Type": "String",
+        "Default": "W50",
+        "DisplayIndex": 1
+    }
+    ```
+4. `DisplayIndex` is generated from the order of the parameters
+5. Jsdoc for the Evaluator has to be above class
+6. Parameter and Package name length need to be <=45
+7. Description is cut off after 99 characters
+
 ## History
 
+**IG.GFX.Packager 2.3.0**
+
+-   handle additional white space in version log parsing
+-   improve error message on invalid license path
+-   add support for generation of index.json files for evaulators
+
 **IG.GFX.Packager 2.2.0**
 
 -   add support for license files