AJR/TechRadarAJR
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

remove existing radar and decouple everything

Browse Source
This commit is contained in:
Bastian Ike
2021-01-08 13:29:24 +01:00
committed by Bastian
parent 2134a6d62d
commit dd8054d1be
238 changed files with 2140 additions and 2742 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
bin/src/config.js Normal file
View File

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

18
bin/src/model.js Normal file
View File

@@ -0,0 +1,18 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.getFirstLetter = exports.groupByFirstLetter = exports.groupByQuadrants = exports.featuredOnly = void 0;
exports.featuredOnly = (items) => items.filter(item => item.featured);
exports.groupByQuadrants = (items) => items.reduce((quadrants, item) => (Object.assign(Object.assign({}, quadrants), { [item.quadrant]: addItemToQuadrant(quadrants[item.quadrant], item) })), {});
exports.groupByFirstLetter = (items) => {
const index = items.reduce((letterIndex, item) => (Object.assign(Object.assign({}, letterIndex), { [exports.getFirstLetter(item)]: addItemToList(letterIndex[exports.getFirstLetter(item)], item) })), {});
return Object.keys(index)
.sort()
.map(letter => ({
letter,
items: index[letter],
}));
};
const addItemToQuadrant = (quadrant = {}, item) => (Object.assign(Object.assign({}, quadrant), { [item.ring]: addItemToRing(quadrant[item.ring], item) }));
const addItemToList = (list = [], item) => [...list, item];
const addItemToRing = (ring = [], item) => [...ring, item];
exports.getFirstLetter = (item) => item.title.substr(0, 1).toUpperCase();

43
bin/tasks/file.js Executable file
View File

@@ -0,0 +1,43 @@
"use strict";
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.distPath = exports.jsPath = exports.faviconPath = exports.assetsPath = exports.stylesPath = exports.radarPath = exports.relativePath = void 0;
const fs_extra_1 = require("fs-extra");
const path_1 = __importDefault(require("path"));
const walk_1 = require("walk");
exports.relativePath = (...relativePath) => (
// path.resolve(__dirname, '..', ...relativePath)
path_1.default.resolve(...relativePath));
exports.radarPath = (...pathInSrc) => (exports.relativePath('radar', ...pathInSrc));
exports.stylesPath = (...pathInSrc) => (exports.relativePath('styles', ...pathInSrc));
exports.assetsPath = (...pathInSrc) => (exports.relativePath('assets', ...pathInSrc));
exports.faviconPath = (...pathInSrc) => (exports.relativePath('assets/favicon.ico', ...pathInSrc));
exports.jsPath = (...pathInSrc) => (exports.relativePath('js', ...pathInSrc));
exports.distPath = (...pathInDist) => (exports.relativePath('src', ...pathInDist));
exports.getAllMarkdownFiles = (folder) => (getAllFiles(folder, isMarkdownFile));
const getAllFiles = (folder, predicate) => (new Promise((resolve, reject) => {
const walker = walk_1.walk(folder, { followLinks: false });
const files = [];
walker.on("file", (root, fileStat, next) => {
if (predicate(fileStat.name)) {
files.push(path_1.default.resolve(root, fileStat.name));
}
next();
});
walker.on("errors", (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", () => {
resolve(files.sort());
});
}));
const isMarkdownFile = (name) => name.match(/\.md$/) !== null;
exports.save = (data, fileName) => fs_extra_1.outputFile(exports.distPath(fileName), data);

128
bin/tasks/radar.js Executable file
View File

