feat: add test

README.md

@@ -6,17 +6,15 @@ Tech radar generator
 
 ```
 yarn add @qiwi/tech-radar
-techradar --csv-path /path/to/csv --out-dir /radar --versions 1.00 --pathPrefix js
+techradar --input /path/to/csv --out-dir /radar
 ```
 or
 ```
-npx @qiwi/tech-radar --csvPath /path/to/csv --outDir /radar --versions 1.00 --pathPrefix js
+npx @qiwi/tech-radar --input /path/to/csv --outDir /radar
 ```
 
 | Args | description |
 |---|---
-| csvPath | path to csv file
+| csvPath | path to csv/json/yml file
 | outDir |
-| versions |
-| pathPrefix |
 

package.json

@@ -39,6 +39,7 @@
  "csv-parse": "^4.12.0",
  "fs-extra": "^10.0.0",
  "html-minifier": "^4.0.0",
+ "js-yaml": "^4.1.0",
  "meow": "^10.0.1"
  }
 }

src/main/js/cli.mjs

@@ -6,30 +6,22 @@ import {generateTechRadar} from './index.js'
 export const cli = meow(
  `
  Usage:
- techradar --csvPath /path/to/csv --outDir /radar --versions 1.00 pathPrefix js
+ techradar --input /path/to/csv --outDir /radar
  Options
- --csvPath
+ --input
  --outDir
- --version
- --pathPrefix
 `,
  {
  importMeta: import.meta,
  flags: {
- csvPath: {
+ input: {
  type: 'string',
  isRequired: true,
  },
  outDir: {
  type: 'string',
  isRequired: true,
  },
- version: {
- type: 'string',
- },
- pathPrefix: {
- type: 'string',
- },
  },
  },
 )

src/main/js/e11y/.eleventy.cjs

@@ -11,7 +11,7 @@ module.exports = (config) => {
  [assetsPath]: '/',
  })
 
