@iqb/validate-md-profile 0.4.0 → 0.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -0
- package/package.json +2 -2
- package/validate-md-profile.js +14 -3
- package/validate-md-profile.js.map +1 -1
package/README.md
CHANGED
|
@@ -1,3 +1,6 @@
|
|
|
1
|
+
[](https://opensource.org/licenses/MIT)
|
|
2
|
+
[](https://www.npmjs.com/package/@iqb/validate-md-profile)
|
|
3
|
+
|
|
1
4
|
# Install
|
|
2
5
|
|
|
3
6
|
Metadata profiles for web applications of [IQB](https://www.iqb.hu-berlin.de) are stored in GitHub-repositories. We group metadata profiles in so-called "profile stores" to improve the handling. Every profile store resides in one GitHub repository. The entry point of the store is a config file `profile-config.json` in the root of the repo.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@iqb/validate-md-profile",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.5.0",
|
|
4
4
|
"author": "IQB - Institut zur Qualitätsentwicklung im Bildungswesen",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"description": "Tooling to validate and generate documentation of metadata profile stores",
|
|
@@ -14,7 +14,7 @@
|
|
|
14
14
|
"homepage": "https://github.com/iqb-vocabs/validate-md-profile#readme",
|
|
15
15
|
"dependencies": {
|
|
16
16
|
"ajv": "^8.12.0",
|
|
17
|
-
"@iqb/metadata": "
|
|
17
|
+
"@iqb/metadata": "1.2.0"
|
|
18
18
|
},
|
|
19
19
|
"bin": {
|
|
20
20
|
"validate-md-profile": "./validate-md-profile.js"
|
package/validate-md-profile.js
CHANGED
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
"use strict";
|
|
3
3
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
4
|
var schema_validate_factory_1 = require("./schema-validate.factory");
|
|
5
|
+
var metadata_1 = require("@iqb/metadata");
|
|
5
6
|
var mdTargetFolder = './docs';
|
|
6
7
|
var mdTargetFilename = "".concat(mdTargetFolder, "/README.md");
|
|
7
8
|
var configFileName = './profile-config.json';
|
|
@@ -36,10 +37,20 @@ if (mdConfig) {
|
|
|
36
37
|
mdContent_1 += "```\n".concat(p.id, "\n```\n\n");
|
|
37
38
|
p.groups.forEach(function (g) {
|
|
38
39
|
if (p.groups.length > 1)
|
|
39
|
-
mdContent_1 += "###
|
|
40
|
+
mdContent_1 += "### ".concat(g.label, "\n\n");
|
|
41
|
+
mdContent_1 += '| Name/Label | Typ | Parameter | ID Profil-Eintrag |\n';
|
|
42
|
+
mdContent_1 += '| :--- | :---: | :--- | :---: |\n';
|
|
40
43
|
g.entries.forEach(function (e) {
|
|
41
|
-
mdContent_1 += "
|
|
42
|
-
|
|
44
|
+
mdContent_1 += "| ".concat(e.label, " | ");
|
|
45
|
+
if (e.type === 'vocabulary' && e.parameters) {
|
|
46
|
+
var p_1 = e.parameters;
|
|
47
|
+
mdContent_1 += "[".concat(metadata_1.profileEntryTypeAsText[e.type], "](").concat(p_1.url, ") | ");
|
|
48
|
+
}
|
|
49
|
+
else {
|
|
50
|
+
mdContent_1 += "".concat(metadata_1.profileEntryTypeAsText[e.type] || '?', " |");
|
|
51
|
+
}
|
|
52
|
+
mdContent_1 += e.getParametersAsText();
|
|
53
|
+
mdContent_1 += " | ".concat(e.id, " |\n");
|
|
43
54
|
});
|
|
44
55
|
});
|
|
45
56
|
});
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"validate-md-profile.js","sourceRoot":"","sources":["../src/validate-md-profile.ts"],"names":[],"mappings":";;;AACA,qEAAgE;
|
|
1
|
+
{"version":3,"file":"validate-md-profile.js","sourceRoot":"","sources":["../src/validate-md-profile.ts"],"names":[],"mappings":";;;AACA,qEAAgE;AAChE,0CAAkG;AAElG,IAAM,cAAc,GAAG,QAAQ,CAAC;AAChC,IAAM,gBAAgB,GAAG,UAAG,cAAc,eAAY,CAAC;AAEvD,IAAI,cAAc,GAAG,uBAAuB,CAAC;AAC7C,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE;IACjB,cAAc,GAAG,YAAK,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAE,CAAC;CAC3C;AAED,IAAM,QAAQ,GAAG,+CAAqB,CAAC,cAAc,CAAC,cAAc,CAAC,CAAC;AACtE,IAAI,QAAQ,EAAE;IACV,OAAO,CAAC,GAAG,CAAC,uBAAgB,cAAc,yBAAe,QAAQ,CAAC,KAAK,CAAE,CAAC,CAAC;IAC3E,IAAI,aAAW,GAAgB,EAAE,CAAC;IAClC,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,UAAA,CAAC;QACvB,IAAM,WAAW,GAAG,+CAAqB,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;QAC7D,IAAI,WAAW,EAAE;YACb,IAAI,YAAU,GAAG,CAAC,CAAC;YACnB,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,UAAA,CAAC;gBACxB,YAAU,IAAI,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC;YACnC,CAAC,CAAC,CAAC;YACH,OAAO,CAAC,GAAG,CAAC,UAAG,WAAW,CAAC,MAAM,CAAC,MAAM,cAAI,WAAW,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,kBAAQ,YAAU,cAAI,YAAU,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,wBAAc,CAAC,OAAI,CAAC,CAAC;YACjL,aAAW,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;SACjC;IACL,CAAC,CAAC,CAAC;IACH,IAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACzB,IAAI,EAAE,CAAC,UAAU,CAAC,cAAc,CAAC,EAAE;QAC/B,IAAI,WAAS,GAAG,YAAK,QAAQ,CAAC,KAAK,OAAI,CAAC;QACxC,WAAS,IAAI,eAAW,QAAQ,CAAC,EAAE,cAAc,CAAC;QAClD,IAAI,QAAQ,CAAC,OAAO;YAAE,WAAS,IAAI,8BAAuB,QAAQ,CAAC,OAAO,SAAM,CAAC;QACjF,IAAI,aAAW,CAAC,MAAM,GAAG,CAAC,EAAE;YACxB,WAAS,IAAI,UAAG,aAAW,CAAC,MAAM,cAAI,aAAW,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,oBAAiB,CAAC;YACvG,aAAW,CAAC,OAAO,CAAC,UAAA,CAAC;gBACjB,WAAS,IAAI,sBAAc,CAAC,CAAC,KAAK,SAAK,CAAC;gBACxC,WAAS,IAAI,eAAW,CAAC,CAAC,EAAE,cAAc,CAAC;gBAC3C,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,UAAA,CAAC;oBACd,IAAI,CAAC,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC;wBAAE,WAAS,IAAI,cAAO,CAAC,CAAC,KAAK,SAAM,CAAC;oBAC3D,WAAS,IAAI,wDAAwD,CAAC;oBACtE,WAAS,IAAI,mCAAmC,CAAC;oBACjD,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,UAAA,CAAC;wBACf,WAAS,IAAI,YAAK,CAAC,CAAC,KAAK,QAAK,CAAC;wBAC/B,IAAI,CAAC,CAAC,IAAI,KAAK,YAAY,IAAI,CAAC,CAAC,UAAU,EAAE;4BACzC,IAAM,GAAC,GAAG,CAAC,CAAC,UAA8C,CAAC;4BAC3D,WAAS,IAAI,WAAI,iCAAsB,CAAC,CAAC,CAAC,IAAI,CAAC,eAAK,GAAC,CAAC,GAAG,SAAM,CAAA;yBAClE;6BAAM;4BACH,WAAS,IAAI,UAAG,iCAAsB,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,GAAG,OAAI,CAAA;yBAC5D;wBACD,WAAS,IAAI,CAAC,CAAC,mBAAmB,EAAE,CAAC;wBACrC,WAAS,IAAI,aAAM,CAAC,CAAC,EAAE,SAAM,CAAC;oBAClC,CAAC,CAAC,CAAA;gBACN,CAAC,CAAC,CAAA;YACN,CAAC,CAAC,CAAA;SACL;aAAM;YACH,WAAS,IAAI,4BAA4B,CAAC;SAC7C;QACD,EAAE,CAAC,aAAa,CAAC,gBAAgB,EAAE,WAAS,EAAE,EAAC,QAAQ,EAAE,MAAM,EAAC,CAAC,CAAC;QAClE,OAAO,CAAC,GAAG,CAAC,0BAAkB,gBAAgB,kBAAc,CAAC,CAAC;KACjE;CACJ"}
|