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

fix: Sort out Ring enum typing issues

Browse Source
This commit is contained in:
Jarosław Marek
2021-05-04 20:24:20 +12:00
parent 622da055c7
commit 15feb9bc58
14 changed files with 138 additions and 75 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
tasks/radar.ts
View File

@@ -7,7 +7,9 @@ import { quadrantsMap } from '../src/config';
import { radarPath, getAllMarkdownFiles } from './file';
import { Item, Revision, ItemAttributes, Radar, FlagType, Ring } from '../src/model';
type FMAttributes = ItemAttributes
type FMAttributes = Omit<ItemAttributes, 'ring'> & {
ring: string // when reading from file it will be a String form, not numeric representation of the enum
}
marked.setOptions({
highlight: code => hljs.highlightAuto(code).value,
@@ -27,14 +29,19 @@ export const createRadar = async (): Promise<Radar> => {
};
const checkAttributes = (fileName: string, attributes: FMAttributes) => {
const validQuadrants = Object.keys(quadrantsMap);
if (attributes.ring && !Ring[attributes.ring]) {
throw new Error(`Error: ${fileName} has an illegal value for 'ring' - must be one of ${Object.values(Ring)}`);
const validRings = [];
for (var ring in Ring) {
if (isNaN(Number(ring))) {
validRings.push(ring);
}
}
if (attributes.quadrant && !validQuadrants.includes(attributes.quadrant)) {
throw new Error(`Error: ${fileName} has an illegal value for 'quadrant' - must be one of ${validQuadrants}`);
if (attributes.ring && !validRings.includes(attributes.ring)) {
throw new Error(`Error: ${fileName} has an illegal value for 'ring' - must be one of ${validRings}`);
}
if (attributes.quadrant && !quadrantsMap.has(attributes.quadrant)) {
throw new Error(`Error: ${fileName} has an illegal value for 'quadrant' - must be one of ${quadrantsMap.keys()}`);
}
if (!attributes.quadrant || attributes.quadrant === '') {
@@ -45,7 +52,11 @@ const checkAttributes = (fileName: string, attributes: FMAttributes) => {
attributes.title = path.basename(fileName);
}
return attributes
return {
...attributes,
// Convert string representation of the ring into enum value
ring: Ring[attributes.ring as keyof typeof Ring]
}
};
const createRevisionsFromFiles = (fileNames: string[]) =>