merge scripts, tasks and config folder and convert code to typescript

This commit is contained in:
dennis.ludwig
2021-06-12 16:11:51 +02:00
parent eb9e85e7a0
commit 8fa1bd1e0d
23 changed files with 336 additions and 582 deletions

View File

@@ -1,39 +0,0 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.assetUrl = exports.isMobileViewport = exports.translate = exports.showEmptyRings = exports.getItemPageNames = exports.rings = exports.quadrants = exports.radarNameShort = exports.radarName = void 0;
exports.radarName = process.env.RADAR_NAME || "AOE Technology Radar";
exports.radarNameShort = exports.radarName;
exports.quadrants = [
"languages-and-frameworks",
"methods-and-patterns",
"platforms-and-aoe-services",
"tools",
];
exports.rings = ["all", "adopt", "trial", "assess", "hold"];
var getItemPageNames = function (items) {
return items.map(function (item) { return item.quadrant + "/" + item.name; });
};
exports.getItemPageNames = getItemPageNames;
exports.showEmptyRings = false;
var messages = {
"languages-and-frameworks": "Languages & Frameworks",
"methods-and-patterns": "Methods & Patterns",
"platforms-and-aoe-services": "Platforms and Operations",
tools: "Tools",
};
var translate = function (key) { return messages[key] || "-"; };
exports.translate = translate;
function isMobileViewport() {
// return false for server side rendering
if (typeof window == "undefined")
return false;
var width = window.innerWidth ||
document.documentElement.clientWidth ||
document.body.clientWidth;
return width < 1200;
}
exports.isMobileViewport = isMobileViewport;
function assetUrl(file) {
return process.env.PUBLIC_URL + "/" + file;
}
exports.assetUrl = assetUrl;

View File

@@ -1,56 +0,0 @@
"use strict";
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 __spreadArray = (this && this.__spreadArray) || function (to, from) {
for (var i = 0, il = from.length, j = to.length; i < il; i++, j++)
to[j] = from[i];
return to;
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.getFirstLetter = exports.groupByFirstLetter = exports.groupByQuadrants = exports.featuredOnly = void 0;
var featuredOnly = function (items) { return items.filter(function (item) { return item.featured; }); };
exports.featuredOnly = featuredOnly;
var groupByQuadrants = function (items) {
return items.reduce(function (quadrants, item) {
var _a;
return (__assign(__assign({}, quadrants), (_a = {}, _a[item.quadrant] = addItemToQuadrant(quadrants[item.quadrant], item), _a)));
}, {});
};
exports.groupByQuadrants = groupByQuadrants;
var groupByFirstLetter = function (items) {
var index = items.reduce(function (letterIndex, item) {
var _a;
return (__assign(__assign({}, letterIndex), (_a = {}, _a[exports.getFirstLetter(item)] = addItemToList(letterIndex[exports.getFirstLetter(item)], item), _a)));
}, {});
return Object.keys(index)
.sort()
.map(function (letter) { return ({
letter: letter,
items: index[letter],
}); });
};
exports.groupByFirstLetter = groupByFirstLetter;
var addItemToQuadrant = function (quadrant, item) {
var _a;
if (quadrant === void 0) { quadrant = {}; }
return (__assign(__assign({}, quadrant), (_a = {}, _a[item.ring] = addItemToRing(quadrant[item.ring], item), _a)));
};
var addItemToList = function (list, item) {
if (list === void 0) { list = []; }
return __spreadArray(__spreadArray([], list), [item]);
};
var addItemToRing = function (ring, item) {
if (ring === void 0) { ring = []; }
return __spreadArray(__spreadArray([], ring), [item]);
};
var getFirstLetter = function (item) { return item.title.substr(0, 1).toUpperCase(); };
exports.getFirstLetter = getFirstLetter;

View File

@@ -1,74 +0,0 @@
#!/usr/bin/env node
"use strict";
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 };
}
};
Object.defineProperty(exports, "__esModule", { value: true });
var radar_1 = require("./radar");
var fs_1 = require("fs");
var config_1 = require("../src/config");
(function () { return __awaiter(void 0, void 0, void 0, function () {
var radar, e_1;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
_a.trys.push([0, 2, , 3]);
console.log("starting static");
return [4 /*yield*/, radar_1.createRadar()];
case 1:
radar = _a.sent();
fs_1.copyFileSync("build/index.html", "build/overview.html");
fs_1.copyFileSync("build/index.html", "build/help-and-about-tech-radar.html");
config_1.quadrants.forEach(function (quadrant) {
var destFolder = "build/" + quadrant;
fs_1.copyFileSync("build/index.html", destFolder + ".html");
if (!fs_1.existsSync(destFolder)) {
fs_1.mkdirSync(destFolder);
}
});
radar.items.forEach(function (item) {
fs_1.copyFileSync("build/index.html", "build/" + item.quadrant + "/" + item.name + ".html");
});
console.log("created static");
return [3 /*break*/, 3];
case 2:
e_1 = _a.sent();
console.error("error:", e_1);
return [3 /*break*/, 3];
case 3: return [2 /*return*/];
}
});
}); })();

