1
0
mirror of https://github.com/simple-icons/simple-icons.git synced 2024-12-16 01:10:30 +02:00
simple-icons/scripts/release/reformat-markdown.js

48 lines
1.4 KiB
JavaScript
Raw Normal View History

2024-03-24 19:38:18 +02:00
#!/usr/bin/env node
/**
2024-06-06 14:40:35 +02:00
* @file
* Rewrite some Markdown files.
*/
2024-03-24 19:38:18 +02:00
import {readFile, writeFile} from 'node:fs/promises';
import path from 'node:path';
2024-03-24 19:38:18 +02:00
import process from 'node:process';
import {getDirnameFromImportMeta} from '../../sdk.mjs';
const LINKS_BRANCH = process.argv[2] || 'develop';
const __dirname = getDirnameFromImportMeta(import.meta.url);
2024-03-24 19:38:18 +02:00
const rootDirectory = path.resolve(__dirname, '..', '..');
const readmeFile = path.resolve(rootDirectory, 'README.md');
const disclaimerFile = path.resolve(rootDirectory, 'DISCLAIMER.md');
2024-06-06 14:40:35 +02:00
/**
* Reformat a file.
* @param {string} filePath Path to the file.
2024-06-06 14:40:35 +02:00
*/
const reformat = async (filePath) => {
const fileContent = await readFile(filePath, 'utf8');
await writeFile(
filePath,
fileContent
// Replace all CDN links with raw links
2024-03-24 19:38:18 +02:00
.replaceAll(
/https:\/\/cdn.simpleicons.org\/(.+)\/000\/fff/g,
`https://raw.githubusercontent.com/simple-icons/simple-icons/${LINKS_BRANCH}/icons/$1.svg`,
)
// Replace all GitHub blockquotes with regular markdown
// Reference: https://github.com/orgs/community/discussions/16925
2024-03-24 19:38:18 +02:00
.replaceAll(
/\[!(NOTE|TIP|IMPORTANT|WARNING|CAUTION)](?!\()/g,
function (string_, $0) {
const capital = $0.slice(0, 1);
const body = $0.slice(1).toLowerCase();
return `**${capital + body}**`;
},
),
);
};
await Promise.all([reformat(readmeFile), reformat(disclaimerFile)]);