@@ -0,0 +1,128 @@
"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 __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.createRadar = void 0;
const fs_extra_1 = require("fs-extra");
const path_1 = __importDefault(require("path"));
const front_matter_1 = __importDefault(require("front-matter"));
const marked_1 = __importDefault(require("marked"));
const highlight_js_1 = __importDefault(require("highlight.js"));
const config_1 = require("../src/config");
const file_1 = require("./file");
marked_1.default.setOptions({
highlight: code => highlight_js_1.default.highlightAuto(code).value,
});
exports.createRadar = () => __awaiter(void 0, void 0, void 0, function* () {
const fileNames = yield file_1.getAllMarkdownFiles(file_1.radarPath());
const revisions = yield createRevisionsFromFiles(fileNames);
const allReleases = getAllReleases(revisions);
const items = createItems(revisions);
const flaggedItems = flagItem(items, allReleases);
return {
items: flaggedItems,
releases: allReleases,
};
});
const checkAttributes = (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}`);
}
if (!attributes.quadrant || attributes.quadrant === '') {
// throw new Error(`Error: ${fileName} has no 'quadrant' set`);
}
if (!attributes.title || attributes.title === '') {
attributes.title = path_1.default.basename(fileName);
}
return attributes;
};
const createRevisionsFromFiles = (fileNames) => Promise.all(fileNames.map(fileName => {
return new Promise((resolve, reject) => {
fs_extra_1.readFile(fileName, 'utf8', (err, data) => {
if (err) {
reject(err);
}
else {
const fm = front_matter_1.default(data);
// add target attribute to external links
// todo: check path
let 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(Object.assign(Object.assign(Object.assign({}, itemInfoFromFilename(fileName)), checkAttributes(fileName, fm.attributes)), { fileName, body: html }));
}
});
});
}));
const itemInfoFromFilename = (fileName) => {
const [release, nameWithSuffix] = fileName.split(path_1.default.sep).slice(-2);
return {
name: nameWithSuffix.substr(0, nameWithSuffix.length - 3),
release,
};
};
const getAllReleases = (revisions) => revisions
.reduce((allReleases, { release }) => {
if (!allReleases.includes(release)) {
return [...allReleases, release];
}
return allReleases;
}, [])
.sort();
const createItems = (revisions) => {
const itemMap = revisions.reduce((items, revision) => {
return Object.assign(Object.assign({}, items), { [revision.name]: addRevisionToItem(items[revision.name], revision) });
}, {});
return Object.values(itemMap).sort((x, y) => (x.name > y.name ? 1 : -1));
};
const ignoreEmptyRevisionBody = (revision, item) => {
if (!revision.body || revision.body.trim() === '') {
return item.body;
}
return revision.body;
};
const addRevisionToItem = (item = {
flag: 'default',
featured: true,
revisions: [],
name: '',
title: '',
ring: 'trial',
quadrant: '',
body: '',
info: '',
}, revision) => {
let newItem = Object.assign(Object.assign(Object.assign({}, item), revision), { body: ignoreEmptyRevisionBody(revision, item) });
if (revisionCreatesNewHistoryEntry(revision)) {
newItem = Object.assign(Object.assign({}, newItem), { revisions: [revision, ...newItem.revisions] });
}
return newItem;
};
const revisionCreatesNewHistoryEntry = (revision) => {
return revision.body.trim() !== '' || typeof revision.ring !== 'undefined';
};
const flagItem = (items, allReleases) => items.map(item => (Object.assign(Object.assign({}, item), { flag: getItemFlag(item, allReleases) })), []);
const isInLastRelease = (item, allReleases) => item.revisions[0].release === allReleases[allReleases.length - 1];
const isNewItem = (item, allReleases) => item.revisions.length === 1 && isInLastRelease(item, allReleases);
const hasItemChanged = (item, allReleases) => item.revisions.length > 1 && isInLastRelease(item, allReleases);
const getItemFlag = (item, allReleases) => {
if (isNewItem(item, allReleases)) {
return 'new';
}
if (hasItemChanged(item, allReleases)) {
return 'changed';
}
return 'default';
};

45
bin/tasks/radarjson.js Executable file
View File

@@ -0,0 +1,45 @@
#!/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());
});
};
Object.defineProperty(exports, "__esModule", { value: true });
const radar_1 = require("./radar");
const file_1 = require("./file");
(() => __awaiter(void 0, void 0, void 0, function* () {
try {
console.log('start');
const radar = yield radar_1.createRadar();
// console.log(radar);
file_1.save(JSON.stringify(radar), 'rd.json');
file_1.save(`import React from 'react';
import ReactDOM from 'react-dom';
import App from 'aoe_technology_radar/src/components/App';
import 'aoe_technology_radar/src/index.scss';
import {Item} from "aoe_technology_radar/src/model";
import radardata from './rd.json';
ReactDOM.render(
<React.StrictMode>
<App items={radardata.items as Item[]} releases={radardata.releases as string[]} />
</React.StrictMode>,
document.getElementById('root')
);
`, 'index.tsx');
// getPageNames(radar).map(pageName => {
// // const pageHtml = renderPage(radar, pageName);
// // save(pageHtml, `${pageName}.html`);
// save([pageName, radar], `${pageName}.html`)
// });
console.log('Built radar');
}
catch (e) {
console.error('error:', e);
}
}))();