View File

@@ -1,120 +0,0 @@
"use strict";
var __spreadArray = (this && this.__spreadArray) || function (to, from) {
for (var i = 0, il = from.length, j = to.length; i < il; i++, j++)
to[j] = from[i];
return to;
};
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.save = exports.getAllMarkdownFiles = exports.builderPath = exports.buildPath = exports.publicPath = exports.jsPath = exports.faviconPath = exports.assetsPath = exports.stylesPath = exports.radarPath = exports.relativePath = void 0;
var fs_extra_1 = require("fs-extra");
var path_1 = __importDefault(require("path"));
var walk_1 = require("walk");
var relativePath = function () {
var relativePath = [];
for (var _i = 0; _i < arguments.length; _i++) {
relativePath[_i] = arguments[_i];
}
// path.resolve(__dirname, '..', ...relativePath)
return path_1.default.resolve.apply(path_1.default, relativePath);
};
exports.relativePath = relativePath;
var radarPath = function () {
var pathInSrc = [];
for (var _i = 0; _i < arguments.length; _i++) {
pathInSrc[_i] = arguments[_i];
}
return exports.relativePath.apply(void 0, __spreadArray(["radar"], pathInSrc));
};
exports.radarPath = radarPath;
var stylesPath = function () {
var pathInSrc = [];
for (var _i = 0; _i < arguments.length; _i++) {
pathInSrc[_i] = arguments[_i];
}
return exports.relativePath.apply(void 0, __spreadArray(["styles"], pathInSrc));
};
exports.stylesPath = stylesPath;
var assetsPath = function () {
var pathInSrc = [];
for (var _i = 0; _i < arguments.length; _i++) {
pathInSrc[_i] = arguments[_i];
}
return exports.relativePath.apply(void 0, __spreadArray(["assets"], pathInSrc));
};
exports.assetsPath = assetsPath;
var faviconPath = function () {
var pathInSrc = [];
for (var _i = 0; _i < arguments.length; _i++) {
pathInSrc[_i] = arguments[_i];
}
return exports.relativePath.apply(void 0, __spreadArray(["assets/favicon.ico"], pathInSrc));
};
exports.faviconPath = faviconPath;
var jsPath = function () {
var pathInSrc = [];
for (var _i = 0; _i < arguments.length; _i++) {
pathInSrc[_i] = arguments[_i];
}
return exports.relativePath.apply(void 0, __spreadArray(["js"], pathInSrc));
};
exports.jsPath = jsPath;
var publicPath = function () {
var pathInDist = [];
for (var _i = 0; _i < arguments.length; _i++) {
pathInDist[_i] = arguments[_i];
}
return exports.relativePath.apply(void 0, __spreadArray(["public"], pathInDist));
};
exports.publicPath = publicPath;
var buildPath = function () {
var pathInDist = [];
for (var _i = 0; _i < arguments.length; _i++) {
pathInDist[_i] = arguments[_i];
}
return exports.relativePath.apply(void 0, __spreadArray(["build"], pathInDist));
};
exports.buildPath = buildPath;
var builderPath = function () {
var pathInDist = [];
for (var _i = 0; _i < arguments.length; _i++) {
pathInDist[_i] = arguments[_i];
}
return exports.relativePath.apply(void 0, __spreadArray(["node_modules", "aoe_technology_radar", "src"], pathInDist));
};
exports.builderPath = builderPath;
var getAllMarkdownFiles = function (folder) {
return getAllFiles(folder, isMarkdownFile);
};
exports.getAllMarkdownFiles = getAllMarkdownFiles;
var getAllFiles = function (folder, predicate) {
return new Promise(function (resolve, reject) {
var walker = walk_1.walk(folder, { followLinks: false });
var files = [];
walker.on("file", function (root, fileStat, next) {
if (predicate(fileStat.name)) {
files.push(path_1.default.resolve(root, fileStat.name));
}
next();
});
walker.on("errors", function (root, nodeStatsArray, next) {
nodeStatsArray.forEach(function (n) {
console.error("[ERROR] " + n.name);
if (n.error) {
console.error(n.error.message || n.error.code + ": " + n.error.path);
}
});
next();
});
walker.on("end", function () {
resolve(files.sort());
});
});
};
var isMarkdownFile = function (name) { return name.match(/\.md$/) !== null; };
var save = function (data, fileName) {
return fs_extra_1.outputFile(exports.buildPath(fileName), data);
};
exports.save = save;

