@iqb/validate-md-profile 0.5.1 → 0.7.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/package.json +2 -2
- package/validate-md-profile.js +34 -9
- package/validate-md-profile.js.map +1 -1
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@iqb/validate-md-profile",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.7.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": "1.
|
|
17
|
+
"@iqb/metadata": "1.4.0"
|
|
18
18
|
},
|
|
19
19
|
"bin": {
|
|
20
20
|
"validate-md-profile": "./validate-md-profile.js"
|
package/validate-md-profile.js
CHANGED
|
@@ -4,11 +4,20 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
4
4
|
var schema_validate_factory_1 = require("./schema-validate.factory");
|
|
5
5
|
var metadata_1 = require("@iqb/metadata");
|
|
6
6
|
var mdTargetFolder = './docs';
|
|
7
|
-
var
|
|
7
|
+
var quartoMode = false;
|
|
8
8
|
var configFileName = './profile-config.json';
|
|
9
9
|
if (process.argv[2]) {
|
|
10
|
-
|
|
10
|
+
if (process.argv[2] === '-quarto') {
|
|
11
|
+
quartoMode = true;
|
|
12
|
+
}
|
|
13
|
+
else {
|
|
14
|
+
configFileName = "./".concat(process.argv[2]);
|
|
15
|
+
}
|
|
11
16
|
}
|
|
17
|
+
if (process.argv[3] && process.argv[3] === '-quarto') {
|
|
18
|
+
quartoMode = true;
|
|
19
|
+
}
|
|
20
|
+
var mdTargetFilename = "".concat(mdTargetFolder, "/README.").concat(quartoMode ? 'qmd' : 'md');
|
|
12
21
|
var mdConfig = schema_validate_factory_1.SchemaValidateFactory.validateConfig(configFileName);
|
|
13
22
|
if (mdConfig) {
|
|
14
23
|
console.log("config file '".concat(configFileName, "' is valid: ").concat(mdConfig.title));
|
|
@@ -23,21 +32,27 @@ if (mdConfig) {
|
|
|
23
32
|
console.log("".concat(myMDProfile.groups.length, " ").concat(myMDProfile.groups.length === 1 ? 'group' : 'groups', " and ").concat(entryCount_1, " ").concat(entryCount_1 === 1 ? 'entry' : 'entries', " found in '").concat(p, "'."));
|
|
24
33
|
allProfiles_1.push(myMDProfile);
|
|
25
34
|
}
|
|
35
|
+
else {
|
|
36
|
+
console.log("\u001B[0;33mWARNING\u001B[0m profile '".concat(p, "' not valid - ignore"));
|
|
37
|
+
}
|
|
26
38
|
});
|
|
27
39
|
var fs = require('fs');
|
|
28
40
|
if (fs.existsSync(mdTargetFolder)) {
|
|
29
|
-
var mdContent_1 =
|
|
30
|
-
mdContent_1 += "
|
|
31
|
-
|
|
32
|
-
|
|
41
|
+
var mdContent_1 = '';
|
|
42
|
+
mdContent_1 += quartoMode ? "" : "# ".concat(mdConfig.title, "\n\n");
|
|
43
|
+
mdContent_1 += "ID of profile-store: `".concat(mdConfig.id, "`\n\n");
|
|
44
|
+
if (mdConfig.publisher)
|
|
45
|
+
mdContent_1 += "Publisher: ".concat(mdConfig.publisher, "\n\n");
|
|
46
|
+
if (mdConfig.maintainer !== "")
|
|
47
|
+
mdContent_1 += "Maintainer: ".concat(mdConfig.maintainer, "\n\n");
|
|
33
48
|
if (allProfiles_1.length > 0) {
|
|
34
49
|
mdContent_1 += "".concat(allProfiles_1.length, " ").concat(allProfiles_1.length === 1 ? 'Profil' : 'Profile', " definiert:\n\n");
|
|
35
50
|
allProfiles_1.forEach(function (p) {
|
|
36
|
-
mdContent_1 += "## Profil \"".concat(p.label, "\"\n");
|
|
37
|
-
mdContent_1 += "
|
|
51
|
+
mdContent_1 += quartoMode ? "# ".concat(p.label, "\n\n") : "## Profil \"".concat(p.label, "\"\n\n");
|
|
52
|
+
mdContent_1 += "ID of profile: `".concat(p.id, "`\n\n");
|
|
38
53
|
p.groups.forEach(function (g) {
|
|
39
54
|
if (p.groups.length > 1)
|
|
40
|
-
mdContent_1 += "### ".concat(g.label, "\n\n");
|
|
55
|
+
mdContent_1 += quartoMode ? "## ".concat(g.label, "\n\n") : "### ".concat(g.label, "\n\n");
|
|
41
56
|
mdContent_1 += '| Name/Label | Typ | Parameter | ID Profil-Eintrag |\n';
|
|
42
57
|
mdContent_1 += '| :--- | :---: | :--- | :---: |\n';
|
|
43
58
|
g.entries.forEach(function (e) {
|
|
@@ -52,14 +67,24 @@ if (mdConfig) {
|
|
|
52
67
|
mdContent_1 += e.getParametersAsText();
|
|
53
68
|
mdContent_1 += " | ".concat(e.id, " |\n");
|
|
54
69
|
});
|
|
70
|
+
mdContent_1 += quartoMode ? '\n: {tbl-colwidths="[15,15,55,15]"}\n\n' : '\n';
|
|
55
71
|
});
|
|
56
72
|
});
|
|
57
73
|
}
|
|
58
74
|
else {
|
|
59
75
|
mdContent_1 += 'Keine Profile definiert.\n';
|
|
76
|
+
console.log('\x1b[0;33mWARNING\x1b[0m no profiles found');
|
|
60
77
|
}
|
|
61
78
|
fs.writeFileSync(mdTargetFilename, mdContent_1, { encoding: 'utf8' });
|
|
62
79
|
console.log("markdown file \"".concat(mdTargetFilename, "\" generated."));
|
|
63
80
|
}
|
|
81
|
+
else {
|
|
82
|
+
console.log("\u001B[0;31mERROR\u001B[0m TargetFolder '".concat(mdTargetFolder, "' not found"));
|
|
83
|
+
process.exitCode = 1;
|
|
84
|
+
}
|
|
85
|
+
}
|
|
86
|
+
else {
|
|
87
|
+
console.log("\u001B[0;31mERROR\u001B[0m profile store '".concat(configFileName, "' not valid"));
|
|
88
|
+
process.exitCode = 1;
|
|
64
89
|
}
|
|
65
90
|
//# sourceMappingURL=validate-md-profile.js.map
|
|
@@ -1 +1 @@
|
|
|
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,
|
|
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,IAAI,UAAU,GAAG,KAAK,CAAC;AAEvB,IAAI,cAAc,GAAG,uBAAuB,CAAC;AAC7C,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE;IACjB,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,SAAS,EAAE;QAC/B,UAAU,GAAG,IAAI,CAAC;KACrB;SAAM;QACH,cAAc,GAAG,YAAK,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAE,CAAC;KAC3C;CACJ;AAED,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,SAAS,EAAE;IAClD,UAAU,GAAG,IAAI,CAAC;CACrB;AAED,IAAM,gBAAgB,GAAG,UAAG,cAAc,qBAAW,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAE,CAAC;AAEjF,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;aAAM;YACH,OAAO,CAAC,GAAG,CAAC,gDAAqC,CAAC,yBAAsB,CAAC,CAAC;SAC7E;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,EAAE,CAAC;QACnB,WAAS,IAAI,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,YAAK,QAAQ,CAAC,KAAK,SAAM,CAAC;QACzD,WAAS,IAAI,gCAA0B,QAAQ,CAAC,EAAE,UAAQ,CAAC;QAC3D,IAAI,QAAQ,CAAC,SAAS;YAAE,WAAS,IAAI,qBAAc,QAAQ,CAAC,SAAS,SAAM,CAAC;QAC5E,IAAI,QAAQ,CAAC,UAAU,KAAK,EAAE;YAAE,WAAS,IAAI,sBAAe,QAAQ,CAAC,UAAU,SAAM,CAAC;QACtF,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,UAAU,CAAC,CAAC,CAAC,YAAK,CAAC,CAAC,KAAK,SAAM,CAAC,CAAC,CAAC,sBAAc,CAAC,CAAC,KAAK,WAAO,CAAC;gBAC5E,WAAS,IAAI,0BAAoB,CAAC,CAAC,EAAE,UAAQ,CAAC;gBAC9C,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,UAAA,CAAC;oBACd,IAAI,CAAC,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC;wBAAE,WAAS,IAAI,UAAU,CAAC,CAAC,CAAC,aAAM,CAAC,CAAC,KAAK,SAAM,CAAC,CAAC,CAAC,cAAO,CAAC,CAAC,KAAK,SAAM,CAAC;oBAC9F,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;oBACF,WAAS,IAAI,UAAU,CAAC,CAAC,CAAC,yCAAyC,CAAC,CAAC,CAAC,IAAI,CAAC;gBAC/E,CAAC,CAAC,CAAA;YACN,CAAC,CAAC,CAAA;SACL;aAAM;YACH,WAAS,IAAI,4BAA4B,CAAC;YAC1C,OAAO,CAAC,GAAG,CAAC,4CAA4C,CAAC,CAAC;SAC7D;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;SAAM;QACH,OAAO,CAAC,GAAG,CAAC,mDAAwC,cAAc,gBAAa,CAAC,CAAC;QACjF,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;KACxB;CACJ;KAAM;IACH,OAAO,CAAC,GAAG,CAAC,oDAAyC,cAAc,gBAAa,CAAC,CAAC;IAClF,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;CACxB"}
|