Mibew/simple-icons
1
0
Fork 0
mirror of https://github.com/Mibew/simple-icons.git synced 2025-05-02 09:06:43 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

Simplify how scripts get icon slugs (#5066)

Browse Source 
* Accept icon rather than title in `iconToSlug`

This removes the need in (most of the) calls to this function to
seperately check if there is a custom slug already defined for the icon.

* Rename `titleToSlug` to `getIconSlug`

* Revert unnecessary style change

* Update function documentation

* Keep `titleToSlug` and add `getIconSlug` helper

Unfortunately `this` is not available because we're using arrow syntax
for these functions, but refering to `titleToSlug` through
`module.exports` works fine as well.

* Fix parameter name in `getIconSlug` docs
This commit is contained in:
Eric Cornelissen 2021-02-22 14:15:37 +01:00 committed by GitHub
parent 1df43dd50b
commit 8431fd9683
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 14 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
scripts/build-package.js
View File

@ -25,7 +25,7 @@ const indexTemplate = fs.readFileSync(indexTemplateFile, UTF8);
const iconObjectTemplate = fs.readFileSync(iconObjectTemplateFile, UTF8); const iconObjectTemplate = fs.readFileSync(iconObjectTemplateFile, UTF8);
const data = require(dataFile); const data = require(dataFile);
const { titleToSlug } = require("./utils.js"); const { getIconSlug, titleToSlug } = require("./utils.js");
// Local helper functions // Local helper functions
function escape(value) { function escape(value) {
@ -61,7 +61,7 @@ function minifyAndWrite(filepath, rawJavaScript) {
// 'main' // 'main'
const icons = []; const icons = [];
data.icons.forEach(icon => { data.icons.forEach(icon => {
const filename = icon.slug || titleToSlug(icon.title); const filename = getIconSlug(icon);
const svgFilepath = path.resolve(iconsDir, `${filename}.svg`); const svgFilepath = path.resolve(iconsDir, `${filename}.svg`);
icon.svg = fs.readFileSync(svgFilepath, UTF8).replace(/\r?\n/, ''); icon.svg = fs.readFileSync(svgFilepath, UTF8).replace(/\r?\n/, '');
icon.slug = filename; icon.slug = filename;

4
scripts/get-filename.js
View File

@ -5,7 +5,7 @@
* icon SVG filename to standard output. * icon SVG filename to standard output.
*/ */
const utils = require("./utils.js"); const { titleToSlug } = require("./utils.js");
if (process.argv.length < 3) { if (process.argv.length < 3) {
console.error("Provide a brand name as argument"); console.error("Provide a brand name as argument");
@ -14,6 +14,6 @@ if (process.argv.length < 3) {
const brandName = process.argv.slice(3) const brandName = process.argv.slice(3)
.reduce((acc, arg) => `${acc} ${arg}`, process.argv[2]); .reduce((acc, arg) => `${acc} ${arg}`, process.argv[2]);
const filename = utils.titleToSlug(brandName); const filename = titleToSlug(brandName);
console.log(`For '${brandName}' use the file 'icons/${filename}.svg'`); console.log(`For '${brandName}' use the file 'icons/${filename}.svg'`);
} }

6
scripts/utils.js
View File

@ -4,6 +4,12 @@
*/ */
module.exports = { module.exports = {
/**
* Get the slug/filename for an icon.
* @param {Object} icon The icon data as it appears in _data/simple-icons.json
*/
getIconSlug: icon => icon.slug || module.exports.titleToSlug(icon.title),
/** /**
* Converts a brand title into a slug/filename. * Converts a brand title into a slug/filename.
* @param {String} title The title to convert * @param {String} title The title to convert

4
tests/icons.test.js
View File

@ -1,8 +1,8 @@
const { icons } = require('../_data/simple-icons.json'); const { icons } = require('../_data/simple-icons.json');
const { titleToSlug } = require('../scripts/utils.js'); const { getIconSlug } = require('../scripts/utils.js');
icons.forEach(icon => { icons.forEach(icon => {
const filename = icon.slug || titleToSlug(icon.title); const filename = getIconSlug(icon);
const subject = require(`../icons/${filename}.js`); const subject = require(`../icons/${filename}.js`);
test(`${icon.title} has a "title"`, () => { test(`${icon.title} has a "title"`, () => {

4
tests/index.test.js
View File

@ -1,6 +1,6 @@
const { icons } = require('../_data/simple-icons.json'); const { icons } = require('../_data/simple-icons.json');
const simpleIcons = require('../index.js'); const simpleIcons = require('../index.js');
const { titleToSlug } = require("../scripts/utils.js"); const { getIconSlug } = require("../scripts/utils.js");
icons.forEach(icon => { icons.forEach(icon => {
const name = icon.slug || icon.title; const name = icon.slug || icon.title;
@ -45,7 +45,7 @@ icons.forEach(icon => {
} }
test(`${icon.title} can be found by it's slug`, () => { test(`${icon.title} can be found by it's slug`, () => {
const name = icon.slug || titleToSlug(icon.title); const name = getIconSlug(icon);
const found = simpleIcons.get(name); const found = simpleIcons.get(name);
expect(found).toBeDefined(); expect(found).toBeDefined();
expect(found.title).toEqual(icon.title); expect(found.title).toEqual(icon.title);