6be07af824
* Fix 3rd party extensions order and add test to avoid regression * Prevent possible error in test * Apply suggestions from code review * Apply suggestion * Remove uneeded import
147 lines
3.9 KiB
JavaScript
147 lines
3.9 KiB
JavaScript
/**
|
||
* @fileoverview
|
||
* Some common utilities for scripts.
|
||
*/
|
||
|
||
import path from 'node:path';
|
||
import { promises as fs } from 'node:fs';
|
||
import { fileURLToPath } from 'node:url';
|
||
|
||
const TITLE_TO_SLUG_REPLACEMENTS = {
|
||
'+': 'plus',
|
||
'.': 'dot',
|
||
'&': 'and',
|
||
đ: 'd',
|
||
ħ: 'h',
|
||
ı: 'i',
|
||
ĸ: 'k',
|
||
ŀ: 'l',
|
||
ł: 'l',
|
||
ß: 'ss',
|
||
ŧ: 't',
|
||
};
|
||
|
||
const TITLE_TO_SLUG_CHARS_REGEX = RegExp(
|
||
`[${Object.keys(TITLE_TO_SLUG_REPLACEMENTS).join('')}]`,
|
||
'g',
|
||
);
|
||
|
||
const TITLE_TO_SLUG_RANGE_REGEX = /[^a-z0-9]/g;
|
||
|
||
/**
|
||
* Get the slug/filename for an icon.
|
||
* @param {Object} icon The icon data as it appears in _data/simple-icons.json
|
||
*/
|
||
export const getIconSlug = (icon) => icon.slug || titleToSlug(icon.title);
|
||
|
||
/**
|
||
* Extract the path from an icon SVG content.
|
||
* @param {Object} svg The icon SVG content
|
||
**/
|
||
export const svgToPath = (svg) => svg.match(/<path\s+d="([^"]*)/)[1];
|
||
|
||
/**
|
||
* Converts a brand title into a slug/filename.
|
||
* @param {String} title The title to convert
|
||
*/
|
||
export const titleToSlug = (title) =>
|
||
title
|
||
.toLowerCase()
|
||
.replace(
|
||
TITLE_TO_SLUG_CHARS_REGEX,
|
||
(char) => TITLE_TO_SLUG_REPLACEMENTS[char],
|
||
)
|
||
.normalize('NFD')
|
||
.replace(TITLE_TO_SLUG_RANGE_REGEX, '');
|
||
|
||
/**
|
||
* Converts a slug into a variable name that can be exported.
|
||
* @param {String} slug The slug to convert
|
||
*/
|
||
export const slugToVariableName = (slug) => {
|
||
const slugFirstLetter = slug[0].toUpperCase();
|
||
const slugRest = slug.slice(1);
|
||
return `si${slugFirstLetter}${slugRest}`;
|
||
};
|
||
|
||
/**
|
||
* Converts a brand title (as it is seen in simple-icons.json) into a brand
|
||
* title in HTML/SVG friendly format.
|
||
* @param {String} brandTitle The title to convert
|
||
*/
|
||
export const titleToHtmlFriendly = (brandTitle) =>
|
||
brandTitle
|
||
.replace(/&/g, '&')
|
||
.replace(/"/g, '"')
|
||
.replace(/</g, '<')
|
||
.replace(/>/g, '>')
|
||
.replace(/./g, (char) => {
|
||
const charCode = char.charCodeAt(0);
|
||
return charCode > 127 ? `&#${charCode};` : char;
|
||
});
|
||
|
||
/**
|
||
* Converts a brand title in HTML/SVG friendly format into a brand title (as
|
||
* it is seen in simple-icons.json)
|
||
* @param {String} htmlFriendlyTitle The title to convert
|
||
*/
|
||
export const htmlFriendlyToTitle = (htmlFriendlyTitle) =>
|
||
htmlFriendlyTitle
|
||
.replace(/&#([0-9]+);/g, (_, num) => String.fromCharCode(parseInt(num)))
|
||
.replace(
|
||
/&(quot|amp|lt|gt);/g,
|
||
(_, ref) => ({ quot: '"', amp: '&', lt: '<', gt: '>' }[ref]),
|
||
);
|
||
|
||
/**
|
||
* Get contents of _data/simple-icons.json.
|
||
*/
|
||
export const getIconsDataString = () => {
|
||
const __dirname = getDirnameFromImportMeta(import.meta.url);
|
||
const rootDir = path.resolve(__dirname, '..');
|
||
const iconDataPath = path.resolve(rootDir, '_data', 'simple-icons.json');
|
||
return fs.readFile(iconDataPath, 'utf8');
|
||
};
|
||
|
||
/**
|
||
* Get icon data as object from _data/simple-icons.json.
|
||
*/
|
||
export const getIconsData = async () => {
|
||
const fileContents = await getIconsDataString();
|
||
return JSON.parse(fileContents).icons;
|
||
};
|
||
|
||
/**
|
||
* Get the directory name from import.meta.url.
|
||
* @param {String} importMetaUrl import.meta.url
|
||
*/
|
||
export const getDirnameFromImportMeta = (importMetaUrl) =>
|
||
path.dirname(fileURLToPath(importMetaUrl));
|
||
|
||
/**
|
||
* Get information about third party extensions.
|
||
*/
|
||
export const getThirdPartyExtensions = async () => {
|
||
const __dirname = getDirnameFromImportMeta(import.meta.url);
|
||
const readmePath = path.resolve(__dirname, '..', 'README.md');
|
||
const readmeContent = await fs.readFile(readmePath, 'utf8');
|
||
return readmeContent
|
||
.split('## Third-Party Extensions\n\n')[1]
|
||
.split('\n\n')[0]
|
||
.split('\n')
|
||
.slice(2)
|
||
.map((line) => {
|
||
const [module, author] = line.split(' | ');
|
||
return {
|
||
module: {
|
||
name: /\[(.+)\]/.exec(module)[1],
|
||
url: /\((.+)\)/.exec(module)[1],
|
||
},
|
||
author: {
|
||
name: /\[(.+)\]/.exec(author)[1],
|
||
url: /\((.+)\)/.exec(author)[1],
|
||
},
|
||
};
|
||
});
|
||
};
|