View File

@@ -1,193 +0,0 @@
"use strict";
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 };
}
};
var __spreadArray = (this && this.__spreadArray) || function (to, from) {
for (var i = 0, il = from.length, j = to.length; i < il; i++, j++)
to[j] = from[i];
return to;
};
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.createRadar = void 0;
var fs_extra_1 = require("fs-extra");
var path_1 = __importDefault(require("path"));
var front_matter_1 = __importDefault(require("front-matter"));
var marked_1 = __importDefault(require("marked"));
var highlight_js_1 = __importDefault(require("highlight.js"));
var config_1 = require("../src/config");
var file_1 = require("./file");
marked_1.default.setOptions({
highlight: function (code) { return highlight_js_1.default.highlightAuto(code).value; },
});
var createRadar = function () { return __awaiter(void 0, void 0, void 0, function () {
var fileNames, revisions, allReleases, items, flaggedItems;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, file_1.getAllMarkdownFiles(file_1.radarPath())];
case 1:
fileNames = _a.sent();
return [4 /*yield*/, createRevisionsFromFiles(fileNames)];
case 2:
revisions = _a.sent();
allReleases = getAllReleases(revisions);
items = createItems(revisions);
flaggedItems = flagItem(items, allReleases);
return [2 /*return*/, {
items: flaggedItems,
releases: allReleases,
}];
}
});
}); };
exports.createRadar = createRadar;
var checkAttributes = function (fileName, attributes) {
if (attributes.ring && !config_1.rings.includes(attributes.ring)) {
throw new Error("Error: " + fileName + " has an illegal value for 'ring' - must be one of " + config_1.rings);
}
if (attributes.quadrant && !config_1.quadrants.includes(attributes.quadrant)) {
throw new Error("Error: " + fileName + " has an illegal value for 'quadrant' - must be one of " + config_1.quadrants);
}
return attributes;
};
var createRevisionsFromFiles = function (fileNames) {
return Promise.all(fileNames.map(function (fileName) {
return new Promise(function (resolve, reject) {
fs_extra_1.readFile(fileName, 'utf8', function (err, data) {
if (err) {
reject(err);
}
else {
var fm = front_matter_1.default(data);
// add target attribute to external links
// todo: check path
var html = marked_1.default(fm.body.replace(/\]\(\//g, '](/techradar/'));
html = html.replace(/a href="http/g, 'a target="_blank" rel="noopener noreferrer" href="http');
resolve(__assign(__assign(__assign({}, itemInfoFromFilename(fileName)), checkAttributes(fileName, fm.attributes)), { fileName: fileName, body: html }));
}
});
});
}));
};
var itemInfoFromFilename = function (fileName) {
var _a = fileName.split(path_1.default.sep).slice(-2), release = _a[0], name = _a[1];
return {
name: path_1.default.basename(name, '.md'),
release: release,
};
};
var getAllReleases = function (revisions) {
return revisions
.reduce(function (allReleases, _a) {
var release = _a.release;
if (!allReleases.includes(release)) {
return __spreadArray(__spreadArray([], allReleases), [release]);
}
return allReleases;
}, [])
.sort();
};
var createItems = function (revisions) {
var itemMap = revisions.reduce(function (items, revision) {
var _a;
return __assign(__assign({}, items), (_a = {}, _a[revision.name] = addRevisionToItem(items[revision.name], revision), _a));
}, {});
return Object.values(itemMap).map(function (item) {
var _a;
return (__assign(__assign({}, item), (_a = {}, _a['title'] = item.title || item.name, _a)));
}).sort(function (x, y) { return (x.name > y.name ? 1 : -1); });
};
var ignoreEmptyRevisionBody = function (revision, item) {
if (!revision.body || revision.body.trim() === '') {
return item.body;
}
return revision.body;
};
var addRevisionToItem = function (item, revision) {
if (item === void 0) { item = {
flag: 'default',
featured: true,
revisions: [],
name: '',
title: '',
ring: 'trial',
quadrant: '',
body: '',
info: '',
}; }
var newItem = __assign(__assign(__assign({}, item), revision), { body: ignoreEmptyRevisionBody(revision, item) });
if (revisionCreatesNewHistoryEntry(revision)) {
newItem = __assign(__assign({}, newItem), { revisions: __spreadArray([revision], newItem.revisions) });
}
return newItem;
};
var revisionCreatesNewHistoryEntry = function (revision) {
return revision.body.trim() !== '' || typeof revision.ring !== 'undefined';
};
var flagItem = function (items, allReleases) {
return items.map(function (item) { return (__assign(__assign({}, item), { flag: getItemFlag(item, allReleases) })); }, []);
};
var isInLastRelease = function (item, allReleases) {
return item.revisions[0].release === allReleases[allReleases.length - 1];
};
var isNewItem = function (item, allReleases) {
return item.revisions.length === 1 && isInLastRelease(item, allReleases);
};
var hasItemChanged = function (item, allReleases) {
return item.revisions.length > 1 && isInLastRelease(item, allReleases);
};
var getItemFlag = function (item, allReleases) {
if (isNewItem(item, allReleases)) {
return 'new';
}
if (hasItemChanged(item, allReleases)) {
return 'changed';
}
return 'default';
};

View File

@@ -1,64 +0,0 @@
#!/usr/bin/env node
"use strict";
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 };
}
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.radarJsonGenerator = void 0;
var radar_1 = require("./radar");
var file_1 = require("./file");
var radarJsonGenerator = function () { return __awaiter(void 0, void 0, void 0, function () {
var radar, e_1;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
_a.trys.push([0, 3, , 4]);
return [4 /*yield*/, radar_1.createRadar()];
case 1:
radar = _a.sent();
return [4 /*yield*/, file_1.save(JSON.stringify(radar), "rd.json")];
case 2:
_a.sent();
return [3 /*break*/, 4];
case 3:
e_1 = _a.sent();
console.error("error:", e_1);
return [3 /*break*/, 4];
case 4: return [2 /*return*/];
}
});
}); };
exports.radarJsonGenerator = radarJsonGenerator;