mirror of
https://github.com/hex248/ob248.com.git
synced 2026-02-08 02:33:02 +00:00
243 lines
7.0 KiB
JavaScript
243 lines
7.0 KiB
JavaScript
// @ts-check
|
||
/**
|
||
* @file
|
||
* Simple Icons SDK.
|
||
*/
|
||
import fs from 'node:fs/promises';
|
||
import path from 'node:path';
|
||
|
||
/**
|
||
* @typedef {import("./sdk.d.ts").ThirdPartyExtension} ThirdPartyExtension
|
||
* @typedef {import("./types.js").IconData} IconData
|
||
*/
|
||
|
||
/** @type {{ [key: string]: string }} */
|
||
const TITLE_TO_SLUG_REPLACEMENTS = {
|
||
'+': 'plus',
|
||
'.': 'dot',
|
||
'&': 'and',
|
||
đ: 'd',
|
||
ħ: 'h',
|
||
ı: 'i',
|
||
ĸ: 'k',
|
||
ŀ: 'l',
|
||
ł: 'l',
|
||
ß: 'ss',
|
||
ŧ: 't',
|
||
ø: 'o',
|
||
};
|
||
|
||
const TITLE_TO_SLUG_CHARS_REGEX = new RegExp(
|
||
`[${Object.keys(TITLE_TO_SLUG_REPLACEMENTS).join('')}]`,
|
||
'g',
|
||
);
|
||
|
||
const TITLE_TO_SLUG_RANGE_REGEX = /[^a-z\d]/g;
|
||
|
||
/**
|
||
* Regex to validate SVG paths.
|
||
*/
|
||
export const SVG_PATH_REGEX = /^m[-mzlhvcsqtae\d,. ]+$/i;
|
||
|
||
/**
|
||
* Get the slug/filename for an icon.
|
||
* @param {IconData} icon The icon data as it appears in *data/simple-icons.json*.
|
||
* @returns {string} The slug/filename for the icon.
|
||
*/
|
||
export const getIconSlug = (icon) => icon.slug || titleToSlug(icon.title);
|
||
|
||
/**
|
||
* Extract the path from an icon SVG content.
|
||
* @param {string} svg The icon SVG content.
|
||
* @returns {string} The path from the icon SVG content.
|
||
*/
|
||
export const svgToPath = (svg) => svg.split('"', 8)[7];
|
||
|
||
/**
|
||
* Converts a brand title into a slug/filename.
|
||
* @param {string} title The title to convert.
|
||
* @returns {string} The slug/filename for the title.
|
||
*/
|
||
export const titleToSlug = (title) =>
|
||
title
|
||
.toLowerCase()
|
||
.replaceAll(
|
||
TITLE_TO_SLUG_CHARS_REGEX,
|
||
(char) => TITLE_TO_SLUG_REPLACEMENTS[char],
|
||
)
|
||
.normalize('NFD')
|
||
.replaceAll(TITLE_TO_SLUG_RANGE_REGEX, '');
|
||
|
||
/**
|
||
* Converts a slug into a variable name that can be exported.
|
||
* @param {string} slug The slug to convert.
|
||
* @returns {string} The variable name for the slug.
|
||
*/
|
||
export const slugToVariableName = (slug) =>
|
||
`si${slug[0].toUpperCase()}${slug.slice(1)}`;
|
||
|
||
/**
|
||
* Converts a brand title as defined in *data/simple-icons.json* into a brand
|
||
* title in HTML/SVG friendly format.
|
||
* @param {string} brandTitle The title to convert.
|
||
* @returns {string} The brand title in HTML/SVG friendly format.
|
||
*/
|
||
export const titleToHtmlFriendly = (brandTitle) =>
|
||
brandTitle
|
||
.replaceAll('&', '&')
|
||
.replaceAll('"', '"')
|
||
.replaceAll('<', '<')
|
||
.replaceAll('>', '>')
|
||
.replaceAll(/./g, (char) => {
|
||
const charCode = char.codePointAt(0) || 0;
|
||
return charCode > 127 ? `&#${charCode};` : char;
|
||
});
|
||
|
||
/**
|
||
* Converts a brand title in HTML/SVG friendly format into a brand title (as
|
||
* it is seen in *data/simple-icons.json*).
|
||
* @param {string} htmlFriendlyTitle The title to convert.
|
||
* @returns {string} The brand title in HTML/SVG friendly format.
|
||
*/
|
||
export const htmlFriendlyToTitle = (htmlFriendlyTitle) =>
|
||
htmlFriendlyTitle
|
||
.replaceAll(/&#(\d+);/g, (_, number_) =>
|
||
String.fromCodePoint(Number.parseInt(number_, 10)),
|
||
)
|
||
.replaceAll(
|
||
/&(quot|amp|lt|gt);/g,
|
||
/**
|
||
* Replace HTML entity references with their respective decoded characters.
|
||
* @param {string} _ Full match.
|
||
* @param {'quot' | 'amp' | 'lt' | 'gt'} reference Reference to replace.
|
||
* @returns {string} Replacement for the reference.
|
||
*/
|
||
(_, reference) => ({quot: '"', amp: '&', lt: '<', gt: '>'})[reference],
|
||
);
|
||
|
||
/**
|
||
* Get path of *data/simple-icons.json*.
|
||
* @returns {string} Path of *data/simple-icons.json*.
|
||
*/
|
||
export const getIconsDataPath = () =>
|
||
path.resolve(import.meta.dirname, 'data', 'simple-icons.json');
|
||
|
||
/**
|
||
* Get contents of *data/simple-icons.json*.
|
||
* @returns {Promise<string>} Content of *data/simple-icons.json*.
|
||
*/
|
||
export const getIconsDataString = () => fs.readFile(getIconsDataPath(), 'utf8');
|
||
|
||
/**
|
||
* Get icons data as object from *data/simple-icons.json*.
|
||
* @returns {Promise<IconData[]>} Icons data as array from *data/simple-icons.json*.
|
||
*/
|
||
export const getIconsData = async () => {
|
||
const fileContents = await getIconsDataString();
|
||
return JSON.parse(fileContents);
|
||
};
|
||
|
||
/**
|
||
* Replace Windows newline characters by Unix ones.
|
||
* @param {string} text The text to replace.
|
||
* @returns {string} The text with Windows newline characters replaced by Unix ones.
|
||
*/
|
||
export const normalizeNewlines = (text) => text.replaceAll('\r\n', '\n');
|
||
|
||
/**
|
||
* Convert non-6-digit hex color to 6-digit with the character `#` stripped.
|
||
* @param {string} text The color text.
|
||
* @returns {string} The color text in 6-digit hex format.
|
||
*/
|
||
export const normalizeColor = (text) => {
|
||
let color = text.replace('#', '').toUpperCase();
|
||
if (color.length < 6) {
|
||
// eslint-disable-next-line unicorn/no-useless-spread
|
||
color = [...color.slice(0, 3)].map((x) => x.repeat(2)).join('');
|
||
} else if (color.length > 6) {
|
||
color = color.slice(0, 6);
|
||
}
|
||
|
||
return color;
|
||
};
|
||
|
||
/**
|
||
* Parse module and author from a line in the third-party extensions/libraries table.
|
||
* @param {string} line The line to parse.
|
||
* @returns {ThirdPartyExtension} The parsed module and author.
|
||
*/
|
||
const parseModuleAuthorFromLine = (line) => {
|
||
const [module_, author] = line.split(' | ');
|
||
const moduleName = />([^<]+)<\/a>$/.exec(module_)?.[1];
|
||
if (moduleName === undefined) {
|
||
throw new Error(`Module name improperly parsed from line: ${line}`);
|
||
}
|
||
|
||
const moduleUrl = /^\s*<a href="(.[^"]+)"/.exec(module_)?.[1];
|
||
if (moduleUrl === undefined) {
|
||
throw new Error(`Module URL improperly parsed from line: ${line}`);
|
||
}
|
||
|
||
const authorName = /\[(.+)]/.exec(author)?.[1];
|
||
if (authorName === undefined) {
|
||
throw new Error(`Author improperly parsed from line: ${line}`);
|
||
}
|
||
|
||
const authorUrl = /\((.+)\)/.exec(author)?.[1];
|
||
if (authorUrl === undefined) {
|
||
throw new Error(`Author URL improperly parsed from line: ${line}`);
|
||
}
|
||
|
||
return {
|
||
module: {
|
||
name: moduleName,
|
||
url: moduleUrl,
|
||
},
|
||
author: {
|
||
name: authorName,
|
||
url: authorUrl,
|
||
},
|
||
};
|
||
};
|
||
|
||
/**
|
||
* Parse extensions from a table header.
|
||
* @param {string} tableHeader Markdown header of the table.
|
||
* @returns {Promise<ThirdPartyExtension[]>} Information about third-party extensions or libraries.
|
||
*/
|
||
const parseExtensionsFromSectionTable = async (tableHeader) => {
|
||
const readme = await fs.readFile(
|
||
path.join(import.meta.dirname, 'README.md'),
|
||
'utf8',
|
||
);
|
||
return normalizeNewlines(readme)
|
||
.split(tableHeader)[1]
|
||
.split('|\n\n')[0]
|
||
.split('|\n|')
|
||
.slice(2)
|
||
.map((line) => parseModuleAuthorFromLine(line));
|
||
};
|
||
|
||
/**
|
||
* Get information about third-party extensions from the README table.
|
||
* @returns {Promise<ThirdPartyExtension[]>} Information about third-party extensions.
|
||
*/
|
||
export const getThirdPartyExtensions = async () =>
|
||
parseExtensionsFromSectionTable('## Third-Party Extensions');
|
||
|
||
/**
|
||
* Get information about third-party libraries from the README table.
|
||
* @returns {Promise<ThirdPartyExtension[]>} Information about third-party libraries.
|
||
*/
|
||
export const getThirdPartyLibraries = async () =>
|
||
parseExtensionsFromSectionTable('## Third-Party Libraries');
|
||
|
||
/**
|
||
* `Intl.Collator` object ready to be used for icon titles sorting.
|
||
* @see {@link https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Intl/Collator Intl.Collator}
|
||
*/
|
||
export const collator = new Intl.Collator('en', {
|
||
usage: 'search',
|
||
caseFirst: 'upper',
|
||
});
|