mirror of
https://github.com/Mibew/simple-icons.git
synced 2024-11-17 19:04:13 +03:00
a930dc57ec
* convert scripts to esm
* fix tests
* fix tests
* fix lints
* syncFs to fsSync
* named export for fs
Co-authored-by: LitoMore <LitoMore@users.noreply.github.com>
* fsSync to { promises as fs }
* convert update-svgs-count to esm
* rename data to icons
* fix build script
* switch svglintrc file to mjs
* use node: protocol
* pluralize getIcons
Co-authored-by: LitoMore <LitoMore@users.noreply.github.com>
106 lines
3.0 KiB
JavaScript
106 lines
3.0 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';
|
||
|
||
/**
|
||
* 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(/\+/g, 'plus')
|
||
.replace(/\./g, 'dot')
|
||
.replace(/&/g, 'and')
|
||
.replace(/đ/g, 'd')
|
||
.replace(/ħ/g, 'h')
|
||
.replace(/ı/g, 'i')
|
||
.replace(/ĸ/g, 'k')
|
||
.replace(/ŀ/g, 'l')
|
||
.replace(/ł/g, 'l')
|
||
.replace(/ß/g, 'ss')
|
||
.replace(/ŧ/g, 't')
|
||
.normalize('NFD')
|
||
.replace(/[^a-z0-9]/g, '');
|
||
|
||
/**
|
||
* 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 = path.dirname(fileURLToPath(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));
|