feat: add configurable quadrant names

data/ios/2021-06.csv

@@ -4,6 +4,20 @@ QIWI iOS Tech Radar
 date
 21-06-2021
 ===
+quadrant,alias
+q1,languages-and-frameworks
+q1,Language
+q2,Platforms
+q3,tools
+q4,tech
+q4,techniques
+===
+quadrant,title
+q1,Languages and frameworks
+q2,Platforms
+q3,Tools
+q4,Techniques
+===
 name,quadrant,ring,description
 Дизайн-система,tech,adopt,
 Модульная архитектура,tech,adopt,
@@ -78,7 +92,3 @@ SwipeCellKit,Language,HOLD,"Swipeable UITableViewCell/UICollectionViewCell based
 TTTAttributedLabel,Language,HOLD,"A drop-in replacement for UILabel that supports attributes, data detectors, links, and more"
 Typhoon,Language,HOLD,Dependency Injection framework
 YapDatabase,Language,HOLD,A collection/key/value store.
-===
-quadrant,alias
-languages-and-frameworks,Language
-Techniques,tech

data/js/2021-06.csv

@@ -4,6 +4,18 @@ QIWI JS Tech Radar
 date
 21-06-2021
 ===
+quadrant,alias
+q1,languages-and-frameworks
+q2,Platforms
+q3,tools
+q4,techniques
+===
+quadrant,title
+q1,Languages and frameworks
+q2,Platforms
+q3,Tools
+q4,Techniques
+===
 name,quadrant,ring,description
 TypeScript,languages-and-frameworks,Adopt,Статически типизированный ЖС
 JavaScript,languages-and-frameworks,Adopt,ЖС

package.json

@@ -10,7 +10,7 @@
  "lint:fix": "yarn lint --fix",
  "format": "prettier --write \"src/**/*.js\"",
  "release": "npx -p @qiwi/semrel-toolkit semrel -e @qiwi/semrel-config",