- config.addShortcode('makeBootScript', (title, settings, collections) => {
+ config.addShortcode('makeBootScript', (settings, collections) => {
  const entries = collections
  .map((entity) => ({
  quadrant: entity.data.quadrant,
@@ -27,7 +27,7 @@ module.exports = (config) => {
 
  const radarSettings = {
  ...settings,
- title,
+ title: global.title,
  entries,
  }
 

src/main/js/generateMdAssets.js

@@ -1,8 +1,9 @@
-import parse from 'csv-parse/lib/sync.js'
 import fs from 'fs'
 import fsExtra from 'fs-extra'
 import path from 'path'
 
+import { reader } from './reader.js'
+
 const tplPath = path.resolve('src/main/tpl')
 
 export const langAndFw = 'languages-and-frameworks'
@@ -55,23 +56,19 @@ moved: ${moved || '0'}
 ${description}`
 }
 
-export const generateMdAssets = ({ csvPath, tempDir }) => {
+export const generateMdAssets = (filePath, tempDir) => {
  const tempDirResolved = path.resolve(tempDir)
- const csvPathResolved = path.resolve(csvPath)
  fsExtra.copySync(tplPath, tempDirResolved)
- const radarData = fs.readFileSync(csvPathResolved)
- try {
- const records = parse(radarData, { columns: true })
- records.forEach(({ name, quadrant, ring, description, moved }) => {
- try {
- const entryFilePath = generatePath({ name, quadrant, tempDirResolved })
- const content = generateMd({ ring, description, moved })
- fs.writeFileSync(entryFilePath, content)
- } catch (err) {
- console.error(err)
- }
- })
- } catch (err) {
- console.error(err)
- }
+ const radarDocument = reader(filePath)
+ radarDocument.data.forEach(({ name, quadrant, ring, description, moved }) => {
+ try {
+ const entryFilePath = generatePath({ name, quadrant, tempDirResolved })
+ const content = generateMd({ ring, description, moved })
+ fs.writeFileSync(entryFilePath, content)
+ } catch (err) {
+ console.error(err)
+ }
+ })
+ global.title = radarDocument.meta.title
+ global.legend = radarDocument.meta.legend
 }

src/main/js/index.js

@@ -4,11 +4,11 @@ import path from 'path'
 
 import { generateMdAssets } from './generateMdAssets.js'
 
-export const generateTechRadar = async ({ csvPath, outDir }) => {
+export const generateTechRadar = async ({ input, outDir }) => {
  global.outDir = outDir
  const tempDir = 'temp'
  global.tempDir = tempDir
- generateMdAssets({ csvPath, tempDir })
+ generateMdAssets(input, tempDir)
  await generateStatics(tempDir, outDir)
 }
 

src/main/js/reader.js

@@ -0,0 +1,58 @@
+import parse from 'csv-parse/lib/sync.js'
+import fs from 'fs'
+import yaml from 'js-yaml'
+import path from 'path'
+
+export const reader = (filePath) => {
+ if (filePath.includes('.csv', filePath.length - 4)) {
+ return csvReader(filePath)
+ }
+ if (filePath.includes('.json', filePath.length - 5)) {
+ return jsonReader(filePath)
+ }
+ if (filePath.includes('.yml', filePath.length - 5)) {
+ return yamlReader(filePath)
+ }
+}
+
+export const csvReader = (csvPath) => {
+ const csvPathResolved = path.resolve(csvPath)
+ const radarContents = fs.readFileSync(csvPathResolved, 'utf8')
+ const radarDocument = {
+ meta: {},
+ data: [],
+ }
+ radarContents.split('===').forEach((radarChunks) => {
+ const records = parse(radarChunks, {
+ columns: true,
+ skip_empty_lines: true,
+ })
+ const keys = Object.keys(records[0]).toString()
+
+ if (keys === 'name,quadrant,ring,description,moved') {
+ radarDocument.data = [...radarDocument.data, ...records]
+ }
+ if (keys === 'title') {
+ radarDocument.meta.title = records[0].title
+ }
+ if (keys === 'date') {
+ radarDocument.meta.date = records[0].date
+ }
+ if (keys === 'legend') {
+ radarDocument.meta.legend = records[0].legend
+ }
+ })
+ return radarDocument
+}
+
+export const jsonReader = (jsonPath) => {
+ const jsonPathResolved = path.resolve(jsonPath)
+ const fileData = fs.readFileSync(jsonPathResolved, 'utf8')
+ return JSON.parse(fileData)
+}
+
+export const yamlReader = (yamlPath) => {
+ const jsonPathResolved = path.resolve(yamlPath)
+ const yamlData = fs.readFileSync(jsonPathResolved, 'utf8')
+ return yaml.load(yamlData, 'utf8')
+}

src/main/tpl/index.njk

@@ -1,10 +1,9 @@
 ---
-title: QIWI JavaScript Tech Radar — 2021.06
 layout: page.njk
 ---
 
 {% set bootScript %}
- {% makeBootScript title, settins, collections.entries %}
+ {% makeBootScript settins, collections.entries %}
 {% endset %}
 
 <svg id="radar"></svg>

src/test/js/__snapshots__/index.js.snap

@@ -37,3 +37,163 @@ moved: 1
 Статически типизированный ЖС",
 }
 `;
+
+exports[`reader.js csvReader 1`] = `
+Object {
+ "data": Array [
+ Object {
+ "description": "Статически типизированный ЖС",
+ "moved": "1",
+ "name": "TypeScript",
+ "quadrant": "language",
+ "ring": "Adopt",
+ },
+ Object {
+ "description": "",
+ "moved": "",
+ "name": "Nodejs",
+ "quadrant": "Platforms",
+ "ring": "Adopt",
+ },
+ Object {
+ "description": "Статический анализатор кода",
+ "moved": "0",
+ "name": "codeclimate",
+ "quadrant": "tools",
+ "ring": "Trial",
+ },
+ Object {
+ "description": "Унификации контракта интерфейсов различных слоев приложений",
+ "moved": "-1",
+ "name": "Гексагональная архитектура",
+ "quadrant": "Techniques",
+ "ring": "Assess",
+ },
+ ],
+ "meta": Object {
+ "date": "2021-06-18",
+ "legend": "bla bla bla",
+ "title": "work it",
+ },
+}
+`;
+
+exports[`reader.js jsonReader 1`] = `
+Object {
+ "data": Array [
+ Object {
+ "description": "Статически типизированный ЖС",
+ "moved": "1",
+ "name": "TypeScript",
+ "quadrant": "language",
+ "ring": "Adopt",
+ },
+ Object {
+ "description": "",
+ "moved": "",
+ "name": "Nodejs",
+ "quadrant": "Platforms",
+ "ring": "Adopt",
+ },
+ Object {
+ "description": "Статический анализатор кода",
+ "moved": "0",
+ "name": "codeclimate",
+ "quadrant": "tools",
+ "ring": "Trial",
+ },
+ Object {
+ "description": "Унификации контракта интерфейсов различных слоев приложений",
+ "moved": "-1",
+ "name": "Гексагональная архитектура",
+ "quadrant": "Techniques",
+ "ring": "Assess",
+ },
+ ],
+ "meta": Object {
+ "date": "2021-06-12",
+ "legend": "bla bla bla",
+ "title": "tech radar js",
+ },
+}
+`;
+
+exports[`reader.js reader 1`] = `
+Object {
+ "data": Array [
+ Object {
+ "description": "Статически типизированный ЖС",
+ "moved": "1",
+ "name": "TypeScript",
+ "quadrant": "language",
+ "ring": "Adopt",
+ },
+ Object {
+ "description": "",
+ "moved": "",
+ "name": "Nodejs",
+ "quadrant": "Platforms",
+ "ring": "Adopt",
+ },
+ Object {
+ "description": "Статический анализатор кода",
+ "moved": "0",
+ "name": "codeclimate",
+ "quadrant": "tools",
+ "ring": "Trial",
+ },
+ Object {
+ "description": "Унификации контракта интерфейсов различных слоев приложений",
+ "moved": "-1",
+ "name": "Гексагональная архитектура",
+ "quadrant": "Techniques",
+ "ring": "Assess",
+ },
+ ],
+ "meta": Object {
+ "date": "2021-06-18",
+ "legend": "bla bla bla",
+ "title": "work it",
+ },
+}
+`;
+
+exports[`reader.js yamlReader 1`] = `
+Object {
+ "data": Array [
+ Object {
+ "description": "Статически типизированный ЖС",
+ "moved": 1,
+ "name": "TypeScript",
+ "quadrant": "language",
+ "ring": "Adopt",
+ },
+ Object {
+ "description": null,
+ "moved": null,
+ "name": "Nodejs",
+ "quadrant": "Platforms",
+ "ring": "Adopt",
+ },
+ Object {
+ "description": "Статический анализатор кода",
+ "moved": 0,
+ "name": "codeclimate",
+ "quadrant": "tools",
+ "ring": "Trial",
+ },
+ Object {
+ "description": "Унификации контракта интерфейсов различных слоев приложений",
+ "moved": -1,
+ "name": "Гексагональная архитектура",
+ "quadrant": "Techniques",
+ "ring": "Assess",
+ },
+ ],
+ "meta": Object {
+ "date": 2021-06-12T00:00:00.000Z,
+ "legend": "bla bla bla",
+ "title": "tech radar js",
+ },
+}
+`;