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

187 lines
4.9 KiB
JavaScript

import process from 'node:process';
import chalk from 'chalk';
import { input, confirm, checkbox } from '@inquirer/prompts';
import autocomplete from 'inquirer-autocomplete-standalone';
import getRelativeLuminance from 'get-relative-luminance';
import { search } from 'fast-fuzzy';
import {
URL_REGEX,
collator,
getIconsDataString,
titleToSlug,
normalizeColor,
} from '../sdk.mjs';
import { getJsonSchemaData, writeIconsData } from './utils.js';
const hexPattern = /^#?[a-f0-9]{3,8}$/i;
const iconsData = JSON.parse(await getIconsDataString());
const jsonSchema = await getJsonSchemaData();
const titleValidator = (text) => {
if (!text) return 'This field is required';
if (
iconsData.icons.find(
(x) => x.title === text || titleToSlug(x.title) === titleToSlug(text),
)
)
return 'This icon title or slug already exists';
return true;
};
const hexValidator = (text) =>
hexPattern.test(text) || 'This should be a valid hex code';
const sourceValidator = (text) =>
URL_REGEX.test(text) || 'This should be a secure URL';
const hexTransformer = (text) => {
const color = normalizeColor(text);
const luminance = hexPattern.test(text)
? getRelativeLuminance.default(`#${color}`)
: -1;
if (luminance === -1) return text.toUpperCase();
return chalk.bgHex(`#${color}`).hex(luminance < 0.4 ? '#fff' : '#000')(
text.toUpperCase(),
);
};
const aliasesTransformer = (text) =>
text
.split(',')
.map((x) => chalk.cyan(x))
.join(',');
const aliasesChoices = Object.entries(
jsonSchema.definitions.brand.properties.aliases.properties,
)
.filter(([k]) => ['aka', 'old'].includes(k))
.map(([k, v]) => ({ name: `${k}: ${v.description}`, value: k }));
const getIconDataFromAnswers = (answers) => ({
title: answers.title,
hex: normalizeColor(answers.hex),
source: answers.source,
...(answers.hasGuidelines ? { guidelines: answers.guidelines } : {}),
...(answers.hasLicense
? {
license: {
type: answers.licenseType,
...(answers.licenseUrl ? { url: answers.licenseUrl } : {}),
},
}
: {}),
...(answers.hasAliases
? {
aliases: aliasesChoices.reduce((previous, current) => {
const promptKey = `${current.value}AliasesList`;
if (answers[promptKey])
return {
...previous,
[current.value]: answers[promptKey]
.split(',')
.map((x) => x.trim()),
};
return previous;
}, {}),
}
: {}),
});
const answers = {};
answers.title = await input({
message: 'Title:',
validate: titleValidator,
});
answers.hex = await input({
message: 'Hex:',
validate: hexValidator,
transformer: hexTransformer,
});
answers.source = await input({
message: 'Source URL:',
validate: sourceValidator,
});
answers.hasGuidelines = await confirm({
message: 'The icon has brand guidelines?',
});
if (answers.hasGuidelines) {
answers.guidelines = await input({
message: 'Guidelines URL:',
validate: sourceValidator,
});
}
answers.hasLicense = await confirm({
message: 'The icon has brand license?',
});
if (answers.hasLicense) {
const licenseTypes =
jsonSchema.definitions.brand.properties.license.oneOf[0].properties.type.enum.map(
(license) => {
return { value: license };
},
);
answers.licenseType = await autocomplete({
message: 'License type:',
source: async (input) => {
input = (input || '').trim();
return input
? search(input, licenseTypes, { keySelector: (x) => x.value })
: licenseTypes;
},
});
answers.licenseUrl = await input({
message: `License URL ${chalk.reset('(optional)')}:`,
validate: (text) => text.length === 0 || sourceValidator(text),
});
}
answers.hasAliases = await confirm({
message: 'This icon has brand aliases?',
default: false,
});
if (answers.hasAliases) {
answers.aliasesTypes = await checkbox({
message: 'What types of aliases do you want to add?',
choices: aliasesChoices,
});
for (const x of aliasesChoices) {
if (!answers?.aliasesTypes?.includes(x.value)) continue;
answers[`${x.value}AliasesList`] = await input({
message: x.value + chalk.reset(' (separate with commas)'),
validate: (text) => text.trim().length > 0,
transformer: aliasesTransformer,
});
}
}
answers.confirmToAdd = await confirm({
message: [
'About to write the following to simple-icons.json:',
chalk.reset(JSON.stringify(getIconDataFromAnswers(answers), null, 4)),
chalk.reset('Is this OK?'),
].join('\n\n'),
});
const icon = getIconDataFromAnswers(answers);
if (answers.confirmToAdd) {
iconsData.icons.push(icon);
iconsData.icons.sort((a, b) => collator.compare(a.title, b.title));
await writeIconsData(iconsData);
console.log(chalk.green('\nData written successfully.'));
} else {
console.log(chalk.red('\nAborted.'));
process.exit(1);
}