- "generate": "node ./src/main/js/cli.mjs --input \"data/**/*.{csv,json,yml}\" --output dist && touch dist/.nojekyll"
+ "generate": "node ./src/main/js/cli.mjs --input \"data/**/*.{csv,json,yml}\" --output dist --base-prefix tech-radar && touch dist/.nojekyll"
  },
  "prettier": "prettier-config-qiwi",
  "exports": {

src/main/js/11ty/.eleventy.cjs

@@ -4,9 +4,7 @@ const htmlmin = require('html-minifier')
 const terser = require('terser')
 
 module.exports = (config) => {
- // const pathPrefix = process.env.PATHPREFIX
- const {temp, output, title, pathPrefix} = global._11ty_
-
+ const {temp, output, title, pathPrefix } = global._11ty_
  const assetsPath = temp + '/assets'
  config.addPassthroughCopy({
  [assetsPath]: '/',

src/main/js/constants.js

@@ -36,3 +36,20 @@ export const radarSchema = {
  },
  },
 }
+export const settings = {
+ svg_id: 'radar',
+ width: 1450,
+ height: 1100,
+ colors: {
+ background: '#fff',
+ grid: '#bbb',
+ inactive: '#ddd',
+ },
+ rings: [
+ { name: 'ADOPT', color: '#93c47d', id: 'adopt' },
+ { name: 'TRIAL', color: '#93d2c2', id: 'trial' },
+ { name: 'ASSESS', color: '#fbdb84', id: 'assess' },
+ { name: 'HOLD', color: '#efafa9', id: 'hold' },
+ ],
+ print_layout: true,
+}

src/main/js/generateMdAssets.js

@@ -3,6 +3,7 @@ import fsExtra from 'fs-extra'
 import path from 'path'
 
 import { tplDir } from './constants.js'
+import { getQuadrant } from './util.js'
 
 /**
  * generate path to .md file
@@ -38,22 +39,15 @@ ${description}`
  */
 export const genMdAssets = (doc, temp) => {
  fsExtra.copySync(tplDir, temp)
-
  doc.data.forEach(({ name, quadrant, ring, description, moved }) => {
  try {
  const quadrantAlias = getQuadrant(quadrant, doc)
  const entryPath = genMdPath({ name, quadrant: quadrantAlias, temp })
  const content = genMdContent({ ring, description, moved })
+
  fs.writeFileSync(entryPath, content)
  } catch (err) {
  console.error('genMdAssets', err)
  }
  })
 }
-
-export const getQuadrant = (quadrant, doc) => {
- if (!('quadrantAliases' in doc)) return quadrant.toLowerCase()
- return doc.quadrantAliases[quadrant.toLowerCase()]
- ? doc.quadrantAliases[quadrant.toLowerCase()]
- : quadrant.toLowerCase()
-}

src/main/js/generateStatic.js

@@ -4,6 +4,7 @@ import path from 'path'
 
 import { radarSchema, tempDir } from './constants.js'
 import { genMdAssets } from './generateMdAssets.js'
+import { writeSettings } from './util.js'
 import { validate } from './validator.js'
 
 /**
@@ -25,15 +26,17 @@ export const genStatics = async (
 
  const temp = tempDir
  const output = dirs[i] ? path.join(_output, dirs[i]) : _output
+ const pathPrefix = basePrefix ? basePrefix + '/' + dirs[i] : undefined
 
  global._11ty_ = {
  title: doc.meta.title,
  output,
  temp,
- pathPrefix: basePrefix + '/' + dirs[i],
+ pathPrefix,
  }
  try {
  genMdAssets(doc, temp)
+ writeSettings(doc, temp)
  await genEleventy(temp, output)
  } catch (err) {
  console.error('genStatics', err)

src/main/js/reader.js

@@ -45,6 +45,7 @@ export const csvReader = (csvPath) => {
  meta: {},
  data: [],
  quadrantAliases: {},
+ quadrantTitles: {},
  }
  radarContents.split('===').forEach((radarChunks) => {
  const records = parse(radarChunks, {
@@ -60,11 +61,15 @@ export const csvReader = (csvPath) => {
  radarDocument.quadrantAliases[record.alias.toLowerCase()] =
  record.quadrant.toLowerCase()
  })
+ } else if (header.includes('title') && header.includes('quadrant')) {
+ records.forEach((record) => {
+ radarDocument.quadrantTitles[record.quadrant.toLowerCase()] =
+ record.title
+ })
  } else {
  Object.assign(radarDocument.meta, records[0])
  }
  })
- // console.log('csvPath:', csvPath, radarDocument)
  return radarDocument
 }
 /**

src/main/js/util.js

@@ -1,8 +1,11 @@
 // import findCacheDir from 'find-cache-dir'
 import crypto from 'crypto'
+import fs from 'fs'
 import { ensureDirSync } from 'fs-extra'
 import path from 'path'
 
+import { settings } from './constants.js'
+
 export const reverse = (arr) => {
  const _arr = [...arr]
  _arr.reverse()
@@ -43,3 +46,22 @@ export const getTemp = (cwd, temp) => {
  const tempDir = id
  return ensureDir(tempDir)
 }
+export const getQuadrant = (quadrant, doc) => {
+ const lowQuadrant = quadrant.toLowerCase()
+ return doc.quadrantAliases[lowQuadrant] || lowQuadrant
+}
+
+export const writeSettings = (doc, output) => {
+ const quadrants = []
+
+ quadrants.push({ name: doc.quadrantTitles.q1 || 'Q1', id: 'q1' })
+ quadrants.push({ name: doc.quadrantTitles.q2 || 'Q2', id: 'q2' })
+ quadrants.push({ name: doc.quadrantTitles.q3 || 'Q3', id: 'q3' })
+ quadrants.push({ name: doc.quadrantTitles.q4 || 'Q4', id: 'q4' })
+
+ const settins = {}
+ Object.assign(settins, settings)
+ settins.quadrants = quadrants
+ const settingsPath = path.join(output, '_data/settins.json')
+ fs.writeFileSync(settingsPath, JSON.stringify(settins))
+}

src/test/js/__snapshots__/generateStatic.js.snap

@@ -2,10 +2,10 @@
 
 exports[`generate 11ty app from .csv file 1`] = `
 Array [
- "/test/entries/languages-and-frameworks/TypeScript/index.html",
- "/test/entries/platforms/Nodejs/index.html",
- "/test/entries/techniques/Гексагональная архитектура/index.html",
- "/test/entries/tools/codeclimate/index.html",
+ "/test/entries/q1/TypeScript/index.html",
+ "/test/entries/q2/Nodejs/index.html",
+ "/test/entries/q3/codeclimate/index.html",
+ "/test/entries/q4/Гексагональная архитектура/index.html",
  "/test/favicon.ico",
  "/test/index.html",
  "/test/radar.css",
@@ -15,10 +15,10 @@ Array [
 
 exports[`generate 11ty app from .json file 1`] = `
 Array [
- "/test/entries/languages-and-frameworks/TypeScript/index.html",
- "/test/entries/platforms/Nodejs/index.html",
- "/test/entries/techniques/Гексагональная архитектура/index.html",
- "/test/entries/tools/codeclimate/index.html",
+ "/test/entries/q1/TypeScript/index.html",
+ "/test/entries/q2/Nodejs/index.html",
+ "/test/entries/q3/codeclimate/index.html",
+ "/test/entries/q4/Гексагональная архитектура/index.html",
  "/test/favicon.ico",
  "/test/index.html",
  "/test/radar.css",
@@ -28,10 +28,10 @@ Array [
 
 exports[`generate 11ty app from .yml file 1`] = `
 Array [
- "/test/entries/languages-and-frameworks/TypeScript/index.html",
- "/test/entries/platforms/Nodejs/index.html",
- "/test/entries/techniques/Гексагональная архитектура/index.html",
- "/test/entries/tools/codeclimate/index.html",
+ "/test/entries/q1/TypeScript/index.html",
+ "/test/entries/q2/Nodejs/index.html",
+ "/test/entries/q3/codeclimate/index.html",
+ "/test/entries/q4/Гексагональная архитектура/index.html",
  "/test/favicon.ico",
  "/test/index.html",
  "/test/radar.css",
@@ -41,26 +41,26 @@ Array [
 
 exports[`generate 11ty app from multiple files 1`] = `
 Array [
- "/test/entries/languages-and-frameworks/TypeScript/index.html",
- "/test/entries/platforms/Nodejs/index.html",
- "/test/entries/techniques/Гексагональная архитектура/index.html",
- "/test/entries/tools/codeclimate/index.html",
+ "/test/entries/q1/TypeScript/index.html",
+ "/test/entries/q2/Nodejs/index.html",
+ "/test/entries/q3/codeclimate/index.html",
+ "/test/entries/q4/Гексагональная архитектура/index.html",
  "/test/favicon.ico",
  "/test/index.html",
  "/test/radar.css",
  "/test/radar.js",
- "/test-2/entries/languages-and-frameworks/TypeScript/index.html",
- "/test-2/entries/platforms/Nodejs/index.html",
- "/test-2/entries/techniques/Гексагональная архитектура/index.html",
- "/test-2/entries/tools/codeclimate/index.html",
+ "/test-2/entries/q1/TypeScript/index.html",
+ "/test-2/entries/q2/Nodejs/index.html",
+ "/test-2/entries/q3/codeclimate/index.html",
+ "/test-2/entries/q4/Гексагональная архитектура/index.html",
  "/test-2/favicon.ico",
  "/test-2/index.html",
  "/test-2/radar.css",
  "/test-2/radar.js",
- "/test-3/entries/languages-and-frameworks/TypeScript/index.html",
- "/test-3/entries/platforms/Nodejs/index.html",
- "/test-3/entries/techniques/Гексагональная архитектура/index.html",
- "/test-3/entries/tools/codeclimate/index.html",
+ "/test-3/entries/q1/TypeScript/index.html",
+ "/test-3/entries/q2/Nodejs/index.html",
+ "/test-3/entries/q3/codeclimate/index.html",
+ "/test-3/entries/q4/Гексагональная архитектура/index.html",
  "/test-3/favicon.ico",
  "/test-3/index.html",
  "/test-3/radar.css",

src/test/js/__snapshots__/reader.js.snap

@@ -38,7 +38,17 @@ Object {
  "title": "work it",
  },
  "quadrantAliases": Object {
- "language": "languages-and-frameworks",
+ "language": "q1",
+ "languages-and-frameworks": "q1",
+ "platforms": "q2",
+ "techniques": "q4",
+ "tools": "q3",
+ },
+ "quadrantTitles": Object {
+ "q1": "Languages and frameworks",
+ "q2": "Platforms",
+ "q3": "Tools",
+ "q4": "Techniques",
  },
 }
 `;
@@ -80,6 +90,18 @@ Object {
  "legend": "bla bla bla",
  "title": "tech radar js",
  },
+ "quadrantAliases": Object {
+ "languages-and-frameworks": "q1",
+ "platforms": "q2",
+ "techniques": "q4",
+ "tools": "q3",
+ },
+ "quadrantTitles": Object {
+ "q1": "Languages and frameworks",
+ "q2": "Platforms",
+ "q3": "Tools",
+ "q4": "Techniques",
+ },
 }
 `;
 
@@ -121,7 +143,17 @@ Object {
  "title": "work it",
  },
  "quadrantAliases": Object {
- "language": "languages-and-frameworks",
+ "language": "q1",
+ "languages-and-frameworks": "q1",
+ "platforms": "q2",
+ "techniques": "q4",
+ "tools": "q3",
+ },
+ "quadrantTitles": Object {
+ "q1": "Languages and frameworks",
+ "q2": "Platforms",
+ "q3": "Tools",
+ "q4": "Techniques",
  },
 }
 `;
@@ -163,5 +195,17 @@ Object {
  "legend": "bla bla bla",
  "title": "tech radar js",
  },
+ "quadrantAliases": Object {
+ "languages-and-frameworks": "q1",
+ "platforms": "q2",
+ "techniques": "q4",
+ "tools": "q3",
+ },
+ "quadrantTitles": Object {
+ "q1": "Languages and frameworks",
+ "q2": "Platforms",
+ "q3": "Tools",
+ "q4": "Techniques",
+ },
 }
 `;