|
| 1 | +import { readFileSync, writeFileSync } from 'fs'; |
| 2 | +import { resolve } from 'path'; |
| 3 | + |
| 4 | +import { format, resolveConfig } from 'prettier'; |
| 5 | + |
| 6 | +import { |
| 7 | + SUPPORTED_TESTING_FRAMEWORKS, |
| 8 | + SupportedTestingFramework, |
| 9 | +} from '../../lib/utils'; |
| 10 | + |
| 11 | +const prettierConfig = resolveConfig.sync(__dirname); |
| 12 | +const readmePath = resolve(__dirname, `../../README.md`); |
| 13 | + |
| 14 | +export type RulesList = string[][]; |
| 15 | + |
| 16 | +export const configBadges = SUPPORTED_TESTING_FRAMEWORKS.reduce( |
| 17 | + (badges, framework) => ({ |
| 18 | + ...badges, |
| 19 | + [framework]: `![${framework}-badge][]`, |
| 20 | + }), |
| 21 | + {} |
| 22 | +) as Record<SupportedTestingFramework, string>; |
| 23 | +export const emojiKey = { |
| 24 | + fixable: '🔧', |
| 25 | +} as const; |
| 26 | +const staticElements = { |
| 27 | + listHeaderRow: [ |
| 28 | + 'Name', |
| 29 | + 'Description', |
| 30 | + emojiKey.fixable, |
| 31 | + 'Included in configurations', |
| 32 | + ], |
| 33 | + listSpacerRow: Array(4).fill('-'), |
| 34 | + rulesListKey: [ |
| 35 | + `**Key**: ${emojiKey.fixable} = fixable`, |
| 36 | + '', |
| 37 | + [ |
| 38 | + `**Configurations**:`, |
| 39 | + Object.entries(configBadges) |
| 40 | + .map(([template, badge]) => `${badge} = ${template}`) |
| 41 | + .join(', '), |
| 42 | + ].join(' '), |
| 43 | + ].join('\n'), |
| 44 | +}; |
| 45 | + |
| 46 | +const generateRulesListTable = (rulesList: RulesList) => |
| 47 | + [staticElements.listHeaderRow, staticElements.listSpacerRow, ...rulesList] |
| 48 | + .map((column) => `|${column.join('|')}|`) |
| 49 | + .join('\n'); |
| 50 | + |
| 51 | +const generateRulesListMarkdown = (rulesList: RulesList) => |
| 52 | + [ |
| 53 | + '', |
| 54 | + staticElements.rulesListKey, |
| 55 | + '', |
| 56 | + generateRulesListTable(rulesList), |
| 57 | + '', |
| 58 | + ].join('\n'); |
| 59 | + |
| 60 | +const listBeginMarker = '<!-- RULES-LIST:START -->'; |
| 61 | +const listEndMarker = '<!-- RULES-LIST:END -->'; |
| 62 | +const overWriteRulesList = (rulesList: RulesList, readme: string) => { |
| 63 | + const listStartIndex = readme.indexOf(listBeginMarker); |
| 64 | + const listEndIndex = readme.indexOf(listEndMarker); |
| 65 | + |
| 66 | + if ([listStartIndex, listEndIndex].includes(-1)) { |
| 67 | + throw new Error(`cannot find start or end rules-list`); |
| 68 | + } |
| 69 | + |
| 70 | + return [ |
| 71 | + readme.substring(0, listStartIndex - 1), |
| 72 | + listBeginMarker, |
| 73 | + '', |
| 74 | + generateRulesListMarkdown(rulesList), |
| 75 | + readme.substring(listEndIndex), |
| 76 | + ].join('\n'); |
| 77 | +}; |
| 78 | + |
| 79 | +export const writeRulesList = (rulesList: RulesList): void => { |
| 80 | + const readme = readFileSync(readmePath, 'utf8'); |
| 81 | + const newReadme = format(overWriteRulesList(rulesList, readme), { |
| 82 | + parser: 'markdown', |
| 83 | + ...prettierConfig, |
| 84 | + }); |
| 85 | + |
| 86 | + writeFileSync(readmePath, newReadme); |
| 87 | +}; |
0 commit comments