mxdocgen
Version:
A small tool that mimics the documentation generation capabilities offered in Mendix Studio Pro, but with greater flexibility. It uses the Mendix Model SDK to extract information from a Mendix model, which is then fed into a set of templates to generate
125 lines • 6.48 kB
JavaScript
;
var __assign = (this && this.__assign) || function () {
__assign = Object.assign || function(t) {
for (var s, i = 1, n = arguments.length; i < n; i++) {
s = arguments[i];
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
t[p] = s[p];
}
return t;
};
return __assign.apply(this, arguments);
};
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
var __generator = (this && this.__generator) || function (thisArg, body) {
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
function verb(n) { return function (v) { return step([n, v]); }; }
function step(op) {
if (f) throw new TypeError("Generator is already executing.");
while (_) try {
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
if (y = 0, t) op = [op[0] & 2, t.value];
switch (op[0]) {
case 0: case 1: t = op; break;
case 4: _.label++; return { value: op[1], done: false };
case 5: _.label++; y = op[1]; op = [0]; continue;
case 7: op = _.ops.pop(); _.trys.pop(); continue;
default:
if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
if (t[2]) _.ops.pop();
_.trys.pop(); continue;
}
op = body.call(thisArg, _);
} catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
}
};
exports.__esModule = true;
var mendixplatformsdk_1 = require("mendixplatformsdk");
var output_1 = require("../options/output");
var client_1 = require("../options/client");
var defaultprocessor_1 = require("../../documentation/defaultprocessor");
var templates_1 = require("../../documentation/templates");
var filters_1 = require("../../documentation/filters");
var templates_2 = require("../options/templates");
var project_1 = require("../options/project");
var filters_2 = require("../options/filters");
var generate_1 = require("../../documentation/generate");
exports.command = "generate";
exports.describe = "Generate documentation";
exports.builder = __assign(__assign(__assign(__assign(__assign({}, client_1.clientOptions), filters_2.filterOptions), output_1.outputOptions), project_1.projectOptions), templates_2.templateOptions);
exports.handler = function (args) { return __awaiter(void 0, void 0, void 0, function () {
var client, projectConfig, filterConfig, templateConfig, outputConfig, moduleFilter, documentFilter, processor;
var _a;
return __generator(this, function (_b) {
switch (_b.label) {
case 0:
client = new mendixplatformsdk_1.MendixSdkClient(args.username, args.apikey);
projectConfig = getProjectConfig(args);
filterConfig = getFilterConfig(args);
templateConfig = getTemplateConfig(args);
outputConfig = getOutputConfig(args);
moduleFilter = filters_1.createRegexModuleFilter(new RegExp(filterConfig.modulesRegex));
documentFilter = filters_1.createGlobDocumentFilter((_a = filterConfig.documentIgnorePatterns, (_a !== null && _a !== void 0 ? _a : [])));
processor = new defaultprocessor_1.DefaultProcessor(moduleFilter, documentFilter);
if (!projectConfig)
throw new Error("Invalid project configuration");
return [4 /*yield*/, generate_1.generate(client, {
project: projectConfig,
filters: filterConfig,
templates: templateConfig,
output: outputConfig,
processor: processor
})];
case 1:
_b.sent();
return [2 /*return*/];
}
});
}); };
var getProjectConfig = function (args) {
return args.mpk
? {
mpk: args.mpk
}
: args.workingcopyid
? {
workingCopyId: args.workingcopyid
}
: args.projectid && args.branch && args.revision
? {
projectId: args.projectid,
branch: args.branch,
revision: args.revision
}
: undefined;
};
var getFilterConfig = function (args) { return ({
modulesRegex: args.modules,
documentIgnorePatterns: args.ignore
}); };
var getTemplateConfig = function (args) {
var _a, _b, _c;
return ({
directory: (_a = args.templatedir, (_a !== null && _a !== void 0 ? _a : templates_1.defaultTemplateConfig.directory)),
extension: (_b = args.templateext, (_b !== null && _b !== void 0 ? _b : templates_1.defaultTemplateConfig.extension)),
mainTemplate: (_c = args.maintemplate, (_c !== null && _c !== void 0 ? _c : templates_1.defaultTemplateConfig.mainTemplate))
});
};
var getOutputConfig = function (args) { return ({
directory: args.outputdir,
filename: args.outputfile
}); };
//# sourceMappingURL=generate.js.map