mirror of
https://github.com/simple-icons/simple-icons.git
synced 2024-11-26 01:00:27 +02:00
98 lines
2.7 KiB
JavaScript
98 lines
2.7 KiB
JavaScript
/**
|
|
* @fileoverview
|
|
* Linters for the package that can't easily be implemented in the existing
|
|
* linters (e.g. jsonlint/svglint).
|
|
*/
|
|
|
|
import process from 'node:process';
|
|
import { URL } from 'node:url';
|
|
import fakeDiff from 'fake-diff';
|
|
import { getIconsDataString, normalizeNewlines, collator } from '../../sdk.mjs';
|
|
|
|
/**
|
|
* Contains our tests so they can be isolated from each other.
|
|
* @type {{[k:string]: () => (string|undefined)}}
|
|
*/
|
|
const TESTS = {
|
|
/* Tests whether our icons are in alphabetical order */
|
|
alphabetical: (data) => {
|
|
const collector = (invalidEntries, icon, index, array) => {
|
|
if (index > 0) {
|
|
const prev = array[index - 1];
|
|
const comparison = collator.compare(icon.title, prev.title);
|
|
if (comparison < 0) {
|
|
invalidEntries.push(icon);
|
|
} else if (comparison === 0) {
|
|
if (prev.slug) {
|
|
if (!icon.slug || collator.compare(icon.slug, prev.slug) < 0) {
|
|
invalidEntries.push(icon);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
return invalidEntries;
|
|
};
|
|
const format = (icon) => {
|
|
if (icon.slug) {
|
|
return `${icon.title} (${icon.slug})`;
|
|
}
|
|
return icon.title;
|
|
};
|
|
|
|
const invalids = data.icons.reduce(collector, []);
|
|
if (invalids.length) {
|
|
return `Some icons aren't in alphabetical order:
|
|
${invalids.map((icon) => format(icon)).join(', ')}`;
|
|
}
|
|
},
|
|
|
|
/* Check the formatting of the data file */
|
|
prettified: (data, dataString) => {
|
|
const normalizedDataString = normalizeNewlines(dataString);
|
|
const dataPretty = `${JSON.stringify(data, null, 4)}\n`;
|
|
|
|
if (normalizedDataString !== dataPretty) {
|
|
const dataDiff = fakeDiff(normalizedDataString, dataPretty);
|
|
return `Data file is formatted incorrectly:\n\n${dataDiff}`;
|
|
}
|
|
},
|
|
|
|
/* Check redundant trailing slash in URL */
|
|
checkUrl: (data) => {
|
|
const hasRedundantTrailingSlash = (url) => {
|
|
const origin = new URL(url).origin;
|
|
return /^\/+$/.test(url.replace(origin, ''));
|
|
};
|
|
|
|
const allUrlFields = [
|
|
...new Set(
|
|
data.icons
|
|
.flatMap((icon) => [icon.source, icon.guidelines, icon.license?.url])
|
|
.filter(Boolean),
|
|
),
|
|
];
|
|
|
|
const invalidUrls = allUrlFields.filter((url) =>
|
|
hasRedundantTrailingSlash(url),
|
|
);
|
|
|
|
if (invalidUrls.length > 0) {
|
|
return `Some URLs have a redundant trailing slash:\n\n${invalidUrls.join(
|
|
'\n',
|
|
)}`;
|
|
}
|
|
},
|
|
};
|
|
|
|
const dataString = await getIconsDataString();
|
|
const data = JSON.parse(dataString);
|
|
|
|
const errors = (
|
|
await Promise.all(Object.values(TESTS).map((test) => test(data, dataString)))
|
|
).filter(Boolean);
|
|
|
|
if (errors.length > 0) {
|
|
errors.forEach((error) => console.error(`\u001b[31m${error}\u001b[0m`));
|
|
process.exit(1);
|
|
}
|